Castellan
Reference · Reeve
Reeve's command line
Every command of Reeve's command line, for developers and scripts, with how to run the installed copy's commands when there's no reeve on your PATH.
- Article
- 1210
- Applies to
- Reeve 0.17.2
- Last reviewed
- For
- For developers
Running a command#
Nothing you must do needs a command: jobs are approved, turned on and run from Reeve's page. The commands are for developers, scripts and the other agents.
Reeve's install puts nothing on your PATH, so there's no reeve command. Run the installed copy with Node:
node $HOME\.reeve\app\src\cli.ts jobs listIn cmd, %USERPROFILE% stands for $HOME. Wherever Reeve prints one of its own commands (in jobs list, the digest, its tasks), it prints the whole line, with the node its tasks run: paste it as it is. Below, reeve <command> is short for that line.
Duty and the page#
| Command | What it does |
|---|---|
reeve start | Back on duty: the rounds run. Starts the page if it's down. |
reeve stop | Off duty until start: no round runs. The page and the MCP tools stay up. |
reeve shutdown | Ends the page's process. Duty is unchanged. |
reeve status [--json] | On or off duty, the accelerators, models and limits, and Kept off the cloud. --json is what Castellan reads. |
reeve dashboard [--port N] | Serves the page, unless it's running already. |
reeve mcp | Runs the stdio MCP server: what your assistant starts. |
Start and Stop on Reeve's card in Castellan run start and stop.
Jobs#
| Command | What it does |
|---|---|
reeve jobs list | Each job: on or off, approved or not, its last result, and when it runs next. |
reeve jobs run [--due] [name...] | Runs the jobs named (or the due ones). A job that changes repositories and is off runs dry. |
reeve jobs approve <name> | Approves the job's script as it is now, by its SHA-256. A job that changes repositories is approved only on its own. |
reeve jobs on <name> / off <name> | Turns a job that changes repositories on (its next run is a dry run) or off. |
reeve jobs digest | Prints the digest. |
reeve jobs ack | Marks the alerts seen. They stay open until put right. |
Asking it things#
The same work as the MCP tools, from a terminal:
| Command | What it does |
|---|---|
reeve triage <logfile> [--question TEXT] | Triages a log. Given a Maestro run's folder, also looks at the failing step's screenshot. |
reeve search <root> <query> [--k N] [--glob G] | Searches code by meaning. |
reeve index <root> | Builds or refreshes a repository's search index to completion. |
reeve summarize <file...> [--focus TEXT] | Summarises files. |
reeve map <instruction> <file...> | Asks each file the same question. |
reeve ask <prompt> [--file F]... | One small task for the model. |
reeve cluster <path>... [--field F] [--threshold T] [--no-label] | Groups near-duplicate texts. |
reeve screens [png or folder]... [--days N] [--source DIR]... | Layout checks on screenshots. |
reeve failures [list] | UI-test failures seen so far, by flow and failing step. |
reeve failures label <n or text> flake|real|fixed|clear [--sha COMMIT] [--note TEXT] | Labels one: a known flake stops alerting; fixed judges later runs by whether their build has the fix. |
Docs and dependencies#
| Command | What it does |
|---|---|
reeve docs-detect <root> | The project's dependencies, their exact versions, and the docs stored. |
reeve docs-sync-project <root> [--modules DIR]... [--all] [--refresh] | Fetches version-pinned docs for a project. |
reeve docs-ask <library> <question> [--root R] [--importer I] [--version V] | Answers from those docs, with checked quotes. |
reeve docs-list | The docs stored. |
reeve lint-docs <root> | Deprecated and removed APIs in use, from the installed types and the pinned docs. Writes a report to %USERPROFILE%\.reeve\lint. |
reeve upgrades <root> [--only a,b] | Which outdated dependencies' breaking changes name APIs this code uses. |
reeve health <root> | Dependency health: security alerts, deprecated APIs and breaking upgrades, per package. |
See Version-pinned docs, docs lint and the upgrade scout.
Repositories and branches#
| Command | What it does |
|---|---|
reeve repos [--json] [--refresh] | Every repository on this PC, and what the rounds do there. |
reeve repos ignore <name or path>... | Leaves a repository alone: no rounds. |
reeve repos include <name or path>... | Looks after it again. |
reeve projects [--json] | The projects the repository jobs work on. |
reeve branches [--json] | The last merged-branch cleanup, and the last deletions with the command that restores each. |
reeve branches clean [--dry-run] | Runs the cleanup now; --dry-run says what it would delete, from the refs as last fetched. |
Your assistant#
| Command | What it does |
|---|---|
reeve hooks [on|off] | Reeve's reminders for the terminal assistant whose hooks it supports, and its read-only tools allowed without asking: on, off, or where they stand. |
reeve ai-use [--json] [--report] | Whether your AI sessions use Reeve, and if too few do, why. --report writes the email to send us when it's a gap in Reeve. |
Accelerators#
With the Smith hired, the Smith sets up and keeps the accelerators, and these only report.
| Command | What it does |
|---|---|
reeve accelerators [--json] | What this PC has (NPU, GPUs, CPU), what's set up, and the recommended order. |
reeve accelerators setup [<id>...] [--yes] [--dry-run] [--serve chat,vision,embed,rerank] | Without the Smith: downloads a model server and the models for each GPU (or the ids given, cpu too), checked against their checksums. Says how much it will download, and asks first. |
Installing#
Castellan installs, updates and removes Reeve for you. By hand:
| Command | What it does |
|---|---|
node <unpacked release>\src\cli.ts install [--no-start] [--dry-run] | Installs a release into %USERPROFILE%\.reeve\app, beside the copy it replaces, and swaps it in at the end; registers its two scheduled tasks. |
reeve uninstall [--purge] [--dry-run] | Removes the installed copy and its tasks. --purge removes its data folder too. |
Related articles
Is this page right?
If something on it is wrong or out of date, tell us and we'll fix the page.
Still stuck? Write to support@castellan-software.com and mention article 1210. Every version of Reeve, and what changed in it, is in its release notes.