Documentation

Everything you need to run inup — from npx inup to a scheduled GitHub Action maintaining one rolling upgrade PR. Prefer reading in your terminal? The full docs are also served as plain text.

• Getting startedInstall and run inup — the interactive dependency upgrader for npm, yarn, pnpm and bun. Zero config, monorepo-ready.
• CLI referenceEvery inup flag — directories, package filters, headless JSON reports, CI checks, upgrade targets and exit codes.
• Keyboard shortcutsEvery key binding in inup's interactive picker — always current, generated from the same source as the tool's help screen.
• ConfigurationThe .inuprc file — ignore packages with globs, exclude directories, extend the scan list, and control vulnerability display.
• CI & scriptingRun inup headless — gate builds with --check, generate versioned JSON dependency reports, and auto-apply safe upgrades in CI/CD.
• JSON report schemaField-by-field reference for inup's --json output — the versioned headless report, per-package entries, and the vulnerability cross-reference.
• GitHub ActionAutomate dependency upgrades with donfear/inup@v1 — one rolling pull request with safe upgrades applied, updated on every scheduled run.
• FAQ & troubleshootingCommon questions about inup — does it edit lockfiles, why a package is skipped, private registries, headless/CI detection, colors, and telemetry.

Can't find something? Open an issue — or press? inside inup for help in the terminal.