Uptide documentation
For anyone running Uptide on a repository (the first section) and for anyone changing Uptide itself (the second). Start with getting started.
Using Uptide
Section titled “Using Uptide”uptide --help and uptide <command> --help are the authority on flags; these pages add
what help cannot show.
| Page | What it answers |
|---|---|
| Getting started | Install nothing, run the four commands, what Uptide needs from your repository |
| Concepts | Tiers, what “breaking” means, the coverage line, exit codes |
uptide list | Discovery: priorities, groups, usage counts, what the scan reads |
uptide check | What an upgrade breaks at your call sites, the HTML report |
uptide plan | The order to upgrade in, with the effort each one takes |
uptide fix | A verified migration on a new branch, step by step; verify and clean |
uptide pr | Pushing a finished branch and its pull request description; pr-body |
uptide telemetry | The opt-in, the switches, what an event contains |
| Models | Providers, defaults, --max-cost, OPENAI_BASE_URL |
| CI | Checking and migrating Renovate and Dependabot pull requests with the GitHub Action |
| Privacy | What runs where, what leaves your machine, and the isolation model |
| Troubleshooting | Yarn PnP, bun lockfiles, proxies and corepack, memory limits, “advisories not checked” |
| FAQ | Renovate and Dependabot, where code goes, packages without a pack, pushing |
Contributing and internals
Section titled “Contributing and internals”| Page | What it holds |
|---|---|
| Contributing | Setup, the rules that do not bend, writing a pack, sign-off |
| Migration packs | The public pack contract, ground truth, scoring, uptide pack |
| Architecture | How the engine works: discovery, the check pipeline, diff semantics, packs |
| Decisions | Why things are the way they are, one record per decision |
| Development | Evaluation and release tooling |
| Releasing | How releases happen, the emergency dry run, one-time setup |
| Priorities | The rules and weights behind PRIORITIES in uptide list |
| Telemetry internals | Exact event fields, local files, delivery, release configuration |
| Package-manager smoke | The packed CLI on npm, pnpm and Yarn fixtures in clean containers |
| Provider evaluation | The measured storefront comparison of Anthropic, OpenAI and Gemini |
| Model pricing | Rates, token estimation and the scope of budget accounting |
| Security | The isolation model and how to report a vulnerability |