Choose By Scenario

Start here when you know what you want to do, but not which repoctl command to use.

I Just Opened A Repository

pnpm install
pnpm doctor

If pnpm doctor does not exist yet:

pnpm add -D repoctl
pnpm exec repo setup --yes
pnpm exec repo doctor

Keep reading: Getting Started.

I Want To Adopt repoctl In An Existing Repo

pnpm add -D repoctl
pnpm exec repo setup --yes
pnpm exec repo doctor --markdown --redact --out reports/doctor-before.md
pnpm exec repo upgrade --no-overwrite
pnpm exec repo doctor --markdown --redact --out reports/doctor-after.md

Keep reading: Adopt Existing Repositories.

I Want To Create A Package Or App

pnpm exec repo templates
pnpm exec repo new sdk --template tsdown
pnpm exec repo new docs --template vitepress --dry-run

For daily development, root scripts also work:

pnpm new sdk --template tsdown

Keep reading: Templates.

I Want To Check Before Committing

pnpm check
pnpm exec repo check --dry-run
pnpm exec repo check --full

Save the plan when automation needs it:

pnpm exec repo check --json --out reports/check-plan.json
pnpm exec repo check --markdown --redact --out reports/check-plan.md

Keep reading: Workflows and CI.

I Want To Debug CI Or Another Machine

pnpm exec repo doctor --markdown --redact --out reports/doctor.md
pnpm exec repo env support --markdown --redact --out reports/support.md
pnpm exec repo env snapshot --json --out reports/snapshot.json

Keep reading: Troubleshooting.

I Want To Sync Standard Assets

pnpm exec repo upgrade --no-overwrite
pnpm exec repo upgrade --yes
pnpm exec repo upgrade --core

Goal	Command
First adoption pass, preserve local config	repo upgrade --no-overwrite
Explicitly overwrite managed assets	repo upgrade --yes
Sync only core config	repo upgrade --core

I Want To Inspect Workspace Structure

pnpm exec repo ws ls
pnpm exec repo ws ls --json --out reports/workspaces.json
pnpm exec repo ws ls --markdown --redact --out reports/workspaces.md

I Want To Inspect Config

pnpm exec repo config inspect
pnpm exec repo cfg i --json --out reports/config.json

Keep reading: Configuration.

I Want Shorter Commands

repo tpl
repo ws ls
repo e support --markdown --redact
repo cfg i

Keep reading: Command Aliases.