CLI Commands

releasio provides a powerful command-line interface for managing releases.

---

Command Overview

Command	Description	Modifies Files
check	Preview what would happen	No
update	Update version and changelog	Yes
release-pr	Create/update release PR	Yes
release	Tag and publish release	Yes
do-release	Complete release workflow	Yes
check-pr	Validate PR title	No
init	Initialize configuration	Yes

---

Global Options

All commands support these options:

Option	Short	Description
--help	-h	Show help message
--version		Show releasio version
--verbose	-v	Enable verbose output

---

Typical Workflows

Preview → Release PR → Merge → Publish

%%{init: {'theme': 'neutral'}}%%
graph LR
    A[releasio check] --> B[releasio release-pr]
    B --> C[Review & Merge PR]
    C --> D[releasio release]

This is the recommended workflow for most projects:

1. Preview with check to see upcoming changes
2. Create PR with release-pr for review
3. Merge the PR after approval
4. Publish with release after merge

One-Command Release

releasio do-release --execute

For simpler workflows, do-release combines everything:

• Update version and changelog
• Commit changes
• Create and push tag
• Publish to PyPI

---

Dry-Run Mode

By default, commands that modify files run in dry-run mode:

# Shows what would happen (dry-run)
releasio release-pr

# Actually executes
releasio release-pr --execute

Safe by Default

Commands never make changes unless you explicitly pass --execute. Always preview first!

---

Exit Codes

Code	Meaning
0	Success
1	Error occurred
2	Invalid arguments

---

Command Details

• check

  Preview release without changes

  Details

• update

  Update version and changelog locally

  Details

• :material-pull-request:{ .lg .middle } release-pr

  Create or update release PR

  Details

• release

  Tag and publish release

  Details

• do-release

  Complete release workflow

  Details

• check-pr

  Validate PR title format

  Details