Skip to content
Documentation

CLI command reference

Run champrep --help and champrep COMMAND --help for the exact flags shipped by the installed version. This page summarizes the current public command tree.

FlagPurpose
--env NAMEOverride the active Gateway environment for one command.
--profile IDUse another stored account for one command without changing the active account.
-v, --verboseLog request and response metadata with the authorization header redacted.
--debugAdd request and response bodies to diagnostic output. Use cautiously around sensitive data.
--jsonEmit machine-readable JSON where supported.
--no-colorDisable ANSI color. The CLI also honors NO_COLOR.

Place persistent flags before or after a subcommand as accepted by the installed version. Prefer --json for automation.

CommandPurpose
champrep auth loginSign in through browser approval.
champrep auth login --no-browserPrint an approval URL for a remote terminal.
champrep auth tokenStore a scoped API key in the OS keychain.
champrep auth whoamiShow the active identity and profile.
champrep auth statusShow identity, live quota, and available audit context.
champrep auth listList stored profiles across environments.
champrep auth switch PROFILESelect another stored profile for the same account.
champrep auth logoutRemove the current local credential and profile state.
CommandPurpose
champrep drive ls [REMOTE_PATH]List files in a folder.
champrep drive tree [REMOTE_PATH]Display a recursive folder tree.
champrep drive cp SOURCE DESTTransfer a file between the local machine and Drive.
champrep drive mv OLD NEWMove or rename a Drive item.
champrep drive rm REMOTE_PATHDelete a file or folder.
champrep drive mkdir REMOTE_PATHCreate a folder.
champrep drive quotaShow used and available storage.

Examples:

Terminal window
champrep drive ls /
champrep drive tree /projects
champrep drive cp ./report.pdf /reports/report.pdf
champrep drive cp /reports/report.pdf ./report.pdf
champrep drive quota --json
CommandPurpose
champrep mail lsList messages in a mailbox folder.
champrep mail read MESSAGE_IDPrint one message.
champrep mail sendSend a message. --subject is required; to send without one, leave it out and pass --no-subject.
champrep mail accountsList connected mailboxes.
champrep mail threadsList mail threads.
champrep mail domainsList visible mail domains.

Use champrep mail send --help before scripting a send so the installed version’s recipient, subject, body, and attachment flags are handled correctly.

CommandPurpose
champrep chat lsList rooms.
champrep chat read ROOM_IDRead recent messages.
champrep chat send ROOM_IDSend a room message.
champrep chat unreadShow the unread count.
champrep chat createCreate a room.
CommandPurpose
champrep contacts lsList contacts.
champrep contacts search QUERYSearch by email or name.
champrep contacts read CONTACT_IDShow one contact.
champrep contacts labelsList labels.
champrep contacts add USER_IDAdd a user to contacts.
champrep contacts update CONTACT_IDUpdate contact metadata.
champrep contacts rm CONTACT_IDDelete a contact.

courses also accepts the learn alias.

CommandPurpose
champrep courses lsList available courses.
champrep courses enrolledList the active user’s enrollments.
champrep courses read COURSE_IDShow one course.
champrep courses sections COURSE_IDList course sections.
CommandPurpose
champrep notes lsList recent notes.
champrep notes createCreate a note.
champrep notes read NOTE_IDPrint a note.
champrep notes edit NOTE_IDUpdate a note’s title and/or body.
champrep notes rm NOTE_IDMove a note to Trash. Restore it in CHAMPREP Notes within 30 days; then it is erased automatically. A note in Trash can be read but not edited.
CommandPurpose
eve or champrep aiStart the Eve interactive AI pair-programming agent in the current directory.
champrep eveAlias for champrep ai / eve.
eve -p PROMPT or champrep ai -p PROMPTRun the agent headlessly for one prompt and print the answer.
champrep ai models lsList platform models and models you registered with your own key.
champrep ai models registerRegister a model that uses your own provider API key.
champrep ai models rm NAMERemove a registered model and its key.
champrep ai pathsPrint every local file and folder the agent uses.
champrep ai chat [PROMPT]Ask a one-shot question or start an interactive session.
champrep ai summarizeSummarize a file.
champrep ai conversationsList saved conversations.
champrep ai read CONVERSATION_IDRead a conversation.
champrep ai rm CONVERSATION_IDDelete a conversation.
champrep ai usageShow current AI usage.

Review important AI output before relying on it.

For the agent’s slash commands, permissions, and options, see AI agent: Eve (champrep ai / eve).

CommandPurpose
champrep meet createCreate a meeting room.
champrep meet lsList meetings.
champrep meet join MEETING_IDOpen a meeting in the default browser.

calendar also accepts the cal alias.

CommandPurpose
champrep calendar todayShow today’s events.
champrep calendar weekShow this week’s events.
champrep calendar createCreate an event.
champrep calendar rm EVENT_IDDelete an event.

Search everything your credential can reach in one query. Results are grouped by service, and anything skipped is listed with the reason.

CommandPurpose
champrep search QUERYSearch across all your services.
champrep search servicesShow which services you can search, and whether AI search is available.
FlagPurpose
-s, --serviceLimit to a service (repeatable). Keeps the query cheap.
--limitMaximum results per service (default 5, max 20).
--aiRank results with AI and get a short answer. Uses your own AI credits.
Terminal window
champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

A search costs one rate-limit unit per service actually searched, so narrowing with --service is the cheapest way to keep it responsive. --ai spends your monthly AI credits; without credits the command still returns normal results and tells you why the AI ranking did not run.

CommandPurpose
champrep work boardsList your boards.
champrep work board BOARD_IDShow one board.
champrep work ticketsList tickets. Filter with --board, --status (a status ID, or with --board a status name), --search, --mine; --limit 1 to 200.
champrep work ticket TICKETShow one ticket by id or key (for example ENG-7).
champrep work createCreate a ticket (--board, --title, --priority, --type).
Terminal window
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
CommandPurpose
champrep invoice lsList invoices. Filter with --status.
champrep invoice read INVOICE_IDShow one invoice.
champrep invoice issue INVOICE_IDIssue a draft (draft to issued).
champrep invoice send INVOICE_IDEmail an invoice (--to when no recipient is on file).
champrep invoice rm INVOICE_IDDelete a draft.

Issuing and sending consume your plan’s invoice-send allowance, so they need the invoice:send scope on an API key.

CommandPurpose
champrep forms lsList your forms.
champrep forms read FORM_IDShow one form.
champrep forms responses FORM_IDList a form’s responses.
champrep forms createCreate a form (--title, --description, --publish).
champrep forms publish FORM_IDPublish a draft form.
champrep forms rm FORM_IDMove a form to Trash.
CommandPurpose
champrep charts meShow your position in the org chart.
champrep charts treePrint the org chart as JSON.
champrep charts search QUERYSearch people in the org.
champrep charts profile USER_IDPrint a person’s profile as JSON.

Organization (enterprise) management. Reads use the business:read scope.

CommandPurpose
champrep business infoShow your organization and your role in it.
champrep business membersList organization members.
champrep business usageShow organization usage statistics.

Projects, branches, merge requests, issues, pipelines, job logs, and releases. PROJECT is the project’s full path (acme/web) or its ID. Full reference: CHAMPREP Code commands.

CommandPurpose
champrep code projects ls / show / createList, show, and create projects.
champrep code repo clone-url PROJECTPrint the clone address (--ssh for SSH).
champrep code cloneClone projects, a group (--group, --include-subgroups) or all yours (--membership, --owned, --all) into a namespace tree; --update keeps it current.
champrep code branches ls PROJECTList branches.
champrep code mr ls / show / create / merge / approveWork with merge requests.
champrep code issues ls / show / create / close / reopenWork with issues.
champrep code pipelines ls / show / run / retry / cancelWork with pipelines.
champrep code pipelines wait PROJECT [ID]Wait for a pipeline, the newest of a commit (--sha), or the newest on --ref to finish; exits 0 on success, 1 otherwise, 8 on --timeout.
champrep code jobs ls / log / play / retryList jobs, print or follow (--follow) a log, start manual jobs.
champrep code releases ls PROJECTList releases.
champrep code runners ls / show / update / createList runners and who is online, change tags, pause and resume, create a runner.
champrep code ssh-keys lsList your SSH keys for git over SSH.
Terminal window
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code mr ls acme/web
champrep code pipelines run acme/web --ref main --yes
champrep code jobs log acme/web 4182 --follow

Task-by-task recipes for Code, Runner Farm and QA, including CI use, are in Common tasks.

runner-farm also accepts the rf alias. --workspace picks the farm account (personal, organization:<id>, team:<id>). Full reference: Runner Farm commands.

CommandPurpose
champrep rf accounts ls / showList the farm accounts you can act in; show one.
champrep rf connections lsList code host connections.
champrep rf pools ls / show / create / updateManage runner pools, including --pause and --resume.
champrep rf usageCredits and minutes for the current period.
champrep rf jobs lsList jobs, including waiting and held ones.
Terminal window
champrep rf pools ls
champrep rf usage

Repositories, scans, findings, quality gates, previews, and IDE workspaces. REPO is a repository key such as code:<project-uuid>. Full reference: CHAMPREP QA commands.

CommandPurpose
champrep qa repos ls / available / activate / deactivate / syncManage the repositories QA analyses.
champrep qa scan REPOStart a scan; --watch follows it to the end.
champrep qa scans ls / showList and show scans.
champrep qa findings ls / show / dismiss / reopenFilter (--severity, --cwe, --branch, --state) and triage findings.
champrep qa gates status REPOShow the quality gate result; exits 1 when it fails.
champrep qa previews ls / show / create / extend / stopManage preview environments.
champrep qa ide ls / start / open / stopManage cloud IDE workspaces.
Terminal window
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

In these three families, commands that change something or use CI minutes, credits, or allowance ask first: code mr create, mr merge, mr approve, issues close and reopen, every pipeline and job action, rf pools create and update, and every qa write (repos activate and deactivate, scan, findings dismiss and reopen, previews create, extend and stop, ide start and stop). Pass --yes (-y) in scripts; without a terminal and without --yes, they change nothing. Creating a Code project or issue does not ask. --workspace on rf and qa picks the account that is used and charged.

CommandPurpose
champrep accountShow your identity, plan, and live rate-limit, daily, and storage usage.
Terminal window
champrep account
champrep account --json

Manage the cpk_... keys used for headless and CI access. These commands require an interactive browser session (run champrep auth login first, not auth token). Creating or rotating a key prints the secret once.

CommandPurpose
champrep keys lsList your API keys.
champrep keys createCreate a key (--name, repeatable --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_IDShow one key’s details.
champrep keys audit KEY_IDShow a key’s recent audit log.
champrep keys update KEY_IDChange name, scopes, IP allowlist, or --active/--inactive.
champrep keys regenerate KEY_IDRotate the secret (old secret stops working).
champrep keys revoke KEY_IDDelete a key.
Terminal window
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

Read-only view of your subscription. Change plans in the billing dashboard.

CommandPurpose
champrep billing subscriptionShow your current subscription (alias sub).
champrep billing cardsList saved payment methods.
champrep billing receiptsList past receipts.

Manage outbound webhook subscriptions. Uses the webhooks:manage scope.

CommandPurpose
champrep webhooks lsList your webhooks.
champrep webhooks eventsList event types you can subscribe to.
champrep webhooks createCreate a webhook (--url, repeatable --event). The signing secret is shown once.
champrep webhooks rotate WEBHOOK_IDRotate the signing secret.
champrep webhooks rm WEBHOOK_IDDelete a webhook.

These commands do not need a service request unless their help text says otherwise.

CommandPurpose
champrep config get KEYRead a configuration value.
champrep config set KEY VALUESet an allowed configuration value. An api_url or web_url must be an https:// address.
champrep config listPrint the current configuration. With --json the keys are the file’s own (default_environment, api_url …).
champrep config pathPrint the configuration file path.
champrep config env [NAME]Show or set the default environment.
champrep completion SHELLGenerate completion for Bash, Zsh, Fish, or PowerShell.
champrep versionPrint version, commit, build date, and runtime information.

Tokens are not stored in the configuration file. Do not attempt to write an authentication token with config set.

CodeMeaning
0Success.
1General or usage failure, or a refusal that signing in again does not fix: no access to the item, not on your plan, payment or credits needed, your role, or a decision that needs your web session.
3Authentication is required or invalid.
4The credential lacks the required scope.
5A live Gateway limit was reached.
6Network failure.
7Gateway or service failure.
8A wait ran out of time: code pipelines wait --timeout.

Scripts should check the exit code and parse --json output when it is available. Do not match human-readable error sentences as a stable interface.

Every Gateway response carries your current limits. The CLI transparently retries a short per-minute limit, honoring Retry-After. It does not sleep through a per-day limit or any wait longer than a few seconds — instead it exits with code 5 and reports the exact wait, so scripts fail fast. Check your live counters any time with champrep account.