---
title: "CLI reference"
description: "Every overlane command, its flags, examples and result shape. Generated from the command registry."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `overlane` CLI is agent-first: every command prints JSON when stdout is not a terminal, takes `--dry-run` before it writes, and describes itself with `overlane schema <command>`. Run `overlane commands` for this list and `overlane search "<task>"` to find a command by what you want to do.

The short alias `ol` runs the same binary.

## Commands

| Command | Effect | Summary |
| --- | --- | --- |
| [overlane context](/cli/context/) | read | One JSON briefing: sign-in, project, release, task, run, policy, next task and suggested commands |
| [overlane search](/cli/search/) | read | Find the command for a task: say the task, get the command (local, no credentials, top 5) |
| [overlane schema](/cli/schema/) | read | Print a command's parameters, safety flags and result shape as JSON |
| [overlane commands](/cli/commands/) | read | List every command |
| [overlane agents-md](/cli/agents-md/) | read | Print the block to paste into AGENTS.md or CLAUDE.md |
| [overlane auth status](/cli/auth-status/) | read | Check sign-in status: whether you are signed in, and how, without revealing the token |
| [overlane init](/cli/init/) | write | Start here: connect this project to your coding agents in one step, with nothing to install first (npx overlane init) |
| [overlane connect](/cli/connect/) | write | Connect this project (native Overlane, or your GitHub repository): sign in, bind it, register the plugin; --kit also sets up a plan |
| [overlane doctor](/cli/doctor/) | read | Check each agent's readiness and where the credential is kept |
| [overlane disconnect](/cli/disconnect/) | destructive | Remove what connect added to this project and delete the stored token |
| [overlane task list](/cli/task-list/) | read | List the project's tasks and their states |
| [overlane task start](/cli/task-start/) | write | Claim an existing task, or create one with a contract and claim it |
| [overlane task status](/cli/task-status/) | read | Show the task this working copy holds |
| [overlane task checkpoint](/cli/task-checkpoint/) | write | Save a checkpoint of the held task, optionally pausing it |
| [overlane task release](/cli/task-release/) | write | Give the held task back to the queue as ready |
| [overlane task resume](/cli/task-resume/) | write | Claim a paused task and verify the working copy matches its checkpoint |
| [overlane task submit](/cli/task-submit/) | write | Submit the held task at the current commit for verification |
| [overlane task evidence](/cli/task-evidence/) | write | Run a verification command and record its result as L1 evidence |
| [overlane task handoff](/cli/task-handoff/) | write | Pause the held task and print the command that continues it in the other agent |
| [overlane task import](/cli/task-import/) | write | Import the checkbox lines of a TASKS.md file as tracked work, safe to repeat |
| [overlane task export](/cli/task-export/) | read | Write the project's imported work back out in the TASKS.md layout |
| [overlane intent show](/cli/intent-show/) | read | Show the current intent revision, or one revision with its impact |
| [overlane intent list](/cli/intent-list/) | read | List intent revisions and their status |
| [overlane intent propose](/cli/intent-propose/) | write | Propose a new intent revision from a JSON file |
| [overlane intent accept](/cli/intent-accept/) | write | Make a proposed intent revision current and apply it to the affected tasks |
| [overlane intent reject](/cli/intent-reject/) | write | Reject a proposed intent revision |
| [overlane intent brief](/cli/intent-brief/) | read | Compile the content-addressed brief for a task |
| [overlane task new](/cli/task-new/) | write | Create a task from a title, claim it for this working copy and rank it |
| [overlane task next](/cli/task-next/) | read | Show the task to work on next, ordered by priority, then rank, then plan order |
| [overlane task queue](/cli/task-queue/) | read | List open tasks in the order they will be worked |
| [overlane task prioritise](/cli/task-prioritise/) | write | Set a task's priority (P0 to P3) and optionally put it first |
| [overlane task policy](/cli/task-policy/) | read | Show whether changes need an active task, and refresh this working copy's copy |
| [overlane task policy set](/cli/task-policy-set/) | write | Require, or relax, the active-task rule for the project (task policy class) |
| [overlane task loop](/cli/task-loop/) | write | Keep this session taking the next task each time it finishes one, until the queue is empty |
| [overlane onboarding funnel](/cli/onboarding-funnel/) | read | Show the team's activation funnel and the time from sign-up to the first reviewed agent change |
| [overlane onboarding status](/cli/onboarding-status/) | read | Show the onboarding steps, which one is current, and the command that completes it |
| [overlane onboarding advance](/cli/onboarding-advance/) | write | Mark an onboarding step done (or failed, with its repair action) and move to the next |
| [overlane onboarding review](/cli/onboarding-review/) | read | Read the first review of the team (the onboarding step first-review) |
| [overlane onboarding invite](/cli/onboarding-invite/) | write | Finish the optional invite step of onboarding |
| [overlane autonomy show](/cli/autonomy-show/) | read | Show the team's autonomy mode and what each action class asks for |
| [overlane autonomy set](/cli/autonomy-set/) | write | Set the team's autonomy mode, with optional per-class and per-project overrides |
| [overlane autonomy approvals list](/cli/autonomy-approvals-list/) | read | List approvals, with who asked, who answered, the evidence and the reason |
| [overlane autonomy approvals request](/cli/autonomy-approvals-request/) | write | Ask an independent agent or a person to approve an action in an action class |
| [overlane autonomy approvals answer](/cli/autonomy-approvals-answer/) | write | Approve or deny a pending approval, recording the evidence you checked and why |
| [overlane operator tables](/cli/operator-tables/) | read | Row counts for every production table, and how each column is masked (Overlane staff) |
| [overlane operator rows](/cli/operator-rows/) | read | A few rows of one production table with personal fields masked (Overlane staff) |
| [overlane operator discounts list](/cli/operator-discounts-list/) | read | List the discounts granted to workspaces (Overlane staff) |
| [overlane operator discounts grant](/cli/operator-discounts-grant/) | write | Grant a workspace an open-source or startup discount (Overlane staff) |
| [overlane operator discounts revoke](/cli/operator-discounts-revoke/) | destructive | Take a workspace's discount away (Overlane staff) |
| [overlane operator invitations list](/cli/operator-invitations-list/) | read | List who may create an account while Overlane is invite-only (Overlane staff) |
| [overlane operator invitations add](/cli/operator-invitations-add/) | write | Invite an email address or a domain to create an account (Overlane staff) |
| [overlane operator invitations remove](/cli/operator-invitations-remove/) | destructive | Take an invitation back (Overlane staff) |
| [overlane bot list](/cli/bot-list/) | read | List the team's bots and whether each is revoked |
| [overlane bot register](/cli/bot-register/) | write | Register a bot that can take tasks and answer approvals; the signing secret is shown once |
| [overlane bot revoke](/cli/bot-revoke/) | destructive | Revoke a bot: it receives nothing more |
| [overlane bot rotate-key](/cli/bot-rotate-key/) | write | Rotate a bot's signing secret; the old secret stops verifying at once |
| [overlane bot redeliver](/cli/bot-redeliver/) | write | Send a bot the events it has not accepted yet |
| [overlane bot map-user](/cli/bot-map-user/) | write | Link a person on the bot's platform to a team member |
| [overlane task approval new](/cli/task-approval-new/) | write | Ask the task's bot or a person a question that must be answered before work goes on |
| [overlane task approval list](/cli/task-approval-list/) | read | List the approvals asked on one task |
| [overlane task messages](/cli/task-messages/) | read | Read what the task's bot has said in its thread |
| [overlane approval list](/cli/approval-list/) | read | List the project's approvals |
| [overlane approval show](/cli/approval-show/) | read | Show one approval |
| [overlane approval answer](/cli/approval-answer/) | write | Approve or deny a task's question; the task resumes on approval |
| [overlane token create](/cli/token-create/) | write | Mint a narrower child token for an agent's own work; the secret is shown once |
| [overlane run start](/cli/run-start/) | write | Start a bounded run and record it in .overlane/state/run.json |
| [overlane run next](/cli/run-next/) | write | One step of the agent loop: finish the held task, open its pull request, claim the next one |
| [overlane run claim](/cli/run-claim/) | write | Claim the next runnable task (or a named one) under the active run |
| [overlane run decide](/cli/run-decide/) | write | Record a decision you made instead of asking |
| [overlane run end](/cli/run-end/) | write | End the active run and release its leases |
| [overlane run status](/cli/run-status/) | read | Show the run policy, the active run's budgets and the next runnable task |
| [overlane run pause](/cli/run-pause/) | write | Pause the run policy: no new run starts and no task is claimed |
| [overlane run resume](/cli/run-resume/) | write | Resume the run policy after a pause |
| [overlane run report](/cli/run-report/) | read | Print the morning report: what was verified, handed off, held and used |
| [overlane run attempt](/cli/run-attempt/) | write | Report one finished iteration on a task and learn whether the task is held |
| [overlane run loop](/cli/run-loop/) | write | Run tasks overnight through Claude Code, Codex, Gemini CLI or Cursor, handing off when one hits its usage limit |
| [overlane usage policy show](/cli/usage-policy-show/) | read | Show how the project and you spend subscription usage, the cap that applies and which clients can start now |
| [overlane usage policy set](/cli/usage-policy-set/) | write | Set the project's usage policy, or your own caps and whether usage events are shared |
| [overlane usage events show](/cli/usage-events-show/) | read | Show the usage events the loop recorded for you in this project |
| [overlane usage events delete](/cli/usage-events-delete/) | write | Delete the usage events recorded for you in this project |
| [overlane release list](/cli/release-list/) | read | List the releases published for this tenant |
| [overlane release status](/cli/release-status/) | read | Show the installed release against the project's pin |
| [overlane release update](/cli/release-update/) | write | Install the project's pinned release (or --to a digest), verified against the signed manifest |
| [overlane release rollback](/cli/release-rollback/) | destructive | Roll back a release: move the project's pin back to the previous release and install it |
| [overlane self-update](/cli/self-update/) | write | Update the overlane command line to the newest build of a release channel |
| [overlane auth login](/cli/auth-login/) | write | Log in: approve a device code on any device, or sign in for this repository with no one at the keyboard |
| [overlane auth logout](/cli/auth-logout/) | write | Log out: forget the stored sign-in and revoke the session on the service |
| [overlane auth token](/cli/auth-token/) | read | Print the access token in use, for scripts (a secret: handle with care) |
| [overlane team list](/cli/team-list/) | read | List the teams you belong to and your role in each |
| [overlane team invite](/cli/team-invite/) | write | Invite a teammate to the team by email |
| [overlane team join](/cli/team-join/) | write | Join a team with the link or secret you were sent |
| [overlane team use](/cli/team-use/) | write | Work in another team you belong to |
| [overlane token list](/cli/token-list/) | read | List agent tokens (never their secrets) |
| [overlane token revoke](/cli/token-revoke/) | destructive | Revoke a token: an agent token stops working within seconds |
| [overlane issue list](/cli/issue-list/) | read | List the project's issues, in issue-number order |
| [overlane issue show](/cli/issue-show/) | read | Show one issue with its links, task and assignee |
| [overlane issue events](/cli/issue-events/) | read | Show the audit trail of an issue: every field change, who made it |
| [overlane issue new](/cli/issue-new/) | write | Create an issue from a title |
| [overlane issue update](/cli/issue-update/) | write | Change an issue's title, description, status, priority, estimate, labels, cycle, work project or linked pull requests |
| [overlane issue assign](/cli/issue-assign/) | write | Assign an issue to a person, an agent or a bot |
| [overlane issue import](/cli/issue-import/) | write | Import issues from a Linear, Jira or GitHub Projects export file |
| [overlane issue pull](/cli/issue-pull/) | write | Pull issues from a connected Linear workspace or a GitHub repository |
| [overlane issue sync](/cli/issue-sync/) | read | Show the project's optional GitHub issue sync settings |
| [overlane issue sync set](/cli/issue-sync-set/) | write | Turn the optional GitHub issue sync off, read-only or write-back (issue triage class) |
| [overlane view list](/cli/view-list/) | read | List the project's saved views |
| [overlane view run](/cli/view-run/) | read | Run a saved view and print its groups |
| [overlane view new](/cli/view-new/) | write | Save a view: a filter, a grouping and a sort |
| [overlane loop list](/cli/loop-list/) | read | List the project's loops |
| [overlane loop new](/cli/loop-new/) | write | Define a loop that works assigned issues on a schedule or an event (issue triage class) |
| [overlane loop fire](/cli/loop-fire/) | write | Run a loop now |
| [overlane issue archive](/cli/issue-archive/) | write | Archive a issue: hide it, keep it, restore it for 30 days |
| [overlane issue restore](/cli/issue-restore/) | write | Reinstate an archived issue |
| [overlane issue label update](/cli/issue-label-update/) | write | Rename a label or change its colour |
| [overlane issue label archive](/cli/issue-label-archive/) | write | Archive a label: hide it, keep it, restore it for 30 days |
| [overlane issue label restore](/cli/issue-label-restore/) | write | Reinstate an archived label |
| [overlane issue label delete](/cli/issue-label-delete/) | destructive | Delete a label: archived now, restorable for 30 days, then erased |
| [overlane issue cycle update](/cli/issue-cycle-update/) | write | Rename a cycle or move its dates |
| [overlane issue cycle archive](/cli/issue-cycle-archive/) | write | Archive a cycle: hide it, keep it, restore it for 30 days |
| [overlane issue cycle restore](/cli/issue-cycle-restore/) | write | Reinstate an archived cycle |
| [overlane issue cycle delete](/cli/issue-cycle-delete/) | destructive | Delete a cycle: archived now, restorable for 30 days, then erased |
| [overlane issue project update](/cli/issue-project-update/) | write | Rename a work project or change its description |
| [overlane issue project archive](/cli/issue-project-archive/) | write | Archive a work project: hide it, keep it, restore it for 30 days |
| [overlane issue project restore](/cli/issue-project-restore/) | write | Reinstate an archived work project |
| [overlane issue project delete](/cli/issue-project-delete/) | destructive | Delete a work project: archived now, restorable for 30 days, then erased |
| [overlane view update](/cli/view-update/) | write | Rename a saved view or change its filter, grouping and sort |
| [overlane view archive](/cli/view-archive/) | write | Archive a saved view: hide it, keep it, restore it for 30 days |
| [overlane view restore](/cli/view-restore/) | write | Reinstate an archived saved view |
| [overlane view delete](/cli/view-delete/) | destructive | Delete a saved view: archived now, restorable for 30 days, then erased |
| [overlane loop update](/cli/loop-update/) | write | Rename a loop, change its filter, or turn it on or off (issue triage class) |
| [overlane loop archive](/cli/loop-archive/) | write | Archive a loop: hide it, keep it, restore it for 30 days |
| [overlane loop restore](/cli/loop-restore/) | write | Reinstate an archived loop |
| [overlane loop delete](/cli/loop-delete/) | destructive | Delete a loop: archived now, restorable for 30 days, then erased |
| [overlane client install](/cli/client-install/) | write | Add Overlane to Grok Build, Cursor or Gemini CLI, or set up a Claude or Codex cloud session |
| [overlane client package](/cli/client-package/) | write | Package the Claude Code plugin as a file to upload on claude.ai |
| [overlane memory search](/cli/memory-search/) | read | Search memory across project, team, user and global scopes |
| [overlane memory add](/cli/memory-add/) | write | Add a memory as a candidate in project, team or user scope |
| [overlane memory confirm](/cli/memory-confirm/) | write | Confirm a candidate memory as a person, a second observer or with CI evidence |
| [overlane memory promote](/cli/memory-promote/) | write | Promote a confirmed memory to team, or contribute a team memory to global |
| [overlane memory export](/cli/memory-export/) | read | Export memories with provenance, promotions and unlearn records as JSON |
| [overlane memory delete](/cli/memory-delete/) | destructive | Delete a memory with its vectors and enrichment records |
| [overlane memory unlearn](/cli/memory-unlearn/) | destructive | Unlearn a memory: remove it and every memory derived from it, and record the action |
| [overlane memory status](/cli/memory-status/) | read | Show memory counts by scope and status, stale items and the global contribution switch |
| [overlane memory contribution](/cli/memory-contribution/) | write | Turn global contribution on or off for the team (admins; off by default) |
| [overlane memory confirmation](/cli/memory-confirmation/) | write | Choose how new memories are confirmed: automatic (the default) or manual (admins) |
| [overlane docs query](/cli/docs-query/) | read | Look up a library's documentation at the version your lockfile pins |
| [overlane docs index](/cli/docs-index/) | write | Fetch and index a library's official docs now, or refresh an existing index |
| [overlane docs pins](/cli/docs-pins/) | write | Read version pins from the project's lockfiles |
| [overlane docs deps](/cli/docs-deps/) | write | List a project's dependencies that are indexed and missing, and index the missing ones |
| [overlane docs add](/cli/docs-add/) | write | Index your own docs as a private library only your team can query |
| [overlane docs usage](/cli/docs-usage/) | read | Show this month's library docs calls against the team allowance |
| [overlane docs libraries](/cli/docs-libraries/) | read | List the library versions this team has indexed, with their age |
| [overlane review run](/cli/review-run/) | write | Review a diff (no repository needed) or a pull request now and report the findings |
| [overlane review status](/cli/review-status/) | read | Show the review mode, recent runs and open findings |
| [overlane review findings](/cli/review-findings/) | read | List review findings, optionally for one pull request or status |
| [overlane review dismiss](/cli/review-dismiss/) | write | Dismiss a finding, which teaches the reviewer |
| [overlane review autofix](/cli/review-autofix/) | write | Create a fix task from a finding and optionally assign it |
| [overlane review settings](/cli/review-settings/) | read | Show the review settings, including the data-use terms |
| [overlane review settings set](/cli/review-settings-set/) | write | Change the review mode, token cap or skip patterns |
| [overlane code-map status](/cli/code-map-status/) | read | Show, per client, whether the code map is on and why |
| [overlane code-map links](/cli/code-map-links/) | write | Show or set whether code lookups follow links into the team's other repositories |
| [overlane wiki list](/cli/wiki-list/) | read | List the pages of the project wiki built from the code map |
| [overlane wiki show](/cli/wiki-show/) | read | Read one page of the project wiki |
| [overlane guard rules list](/cli/guard-rules-list/) | read | List the guardrail rules in force and the versions of the rule files |
| [overlane guard rules test](/cli/guard-rules-test/) | read | Test a rule file against an action, locally, before it is merged |
| [overlane guard rules put](/cli/guard-rules-put/) | write | Publish a new version of the team or project rule file |
| [overlane guard check](/cli/guard-check/) | write | Ask the server to decide an action now; exits 6 when it is refused |
| [overlane guard dry-run](/cli/guard-dry-run/) | read | Report what the guardrails would decide for an action, without blocking or recording |
| [overlane guard scan](/cli/guard-scan/) | read | Scan a file for credentials the way a push would be scanned |
| [overlane guard approvals list](/cli/guard-approvals-list/) | read | List approvals waiting for an answer, with the summary and diff of each |
| [overlane guard approvals answer](/cli/guard-approvals-answer/) | write | Approve or deny an action waiting for approval, as an independent agent or a person |
| [overlane billing status](/cli/billing-status/) | read | Show the plan, seats, usage against allowances, caps, grace period and invoices |
| [overlane billing usage](/cli/billing-usage/) | read | Show usage this period against each allowance, the spending caps and the pooled allowance left |
| [overlane billing check](/cli/billing-check/) | read | Ask whether a spend is allowed now; exits 6 when a limit or cap refuses it |
| [overlane billing checkout](/cli/billing-checkout/) | write | Start buying a plan: prints a Stripe-hosted checkout link (a person pays; agents cannot) |
| [overlane billing plan](/cli/billing-plan/) | write | Upgrade or downgrade the plan; a downgrade over the new limits makes the workspace read-only and deletes nothing |
| [overlane billing seats](/cli/billing-seats/) | write | Change the number of seats mid-cycle; the change prorates |
| [overlane billing cancel](/cli/billing-cancel/) | destructive | Cancel the paid plan at the end of the period already paid for |
| [overlane billing portal](/cli/billing-portal/) | write | Print a link to Stripe's billing portal: card, invoices and tax details |
| [overlane billing caps list](/cli/billing-caps-list/) | read | List spending caps per team, project and agent |
| [overlane billing caps set](/cli/billing-caps-set/) | write | Set a spending cap per period for the team, a project or an agent |
| [overlane billing caps remove](/cli/billing-caps-remove/) | write | Remove a spending cap |
| [overlane connector list](/cli/connector-list/) | read | List the connectors Overlane offers (optional links to services a team already uses) |
| [overlane connector show](/cli/connector-show/) | read | Show one connector: auth, scopes, typed actions with their class, and events |
| [overlane connector status](/cli/connector-status/) | read | List the team's connections (never their secrets) |
| [overlane connector connect](/cli/connector-connect/) | write | Store a connector credential in the tenant vault |
| [overlane connector revoke](/cli/connector-revoke/) | destructive | Revoke a connection and delete its stored secrets |
| [overlane connector run](/cli/connector-run/) | write | Run a connector action (a write or destructive action follows the autonomy gate) |
| [overlane connector events](/cli/connector-events/) | read | List verified inbound events from a connector, each labelled as data |
| [overlane connector approval](/cli/connector-approval/) | write | Post an approval request to a chat connector's channel |
| [overlane connector chat-user](/cli/connector-chat-user/) | write | Map a chat user to a team member who may answer approvals there |
| [overlane connector link](/cli/connector-link/) | write | Link your own Slack or Teams account to your team membership |
| [overlane connector authorize](/cli/connector-authorize/) | write | Connect a service by signing in with it (no token to paste) |
| [overlane connector mcp list](/cli/connector-mcp-list/) | read | List the team's allowlisted passthrough MCP servers |
| [overlane connector mcp add](/cli/connector-mcp-add/) | write | Allow a passthrough MCP server (https, a public DNS name) |
| [overlane connector mcp remove](/cli/connector-mcp-remove/) | destructive | Remove a passthrough MCP server from the allowlist |
| [overlane api-key create](/cli/api-key-create/) | write | Create a team API key; the secret is shown once |
| [overlane api-key list](/cli/api-key-list/) | read | List the team's API keys (never their secrets) |
| [overlane api-key rotate](/cli/api-key-rotate/) | write | Rotate an API key: a new secret with the same settings, the old key revoked at once |
| [overlane api-key revoke](/cli/api-key-revoke/) | destructive | Revoke an API key; the next call with it fails |
| [overlane api-key limits](/cli/api-key-limits/) | read | Show the team's request limit from the plan data and what is left this minute |
| [overlane webhook create](/cli/webhook-create/) | write | Create an outbound webhook; the signing secret is shown once |
| [overlane webhook list](/cli/webhook-list/) | read | List outbound webhooks (never their secrets) |
| [overlane webhook delete](/cli/webhook-delete/) | destructive | Disable an outbound webhook; its pending events are dropped |
| [overlane webhook rotate](/cli/webhook-rotate/) | write | Rotate a webhook's signing secret; the new secret is shown once |
| [overlane webhook test](/cli/webhook-test/) | write | Send a webhook.test event to a webhook and show its delivery |
| [overlane webhook deliveries](/cli/webhook-deliveries/) | read | List a webhook's recent deliveries with status, attempts and the next attempt |
| [overlane api versions](/cli/api-versions/) | read | List the API versions, their changelog and end dates |
| [overlane api openapi](/cli/api-openapi/) | read | Read the OpenAPI 3.1 document the API serves |
| [overlane claim acquire](/cli/claim-acquire/) | write | Claim the files or modules a task will change; an overlapping claim by another agent is queued or refused |
| [overlane claim list](/cli/claim-list/) | read | List the project's claims: who holds which scope, who waits, and when each lease ends |
| [overlane claim renew](/cli/claim-renew/) | write | Extend a claim's lease and report the branch head you are on |
| [overlane claim release](/cli/claim-release/) | write | Release a claim so a queued agent can take the scope |
| [overlane claim readiness](/cli/claim-readiness/) | read | Say whether this claim's branch is clear to merge as far as claims and the conflict check can tell |
| [overlane claim conflicts](/cli/claim-conflicts/) | write | Check two branch heads for a merge conflict with git merge-tree, before either pull request merges |
| [overlane budget show](/cli/budget-show/) | read | Show budgets per task, agent, project and team, with what is spent and what is left |
| [overlane budget set](/cli/budget-set/) | write | Set a budget for a task, an agent, a project or the team |
| [overlane budget check](/cli/budget-check/) | write | Ask before spending: exits 6 and records a stop when the call would reach a budget |
| [overlane budget stops](/cli/budget-stops/) | read | List the runs a budget stopped, newest first |
| [overlane rules sync](/cli/rules-sync/) | write | Write the project's rules source to AGENTS.md, CLAUDE.md, Cursor, Gemini and the Gemini settings |
| [overlane rules check](/cli/rules-check/) | read | Report drift between the rules source and each agent's file; exits 6 on drift, for CI |
| [overlane pr route](/cli/pr-route/) | write | Route a pull request by risk: blocked, fast path, standard or approver |
| [overlane pr approve](/cli/pr-approve/) | write | Approve a routed pull request as an independent agent with evidence, or as a person |
| [overlane pr batch](/cli/pr-batch/) | read | Group related routed pull requests so one reviewer looks once |
| [overlane pr policy](/cli/pr-policy/) | write | Show or set who approves the approver lane and how large a batch may be |
| [overlane egress policy show](/cli/egress-policy-show/) | read | Show the egress allowlist: which hosts native CI and agent sandboxes may reach |
| [overlane egress policy set](/cli/egress-policy-set/) | write | Set the egress allowlist and its mode |
| [overlane egress check](/cli/egress-check/) | write | Ask whether a host may be reached; exits 6 when the allowlist denies it |
| [overlane egress events](/cli/egress-events/) | read | List recent egress decisions: host, port and outcome, never a path or a body |
| [overlane egress grant](/cli/egress-grant/) | write | Grant one task a credential for named hosts; the value never reaches the agent |
| [overlane egress grants](/cli/egress-grants/) | read | List the project's credential grants and whether each is still active |
| [overlane egress revoke](/cli/egress-revoke/) | write | Revoke a credential grant at once |
| [overlane egress scan](/cli/egress-scan/) | read | Check this workspace's file list for files that usually hold a credential |
| [overlane events watch](/cli/events-watch/) | read | Follow the project's events in order, from a sequence number, as they happen |
| [overlane observe status](/cli/observe-status/) | read | Show runs, open incidents, cost, decision records and the retention period |
| [overlane observe logs](/cli/observe-logs/) | read | List a project's logs, optionally for one run |
| [overlane observe trace](/cli/observe-trace/) | read | Show one run's events, logs and spans together |
| [overlane observe live](/cli/observe-live/) | read | List the project's running agent runs and what each is doing now |
| [overlane observe live-activity](/cli/observe-live-activity/) | write | Show or change whether agents send live activity for this project |
| [overlane observe cost](/cli/observe-cost/) | read | Show cost and tokens per agent, project and team for this billing period |
| [overlane observe reconcile](/cli/observe-reconcile/) | read | Compare observed cost with metered usage; the tolerance is 1 percent |
| [overlane observe compare](/cli/observe-compare/) | read | Compare the agents that worked the same task: cost, time and review outcome |
| [overlane observe evals](/cli/observe-evals/) | read | Show eval scores from replaying merged pull requests per agent and configuration |
| [overlane observe evals run](/cli/observe-evals-run/) | write | Replay merged pull requests against agents and configurations and score the results |
| [overlane observe alerts](/cli/observe-alerts/) | read | List alert rules and incidents |
| [overlane observe alerts set](/cli/observe-alerts-set/) | write | Create or change an alert rule |
| [overlane observe alerts remove](/cli/observe-alerts-remove/) | destructive | Remove an alert rule |
| [overlane observe alerts evaluate](/cli/observe-alerts-evaluate/) | write | Check every alert rule now and send the notices that are due |
| [overlane observe retention](/cli/observe-retention/) | read | Show how long telemetry is kept on the plan |
| [overlane observe retention purge](/cli/observe-retention-purge/) | destructive | Delete telemetry older than the plan keeps |
| [overlane project settings](/cli/project-settings/) | read | Show this project's settings, including repository sign-in |
| [overlane project settings set](/cli/project-settings-set/) | write | Turn repository sign-in or the code settings on or off |
| [overlane project readiness](/cli/project-readiness/) | read | Show whether this project is set up for agents to work on it, and the numbered list of what is left |
| [overlane repo access](/cli/repo-access/) | read | Show the members whose access is narrowed on a repository |
| [overlane repo access set](/cli/repo-access-set/) | write | Narrow one member's role on a repository |
| [overlane repo access clear](/cli/repo-access-clear/) | write | Give a member their team role on a repository again |
| [overlane repo list](/cli/repo-list/) | read | List the project's repositories |
| [overlane repo status](/cli/repo-status/) | read | Show whether this project can get a native repository now |
| [overlane repo show](/cli/repo-show/) | read | Show one repository, or one commit with its full diff |
| [overlane repo diff](/cli/repo-diff/) | read | Show the full diff between two branches or commits |
| [overlane repo diff-file](/cli/repo-diff-file/) | read | Show one file's full diff between two commits, including a file too large for the diff listing |
| [overlane repo create](/cli/repo-create/) | write | Create a native repository for the project |
| [overlane repo import](/cli/repo-import/) | write | Import or mirror a GitHub repository |
| [overlane repo delete](/cli/repo-delete/) | destructive | Delete a native repository and its history |
| [overlane repo branches](/cli/repo-branches/) | read | List a repository's branches and which are protected |
| [overlane repo branch create](/cli/repo-branch-create/) | write | Create a branch from the default branch or another start point |
| [overlane repo branch delete](/cli/repo-branch-delete/) | destructive | Delete a branch |
| [overlane repo push](/cli/repo-push/) | write | Commit files to a branch through the API |
| [overlane repo protect](/cli/repo-protect/) | write | Protect a branch: pull requests, approvals and required checks |
| [overlane repo protection](/cli/repo-protection/) | read | Show a repository's branch protection rules |
| [overlane repo token](/cli/repo-token/) | write | Mint a scoped git token for one repository |
| [overlane repo token revoke](/cli/repo-token-revoke/) | destructive | Stop a repository git push credential from working |
| [overlane repo mirror set](/cli/repo-mirror-set/) | write | Choose which side of a mirror is writable |
| [overlane repo sync](/cli/repo-sync/) | write | Sync a mirror from its GitHub source |
| [overlane repo index show](/cli/repo-index-show/) | read | Show the code index jobs and shard plan |
| [overlane repo index run](/cli/repo-index-run/) | write | Run the queued index jobs now |
| [overlane repo pr list](/cli/repo-pr-list/) | read | List pull requests |
| [overlane repo pr show](/cli/repo-pr-show/) | read | Show a pull request: reviews, checks and what blocks the merge |
| [overlane repo pr diff](/cli/repo-pr-diff/) | read | Show a pull request's full diff |
| [overlane repo pr open](/cli/repo-pr-open/) | write | Open a pull request |
| [overlane repo pr review](/cli/repo-pr-review/) | write | Approve, request changes on, or comment on a pull request |
| [overlane repo pr merge](/cli/repo-pr-merge/) | write | Merge a pull request |
| [overlane repo pr close](/cli/repo-pr-close/) | write | Close a pull request without merging |
| [overlane ci validate](/cli/ci-validate/) | read | Check the pipeline file and show the line of each error |
| [overlane ci run](/cli/ci-run/) | write | Start a pipeline run for a commit |
| [overlane ci list](/cli/ci-list/) | read | List recent pipeline runs |
| [overlane ci schedule list](/cli/ci-schedule-list/) | read | List scheduled pipelines and when each runs next |
| [overlane ci show](/cli/ci-show/) | read | Show a run with its jobs, routing and cache result |
| [overlane ci logs](/cli/ci-logs/) | read | Show a run's logs, with secrets masked |
| [overlane ci cancel](/cli/ci-cancel/) | write | Cancel a queued or running pipeline run |
| [overlane ci rerun](/cli/ci-rerun/) | write | Run a finished or held run again |
| [overlane ci secrets](/cli/ci-secrets/) | read | List the project's CI secret names |
| [overlane ci secret set](/cli/ci-secret-set/) | write | Set a CI secret from the environment or standard input |
| [overlane ci secret delete](/cli/ci-secret-delete/) | destructive | Delete a CI secret |
| [overlane ci settings](/cli/ci-settings/) | read | Show the CI cost gate and concurrency settings |
| [overlane ci settings set](/cli/ci-settings-set/) | write | Change the cost gate, concurrency or superseded-run cancelling |
| [overlane ci usage](/cli/ci-usage/) | read | Show this month's CI minutes, cost, flaky tests and where job databases ran |
| [overlane ci receipts](/cli/ci-receipts/) | read | Show the check receipts a run produced |
| [overlane ci checks](/cli/ci-checks/) | read | List the project's registered checks and their definition digests |
| [overlane ci check show](/cli/ci-check-show/) | read | Show one registered check with its definition and digest |
| [overlane ci check set](/cli/ci-check-set/) | write | Register or replace a check's definition from JSON |
| [overlane deploy providers](/cli/deploy-providers/) | read | List the deploy services this project can use |
| [overlane deploy targets](/cli/deploy-targets/) | read | List deploy targets and environments |
| [overlane deploy target add](/cli/deploy-target-add/) | write | Add a deploy target with its provider token |
| [overlane deploy target update](/cli/deploy-target-update/) | write | Rename a deploy target, change its settings or replace its token |
| [overlane deploy target remove](/cli/deploy-target-remove/) | destructive | Remove a deploy target and its stored token |
| [overlane deploy env create](/cli/deploy-env-create/) | write | Create an environment on a target |
| [overlane deploy env secret set](/cli/deploy-env-secret-set/) | write | Set a deploy secret for an environment |
| [overlane deploy env secret delete](/cli/deploy-env-secret-delete/) | destructive | Delete a deploy secret from an environment |
| [overlane deploy releases](/cli/deploy-releases/) | read | List releases and which is live in each environment |
| [overlane deploy run](/cli/deploy-run/) | write | Deploy a passed CI run's artifact to an environment |
| [overlane deploy preview](/cli/deploy-preview/) | write | Deploy a branch preview |
| [overlane deploy rollback](/cli/deploy-rollback/) | destructive | Restore an environment's previous release |
| [overlane channel list](/cli/channel-list/) | read | Show each release channel with its build, hold and recent promotions |
| [overlane channel promote](/cli/channel-promote/) | write | Promote the build one channel below into a channel |
| [overlane channel hold](/cli/channel-hold/) | write | Hold a channel so nothing is promoted into it |
| [overlane channel release](/cli/channel-release/) | write | Release a hold so the channel takes promotions again |
| [overlane channel rollback](/cli/channel-rollback/) | destructive | Put a channel back on the build it ran before |
| [overlane channel preset](/cli/channel-preset/) | write | Set the channel preset a project promotes through |
| [overlane channel use](/cli/channel-use/) | write | Choose which build of the app you see: follow your team, stable or beta |
| [overlane channel show](/cli/channel-show/) | read | Show which build of the app you see and why |
| [overlane project merge](/cli/project-merge/) | write | Merge a second project for the same code into this one |
| [overlane workspace channel](/cli/workspace-channel/) | write | Show or set the build your workspace sees: stable or beta, and whether everyone stays on stable |
| [overlane features list](/cli/features-list/) | read | List features with their stage and whether each is on for this workspace |
| [overlane features set](/cli/features-set/) | write | Switch a feature on or off for this workspace |
| [overlane features clear](/cli/features-clear/) | write | Remove this workspace's override so the feature follows its stage again |
| [overlane enterprise sso show](/cli/enterprise-sso-show/) | read | Show the single sign-on and directory state, and the group to role mappings |
| [overlane enterprise sso test](/cli/enterprise-sso-test/) | write | Test the single sign-on or directory connection end to end; exits 1 when it fails |
| [overlane enterprise sso groups set](/cli/enterprise-sso-groups-set/) | write | Replace the group to role mappings and the highest role a group may grant |
| [overlane enterprise audit stream list](/cli/enterprise-audit-stream-list/) | read | List SIEM stream targets with their status and how far each has been delivered |
| [overlane enterprise audit stream run](/cli/enterprise-audit-stream-run/) | write | Send the audit rows a target has not acknowledged yet, now |
| [overlane enterprise audit stream remove](/cli/enterprise-audit-stream-remove/) | destructive | Remove a SIEM stream target; its stored signing secret goes with it |
| [overlane enterprise retention reports](/cli/enterprise-retention-reports/) | read | List the purge reports, newest first |
| [overlane enterprise backups drill](/cli/enterprise-backups-drill/) | write | Run the backup restore drill; exits 1 if any record count differs or the audit chain breaks |
| [overlane enterprise mcp-allowlist show](/cli/enterprise-mcp-allowlist-show/) | read | Show the MCP server allowlist for the team's agents |
| [overlane enterprise mcp-allowlist set](/cli/enterprise-mcp-allowlist-set/) | write | Turn the MCP server allowlist on or off and set the listed hosts |
| [overlane enterprise evidence-pack](/cli/enterprise-evidence-pack/) | read | Print the security review evidence pack: chain state, agent action counts and controls |
| [overlane enterprise status](/cli/enterprise-status/) | read | Show which enterprise features this team's plan includes |
| [overlane enterprise sso link](/cli/enterprise-sso-link/) | write | Print a short-lived link to the identity provider's hosted setup portal |
| [overlane enterprise sso sync](/cli/enterprise-sso-sync/) | write | Sync the directory now: apply group roles and deprovision removed people |
| [overlane enterprise audit export](/cli/enterprise-audit-export/) | write | Export the tamper-evident audit log as CSV, with a manifest, to files |
| [overlane enterprise audit verify](/cli/enterprise-audit-verify/) | read | Check an exported audit CSV offline; exits 1 if any row was altered, removed or reordered |
| [overlane enterprise audit stream add](/cli/enterprise-audit-stream-add/) | write | Add a SIEM stream target: an https address and a signing secret you choose |
| [overlane enterprise region show](/cli/enterprise-region-show/) | read | Show the data region and where each store holds the team's data |
| [overlane enterprise region set](/cli/enterprise-region-set/) | write | Pin the team's data to a region, or request a migration to another one |
| [overlane enterprise keys list](/cli/enterprise-keys-list/) | read | List bring-your-own inference keys by alias, provider and status |
| [overlane enterprise keys add](/cli/enterprise-keys-add/) | write | Add an inference key under an alias; the value comes from the environment or stdin |
| [overlane enterprise keys test](/cli/enterprise-keys-test/) | write | Test a key against its provider; a key that fails is not used for inference |
| [overlane enterprise keys rotate](/cli/enterprise-keys-rotate/) | write | Replace a key's value under the same alias; the old value stays if the provider refuses the new one |
| [overlane enterprise keys revoke](/cli/enterprise-keys-revoke/) | destructive | Disable a key for good: the stored value is deleted and inference by that alias is refused |
| [overlane enterprise retention show](/cli/enterprise-retention-show/) | read | Show the retention rules per data class |
| [overlane enterprise retention set](/cli/enterprise-retention-set/) | write | Set retention rules, replacing the current ones |
| [overlane enterprise retention purge](/cli/enterprise-retention-purge/) | destructive | Run the retention purge now and print the report |
| [overlane enterprise data export](/cli/enterprise-data-export/) | write | Export the team's own data (or one project's or user's) as NDJSON |
| [overlane enterprise data delete](/cli/enterprise-data-delete/) | destructive | Delete the team's own data (or one project's or user's) from every store |
| [overlane model list](/cli/model-list/) | read | List the team's model executors with their caps and key state |
| [overlane model add](/cli/model-add/) | write | Add a model the dispatcher can run by alias, with a cap per run |
| [overlane model remove](/cli/model-remove/) | destructive | Remove a model executor and destroy its stored key |
| [overlane code find](/cli/code-find/) | read | Find where a symbol is defined: one line each, kind, qualified name, path:line |
| [overlane code show](/cli/code-show/) | read | Print one symbol's source with line numbers, instead of cat or sed on a whole file |
| [overlane code outline](/cli/code-outline/) | read | List a file's symbols, one per line: line, kind, name |
| [overlane code refs](/cli/code-refs/) | read | List callers and other uses of a symbol: path:line plus the trimmed line |
| [overlane exec](/cli/exec/) | write | Run a command; keep the full output in a log and print a short status and parsed summary |
| [overlane brief](/cli/brief/) | read | Repository state in one line and the open P0 lines of TASKS.md |
| [overlane tokens report](/cli/tokens-report/) | read | Where tool-call tokens went, by category, with the terse command that replaces each |
| [overlane assistant save-skill](/cli/assistant-save-skill/) | write | Save one of your assistant conversations as a skill draft for review |
| [overlane skill list](/cli/skill-list/) | read | List the project's skills and whether each is active, waiting for review or rejected |
| [overlane skill show](/cli/skill-show/) | read | Print a skill's SKILL.md text and review state |
| [overlane skill approve](/cli/skill-approve/) | write | Approve a skill draft so tasks in the project use it |
| [overlane skill reject](/cli/skill-reject/) | write | Reject a skill draft so tasks never use it |
| [overlane assistant audit](/cli/assistant-audit/) | read | Show the assistant's audit trail for the team |
| [overlane assistant readonly](/cli/assistant-readonly/) | write | Turn the assistant's read-only mode on or off for the team |
| [overlane assistant conversation](/cli/assistant-conversation/) | read | Read one of your assistant conversations |
| [overlane assistant approval](/cli/assistant-approval/) | read | Show a change the assistant proposed and its state |
| [overlane assistant config](/cli/assistant-config/) | read | Show what the assistant can do for the team and whether it is read-only |
| [overlane assistant ask](/cli/assistant-ask/) | write | Ask the assistant a question or for a change |
| [overlane assistant decide](/cli/assistant-decide/) | write | Approve or reject a change the assistant proposed |
| [overlane assistant undo](/cli/assistant-undo/) | write | Propose undoing a change the assistant made |
| [overlane assistant feedback](/cli/assistant-feedback/) | write | Rate one of the assistant's answers |
| [overlane github installations](/cli/github-installations/) | read | List the team's GitHub App installations and any request waiting for an organization owner |
| [overlane github repositories](/cli/github-repositories/) | read | List the repositories a GitHub App installation reaches |
| [overlane github install](/cli/github-install/) | write | Install the Overlane GitHub App for this repository from a link any device can open, and wait for it |
| [overlane inbox list](/cli/inbox-list/) | read | List your notifications, newest first, with the unread count |
| [overlane inbox read](/cli/inbox-read/) | write | Mark one notification read |
| [overlane inbox read-all](/cli/inbox-read-all/) | write | Mark every notification read |
| [overlane inbox snooze](/cli/inbox-snooze/) | write | Hide a notification until a time you give |
| [overlane inbox preferences](/cli/inbox-preferences/) | read | Show how you are told about each kind of event |
| [overlane inbox preferences set](/cli/inbox-preferences-set/) | write | Choose how you are told about the kinds of event you name |
| [overlane task capsule](/cli/task-capsule/) | read | Show a task as an open, versioned capsule |
| [overlane task payload](/cli/task-payload/) | read | Show the rendered payload sections of a task you hold |
| [overlane task update](/cli/task-update/) | write | Change a task's title or outcome |
| [overlane task cancel](/cli/task-cancel/) | destructive | Cancel a task that is not finished |
| [overlane task archive](/cli/task-archive/) | write | Archive a task: hide it from lists, keep everything, restore it for 30 days |
| [overlane task restore](/cli/task-restore/) | write | Bring an archived task back |
| [overlane task delete](/cli/task-delete/) | destructive | Delete a task: it is archived and can be restored for 30 days, then removed |
| [overlane project list](/cli/project-list/) | read | List the team's projects |
| [overlane project update](/cli/project-update/) | write | Rename a project or change its code settings |
| [overlane project archive](/cli/project-archive/) | write | Archive a project and its open tasks; restore them for 30 days |
| [overlane project restore](/cli/project-restore/) | write | Bring an archived project and its tasks back |
| [overlane project delete](/cli/project-delete/) | destructive | Delete a project: archived now, restorable for 30 days, then purged |
| [overlane team members](/cli/team-members/) | read | List the people on the team and their roles |
| [overlane team remove](/cli/team-remove/) | destructive | Remove a member from the team and revoke the tokens they hold |
| [overlane team role](/cli/team-role/) | write | Change a member's role |
| [overlane team invitations](/cli/team-invitations/) | read | Show who was asked to join and has not answered |
| [overlane team invitations revoke](/cli/team-invitations-revoke/) | destructive | Revoke an invite nobody has accepted yet |
| [overlane project set](/cli/project-set/) | write | Change a project setting: the code layer or the code map in context |
| [overlane task assign](/cli/task-assign/) | write | Hand a task to a bot, such as a chat assistant |
| [overlane task events](/cli/task-events/) | read | Read the project's event feed after a position |
| [overlane release promote](/cli/release-promote/) | write | Promote an internal release to stable once it has soaked |
| [overlane release promotion](/cli/release-promotion/) | write | Show or set how internal releases reach stable |
| [overlane release withdraw](/cli/release-withdraw/) | destructive | Withdraw a release so it can no longer be pinned or promoted |
| [overlane issue project list](/cli/issue-project-list/) | read | Show the work projects and their status |
| [overlane issue project new](/cli/issue-project-new/) | write | Create a work project to group issues |
| [overlane issue cycle list](/cli/issue-cycle-list/) | read | List the cycles (time boxes) issues are planned in |
| [overlane issue cycle new](/cli/issue-cycle-new/) | write | Create a cycle with a start and end day |
| [overlane issue label list](/cli/issue-label-list/) | read | List the labels issues can carry |
| [overlane issue label new](/cli/issue-label-new/) | write | Create a label for issues |
| [overlane memory show](/cli/memory-show/) | read | Show one memory by ID |
| [overlane memory purge](/cli/memory-purge/) | destructive | Delete many memories at once, by scope, project or person |
| [overlane audit list](/cli/audit-list/) | read | Read the tamper-evident audit log, a page at a time |
| [overlane audit verify](/cli/audit-verify/) | read | Check the audit log's hash chain; exits 1 if a row was altered or removed |
| [overlane audit export](/cli/audit-export/) | write | Write the whole audit log to a file, one JSON row per line |
| [overlane billing limits](/cli/billing-limits/) | read | Show what the plan allows this period |
| [overlane billing invoices](/cli/billing-invoices/) | read | List the latest invoices with their lines and status |
| [overlane decision settings](/cli/decision-settings/) | read | Show where the decision model is switched on and how sure it must be |
| [overlane decision settings set](/cli/decision-settings-set/) | write | Switch a use of the decision model on or off, or tighten its gate |
| [overlane channel schedule](/cli/channel-schedule/) | write | Turn the release schedule on or off for a project |
| [overlane deploy envs](/cli/deploy-envs/) | read | List the deploy environments and the targets they belong to |
| [overlane claim settings](/cli/claim-settings/) | read | Show how the project handles overlapping claims and how long a lease lasts |
| [overlane claim settings set](/cli/claim-settings-set/) | write | Set the overlap policy and the default lease length |
| [overlane claim checks](/cli/claim-checks/) | read | List the recorded merge checks between open branches |
| [overlane claim show](/cli/claim-show/) | read | Show one claim: holder, scope, status and lease |
| [overlane budget remove](/cli/budget-remove/) | destructive | Remove a budget so nothing limits spend at that scope |
| [overlane pr list](/cli/pr-list/) | read | List the pull requests that have been routed, with their lane |
| [overlane egress grants show](/cli/egress-grants-show/) | read | Show one credential grant and whether it is still active |
| [overlane observe metrics](/cli/observe-metrics/) | read | Total one kind of metric by agent, project, team, pull request or task |
| [overlane repo token list](/cli/repo-token-list/) | read | List a repository's git tokens (never the tokens themselves) |
| [overlane repo events](/cli/repo-events/) | read | Read a repository's push and branch events after a position |

## Global flags

- `--json` or `--text`: choose the output format (default: JSON when stdout is not a terminal).
- `--verbose`: print diagnostics to stderr.
- `--help`: print help for the command.
- `--dry-run`: on commands that write, print the plan and change nothing.
- `--force`: destructive commands need it when there is no terminal.

## Exit codes

| Code | Meaning |
| --- | --- |
| `0` | ok |
| `1` | failure |
| `2` | usage error |
| `3` | authentication required |
| `4` | not found |
| `5` | conflict or precondition not met |
| `6` | blocked by policy or budget |
| `7` | service unreachable |

## Credentials

Commands use the stored sign-in from `overlane auth login`. Unattended agents sign in for their repository with `overlane auth login --repo`, and commands do so on their own when there is no terminal. Credentials never come from environment variables. Never write a token to a file.

Source: https://docs.overlane.app/cli/index.mdx