CLI Commands
Complete reference for Universal Release CLI commands.
publishβ
Publish packages to registries.
release publish [options]
Optionsβ
| Option | Description |
|---|---|
--ecosystem <name> | Specific ecosystem (npm, cargo, docker, python, go) |
--dry-run | Test without publishing |
--tag <tag> | Publication tag (latest, beta, next) |
--registry <url> | Override registry URL |
--skip-validation | Skip validation checks |
--skip-build | Skip build step |
--skip-tests | Skip test step |
Examplesβ
# Auto-detect and publish
release publish
# Specific ecosystem
release publish --ecosystem npm
# Dry run
release publish --dry-run
# Prerelease
release publish --tag beta
# Skip validation
release publish --skip-tests --skip-build
versionβ
Manage package versions.
release version [options]
Optionsβ
| Option | Description |
|---|---|
--bump <level> | Bump version (major, minor, patch) |
--set <version> | Set explicit version |
--detect | Auto-detect from commits |
--pre <identifier> | Prerelease identifier (alpha, beta, rc) |
Examplesβ
# Show current version
release version
# Bump version
release version --bump patch
release version --bump minor
release version --bump major
# Set explicit version
release version --set 2.0.0
# Auto-detect from commits
release version --detect
# Create prerelease
release version --bump minor --pre beta
secretsβ
Manage encrypted credentials.
release secrets <command> [key]
Commandsβ
| Command | Description |
|---|---|
set <key> | Store secret in OS keychain |
get <key> | Retrieve secret |
has <key> | Check if secret exists |
delete <key> | Remove secret |
export <keys...> | Export to .env format |
import | Import from .env file |
Examplesβ
# Store secret
release secrets set NPM_TOKEN
# Retrieve secret
release secrets get NPM_TOKEN
# Check existence
release secrets has NPM_TOKEN
# Delete secret
release secrets delete NPM_TOKEN
# Export multiple
release secrets export NPM_TOKEN CARGO_TOKEN
# Import from .env
release secrets import < .env
validateβ
Run validation checks without publishing.
release validate [options]
Optionsβ
| Option | Description |
|---|---|
--ecosystem <name> | Validate specific ecosystem |
--skip-build | Skip build validation |
--skip-tests | Skip test validation |
--skip-lint | Skip linting validation |
Examplesβ
# Validate all
release validate
# Validate specific ecosystem
release validate --ecosystem cargo
# Skip certain checks
release validate --skip-lint
configβ
Manage configuration.
release config [options]
Optionsβ
| Option | Description |
|---|---|
--validate | Validate configuration file |
--show | Display merged configuration |
--init | Create default configuration |
Examplesβ
# Validate config
release config --validate
# Show merged config
release config --show
# Initialize new config
release config --init
rollbackβ
Rollback published versions (where supported).
release rollback <version> [options]
Optionsβ
| Option | Description |
|---|---|
--strategy <type> | Rollback strategy (deprecate, yank) |
--ecosystem <name> | Specific ecosystem |
--reason <text> | Reason for rollback |
Examplesβ
# Rollback npm (deprecate)
release rollback 1.2.3 --strategy deprecate
# Rollback cargo (yank)
release rollback 1.2.3 --strategy yank --ecosystem cargo
# With reason
release rollback 1.2.3 --reason "Critical security issue"
initβ
Initialize Universal Release in a project.
release init [options]
Optionsβ
| Option | Description |
|---|---|
--ecosystem <name> | Primary ecosystem |
--monorepo | Enable monorepo support |
Examplesβ
# Interactive setup
release init
# Specific ecosystem
release init --ecosystem cargo
# Monorepo
release init --monorepo
Global Optionsβ
Available for all commands:
| Option | Description |
|---|---|
--config <path> | Config file path (default: .release.yaml) |
--verbose | Verbose output |
--quiet | Minimal output |
--help | Show help |
--version | Show version |
Examplesβ
# Custom config location
release publish --config .config/release.yaml
# Verbose output
release publish --verbose
# Quiet mode
release publish --quiet
Environment Variablesβ
Override configuration via environment variables:
# Registry override
RELEASE_NPM_REGISTRY=https://npm.company.com release publish
# Skip validation
RELEASE_SKIP_VALIDATION=true release publish
# Credentials
NPM_TOKEN=xxx release publish
Exit Codesβ
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Configuration error |
| 3 | Validation failed |
| 4 | Publication failed |
| 5 | Rollback failed |
Next Stepsβ
- Configuration - Configuration guide
- API Reference - Programmatic usage