CLI overview
Every command group, the flags every command takes, and how to get help without signing in.
Every part of the CLI runs under one command, rehearsal, which is the only name it installs. These reference pages list every command it has, with the arguments, flags and examples its own help prints, so you can look up what a command takes. If you are new to the CLI, start with Install and sign in, which takes you through the first commands in order.
Get help in the terminal Link to Get help in the terminal
Help works without signing in and without reaching Rehearsal, because the CLI carries the description of every command with it. rehearsal help lists the command groups, rehearsal help <group> lists the commands in one group, and --help after any command prints its usage, flags and examples. A coding agent can read the same description as JSON with rehearsal help <command> --json, or read rehearsal help agent-workflow, a page written for agents.
rehearsal helprehearsal help dorehearsal run wait --helprehearsal help run wait --jsonCommand groups Link to Command groups
Every command belongs to one group, and rehearsal help <group> takes the names in the first column. The last column links to the page that documents the group's commands.
| Group | What it covers | Page |
|---|---|---|
do | Start work. Type the word alone and it asks what it needs. | Run commands |
results | Read what the work found. | Test commands |
your project | See what the work runs on. | Project commands |
you and setup | Sign in and choose what this repository works on. | CLI overview |
Flags for every command Link to Flags for every command
Every command takes these flags as well as its own, so the tables on the other reference pages leave them out.
| Flag | Description |
|---|---|
--json | Print one JSON object, ask nothing, and open no browser. REHEARSAL_OUTPUT=json does the same for every command. |
--fields <name> | With --json, keep only these fields of the answer, or of each item in a list. Give a comma list or repeat it. Every field is kept by default. |
--no-input | Never ask a question. A missing choice becomes an error. |
--request-timeout <time> | How long to wait for each answer from Rehearsal, such as 15s or 500ms. The default is 15s, at most 5m. |
--api <url> | Use another Rehearsal API. |
--help, -h | Show how to use a command. |
--version, -v | Show the installed version. |
Output and exit codes Link to Output and exit codes
With --json, a command prints one JSON object instead of text, and its exit code tells a script how it ended. JSON output and exit codes describes that object and what each exit code means.
REHEARSAL_OUTPUT=json does what --json does, for every command. --fields keeps only the fields of the answer you name. A command that starts paid work or changes something takes --dry-run, which checks it and does nothing. JSON output shows both.
rehearsal help Link to rehearsal help
Show how to use Rehearsal.
Help works offline and without signing in. With --json, a command's help is its full description for a script: its flags and their values, the questions it asks, and its effect.
rehearsal help [topic...]| Argument | Description |
|---|---|
[topic...] | A group, a command, or agent-workflow. |
# See every grouprehearsal help# Learn one commandrehearsal help run# Describe a command for a scriptrehearsal help run --json# Read the page written for coding agentsrehearsal help agent-workflow