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.

Global flags

Flag	Purpose
`--env NAME`	Override the active Gateway environment for one command.
`-v`, `--verbose`	Log request and response metadata with the authorization header redacted.
`--debug`	Add request and response bodies to diagnostic output. Use cautiously around sensitive data.
`--json`	Emit machine-readable JSON where supported.
`--no-color`	Disable 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.

Authentication

Command	Purpose
`champrep auth login`	Sign in through browser approval.
`champrep auth login --no-browser`	Print an approval URL for a remote terminal.
`champrep auth token`	Store a scoped API key in the OS keychain.
`champrep auth whoami`	Show the active identity and profile.
`champrep auth status`	Show identity, live quota, and available audit context.
`champrep auth list`	List stored profiles across environments.
`champrep auth switch PROFILE`	Select another stored profile for the same account.
`champrep auth logout`	Remove the current local credential and profile state.

Drive

Command	Purpose
`champrep drive ls [REMOTE_PATH]`	List files in a folder.
`champrep drive tree [REMOTE_PATH]`	Display a recursive folder tree.
`champrep drive cp SOURCE DEST`	Transfer a file between the local machine and Drive.
`champrep drive mv OLD NEW`	Move or rename a Drive item.
`champrep drive rm REMOTE_PATH`	Delete a file or folder.
`champrep drive mkdir REMOTE_PATH`	Create a folder.
`champrep drive quota`	Show used and available storage.

Examples:

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

Mail

Command	Purpose
`champrep mail ls`	List messages in a mailbox folder.
`champrep mail read MESSAGE_ID`	Print one message.
`champrep mail send`	Send a message using flags or prompts.
`champrep mail accounts`	List connected mailboxes.
`champrep mail threads`	List mail threads.
`champrep mail domains`	List 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.

Chat

Command	Purpose
`champrep chat ls`	List rooms.
`champrep chat read ROOM_ID`	Read recent messages.
`champrep chat send ROOM_ID`	Send a room message.
`champrep chat unread`	Show the unread count.
`champrep chat create`	Create a room.

Contacts

Command	Purpose
`champrep contacts ls`	List contacts.
`champrep contacts search QUERY`	Search by email or name.
`champrep contacts read CONTACT_ID`	Show one contact.
`champrep contacts labels`	List labels.
`champrep contacts add USER_ID`	Add a user to contacts.
`champrep contacts update CONTACT_ID`	Update contact metadata.
`champrep contacts rm CONTACT_ID`	Delete a contact.

Learn

courses also accepts the learn alias.

Command	Purpose
`champrep courses ls`	List available courses.
`champrep courses enrolled`	List the active user’s enrollments.
`champrep courses read COURSE_ID`	Show one course.
`champrep courses sections COURSE_ID`	List course sections.

Notes

Command	Purpose
`champrep notes ls`	List recent notes.
`champrep notes create`	Create a note.
`champrep notes read NOTE_ID`	Print a note.
`champrep notes edit NOTE_ID`	Update a note’s title and/or body.
`champrep notes rm NOTE_ID`	Delete a note.

CHAMPREP AI

Command	Purpose
`champrep ai chat [PROMPT]`	Ask a one-shot question or start an interactive session.
`champrep ai summarize`	Summarize a file.
`champrep ai conversations`	List saved conversations.
`champrep ai read CONVERSATION_ID`	Read a conversation.
`champrep ai rm CONVERSATION_ID`	Delete a conversation.
`champrep ai usage`	Show current AI usage.

Review important AI output before relying on it.

Meet

Command	Purpose
`champrep meet create`	Create a meeting room.
`champrep meet ls`	List meetings.
`champrep meet join MEETING_ID`	Open a meeting in the default browser.

Calendar

calendar also accepts the cal alias.

Command	Purpose
`champrep calendar today`	Show today’s events.
`champrep calendar week`	Show this week’s events.
`champrep calendar create`	Create an event.
`champrep calendar rm EVENT_ID`	Delete an event.

Search

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

Command	Purpose
`champrep search QUERY`	Search across all your services.
`champrep search services`	Show which services you can search, and whether AI search is available.

Flag	Purpose
`-s`, `--service`	Limit to a service (repeatable). Keeps the query cheap.
`--limit`	Maximum results per service (default 5, max 20).
`--ai`	Rank results with AI and get a short answer. Uses your own AI credits.

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.

Work

Command	Purpose
`champrep work boards`	List your boards.
`champrep work board BOARD_ID`	Show one board.
`champrep work tickets`	List tickets. Filter with `--board`, `--status`, `--search`, `--mine`.
`champrep work ticket TICKET`	Show one ticket by id or key (for example `ENG-7`).
`champrep work create`	Create a ticket (`--board`, `--title`, `--priority`, `--type`).

champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug

Invoice

Command	Purpose
`champrep invoice ls`	List invoices. Filter with `--status`.
`champrep invoice read INVOICE_ID`	Show one invoice.
`champrep invoice issue INVOICE_ID`	Issue a draft (draft to issued).
`champrep invoice send INVOICE_ID`	Email an invoice (`--to` when no recipient is on file).
`champrep invoice rm INVOICE_ID`	Delete a draft.

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

Forms

Command	Purpose
`champrep forms ls`	List your forms.
`champrep forms read FORM_ID`	Show one form.
`champrep forms responses FORM_ID`	List a form’s responses.
`champrep forms create`	Create a form (`--title`, `--description`, `--publish`).
`champrep forms publish FORM_ID`	Publish a draft form.
`champrep forms rm FORM_ID`	Move a form to Trash.

Org chart

Command	Purpose
`champrep charts me`	Show your position in the org chart.
`champrep charts tree`	Print the org chart as JSON.
`champrep charts search QUERY`	Search people in the org.
`champrep charts profile USER_ID`	Print a person’s profile as JSON.

Business

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

Command	Purpose
`champrep business info`	Show your organization and your role in it.
`champrep business members`	List organization members.
`champrep business usage`	Show organization usage statistics.

Account and usage

Command	Purpose
`champrep account`	Show your identity, plan, and live rate-limit, daily, and storage usage.

champrep account
champrep account --json

API keys

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.

Command	Purpose
`champrep keys ls`	List your API keys.
`champrep keys create`	Create a key (`--name`, repeatable `--scope`, `--expires-in-days`, `--allowed-ip`).
`champrep keys get KEY_ID`	Show one key’s details.
`champrep keys audit KEY_ID`	Show a key’s recent audit log.
`champrep keys update KEY_ID`	Change name, scopes, IP allowlist, or `--active`/`--inactive`.
`champrep keys regenerate KEY_ID`	Rotate the secret (old secret stops working).
`champrep keys revoke KEY_ID`	Delete a key.

champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

Billing

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

Command	Purpose
`champrep billing subscription`	Show your current subscription (alias `sub`).
`champrep billing cards`	List saved payment methods.
`champrep billing receipts`	List past receipts.

Webhooks

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

Command	Purpose
`champrep webhooks ls`	List your webhooks.
`champrep webhooks events`	List event types you can subscribe to.
`champrep webhooks create`	Create a webhook (`--url`, repeatable `--event`). The signing secret is shown once.
`champrep webhooks rotate WEBHOOK_ID`	Rotate the signing secret.
`champrep webhooks rm WEBHOOK_ID`	Delete a webhook.

Local configuration and tooling

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

Command	Purpose
`champrep config get KEY`	Read a configuration value.
`champrep config set KEY VALUE`	Set an allowed configuration value.
`champrep config list`	Print the current configuration.
`champrep config path`	Print the configuration file path.
`champrep config env [NAME]`	Show or set the default environment.
`champrep completion SHELL`	Generate completion for Bash, Zsh, Fish, or PowerShell.
`champrep version`	Print 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.

Exit codes

Code	Meaning
`0`	Success.
`1`	General or usage failure.
`3`	Authentication is required or invalid.
`4`	The credential lacks the required scope.
`5`	A live Gateway limit was reached.
`6`	Network failure.
`7`	Gateway or service failure.

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.

Rate limits

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.