Skip to main content

Usage

The directory you launch OrbCode from becomes the workspace directory: the default target for file operations and commands, and the file listing the model sees in its environment details.

Interactive mode

orbcode                 start an interactive session in the current directory
orbcode "<prompt>"      start an interactive session with an initial prompt
orbcode login           sign in to MatterAI (browser device flow)
orbcode --model <id>    use a specific model for this run (also -m)
orbcode --resume <id>   resume a previous session by id (also -r)
orbcode --version       print version
orbcode --help          show help
The TUI always takes over the full terminal screen on launch (prior shell output stays in scrollback).

Headless mode

orbcode -p "explain the build pipeline in this repo"
orbcode -p "fix the lint errors" --yolo
Prints only the final content to stdout (the completion result, or the last assistant message) — no tool activity, no intermediate text. Errors go to stderr. Without --yolo, edit/command approvals are auto-denied (read-only analysis). Followup questions are auto-answered with “proceed with best judgment”.
flageffect
-p "<prompt>"run a single prompt non-interactively, print only the final response
--yolonon-interactive with edits/commands auto-approved (dangerous ones still prompt)
--model <id>use a specific model for this run (also -m)
--resume <id>resume a previous session by id (also -r)

Slash commands

commandaction
/helplist commands
/modelscrollable model picker (/model pro / /model mini / full id selects directly)
/clearclear the screen only, like the terminal’s clear — the conversation and context continue
/newstart a fresh conversation/session with a clean slate
/resumepick a previous session for this directory and continue it (screen is cleared, conversation replayed)
/analyticsopen the MatterAI analytics dashboard (app.matterai.so/orbital) in the browser
/compactsummarize the conversation and replace history with the summary
/tasksprint the current task list
/statusversion, model, account, gateway, context usage, cost, approval modes
/costshow session cost and fetch account balance
/initanalyze the codebase and create/improve AGENTS.md
/loginstart the browser sign-in flow
/logoutremove the saved token
/versionprint the CLI version
/exitquit
Every menu in the CLI (slash commands, @-files, model picker, session picker, followups) is navigable with / and selectable with enter. A partial command like /mod + enter runs the highlighted match.

Keyboard shortcuts

keyaction
Escinterrupt the running turn (or cancel login polling / close a menu)
Ctrl+Cquit
Ctrl+Otoggle thinking display for the whole transcript (past turns included)
Shift+Tabcycle approval mode: ask → accept edits → auto-approve
/ input history, or navigate any open menu
Ctrl+A / Ctrl+Estart / end of line
Ctrl+Uclear the input line

Approvals & safety

Read-only tools (read/list/search/web/todos) run without prompting. Mutating tools prompt first:
  • File edits (file_edit, multi_file_edit, file_write) — prompt shows the target; y allow once, n deny, a allow for the rest of the session.
  • Commands (execute_command) — prompt shows the exact command line. The model classifies commands with an isDangerous flag; dangerous commands (deletes, force-pushes, system changes) can never be auto-approved — no a option, and --yolo/session-approval don’t apply.
A denial is reported back to the model as “The user denied this operation.” so it can adjust course rather than fail.
Use Shift+Tab at runtime to cycle the approval mode: askaccept edits onauto-approve. The session defaults can also be set in settings.json via autoApproveEdits and autoApproveSafeCommands (dangerous commands still always prompt).

Sessions

Sessions are stored in ~/.orbcode/sessions/<id>.json and power /resume and --resume <id>. The backend-generated task title is fetched once per task and shows in the status bar, the session file, and the terminal window title: <title> (orbcode).

Tools

Active in the CLI (schemas byte-identical to the extension’s native tools):
toolexecutor notes
read_fileline-numbered output, 1000-line cap, offset/limit
file_editsingle replacement; unique-match enforcement; replace_all; empty old_string = whole file
multi_file_editbatched edits grouped per file, per-edit OK/FAILED results
file_writecreates parent dirs, full-content writes
list_filesoptional recursive, ignores node_modules/.git/build dirs, 800-entry cap
search_filesregex search with glob file_pattern, 300-match cap, binary skip
execute_commanduser’s shell, 120s timeout, 30k output cap, optional cwd
web_search / web_fetchproxied through the MatterAI backend with your token
update_todo_listdrives the TUI todo panel
ask_followup_questioninteractive menu in the TUI
attempt_completionends the turn with a completion card