diff --git a/src/content/docs/agents/inference/grok-subscription.mdx b/src/content/docs/agents/inference/grok-subscription.mdx index 03f73129..3366d139 100644 --- a/src/content/docs/agents/inference/grok-subscription.mdx +++ b/src/content/docs/agents/inference/grok-subscription.mdx @@ -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](/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](/cli/models-and-usage/#bring-your-own-api-key). + ## Usage and billing behavior When a Grok model with the key icon is selected: diff --git a/src/content/docs/cli/configuration.mdx b/src/content/docs/cli/configuration.mdx index 4d09b1b2..4cef468f 100644 --- a/src/content/docs/cli/configuration.mdx +++ b/src/content/docs/cli/configuration.mdx @@ -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 diff --git a/src/content/docs/cli/index.mdx b/src/content/docs/cli/index.mdx index b79aef13..e17ee287 100644 --- a/src/content/docs/cli/index.mdx +++ b/src/content/docs/cli/index.mdx @@ -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](/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 web dashboard. + +* **Session and account status** - Run `/status` to open a read-only panel listing the installed version, the current session and conversation IDs, 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. This command appears only for team admins, because only admins can manage a team's billing. + +For how usage is metered as you work, see [models and usage](/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. diff --git a/src/content/docs/cli/input-and-shell-commands.mdx b/src/content/docs/cli/input-and-shell-commands.mdx index fbecc41a..f5197f65 100644 --- a/src/content/docs/cli/input-and-shell-commands.mdx +++ b/src/content/docs/cli/input-and-shell-commands.mdx @@ -23,6 +23,10 @@ The full editing and selection table is in the [keyboard shortcuts reference](/c 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 CLI confirms with a "Vim mode enabled" hint, starts you in insert mode, and remembers the setting across sessions. Turn on the [statusline](/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)`. diff --git a/src/content/docs/cli/models-and-usage.mdx b/src/content/docs/cli/models-and-usage.mdx index 6e26ff81..5d7791c1 100644 --- a/src/content/docs/cli/models-and-usage.mdx +++ b/src/content/docs/cli/models-and-usage.mdx @@ -27,7 +27,9 @@ Run `/api-keys` to open the key management menu. It lists each provider with its * **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. * **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](/cli/reference/#command-line-flags). X Premium/SuperGrok connections can only be managed through `/api-keys`. +Run `/connect-grok` to jump straight to the subscription row and start the xAI sign-in, without opening the full key list first. + +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](/cli/reference/#command-line-flags). X Premium/SuperGrok connections can only be managed through `/api-keys` and `/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. diff --git a/src/content/docs/cli/reference.mdx b/src/content/docs/cli/reference.mdx index 5f8c2019..7feedb53 100644 --- a/src/content/docs/cli/reference.mdx +++ b/src/content/docs/cli/reference.mdx @@ -124,6 +124,7 @@ 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 to run Grok models through your xAI account | | `/conversations` | | Open conversation history | | `/copy-debugging-id` | | Copy the current conversation's debugging information to the clipboard | | `/cost` | | Toggle per-response credit usage details | @@ -131,18 +132,24 @@ Type `/` at the start of the input to open the slash command menu. Commands that | `/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 your browser (team admins only) | | `/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 the current task into subtasks and run them in parallel with multiple agents. See [multi-agent orchestration](/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` | `` | Set the color theme | -| `/version` | | Show the installed version | +| `/upgrade` | | Open the Warp upgrade page in your browser | | `/view-logs` | | Bundle your logs into a zip archive | +| `/vim-mode` | | Toggle Vim keybindings in the input | | `/voice` | | Start voice input | Skills also appear in the same menu under their own names, so you can invoke a skill directly as `/skill-name`. [Customizing the CLI](/cli/configuration/) covers how skills are discovered. @@ -283,7 +290,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