CLI commands

Complete reference for all Relizy CLI commands.

Overview

Relizy provides seven main commands:

Command	Description
release	Complete release workflow (bump + changelog + commit + tag + publish + provider release)
bump	Update version in package.json
changelog	Generate or update CHANGELOG.md
publish	Publish packages to npm
provider-release	Create GitHub or GitLab releases
social	Post release announcements to social media
pr-comment	Post release information as a PR/MR comment

Global Options

These options work with all commands:

--config

Specify which config file to use:

relizy release --config relizy.standalone
# Uses relizy.standalone.config.ts

--log-level

Control logging verbosity:

relizy release --log-level debug
# Levels: silent, error, warn, info, debug

--dry-run

Preview changes without making them:

relizy release --patch --dry-run

--yes

Skip all interactive prompts:

relizy release --patch --yes

Quick Examples

Full Release

# Interactive - asks for confirmation
relizy release --minor

# Automatic - no prompts
relizy release --minor --yes

Canary Release

# Publish a temporary test version
relizy release --canary

# Canary with custom preid
relizy release --canary --preid snapshot

# Canary in CI (skip prompts)
relizy release --canary --yes

Version Bump Only

# Bump patch version
relizy bump --patch

# Bump minor version
relizy bump --minor

# Bump major version
relizy bump --major

Changelog Only

# Generate changelog
relizy changelog

# From specific version
relizy changelog --from v1.0.0

Publish Only

# Publish all packages
relizy publish

# Publish specific packages
relizy publish

Provider Release Only

# Create GitHub or GitLab release
relizy provider-release

PR Comment Only

# Post release info as a PR comment
relizy pr-comment

# With specific PR number
relizy pr-comment --pr-number 42

Monorepo-Specific Options

Version Modes

Set in config file:

// relizy.config.ts
import { defineConfig } from 'relizy'

export default defineConfig({
  monorepo: {
    versionMode: 'selective', // 'unified' | 'selective' | 'independent'
  },
})

Common Workflows

Standard Release

# 1. Make changes and commit
git add .
git commit -m "feat: new feature"

# 2. Release
relizy release --minor

# Done! Version bumped, changelog updated, committed, and tagged

Release with Publishing

# Complete release + npm publish + GitHub release
relizy release --minor

Canary Release from PR

# Publish a canary version and comment on the PR
relizy release --canary --yes --pr-number 42

Preview Before Release

# See what would happen
relizy release --minor --dry-run

# If satisfied, run for real
relizy release --minor

Monorepo Selective Release

# Only release changed packages
relizy release --selective --minor

Manual Control

# Step 1: Bump version
relizy bump --minor

# Step 2: Generate changelog
relizy changelog

# Step 3: Commit and tag manually
git add .
git commit -m "chore(release): v1.2.0"
git tag v1.2.0

# Step 4: Publish
relizy publish

# Step 5: Create provider release
relizy provider-release

# Step 6: Post PR comment
relizy pr-comment

Command Chaining

While Relizy doesn't support chaining directly, you can use shell operators:

# Run multiple commands
relizy bump --patch && \
relizy changelog && \
relizy publish

# With error handling
relizy bump --patch || exit 1
relizy changelog || exit 1
relizy publish || exit 1

Exit Codes

Relizy uses standard exit codes:

• 0 - Success
• 1 - Error occurred
• 2 - Invalid arguments

Use in scripts:

if relizy release --patch; then
  echo "Release successful"
else
  echo "Release failed"
  exit 1
fi

Debug Mode

Get detailed output for troubleshooting:

relizy release --minor --log-level debug

This shows:

• Git commands being executed
• File changes
• Version calculations
• Dependency resolution
• Publishing steps

Help

Get help for any command:

# General help
relizy --help

# Command-specific help
relizy release --help
relizy bump --help
relizy changelog --help
relizy publish --help
relizy provider-release --help
relizy social --help
relizy pr-comment --help

Next Steps

Dive deeper into each command:

• release - Full release workflow
• bump - Version bumping
• changelog - Changelog generation
• publish - NPM publishing
• provider-release - GitHub/GitLab releases
• social - Social media posting
• pr-comment - PR/MR comments