CLI Reference
RightNow Agent is coming soon for Windows, macOS and Linux. Installation commands and workflows in these guides are reference material until the public release is available.
Shell commands and flags for the installed rightnow binary. Commands typed inside a session are in Slash Commands.
Start here
- rightnow [PROMPT]
- Start an interactive session, optionally with an initial prompt.
- -p / --single / --print PROMPT
- Run one prompt, print the response to stdout, and exit. See Headless Mode for output and exit codes.
- rightnow --help
- List the commands and flags of your installed version.
- rightnow doctor
- Check terminal, clipboard, color, and input support without opening the TUI. See Troubleshooting.
rightnow -p "Summarize this workspace"Command index
Add a command after rightnow. Capitalized words are placeholders; a vertical bar separates alternatives.
- doctor [--json] | doctor fix [ID] [--yes]
- Print the terminal report. doctor fix lists automatic fixes; with an ID it applies one, and --yes skips the confirmation. Guide.
- inspect [--json]
- Show the configuration discovered for the current directory. Guide.
- models
- List the models available to the loaded configuration.
- auth / connect
- Manage provider API keys. Guide.
- sessions
- List, search, or restore stored sessions. Guide.
- export
- Export a session transcript as Markdown. Guide.
- trace SESSION_ID
- Export or upload session trace data. Details.
- worktree
- Manage Git worktrees. Guide.
- dashboard
- Open the Agent Dashboard at startup. Guide.
- chore
- Manage the durable local repository chore queue. Guide.
- receipt
- Inspect and verify deterministic transaction receipts. Guide.
- memory
- Manage cross-session memory. Guide.
- mcp
- Manage MCP server configurations. Guide.
- plugin
- Manage plugins and marketplace sources. Guide.
- agent
- Run without the interactive UI; see the ACP transport options. Guide.
- leader / daemon
- Manage the warm agent service. Details.
- wrap CMD [ARGS...]
- Run a command in a local PTY that forwards its clipboard (experimental). Details.
- setup [--json]
- Fetch and install managed configuration. Details.
- update [--check] [--json] [--force-reinstall] [--version VERSION] [--alpha | --stable]
- Check or install an update; --json is for --check, and channel switches are mutually exclusive. Guide.
- version / v [--json]
- Print version information; --json emits machine-readable output with currentVersion and channel.
- completions SHELL
- Print a shell completion script. Details.
- du / disk-usage
- Report disk use under the effective product home.
- config sync --config PATH --template PATH
- Synchronize active configuration with a supplied configuration template. Guide.
- telemetry speed [--log PATH] [--since RFC3339] [--json]
- Summarize speed telemetry from the local unified log. Guide.
login, logout, status, and --oauth belong to retired RightNow account sign-in; use provider credentials instead.
Flag index
- -v / -V / --version
- Print the version.
- --cwd DIR
- Set the working directory.
- --leader-socket PATH
- Use a custom warm agent service socket path.
- --debug
- Enable debug logging.
- --debug-file FILE
- Write debug logs to the selected file.
- Input and output
- --prompt-json JSON--prompt-file PATH--verbatim--output-format FORMAT--include-partial-messages--json-schema SCHEMAFORMAT is plain (default), json, streaming-json, or streaming-messages-json.
- Model and prompt rules
- -m / --model MODEL--reasoning-effort / --effort EFFORT--rules / --append-system-prompt TEXT--system-prompt-override / --system-prompt TEXT
- Session selection and worktrees
- -r / --resume [ID_OR_TITLE]-c / --continue-s / --session-id UUID--fork-session-w / --worktree [NAME]--worktree-ref / --ref REF--restore-code
- Tools and permission controls
- --agent NAME--agents JSON--tools TOOLS--disallowed-tools TOOLS--max-turns N--permission-mode MODE--allow / --allowedTools RULE--deny / --disallowedTools RULE--always-approve / --yolo / --dangerously-skip-permissions--disable-web-search--sandbox PROFILE
- Interactive session controls
- --no-plan--no-subagents--experimental-memory--no-memory--no-alt-screen--minimal--fullscreen
Some flags are accepted but ignored with -p; check the headless execution controls. Permission rules are in Permissions and Safety.
Models and shell completions
rightnow modelsCompletion generation prints a shell script; it does not activate that script in your current shell. Supported shells: bash, elvish, fish, powershell, zsh.
Windows PowerShell
rightnow completions powershellmacOS zsh
rightnow completions zshLinux bash
rightnow completions bashFish and elvish work the same way, for example rightnow completions fish.
Managed configuration
Managed setup requires a deployment key or an active team credential; it is separate from choosing a model provider.
It also needs RIGHTNOW_, which the shipped configuration leaves unset.
- rightnow setup --json
- Fetch managed configuration and print it as JSON without installing it.
- rightnow setup
- Fetch and install managed configuration.
Warm agent service
The warm agent service uses rightnow leader; daemon is its compatibility alias.
- rightnow leader start
- Start the warm agent service or reuse the one already running.
- rightnow leader status
- Report whether the warm agent service is running.
- rightnow leader stop
- Gracefully stop the warm agent service.
- rightnow leader list
- List running leader processes.
- rightnow leader info
- Show details for a leader process.
- rightnow leader kill
- Stop all running leader processes.
Use --pid with status, stop, or info to target a PID from leader list. Start, status, stop, list, and info accept --json. Start needs [rightnow] warm_daemon = true, the shipped default.
Clipboard wrapper
- rightnow wrap CMD [ARGS...]
- Experimental. When stdin, stdout, and stderr are terminals and PTY setup succeeds, run the command in a local PTY and forward OSC 52 clipboard writes to the local clipboard.
- On macOS and Linux, the wrapped terminal follows window-size changes; on Windows it keeps its starting size.
- On Unix, a single quoted command string or an aliased command uses an interactive shell only in PTY mode.
- If a standard stream is not a terminal, the command runs directly without clipboard forwarding, through a non-interactive Unix shell when shell routing is needed.
- If wrapped mode fails, 1.0.5 falls back to the same direct run, even when the failure happened after the command started, so the command can run twice. Avoid wrapping commands that are unsafe to repeat.
Session traces
Use --local to export without uploading. Without it, trace uploads only when trace upload is enabled; otherwise it falls back to local export. Uploads need [telemetry] trace_upload = true.
Take SESSION_ID from rightnow sessions; see Sessions.
rightnow trace SESSION_ID --local- --output / -o PATH
- Choose the local archive path. The default is
<RIGHTNOW_HOME>/.trace-exports/ <session-id>.tar.gz - --json
- Print a machine-readable trace result.
A successful local export prints the archive path; JSON output includes status and local_path.
Review the archive before sharing it.