CLI Reference

Quick reference for all Upshift commands and options. Run upshift --help or upshift <command> --help for the latest.

Global

upshift [options] [command]
  -V, --version   output version
  -h, --help      display help

Core

scan

Scan dependencies for updates and vulnerabilities.

upshift scan [options]
  --json           Output as JSON
  --licenses       Include license per direct dependency (npm, Python)
  --report <path>  Write JSON report to file (for Radar)
  --cwd <path>     Project directory (default: .)

Supports Node (npm/yarn/pnpm), Python (pip/poetry), Ruby (bundler), Go (go.mod). Auto-detects ecosystem.

explain

Explain breaking changes for a dependency.

upshift explain <package> [options]
  --json       Output as JSON
  --risk       Show risk (low/medium/high)
  --changelog  Fetch changelog from GitHub
  --ai         AI analysis (1 credit)
  --from <v>   Current version
  --to <v>     Target version
  --cwd <path>

fix

AI-powered code fixes for breaking changes (3 credits).

upshift fix <package> [options]
  --dry-run   Preview changes without applying
  --cwd <path>

upgrade

Upgrade a dependency (single or batch). Runs tests; rolls back on failure.

upshift upgrade [package] [options]
  --to <version>   Target version (default: latest)
  --all            Upgrade all outdated
  --all-minor      Only minor/patch
  --all-patch      Only patch
  --dry-run        Show planned changes, no file changes
  -y, --yes        Skip confirmation prompts
  --skip-tests     Skip tests after upgrade
  --cwd <path>

rollback

upshift rollback [options]
  --list   List available backups
  --cwd <path>

audit

Security audit with optional AI remediation.

upshift audit [options]
  --ai       AI remediation suggestions (2 credits)
  --cwd <path>

Suggest & plan

suggest

upshift suggest [options]
  --json       Output as JSON
  --limit <n>  Max suggestions (default: 5)
  --cwd <path>

plan

upshift plan [options]
  --json        Output as JSON
  --mode <m>    all | minor | patch (default: all)
  --cwd <path>

Migrate

upshift migrate <package> [options]
  --template <name>       Template id (e.g. react-18-19)
  --template-file <path>  Custom migration JSON
  --dry-run               Preview, no file changes
  --list                  List templates for package
  --cwd <path>

Radar

upshift radar [options]
  --no-open   Only print URL, don't open browser

Interactive & monorepo

interactive

upshift interactive [options]  --cwd <path>

workspaces

upshift workspaces [options]  --cwd <path>

Notifications

upshift notify --slack <url>
upshift notify --discord <url>
upshift notify --webhook <url>

Setup & billing

upshift init — Create .upshiftrc.json.   upshift credits — Check balance.   upshift buy-credits --pack <size> — Credit packs.   upshift subscribe --tier pro — Pro/Team.   upshift status — Subscription and credit status.

Environment

OPENAI_API_KEY — For AI explain/fix (or use credits with Upshift API).   UPSHIFT_RECORD_OUTCOMES=1 — Append outcomes to .upshift/outcomes.json.   UPSHIFT_CREDITS_ENDPOINT / UPSHIFT_API_TOKEN — Override credits API.

Options can be set in .upshiftrc.json; see Configuration. CLI flags override config.