Documentation
Everything you need to get started and get the most out of Upshift.
What do you want to do?
- Install Upshift locally CLI quick start: npm global install and first commands.
- Learn the upgrade workflow Scan → explain → upgrade → fix; suggest, plan, migrate, CI.
- Add the GitHub App to my org Scan on every push and PR. Use the GitHub App doc for workflows and tokens.
- Configure the GitHub App (workflows & webhooks) Scaffold, tokens, and scan-on-PR behavior.
- See dependency health across repos (Radar) Paste JSON free; Pro saves reports on the dashboard.
-
Sign in, API keys, and what needs an account
CLI vs dashboard;
usk_keys and JARVIS. - Billing, checkout, and plan changes Stripe, seats, Radar Pro vs free Radar.
-
Tune approvals, rollback, and upgrade policy
Full
.upshiftrc.jsonreference.
For users
- User guide Quick start, workflow (scan → explain → upgrade → fix), suggest/plan, migrate, Radar, config, Python/Ruby/Go, VS Code, CI.
- CLI reference All 28 commands: scan, radar --score, upgrade, debt, license, compare, sbom, schedule, pr-description, doctor, and more.
-
Configuration
Full
.upshiftrc.jsonreference: approval, upgrade policy, registry, and schema. - Radar Central dependency view: free tier (paste/upload) and Radar Pro (persisted dashboard, history, alerts).
- Access & auth How to use the tools: CLI and Radar (no account), sign-in for dashboard and Pro, tokens and API keys.
-
Platform & billing
Hosted dashboard (api.upshiftai.dev), Stripe checkout,
usk_API keys, JARVIS, Radar Pro vs free paste. -
Capabilities
What automated tests guarantee vs best-effort AI (
explain --ai,fix). Read before spending credits. - When it breaks & guardrails Guardrails, rollback, and human-in-the-loop. How Upshift keeps upgrades safe.
- What to anticipate and test Before/after upgrade: risk, test script, checklist, fewer rollbacks.
New in v0.5
-
Upgrade debt calculator
upshift debt: total hours and cost to get current, codemod-aware. -
License compliance scan
upshift license: SPDX categorization, deny lists, copyleft detection. -
Version comparison
upshift compare pkg A B: bundle size, downloads, deps, and community confidence side-by-side. -
Scheduled CI scans
upshift schedule install: one command installs a GitHub Actions workflow. -
Environment diagnostics
upshift doctor: checks Node, git, API token, reachability, and GitHub App config.
Developers & platform
What you get today
Core workflow
- upshift scan: outdated packages & CVEs (npm, yarn, pnpm)
- upshift radar --score: A–F dependency health score
- upshift upgrade: safe upgrade with tests + rollback
- upshift migrate: AST-aware major version migration
- upshift audit --ai: AI-powered vulnerability remediation
- upshift fix: AI-generated code fixes for breaking changes
Analysis
- upshift explain: plain-English upgrade risk per package
- upshift debt: total upgrade effort in hours + cost
- upshift license: SPDX license compliance scan
- upshift compare: side-by-side version diff (size, downloads, deps)
- upshift changelog: release notes pulled from GitHub
- upshift suggest: AI-ranked upgrades with community confidence
- upshift sbom: CycloneDX 1.4 software bill of materials
- upshift badge: README health badge
Automation
- upshift schedule install: GitHub Actions workflow for scheduled scans
- upshift notify --slack: scan results to Slack or Discord
- upshift pr-description: auto-generate PR descriptions for upgrades
- upshift release: CHANGELOG from conventional commits
- upshift workspaces: monorepo fleet health scores
- GitHub App: inline PR review comments on breaking changes
- VS Code extension: inline decorations, hover hints, quick-fix lightbulbs
Home · Get started · Pricing