Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/agents/cli/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Choose which items appear and in what order:
3. Press `←` and `→` to move the highlighted item earlier or later in the row.
4. Press `Esc` to save and close. Press `Ctrl+C` to cancel without saving.

Your choices are saved to the settings file, so the layout persists across sessions.
Your choices are saved to the settings file, so the layout persists across sessions. To start over, run `/reset-statusline`, which restores the default items and ordering.

## Start screen

Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/agents/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ You sign in once, and the CLI stays signed in across sessions.
* **Sign in with an API key** - In non-interactive environments such as CI, authenticate with a Warp API key through the `WARP_API_KEY` environment variable or the `--api-key` flag. See [command-line flags](/agents/cli/reference/#command-line-flags).
* **Sign out** - Run `/logout`. The CLI returns to its login screen and opens Warp's web sign-out page, so your browser session is signed out too.

## Checking your account, plan, and billing

The CLI has slash commands for the account details you'd otherwise look up in the Warp app or the {VARS.WEB_APP}.

* **Session and account status** - Run `/status` to open a read-only panel with the installed version, the current conversation's name and ID, the working directory, and the organization and email you're signed in as. Press `Esc` to close it. Include these details when you report a problem.
* **Upgrade your plan** - Run `/upgrade` to open Warp's upgrade page in your browser.
* **Manage team billing** - Run `/manage-billing` to open your team's billing page in your browser. The command is listed only when you administer billing for your team.

For how usage is metered as you work, see [models and usage](/agents/cli/models-and-usage/#usage-and-cost).

## Automatic updates

The CLI updates automatically. While it runs, it periodically checks for a newer version, downloads it in the background, and stages it without interrupting your session. The staged version takes effect the next time you launch `warp`. When an update is ready, the start screen shows an "update installed, restart to apply" notice next to the version.
Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/agents/cli/input-and-shell-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The full editing and selection table is in the [keyboard shortcuts reference](/a
Core `Ctrl` and `Alt` bindings are cross-platform. Shortcuts that use `Alt` require some macOS terminals' Option-as-Alt (Meta) setting. Command-modified shortcuts require a terminal with the Kitty keyboard protocol enabled.
:::

### Vim mode

If you prefer modal editing, run `/vim-mode` to toggle Vim keybindings in the input. The setting persists across sessions. Turn on the [statusline](/agents/cli/configuration/#statusline) Vim mode item to see the active mode (such as `NOR` or `INS`) while you type.

## Slash commands

Type `/` at the start of an empty input to open the slash command menu. Entries for toggles and pickers show their current state, for example `/theme (currently auto: Dark)` or `/auto-approve (currently off)`.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/agents/cli/models-and-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Run `/api-keys` to open the key management menu. It lists each provider with its

* **Set a key** - Press `Enter` on OpenAI, Anthropic, or Google and enter the key. Input is masked, so the key never appears in your transcript or shell history, and it's saved to your device's secure storage. Warp does not store provider keys on its servers.
* **Replace or clear a key** - On a connected provider, `Enter` loads the stored key (still masked) for editing, and saving an empty field clears it. `Ctrl+X` clears the highlighted provider's key from the list.
* **Connect X Premium or SuperGrok** - Press `Enter` on the subscription row and the CLI opens your browser to sign in to your xAI account. `Ctrl+X` disconnects it.
* **Connect X Premium or SuperGrok** - Press `Enter` on the subscription row and the CLI opens your browser to sign in to your xAI account. `Ctrl+X` disconnects it. Running `/connect-grok` jumps straight to this row and starts the sign-in.
* **Warp credit fallback** - Press `Enter` to toggle whether a request that fails through your key is retried with Warp credits. See [failover and fallback behavior](/agents/inference/bring-your-own-api-key/#failover-and-fallback-behavior).

You can also store or clear keys outside a session with the `--set-provider-api-key` and `--clear-provider-api-key` flags. See the [{VARS.WARP_CLI} reference](/agents/cli/reference/#command-line-flags). X Premium/SuperGrok connections can only be managed through `/api-keys`.
You can also store or clear keys outside a session with the `--set-provider-api-key` and `--clear-provider-api-key` flags. See the [{VARS.WARP_CLI} reference](/agents/cli/reference/#command-line-flags). X Premium/SuperGrok connections can only be managed from inside a session, with `/api-keys` or `/connect-grok`.

:::note
Warp's built-in Auto models always consume Warp credits, even with BYOK configured. To bill through your own account, select a specific provider model, or use a [custom router](/agents/inference/custom-routers/#using-your-own-api-keys-byok) whose targets your keys cover. See [BYOK usage and billing behavior](/agents/inference/bring-your-own-api-key/#byok-usage-and-billing-behavior) for the full rules.
Expand Down
15 changes: 13 additions & 2 deletions src/content/docs/agents/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,27 +124,38 @@ Type `/` at the start of the input to open the slash command menu. Commands that
| `/auto-approve` | | Toggle auto-approve for agent actions |
| `/clear` | `[prompt]` | Clear the transcript and start a new conversation |
| `/compact` | `[instructions]` | Free up context by summarizing the conversation history |
| `/connect-grok` | | Connect an X Premium or SuperGrok subscription for Grok models |
| `/conversations` | | Open conversation history |
| `/copy-debugging-id` | | Copy the current conversation's debugging information to the clipboard |
| `/cost` | | Toggle per-response credit usage details |
| `/create-new-project` | `<description>` | Have the agent walk you through creating a new coding project |
| `/exit` | | Exit the CLI |
| `/export-to-clipboard` | | Export the current conversation to the clipboard as Markdown |
| `/export-to-file` | `[filename]` | Export the current conversation to a Markdown file |
| `/fork` | `[prompt]` | Fork the current conversation into a copy, optionally sending a prompt in the copy |
| `/handoff` | `[prompt]` | Hand off this conversation to a cloud agent |
| `/logout` | | Log out of Warp |
| `/manage-billing` | | Open your team's billing page in the browser |
| `/mcp` | | View and manage MCP servers |
| `/model` | | Switch the base agent model |
| `/natural-language-detection` | | Toggle natural language detection for shell input |
| `/new` | `[prompt]` | Start a new conversation (alias for `/agent`) |
| `/orchestrate` | `[task]` | Break a task into subtasks and run them in parallel with multiple agents. See [multi-agent orchestration](/agents/cli/cloud-and-orchestration/#multi-agent-orchestration) |
| `/plan` | `[task]` | Ask the agent to research and create a plan for a task |
| `/reset-statusline` | | Restore the statusline to its default items and ordering |
| `/skills` | | Browse skills in scope and insert one into the input |
| `/status` | | Show session and account status |
| `/statusline` | | Configure the statusline |
| `/theme` | `<auto\|light\|dark>` | Set the color theme |
| `/version` | | Show the installed version |
| `/upgrade` | | Open the Warp upgrade page in the browser |
| `/view-logs` | | Bundle your logs into a zip archive |
| `/vim-mode` | | Toggle Vim keybindings in the input |
| `/voice` | | Start voice input |

Some commands appear only when they apply to your account. `/manage-billing` is listed when you administer billing for your team, and opens that team's billing page; it isn't available to members without billing access. `/connect-grok` opens the same subscription row as [`/api-keys`](/agents/cli/models-and-usage/#bring-your-own-api-key) and starts the xAI sign-in directly.

`/status` opens a read-only panel with the installed version, the current conversation's name and ID, the working directory, and the organization and email you're signed in as. Press `Esc` to close it, and include those details when you report a problem.

Skills also appear in the same menu under their own names, so you can invoke a skill directly as `/skill-name`. [Customizing the CLI](/agents/cli/configuration/) covers how skills are discovered.

## Keyboard shortcuts
Expand Down Expand Up @@ -283,7 +294,7 @@ The sign-in attempt was rejected or timed out. The error message in the CLI name

The CLI updates automatically. Installed builds check for updates in the background, download new versions, and apply them the next time you launch `warp`. A running session is never interrupted.

To check which version you're running, use `/version` in a session, or run:
To check which version you're running, use `/status` in a session, or run:

```bash
warp --version
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/agents/inference/grok-subscription.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Once connected, supported Grok models show a **key icon** in the model picker, i
3. Approve the connection in your browser. The page confirms with "Grok connected," and back in Warp the row shows a "Connected on..." timestamp.
4. Select a Grok model with the key icon from the model picker in your prompt input. Connecting a subscription doesn't change your selected model, so this last step is what actually routes your requests through your subscription. See [Model choice](/agents/inference/model-choice/) for the list of available models.

In the [Warp Agent CLI](/agents/cli/), run `/connect-grok` instead. It starts the same xAI sign-in from your session, and `/api-keys` shows the connection state afterward. See [models and usage in the Warp Agent CLI](/agents/cli/models-and-usage/#bring-your-own-api-key).

## Usage and billing behavior

When a Grok model with the key icon is selected:
Expand Down
Loading