CLI Reference
This page is the command and flag reference for RightNow Agent. Use it when you know the task and need the shell syntax or a link to the detailed workflow.
Start with help
- Check the commands available in your installed version.
- Run diagnostics before starting a model-backed task.
- Choose an interactive session or one headless prompt.
rightnow --helprightnow doctor| Command or option | Purpose |
|---|---|
| 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. |
rightnow -p "Summarize this workspace"For setup failures, follow Troubleshooting. For task output and exit codes, see Headless Mode.
Command index
Syntax in the tables is reference notation: replace capitalized arguments, and choose one alternative separated by a vertical bar. Add a command after rightnow.
| Command or option | Purpose |
|---|---|
| doctor | Check terminal, clipboard, color, and input support without opening the TUI. Guide. |
| inspect [--json] | Show the configuration discovered for the current directory. Guide. |
| agent | Run without the interactive UI; see the ACP transport options. Guide. |
| chore | Manage the durable local repository chore queue. Guide. |
| auth / connect | Manage provider API keys. Guide. |
| mcp | Manage MCP server configurations. Guide. |
| plugin | Manage plugins and marketplace sources. Guide. |
| memory | Manage cross-session memory. Guide. |
| receipt | Inspect and verify deterministic transaction receipts. Guide. |
| sessions | List, search, or restore stored sessions. Guide. |
| export | Export a session transcript as Markdown. Guide. |
| worktree | Manage Git worktrees. Guide. |
| du / disk-usage | Report disk use under the effective product home. Guide. |
| dashboard | Open the Agent Dashboard at startup. Guide. |
| version / v | Print version information; --json emits machine-readable output. |
| 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. |
| config sync | Synchronize active configuration with a supplied configuration template. Guide. |
| telemetry speed | Report local speed telemetry. Guide. |
login, logout, status, and --oauth belong to retired RightNow account sign-in; use provider credentials instead.
The remaining commands are documented in the sections below: models and completions, setup, leader, wrap, and trace.
Flag index
| Flag syntax | Details |
|---|---|
| -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. |
| --prompt-json JSON--prompt-file PATH--verbatim--output-format FORMAT--include-partial-messages--json-schema SCHEMA | Input and output |
| -m / --model MODEL--reasoning-effort / --effort EFFORT--rules / --append-system-prompt TEXT--system-prompt-override / --system-prompt TEXT | Model and prompt rules |
| -r / --resume [ID_OR_TITLE]-c / --continue-s / --session-id UUID--fork-session-w / --worktree [NAME]--worktree-ref / --ref REF--restore-code | Session selection and worktrees |
| --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 | Tools and permission controls |
| --no-plan--no-subagents--experimental-memory--no-memory--no-alt-screen--minimal--fullscreen | Interactive session controls |
Read the headless execution controls before combining flags with -p; that guide identifies accepted flags that do not affect headless execution. Use Permissions and Safety to choose permission rules.
Models and shell completions
List the models available to the loaded configuration.
rightnow modelsCompletion generation prints a shell script; it does not activate that script in your current shell.
Windows PowerShell
rightnow completions powershellmacOS zsh
rightnow completions zshLinux bash
rightnow completions bashFish
rightnow completions fishManaged configuration
Managed setup requires a deployment key or an active team credential; it is separate from choosing a model provider.
1. Preview
Fetch managed configuration and print it as JSON without installing it.
rightnow setup --json2. Install
Fetch and install managed configuration.
rightnow setupWarm agent service
The warm agent service uses rightnow leader; daemon is its compatibility alias.
Use --pid with status, stop, or info to target a PID from leader list. Start, status, stop, list, and info accept --json.
| Command or option | Purpose |
|---|---|
| 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. |
Check status
rightnow leader statusStart
rightnow leader startStop
rightnow leader stopClipboard wrapper
| Command or option | Purpose |
|---|---|
| rightnow wrap CMD [ARGS...] | 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. |
In PTY mode, the wrapped terminal follows window-size changes.
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 or PTY setup fails before launch, the fallback runs without clipboard forwarding and uses a non-interactive Unix shell when shell routing is needed.
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.
Template: replace SESSION_ID with an existing ID from Sessions.
rightnow trace SESSION_ID --local| Command or option | Purpose |
|---|---|
| --output / -o PATH | Choose the local archive path. |
| --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. Use Troubleshooting if diagnostics or configuration need attention.