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 commands and options: scan, explain, upgrade, fix, suggest, plan, migrate, radar, 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 we keep upgrades safe.
- What to anticipate and test Before/after upgrade: risk, test script, checklist, fewer rollbacks.
Developers & platform
Home · Get started · Pricing