diff --git a/.agents/references/terminology.md b/.agents/references/terminology.md index 6aad15a8..98e7489e 100644 --- a/.agents/references/terminology.md +++ b/.agents/references/terminology.md @@ -135,6 +135,8 @@ For the summary of the most critical terms (core features, Oz terms, terms to av ### Warp Agent vs Oz - **Warp Agent** — Warp's built-in agent harness. Use "Warp Agent" when specifically referring to the built-in harness, especially when contrasting with third-party agents (Claude Code, Codex, etc.), or when referencing the Settings label (**Settings** > **Agents** > **Warp Agent**). +- **Warp Agent CLI** — The standalone terminal program (the `warp` binary) that runs the Warp Agent in any terminal, including over SSH and on machines without the Warp app. Documented at `/agents/cli/`. + *Usage note:* Distinct from the Oz CLI (the `oz` binary), which runs and manages cloud agents. At the next launch (approximately August 18, 2026) the Oz CLI is retired and wrapped into the Warp Agent CLI, leaving a single CLI under this name. Until that ships, keep the two clearly separate in prose; afterwards, "Warp Agent CLI" covers both. - **Oz** — Warp's programmable platform for running and coordinating agents at scale - There is typically one Warp environment per user session. Oz can run many agents concurrently, across machines, repos, and teams. @@ -209,7 +211,7 @@ For the summary of the most critical terms (core features, Oz terms, terms to av - **Trigger** — The event that starts a run (Slack mention, schedule, CI event, API call). -- **Warp CLI** — The command-line tool for running and managing Warp Platform workflows. Formerly called `warp-cli`, now `oz`. +- **Warp CLI** — Ambiguous since the Warp Agent CLI launched; avoid the bare term. Use "Oz CLI" for the `oz` binary that runs and manages cloud agents (formerly called `warp-cli`), or "Warp Agent CLI" for the `warp` binary that runs the Warp Agent in any terminal. ## Technical terms diff --git a/.agents/skills/style_lint/style_lint.py b/.agents/skills/style_lint/style_lint.py index d6169a29..5ec8b518 100644 --- a/.agents/skills/style_lint/style_lint.py +++ b/.agents/skills/style_lint/style_lint.py @@ -108,7 +108,22 @@ TERMINOLOGY_FILE = Path(".agents/references/terminology.md") -STANDARD_SCREENSHOT_WIDTHS = {"300px", "350px", "375px", "563px"} +# Standard figure widths for screenshots. See AGENTS.md § "Screenshot sizing +# standards". +# +# 736px is full content width: it matches `.main-pane .sl-container`'s +# `max-width: 46rem` in src/styles/custom.css. Because the container already +# caps at that width, 736px renders identically to omitting maxWidth entirely. +# It is listed explicitly so authors can signal "this screenshot is +# deliberately full width" and so this check can tell that apart from a figure +# that is simply missing a width. If the content column in custom.css ever +# changes, update this value to match. +STANDARD_SCREENSHOT_WIDTHS = {"300px", "350px", "375px", "563px", "736px"} + +# Rendered as "300px, 350px, 375px, 563px, or 736px" in check messages, derived +# from the set above so the two can never drift apart. +_SORTED_WIDTHS = sorted(STANDARD_SCREENSHOT_WIDTHS) +STANDARD_WIDTHS_PHRASE = f"{', '.join(_SORTED_WIDTHS[:-1])}, or {_SORTED_WIDTHS[-1]}" SCREENSHOT_PATH_HINTS = ( "/assets/", @@ -556,7 +571,7 @@ def check_screenshot_widths(lines: List[str], filepath: str) -> List[Issue]: if figure_start_line is None: issues.append(Issue( filepath, i, "screenshot-width", - "Likely screenshot image should be wrapped in a
with a standard maxWidth (300px, 350px, 375px, or 563px)", + f"Likely screenshot image should be wrapped in a
with a standard maxWidth ({STANDARD_WIDTHS_PHRASE})", "warning", )) else: @@ -568,13 +583,13 @@ def check_screenshot_widths(lines: List[str], filepath: str) -> List[Issue]: if width is None: issues.append(Issue( filepath, figure_start_line, "screenshot-width", - "Screenshot figure is missing a standard maxWidth (300px, 350px, 375px, or 563px)", + f"Screenshot figure is missing a standard maxWidth ({STANDARD_WIDTHS_PHRASE})", "warning", )) elif width not in STANDARD_SCREENSHOT_WIDTHS: issues.append(Issue( filepath, figure_start_line, "screenshot-width", - f"Screenshot figure uses non-standard maxWidth \"{width}\"; use one of {', '.join(sorted(STANDARD_SCREENSHOT_WIDTHS))}", + f"Screenshot figure uses non-standard maxWidth \"{width}\"; use one of {STANDARD_WIDTHS_PHRASE}", "warning", )) figure_start_line = None diff --git a/AGENTS.md b/AGENTS.md index 68504763..0cd843e1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -228,15 +228,17 @@ Use screenshots to clarify product surfaces, configuration points, or visual sta Use consistent screenshot widths so docs pages feel visually balanced. Crop unnecessary empty space before resizing, then choose the closest standard size. **Standard widths:** -- **Large screenshots: default content width** — Use normal `
` or Markdown image rendering for full-window, full-pane, or broad product-surface screenshots where the surrounding layout matters. In legacy GitBook screenshots, this was usually `563px`. +- **Full content width: 736px** — Use for wide screenshots whose content cannot be cropped narrower without clipping, such as full-width terminal strips, wide status bars, and wide tables. `736px` equals the content column (`46rem`, set on `.main-pane .sl-container` in `src/styles/custom.css`), so it renders the same as omitting `maxWidth`. Set it explicitly anyway: it records that the width is deliberate rather than forgotten, and the style lint treats a missing width as an error. Reach for this tier only when a narrower size would make text illegible. +- **Large screenshots: 563px** — The default for full-window, full-pane, or broad product-surface screenshots where the surrounding layout matters. This was the usual width in legacy GitBook screenshots. Prefer this over `736px` unless the content genuinely needs the extra room. - **Medium screenshots: ~375px** — Use for narrow UI surfaces such as popovers, command menus, side panes, dropdowns, and focused interaction flows. This is the preferred constrained size for most small Warp UI screenshots. - **Small screenshots: ~300-350px** — Use for tightly cropped controls, chips, buttons, tooltips, and small menus. Use a smaller width only when the UI remains legible and the crop is intentionally compact. **Rules:** - **Avoid arbitrary widths** — Choose the nearest standard size instead of one-off values. If a screenshot needs a different size, the reason should be clear from the UI being shown. - **Keep sequences consistent** — Screenshots in the same section or step sequence should use the same width unless they show meaningfully different UI surfaces. -- **Preserve legibility** — Text in the screenshot must remain readable at the chosen size on the docs page. -- **Prefer the default figure size for large screenshots** — Only constrain width when the screenshot is a narrow UI element that looks oversized at full content width. +- **Preserve legibility** — Text in the screenshot must remain readable at the chosen size on the docs page. This rule outranks the preference for a smaller tier: if text is unreadable at `563px`, move up to `736px` rather than shipping an illegible image. +- **Crop before widening** — Widening is the last resort. First crop out empty space and anything that is not the subject, and re-capture at a narrower terminal or window size if you can. Only step up a tier when the content itself sets the floor, as with a status bar that clips instead of reflowing. +- **Prefer the default figure size for large screenshots** — Only constrain width below `563px` when the screenshot is a narrow UI element that looks oversized at full content width. #### Image caption guidelines Captions orient the reader — they identify what the image shows so the reader knows where to look. They are not a place for instructions, marketing language, or exhaustive descriptions. diff --git a/astro.config.mjs b/astro.config.mjs index b5820c93..12462c7b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -167,7 +167,7 @@ export default defineConfig({ customSets: [ { label: 'Terminal', description: 'Warp Terminal features and configuration.', paths: ['terminal/**'] }, { label: 'Agents', description: 'Warp\'s agents: capabilities, local agents, and CLI agents.', paths: ['agents/**'] }, - { label: 'Warp Agent CLI', description: 'The Warp Agent CLI: agent conversations, shell commands, permissions, and configuration in any terminal.', paths: ['cli/**'] }, + { label: 'Warp Agent CLI', description: 'The Warp Agent CLI: agent conversations, shell commands, permissions, and configuration in any terminal.', paths: ['agents/cli/**'] }, { label: 'Oz Platform', description: 'Warp\'s Oz platform: cloud agents, orchestration, triggers, integrations, environments, harnesses, and self-hosting.', paths: ['platform/**'] }, { label: 'Code', description: 'Code editor, code review, and Git worktrees.', paths: ['code/**'] }, { label: 'Enterprise', description: 'Enterprise features, SSO, team management, and security.', paths: ['enterprise/**'] }, diff --git a/src/assets/agents/cli/tui-agents-tab-bar.png b/src/assets/agents/cli/tui-agents-tab-bar.png new file mode 100644 index 00000000..b9f9ac45 Binary files /dev/null and b/src/assets/agents/cli/tui-agents-tab-bar.png differ diff --git a/src/assets/agents/cli/tui-statusline.png b/src/assets/agents/cli/tui-statusline.png new file mode 100644 index 00000000..57a057be Binary files /dev/null and b/src/assets/agents/cli/tui-statusline.png differ diff --git a/src/assets/cli/tui-agents-tab-bar.png b/src/assets/cli/tui-agents-tab-bar.png deleted file mode 100644 index d3c3660e..00000000 Binary files a/src/assets/cli/tui-agents-tab-bar.png and /dev/null differ diff --git a/src/assets/cli/tui-statusline.png b/src/assets/cli/tui-statusline.png deleted file mode 100644 index 305edbaf..00000000 Binary files a/src/assets/cli/tui-statusline.png and /dev/null differ diff --git a/src/content/docs/agents/cli-agents/overview.mdx b/src/content/docs/agents/cli-agents/overview.mdx index 9dd968eb..f47f1537 100644 --- a/src/content/docs/agents/cli-agents/overview.mdx +++ b/src/content/docs/agents/cli-agents/overview.mdx @@ -11,6 +11,8 @@ Warp auto-detects supported CLI agents and enhances them with IDE-level features This feature set is also known as **universal agent support**. +Looking for Warp's own CLI instead? The [Warp Agent CLI](/agents/cli/) runs the Warp Agent itself in any terminal. This page covers running third-party coding agents inside the Warp app. + :::note Claude Code and Codex are also supported as harnesses in Oz for cloud orchestration. See [Harnesses in Oz](/platform/harnesses/). ::: diff --git a/src/content/docs/cli/agent-conversations.mdx b/src/content/docs/agents/cli/agent-conversations.mdx similarity index 91% rename from src/content/docs/cli/agent-conversations.mdx rename to src/content/docs/agents/cli/agent-conversations.mdx index 2a2e996a..d6930e52 100644 --- a/src/content/docs/cli/agent-conversations.mdx +++ b/src/content/docs/agents/cli/agent-conversations.mdx @@ -20,12 +20,12 @@ Every tool call the agent makes appears inline in the transcript, in the order i Some tool calls render richer, interactive content: -* **[Shell commands](/cli/input-and-shell-commands/#shell-mode)** - Commands run in your session, with output streamed into the transcript. +* **[Shell commands](/agents/cli/input-and-shell-commands/#shell-mode)** - Commands run in your session, with output streamed into the transcript. * **[File edits](#code-diffs)** - Expandable diffs with per-file headers. * **[Questions](#agent-questions)** - Interactive option prompts. * **[Plans](#planning)** - Inline plan documents. -When a tool call needs your approval before it runs, an approval card appears in place of the input. See [permissions in the CLI](/cli/permissions-and-profiles/) to learn how approvals work. +When a tool call needs your approval before it runs, an approval card appears in place of the input. See [permissions in the CLI](/agents/cli/permissions-and-profiles/) to learn how approvals work. ## Code diffs @@ -109,7 +109,7 @@ The menu lists your Warp Agent conversations, including conversations started in If the CLI can't load conversation data from Warp's servers, the menu shows conversations from your local device only and displays a warning. Conversations from other devices reappear once the connection recovers. ::: -To continue a cloud agent run from the CLI, or to hand the current conversation off to a cloud agent, see [cloud handoff and orchestration](/cli/cloud-and-orchestration/). +To continue a cloud agent run from the CLI, or to hand the current conversation off to a cloud agent, see [cloud handoff and orchestration](/agents/cli/cloud-and-orchestration/). ### Resuming conversations @@ -125,7 +125,7 @@ To continue this conversation, run: warp --resume YOUR_CONVERSATION_TOKEN ``` -`YOUR_CONVERSATION_TOKEN` is a conversation identifier generated by Warp. For the complete list of command-line flags, see the [CLI reference](/cli/reference/). +`YOUR_CONVERSATION_TOKEN` is a conversation identifier generated by Warp. For the complete list of command-line flags, see the [CLI reference](/agents/cli/reference/). ### Compacting context @@ -138,9 +138,9 @@ After compaction, a collapsed **Conversation summary** block appears in the tran ## Related pages -* [Permissions and profiles](/cli/permissions-and-profiles/) - Approve, reject, or auto-approve the agent's tool calls. -* [Input and shell commands](/cli/input-and-shell-commands/) - How commands the agent (or you) run appear in the transcript. -* [Cloud handoff and orchestration](/cli/cloud-and-orchestration/) - Hand off conversations to cloud agents and resume cloud runs. -* [{VARS.WARP_CLI} reference](/cli/reference/) - Command-line flags, slash commands, and keyboard shortcuts. +* [Permissions and profiles](/agents/cli/permissions-and-profiles/) - Approve, reject, or auto-approve the agent's tool calls. +* [Input and shell commands](/agents/cli/input-and-shell-commands/) - How commands the agent (or you) run appear in the transcript. +* [Cloud handoff and orchestration](/agents/cli/cloud-and-orchestration/) - Hand off conversations to cloud agents and resume cloud runs. +* [{VARS.WARP_CLI} reference](/agents/cli/reference/) - Command-line flags, slash commands, and keyboard shortcuts. * [Planning](/agents/capabilities/planning/) - The full planning workflow. * [Task lists](/agents/capabilities/task-lists/) - How agents create and update task lists. diff --git a/src/content/docs/cli/cloud-and-orchestration.mdx b/src/content/docs/agents/cli/cloud-and-orchestration.mdx similarity index 94% rename from src/content/docs/cli/cloud-and-orchestration.mdx rename to src/content/docs/agents/cli/cloud-and-orchestration.mdx index d6948da6..4bc5c14e 100644 --- a/src/content/docs/cli/cloud-and-orchestration.mdx +++ b/src/content/docs/agents/cli/cloud-and-orchestration.mdx @@ -53,7 +53,7 @@ Resuming in the CLI has two constraints: * **The run must be finished** - Cloud runs that are still in progress or blocked can't be opened in the CLI. * **Warp Agent runs only** - Conversations that ran with a different harness, such as Claude Code or Codex, can't be opened in the CLI. -You can also open a conversation directly at startup with `warp --resume `. See [managing conversations in the CLI](/cli/agent-conversations/#managing-conversations) to learn more about conversation history and resume details. +You can also open a conversation directly at startup with `warp --resume `. See [managing conversations in the CLI](/agents/cli/agent-conversations/#managing-conversations) to learn more about conversation history and resume details. ## Multi-agent orchestration @@ -65,7 +65,7 @@ You can also shape the configuration in your prompt. For example, ask for a spec When the agent decides to spawn child agents, the CLI shows an approval card titled **Can I start additional agents for this task?** that summarizes the agents it wants to launch and the run-wide configuration. -By default, no child agents launch until you approve. The **Run orchestrated agents** permission in your profile controls this: **Always allow** skips the approval card, and **Never** blocks child agents entirely. See [Permissions and profiles](/cli/permissions-and-profiles/). +By default, no child agents launch until you approve. The **Run orchestrated agents** permission in your profile controls this: **Always allow** skips the approval card, and **Never** blocks child agents entirely. See [Permissions and profiles](/agents/cli/permissions-and-profiles/). From the approval card: @@ -75,8 +75,8 @@ From the approval card: After launch, a tab bar labeled **Agents:** appears above the session with one tab for the orchestrator and one tab per child agent. Messages between the parent and child agents appear in each agent's transcript. -
-![The Agents: tab bar in the Warp Agent CLI, showing the orchestrator tab and three child agent tabs with status glyphs](../../../assets/cli/tui-agents-tab-bar.png) +
+![The Agents: tab bar in the Warp Agent CLI, showing the orchestrator tab and three child agent tabs with status glyphs](../../../../assets/agents/cli/tui-agents-tab-bar.png)
The Agents: tab bar with one child agent running and two finished.
@@ -116,5 +116,5 @@ In the orchestrator's own session, `Ctrl+C` keeps its usual behavior. * [Handoff from local to cloud](/platform/handoff/local-to-cloud/) - Prerequisites, the Warp app flow, and troubleshooting. * [Multi-agent orchestration](/platform/orchestration/) - The parent/child model, run states, and orchestration patterns. * [Viewing cloud agent runs](/platform/viewing-cloud-agent-runs/) - Open, inspect, and continue cloud runs in the {VARS.WEB_APP}. -* [Agent conversations in the CLI](/cli/agent-conversations/#managing-conversations) - Conversation history, `/conversations`, and `--resume`. +* [Agent conversations in the CLI](/agents/cli/agent-conversations/#managing-conversations) - Conversation history, `/conversations`, and `--resume`. * [Environments](/platform/environments/) - Configure the repos, image, and setup commands cloud agents run with. diff --git a/src/content/docs/cli/configuration.mdx b/src/content/docs/agents/cli/configuration.mdx similarity index 98% rename from src/content/docs/cli/configuration.mdx rename to src/content/docs/agents/cli/configuration.mdx index 4d09b1b2..f1da1b07 100644 --- a/src/content/docs/cli/configuration.mdx +++ b/src/content/docs/agents/cli/configuration.mdx @@ -67,8 +67,8 @@ In auto mode, detection runs at startup, so if you switch your terminal's colors The statusline is the row below the CLI's input box that shows session information at a glance. By default it shows the auto-approve indicator, the active model, the working directory, the Git branch, and the Git diff status inside a repository, plus the Vim mode indicator when Vim mode is on. You can enable any of these items: -
-![The Warp Agent CLI statusline showing the auto-approve, model, working directory, Git branch status, Git diff status, credit usage, context window usage, and agent to-do list chips](../../../assets/cli/tui-statusline.png) +
+![The Warp Agent CLI statusline showing the auto-approve, model, working directory, Git branch status, Git diff status, credit usage, context window usage, and agent to-do list chips](../../../../assets/agents/cli/tui-statusline.png)
The statusline with credit usage, context window usage, and task list chips enabled.
@@ -160,4 +160,4 @@ Press `Enter` on a server to start, stop, or retry it depending on its state. Fa * [Skills](/agents/capabilities/skills/) - Authoring skills, skill arguments, and skill locations. * [MCP servers](/agents/capabilities/mcp/) - Config format, server examples, and authentication. * [Codebase Context](/agents/capabilities/codebase-context/) - Codebase indexing in the Warp app. -* [{VARS.WARP_CLI} reference](/cli/reference/) - Command-line flags, slash commands, and keyboard shortcuts. +* [{VARS.WARP_CLI} reference](/agents/cli/reference/) - Command-line flags, slash commands, and keyboard shortcuts. diff --git a/src/content/docs/cli/index.mdx b/src/content/docs/agents/cli/index.mdx similarity index 60% rename from src/content/docs/cli/index.mdx rename to src/content/docs/agents/cli/index.mdx index b79aef13..9e0a36d1 100644 --- a/src/content/docs/cli/index.mdx +++ b/src/content/docs/agents/cli/index.mdx @@ -14,23 +14,23 @@ The {VARS.WARP_CLI} is a standalone terminal program that runs [Warp Agent](/pla The CLI is also a native terminal multiplexer. It creates and maintains its own pseudoterminal (PTY), which lets you and the agent execute commands and interact with running processes through the same terminal, including prompts and full-screen terminal apps. Because it's a regular command-line program, it works in any terminal emulator, including over SSH. -To get a working setup in a few minutes, follow the [quickstart](/cli/quickstart/). +To get a working setup in a few minutes, follow the [quickstart](/agents/cli/quickstart/). ## Key features -* **[Agent conversations](/cli/agent-conversations/)** - Follow the agent's work in a scrollable transcript with streamed responses, Markdown formatting, file-edit diffs, tool calls, plans, and task lists. -* **[Shell commands](/cli/input-and-shell-commands/#shell-mode)** - Run shell commands from the same input you use to prompt the agent, including long-running and interactive ones. -* **[Permissions and profiles](/cli/permissions-and-profiles/)** - Approve commands and file edits from inline request cards, or configure execution profiles and auto-approve. -* **[Persistent conversations](/cli/agent-conversations/#managing-conversations)** - Conversations save to your Warp account, so you can exit and resume later or switch between them. -* **[Cloud handoff and orchestration](/cli/cloud-and-orchestration/)** - Hand off a conversation to a cloud agent, continue cloud runs in the CLI, and coordinate multiple agents. -* **[Project context](/cli/configuration/#project-context-and-rules)** - The agent automatically picks up your project's rules (like `AGENTS.md`), skills, and MCP servers. -* **[Model choice](/cli/models-and-usage/)** - Pick a model per conversation, bring your own provider API keys, and track credit usage. -* **[Customization](/cli/configuration/)** - Configure themes, the statusline, and the start screen through a local settings file. +* **[Agent conversations](/agents/cli/agent-conversations/)** - Follow the agent's work in a scrollable transcript with streamed responses, Markdown formatting, file-edit diffs, tool calls, plans, and task lists. +* **[Shell commands](/agents/cli/input-and-shell-commands/#shell-mode)** - Run shell commands from the same input you use to prompt the agent, including long-running and interactive ones. +* **[Permissions and profiles](/agents/cli/permissions-and-profiles/)** - Approve commands and file edits from inline request cards, or configure execution profiles and auto-approve. +* **[Persistent conversations](/agents/cli/agent-conversations/#managing-conversations)** - Conversations save to your Warp account, so you can exit and resume later or switch between them. +* **[Cloud handoff and orchestration](/agents/cli/cloud-and-orchestration/)** - Hand off a conversation to a cloud agent, continue cloud runs in the CLI, and coordinate multiple agents. +* **[Project context](/agents/cli/configuration/#project-context-and-rules)** - The agent automatically picks up your project's rules (like `AGENTS.md`), skills, and MCP servers. +* **[Model choice](/agents/cli/models-and-usage/)** - Pick a model per conversation, bring your own provider API keys, and track credit usage. +* **[Customization](/agents/cli/configuration/)** - Configure themes, the statusline, and the start screen through a local settings file. ## How it relates to the Warp app and Oz * **The Warp app** - The CLI runs the same [Warp Agent](/platform/harnesses/warp-agent/) harness as the Warp app, so your account, plan, model access, rules, and skills work the same in both. The CLI doesn't require the Warp app to be installed. -* **{VARS.WARP_AUTOMATION_PLATFORM}** - {VARS.WARP_AUTOMATION_PLATFORM} is Warp's programmable platform for running and coordinating agents at scale. The CLI connects to the same platform. Conversations sync to your Warp account, and you can hand work off to [cloud agents](/cli/cloud-and-orchestration/) or continue a cloud run from your terminal. +* **{VARS.WARP_AUTOMATION_PLATFORM}** - {VARS.WARP_AUTOMATION_PLATFORM} is Warp's programmable platform for running and coordinating agents at scale. The CLI connects to the same platform. Conversations sync to your Warp account, and you can hand work off to [cloud agents](/agents/cli/cloud-and-orchestration/) or continue a cloud run from your terminal. ## Supported platforms @@ -44,15 +44,15 @@ The CLI runs on: You sign in once, and the CLI stays signed in across sessions. -* **Sign in through your browser** - The first time you run `warp`, the CLI shows a verification link and code and opens the link in your browser. It unlocks automatically once you approve the login. See [logging in](/cli/quickstart/#2-log-in) for the full walkthrough. -* **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 in through your browser** - The first time you run `warp`, the CLI shows a verification link and code and opens the link in your browser. It unlocks automatically once you approve the login. See [logging in](/agents/cli/quickstart/#2-log-in) for the full walkthrough. +* **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. ## 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. -To turn off background updates, set `general.autoupdate_enabled` to `false` in the [settings file](/cli/configuration/#the-settings-file). To turn them off for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. +To turn off background updates, set `general.autoupdate_enabled` to `false` in the [settings file](/agents/cli/configuration/#the-settings-file). To turn them off for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. ## Coming from the Warp app @@ -60,8 +60,8 @@ If you already use the Warp app, most of your setup carries over. Rules and skil ## Next steps -* [Quickstart](/cli/quickstart/) - Install the CLI, log in, and run your first prompt. -* [Agent conversations](/cli/agent-conversations/) - Learn how the transcript, diffs, and approvals work. -* [Input and shell commands](/cli/input-and-shell-commands/) - Compose prompts and run shell commands from the same input. -* [Configuration](/cli/configuration/) - Customize the CLI with the settings file. -* [Reference](/cli/reference/) - Flags, slash commands, and keyboard shortcuts. +* [Quickstart](/agents/cli/quickstart/) - Install the CLI, log in, and run your first prompt. +* [Agent conversations](/agents/cli/agent-conversations/) - Learn how the transcript, diffs, and approvals work. +* [Input and shell commands](/agents/cli/input-and-shell-commands/) - Compose prompts and run shell commands from the same input. +* [Configuration](/agents/cli/configuration/) - Customize the CLI with the settings file. +* [Reference](/agents/cli/reference/) - Flags, slash commands, and keyboard shortcuts. diff --git a/src/content/docs/cli/input-and-shell-commands.mdx b/src/content/docs/agents/cli/input-and-shell-commands.mdx similarity index 92% rename from src/content/docs/cli/input-and-shell-commands.mdx rename to src/content/docs/agents/cli/input-and-shell-commands.mdx index fbecc41a..6587fc4b 100644 --- a/src/content/docs/cli/input-and-shell-commands.mdx +++ b/src/content/docs/agents/cli/input-and-shell-commands.mdx @@ -7,7 +7,7 @@ description: >- --- import { VARS } from '@data/vars'; -The {VARS.WARP_CLI} is a full terminal as well as an agent. Every session runs a real shell, so you can run commands in the same place you prompt the agent. The input is a multiline editor that combines readline-style editing with inline menus for slash commands, history, and completions, plus mouse support, image attachments, and voice input. For the complete list of flags, slash commands, and keyboard shortcuts, see the [{VARS.WARP_CLI} reference](/cli/reference/). +The {VARS.WARP_CLI} is a full terminal as well as an agent. Every session runs a real shell, so you can run commands in the same place you prompt the agent. The input is a multiline editor that combines readline-style editing with inline menus for slash commands, history, and completions, plus mouse support, image attachments, and voice input. For the complete list of flags, slash commands, and keyboard shortcuts, see the [{VARS.WARP_CLI} reference](/agents/cli/reference/). ## Editing basics @@ -17,7 +17,7 @@ The input is a multiline editor. * **Edit with readline-style keys** - The editor supports familiar bindings such as `Ctrl+A` and `Ctrl+E` (start and end of line), `Ctrl+W` (delete the previous word), `Ctrl+K` and `Ctrl+U` (delete to the end or start of the line), `Ctrl+Y` (reinsert the last deleted text), and `Ctrl+Z` (undo). * **Use macOS Command shortcuts** - When the Kitty keyboard protocol is enabled in your terminal, the editor supports Command-modified shortcuts such as `⌘+X` to cut and `⌘+Shift+←` or `⌘+Shift+→` to extend the selection. -The full editing and selection table is in the [keyboard shortcuts reference](/cli/reference/#keyboard-shortcuts). +The full editing and selection table is in the [keyboard shortcuts reference](/agents/cli/reference/#keyboard-shortcuts). :::note 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. @@ -29,9 +29,9 @@ Type `/` at the start of an empty input to open the slash command menu. Entries When a command takes an argument, the input shows a ghost-text argument hint after the full command name, for example `/theme `. -Your [skills](/cli/configuration/#skills) also appear in the slash command menu, so you can invoke a skill by typing `/` followed by its name. +Your [skills](/agents/cli/configuration/#skills) also appear in the slash command menu, so you can invoke a skill by typing `/` followed by its name. -The [slash commands reference](/cli/reference/#slash-commands) lists every command. +The [slash commands reference](/agents/cli/reference/#slash-commands) lists every command. ## Input history @@ -51,7 +51,7 @@ In [shell mode](#shell-mode), press `Tab` to complete the command you're typing, ## Selection and clipboard -* **Highlight to copy** - Finishing a mouse selection in the input or the [conversation transcript](/cli/agent-conversations/) automatically copies it. +* **Highlight to copy** - Finishing a mouse selection in the input or the [conversation transcript](/agents/cli/agent-conversations/) automatically copies it. * **Keyboard selection** - Extend the selection with `Shift` plus the arrow keys, or select everything with `Ctrl+Shift+A`. Copy with `Ctrl+Shift+C` and cut with `Ctrl+X`. * **Paste** - Press `Ctrl+V` or `Ctrl+Shift+V` (also `Alt+V` on Windows). Your terminal's own paste shortcut works as well. * **Click controls** - Interactive elements such as the **Voice** footer entry and the attachment bar controls respond to clicks. @@ -149,9 +149,9 @@ There are two other ways to exit: * **`Ctrl+D`** - Exits immediately when the input is empty. * **`/exit`** - Exits from the slash command menu. -When you exit, the CLI prints a command you can use to pick the conversation back up later. See [Managing conversations](/cli/agent-conversations/#managing-conversations) for resuming and switching conversations. +When you exit, the CLI prints a command you can use to pick the conversation back up later. See [Managing conversations](/agents/cli/agent-conversations/#managing-conversations) for resuming and switching conversations. ## Related pages -* [{VARS.WARP_CLI} reference](/cli/reference/) - Flags, environment variables, slash commands, and keyboard shortcuts. -* [Agent conversations in the {VARS.WARP_CLI}](/cli/agent-conversations/) - The transcript, tool calls, diffs, and managing conversations. +* [{VARS.WARP_CLI} reference](/agents/cli/reference/) - Flags, environment variables, slash commands, and keyboard shortcuts. +* [Agent conversations in the {VARS.WARP_CLI}](/agents/cli/agent-conversations/) - The transcript, tool calls, diffs, and managing conversations. diff --git a/src/content/docs/cli/models-and-usage.mdx b/src/content/docs/agents/cli/models-and-usage.mdx similarity index 82% rename from src/content/docs/cli/models-and-usage.mdx rename to src/content/docs/agents/cli/models-and-usage.mdx index 6e26ff81..78838eef 100644 --- a/src/content/docs/cli/models-and-usage.mdx +++ b/src/content/docs/agents/cli/models-and-usage.mdx @@ -10,11 +10,11 @@ The {VARS.WARP_CLI} gives you the same model options as the Warp app. You can pi ## Choosing a model -Run `/model` to open the model picker. You can also click the model name in the [statusline](/cli/configuration/#statusline) to open the same picker. +Run `/model` to open the model picker. You can also click the model name in the [statusline](/agents/cli/configuration/#statusline) to open the same picker. Models that your plan or your team's settings don't allow appear disabled in the picker. -Your choice is saved as the base model of your active profile, so it persists across sessions. See [permissions and profiles](/cli/permissions-and-profiles/) for how profiles work in the CLI. For the full list of supported models and to learn more about how Warp's Auto models pick for you, see [Model choice](/agents/inference/model-choice/). +Your choice is saved as the base model of your active profile, so it persists across sessions. See [permissions and profiles](/agents/cli/permissions-and-profiles/) for how profiles work in the CLI. For the full list of supported models and to learn more about how Warp's Auto models pick for you, see [Model choice](/agents/inference/model-choice/). ## Bring your own API key @@ -27,7 +27,7 @@ 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`. +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`. :::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. @@ -43,7 +43,7 @@ The CLI loads the same router definitions as the Warp app. These are YAML files The CLI shows usage at two levels: -* **Conversation total** - Once a conversation has reported any usage, the [statusline](/cli/configuration/#statusline) shows its accumulated credits (e.g., `2.5 credits`). Click the entry to switch between credits and the equivalent provider cost in dollars. Your choice persists across sessions. +* **Conversation total** - Once a conversation has reported any usage, the [statusline](/agents/cli/configuration/#statusline) shows its accumulated credits (e.g., `2.5 credits`). Click the entry to switch between credits and the equivalent provider cost in dollars. Your choice persists across sessions. * **Per-response details** - Run `/cost` to toggle a summary row under the latest response showing how long it took and how many credits it spent (e.g., `12s • 1.2 credits`). The summary appears once the response finishes. Credits are Warp's unit of usage for agent requests. For what credits cover and how plans differ, see [Credits](/support-and-community/plans-and-billing/credits/). @@ -54,4 +54,4 @@ Credits are Warp's unit of usage for agent requests. For what credits cover and * [Bring Your Own API Key](/agents/inference/bring-your-own-api-key/) - How BYOK works, key storage, and billing behavior. * [SuperGrok subscription](/agents/inference/grok-subscription/) - Use Grok models through your xAI account. * [Custom routers](/agents/inference/custom-routers/) - Define routing logic that picks a model per task. -* [{VARS.WARP_CLI} reference](/cli/reference/) - Flags and slash commands, including the API key commands. +* [{VARS.WARP_CLI} reference](/agents/cli/reference/) - Flags and slash commands, including the API key commands. diff --git a/src/content/docs/cli/permissions-and-profiles.mdx b/src/content/docs/agents/cli/permissions-and-profiles.mdx similarity index 91% rename from src/content/docs/cli/permissions-and-profiles.mdx rename to src/content/docs/agents/cli/permissions-and-profiles.mdx index 6dd3d6c9..a394b605 100644 --- a/src/content/docs/cli/permissions-and-profiles.mdx +++ b/src/content/docs/agents/cli/permissions-and-profiles.mdx @@ -38,7 +38,7 @@ Auto-approve is scoped to a single conversation, and new conversations start wit With auto-approve on, the agent runs commands and applies file edits without review, including commands that match your own command denylist. Press `Ctrl+C` to stop the agent if it starts doing something you didn't intend. ::: -To keep your denylist in force while auto-approve is on, turn off the bypass in your [settings file](/cli/configuration/#the-settings-file): +To keep your denylist in force while auto-approve is on, turn off the bypass in your [settings file](/agents/cli/configuration/#the-settings-file): ```toml title="settings.toml" [agents.warp_agent.other] @@ -49,7 +49,7 @@ Denylist rules enforced by your team in the [Admin Panel](/enterprise/team-manag ## Execution profiles -The CLI reads its permissions from execution profiles stored in its [settings file](/cli/configuration/). Profiles live under the `agents.execution_profiles` table, and the CLI always runs with the profile under the reserved `default` key: +The CLI reads its permissions from execution profiles stored in its [settings file](/agents/cli/configuration/). Profiles live under the `agents.execution_profiles` table, and the CLI always runs with the profile under the reserved `default` key: ```toml title="settings.toml" [agents.execution_profiles.default] @@ -89,7 +89,7 @@ Most permission fields accept one of three values: * **`command_denylist`** - Regular expressions for commands that require approval regardless of the other permission values. [Auto-approve bypasses this list by default](#auto-approve). * **`directory_allowlist`** - Directories the agent may read without approval. -Profiles also hold model overrides such as `base_model`, covered in [Models and usage in the {VARS.WARP_CLI}](/cli/models-and-usage/). +Profiles also hold model overrides such as `base_model`, covered in [Models and usage in the {VARS.WARP_CLI}](/agents/cli/models-and-usage/). :::note The profile collection is validated as a whole. If any profile contains an invalid value, the CLI keeps the last valid configuration while it's running and falls back to the built-in default profile on the next launch, until the file is fixed. @@ -98,5 +98,5 @@ The profile collection is validated as a whole. If any profile contains an inval ## Related pages * [Profiles & Permissions](/agents/capabilities/agent-profiles-permissions/) - The full permission model, autonomy levels, and allowlist/denylist behavior. -* [Configuring the {VARS.WARP_CLI}](/cli/configuration/) - The settings file, themes, statusline, and start screen. -* [Agent conversations in the {VARS.WARP_CLI}](/cli/agent-conversations/) - How tool calls, diffs, and agent questions render in the transcript. +* [Configuring the {VARS.WARP_CLI}](/agents/cli/configuration/) - The settings file, themes, statusline, and start screen. +* [Agent conversations in the {VARS.WARP_CLI}](/agents/cli/agent-conversations/) - How tool calls, diffs, and agent questions render in the transcript. diff --git a/src/content/docs/cli/quickstart.mdx b/src/content/docs/agents/cli/quickstart.mdx similarity index 82% rename from src/content/docs/cli/quickstart.mdx rename to src/content/docs/agents/cli/quickstart.mdx index 7da904cb..902d65f1 100644 --- a/src/content/docs/cli/quickstart.mdx +++ b/src/content/docs/agents/cli/quickstart.mdx @@ -12,7 +12,7 @@ This guide takes you from installing the {VARS.WARP_CLI} to your first agent con ## Prerequisites * **A Warp account** - The login step opens your browser, where you can sign in or [create an account](https://app.warp.dev/signup). The CLI uses the same account as the Warp app, but doesn't require the app to be installed. -* **A supported platform** - macOS, Linux, or Windows. See [supported platforms](/cli/#supported-platforms). +* **A supported platform** - macOS, Linux, or Windows. See [supported platforms](/agents/cli/#supported-platforms). ## 1. Install the Warp Agent CLI @@ -39,7 +39,7 @@ After installing, verify that the `warp` command is available: warp --version ``` -The command prints the installed version. From here on, the CLI updates automatically. See [automatic updates](/cli/#automatic-updates). +The command prints the installed version. From here on, the CLI updates automatically. See [automatic updates](/agents/cli/#automatic-updates). ## 2. Log in @@ -69,7 +69,7 @@ Type a prompt in plain language, such as `What does this project do?`, and press If the agent wants to run a command or edit a file, it shows a permission request. Choose an option to approve or reject the action. -Learn more about the transcript, diffs, and approvals in [Agent conversations](/cli/agent-conversations/) and [Permissions and profiles](/cli/permissions-and-profiles/). +Learn more about the transcript, diffs, and approvals in [Agent conversations](/agents/cli/agent-conversations/) and [Permissions and profiles](/agents/cli/permissions-and-profiles/). ## 4. Run a shell command @@ -79,7 +79,7 @@ Type `!` at the start of an empty input to switch to shell mode. The footer show To run recognized shell commands without the `!` prefix, run `/natural-language-detection` to turn on natural language detection. The CLI then classifies input as you type: recognized commands switch to shell mode, while natural-language prompts stay in agent mode. The prompt marker and statusline show the active mode before you press `Enter`. -See [Input and shell commands](/cli/input-and-shell-commands/) for long-running commands, interactive programs, and full-screen apps. +See [Input and shell commands](/agents/cli/input-and-shell-commands/) for long-running commands, interactive programs, and full-screen apps. ## 5. Exit and resume @@ -93,10 +93,10 @@ warp --resume CONVERSATION_TOKEN Run the printed command later to pick up where you left off. -To browse and reopen past conversations from inside the CLI, see [Agent conversations](/cli/agent-conversations/#conversation-history). +To browse and reopen past conversations from inside the CLI, see [Agent conversations](/agents/cli/agent-conversations/#conversation-history). ## Next steps -* [Agent conversations](/cli/agent-conversations/) - Work with the transcript, code diffs, plans, and tasks. -* [Customizing the CLI](/cli/configuration/) - Rules, skills, MCP servers, themes, and settings. -* [Reference](/cli/reference/) - All flags, slash commands, and keyboard shortcuts. +* [Agent conversations](/agents/cli/agent-conversations/) - Work with the transcript, code diffs, plans, and tasks. +* [Customizing the CLI](/agents/cli/configuration/) - Rules, skills, MCP servers, themes, and settings. +* [Reference](/agents/cli/reference/) - All flags, slash commands, and keyboard shortcuts. diff --git a/src/content/docs/cli/reference.mdx b/src/content/docs/agents/cli/reference.mdx similarity index 92% rename from src/content/docs/cli/reference.mdx rename to src/content/docs/agents/cli/reference.mdx index 5f8c2019..fc8088c7 100644 --- a/src/content/docs/cli/reference.mdx +++ b/src/content/docs/agents/cli/reference.mdx @@ -42,7 +42,7 @@ Starts new conversations with auto-approve enabled, so the agent runs actions wi warp --auto-approve ``` -This flag applies only to the session you launch with it and doesn't change your saved settings. You can still toggle auto-approve per conversation with `/auto-approve` or `Ctrl+Shift+I`. See [permissions and profiles](/cli/permissions-and-profiles/) for how approvals work. +This flag applies only to the session you launch with it and doesn't change your saved settings. You can still toggle auto-approve per conversation with `/auto-approve` or `Ctrl+Shift+I`. See [permissions and profiles](/agents/cli/permissions-and-profiles/) for how approvals work. ### `--clear-provider-api-key` @@ -74,7 +74,7 @@ Reopens a previous conversation from your shell as the CLI starts. warp --resume CONVERSATION_TOKEN ``` -`CONVERSATION_TOKEN` is the token the CLI prints when you exit a session ("To continue this conversation, run: `warp --resume ...`"). You can also reopen past conversations from inside a session with `/conversations`. See [agent conversations in the CLI](/cli/agent-conversations/#managing-conversations) for how persistence and resuming work. +`CONVERSATION_TOKEN` is the token the CLI prints when you exit a session ("To continue this conversation, run: `warp --resume ...`"). You can also reopen past conversations from inside a session with `/conversations`. See [agent conversations in the CLI](/agents/cli/agent-conversations/#managing-conversations) for how persistence and resuming work. ### `--set-provider-api-key` @@ -98,7 +98,7 @@ your-secret-manager read anthropic-api-key | warp --set-provider-api-key anthrop Avoid staging keys in plaintext files. If you must use a temporary file, delete it immediately afterward. -Inside a session, manage the same keys with the `/api-keys` menu. See [models and usage](/cli/models-and-usage/#bring-your-own-api-key) for how stored keys affect billing. +Inside a session, manage the same keys with the `/api-keys` menu. See [models and usage](/agents/cli/models-and-usage/#bring-your-own-api-key) for how stored keys affect billing. ### `--version` @@ -145,14 +145,14 @@ Type `/` at the start of the input to open the slash command menu. Commands that | `/view-logs` | | Bundle your logs into a zip archive | | `/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. +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 Press `?` on an empty input to open the contextual shortcuts panel inside the CLI. The tables below list the default bindings. :::note -Bindings are the same on macOS, Linux, and Windows, except that Windows also accepts `Alt+V` for paste. For shortcuts that use `Alt`, some macOS terminals deliver `Option` as `Alt` only when their Option-as-Alt (Meta) setting is enabled. The macOS Command shortcuts described in [input and shell commands](/cli/input-and-shell-commands/#editing-basics) require a terminal with the Kitty keyboard protocol enabled. +Bindings are the same on macOS, Linux, and Windows, except that Windows also accepts `Alt+V` for paste. For shortcuts that use `Alt`, some macOS terminals deliver `Option` as `Alt` only when their Option-as-Alt (Meta) setting is enabled. The macOS Command shortcuts described in [input and shell commands](/agents/cli/input-and-shell-commands/#editing-basics) require a terminal with the Kitty keyboard protocol enabled. ::: ### Session @@ -175,7 +175,7 @@ Bindings are the same on macOS, Linux, and Windows, except that Windows also acc ### Approvals -These bindings apply while the agent is waiting for you to approve an action. [Permissions and profiles](/cli/permissions-and-profiles/) explains the approval flow. +These bindings apply while the agent is waiting for you to approve an action. [Permissions and profiles](/agents/cli/permissions-and-profiles/) explains the approval flow. | Shortcut | Action | | --- | --- | @@ -195,7 +195,7 @@ These bindings apply while an interactive terminal command is running. ### Multi-agent tabs -When an orchestration launches child agents, an **Agents:** tab bar appears above the session. [Cloud and orchestration](/cli/cloud-and-orchestration/) covers the workflow. +When an orchestration launches child agents, an **Agents:** tab bar appears above the session. [Cloud and orchestration](/agents/cli/cloud-and-orchestration/) covers the workflow. | Shortcut | Action | | --- | --- | @@ -228,7 +228,7 @@ The input supports readline-style editing. | `Ctrl+Shift+C` | Copy the selection | | `Ctrl+X` | Cut the selection | -For mouse support, completions, and other input behavior, see [input and shell commands](/cli/input-and-shell-commands/). +For mouse support, completions, and other input behavior, see [input and shell commands](/agents/cli/input-and-shell-commands/). ## Troubleshooting @@ -277,7 +277,7 @@ The sign-in attempt was rejected or timed out. The error message in the CLI name 1. Press `Ctrl+C` to exit, then run `warp` to start normally. 2. Check the token against the resume command printed when you exited the original session. -3. If the conversation exists locally, open it from the [conversation menu](/cli/agent-conversations/#conversation-history) with `/conversations` instead. +3. If the conversation exists locally, open it from the [conversation menu](/agents/cli/agent-conversations/#conversation-history) with `/conversations` instead. ### Updating @@ -289,9 +289,9 @@ To check which version you're running, use `/version` in a session, or run: warp --version ``` -To turn off background updates for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. To turn them off persistently, set `general.autoupdate_enabled` to `false` in the [CLI settings file](/cli/configuration/#the-settings-file). +To turn off background updates for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. To turn them off persistently, set `general.autoupdate_enabled` to `false` in the [CLI settings file](/agents/cli/configuration/#the-settings-file). -If an install becomes corrupted, re-running the install command from the [quickstart](/cli/quickstart/) replaces it with the latest version. +If an install becomes corrupted, re-running the install command from the [quickstart](/agents/cli/quickstart/) replaces it with the latest version. ### Getting help diff --git a/src/content/docs/agents/getting-started/agents-in-warp.mdx b/src/content/docs/agents/getting-started/agents-in-warp.mdx index b870c572..8e7d5d44 100644 --- a/src/content/docs/agents/getting-started/agents-in-warp.mdx +++ b/src/content/docs/agents/getting-started/agents-in-warp.mdx @@ -88,6 +88,16 @@ Agents work best when they understand your codebase and workflows. Warp provides --- +## The Warp Agent CLI + +The Warp Agent isn't limited to the Warp app. The [Warp Agent CLI](/agents/cli/) is a standalone terminal program that starts an agent conversation from the `warp` command, so you can use the same agent over SSH, in a different terminal emulator, or on a machine where the Warp app isn't installed. + +It runs the same agent, so your account, plan, model access, rules, and skills work the same way. Conversations sync to your Warp account, and you can hand work off to cloud agents from the CLI. + +→ [Get started with the Warp Agent CLI](/agents/cli/quickstart/) + +--- + ## Third-party CLI agents In addition to Warp's built-in agent, Warp provides first-class support for third-party CLI coding agents like Claude Code, Codex, and OpenCode. Run any supported agent inside Warp and get rich input, code review, agent notifications, vertical tabs with agent metadata, and more. @@ -114,7 +124,8 @@ Cloud agents are ideal for work that doesn't need your immediate attention—PR ## Resources * [**Oz web app**](https://oz.warp.dev) - Create runs, manage schedules, browse skills, and configure integrations -* [**Warp Agents overview**](/agents/local-agents/overview/) - Detailed guide to working with agents in Warp +* [**Using the Warp Agent**](/agents/local-agents/overview/) - Detailed guide to working with agents in Warp +* [**Warp Agent CLI**](/agents/cli/) - Run the Warp Agent from any terminal * [**Capabilities**](/agents/capabilities/) - All agent capabilities: planning, task lists, model choice, and more * [**Oz CLI**](/reference/cli/) - Run agents from the command line * [**Oz API & SDK**](/reference/api-and-sdk/) - Programmatic access to agent runs diff --git a/src/content/docs/agents/index.mdx b/src/content/docs/agents/index.mdx index 118f6d0d..cb2f03b1 100644 --- a/src/content/docs/agents/index.mdx +++ b/src/content/docs/agents/index.mdx @@ -1,52 +1,52 @@ --- title: Agents overview description: >- - Oz is the orchestration platform for cloud agents, powering both interactive - and autonomous agents for development workflows. + The Warp Agent writes code, debugs issues, and runs commands. Use it in the + Warp app, in any terminal with the CLI, or in the cloud. --- -Warp includes **Oz**, the orchestration platform that powers all of Warp's agents. Oz runs interactive agents locally inside Warp for real-time coding assistance and deploys autonomous agents in the cloud for background automation, event-driven workflows, and parallel execution across repos and teams. +The **Warp Agent** writes and edits code, debugs issues, runs commands, and works through multi-step tasks from natural language prompts. It reads your codebase, follows your rules and skills, and asks for approval before it acts. -Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE-AGPL), so the editor and terminal that host your agents are fully auditable. See [Contributing to Warp](/support-and-community/community/contributing/) for the source and contribution flow. +You reach the same agent three ways. Which one you pick depends on where you're working, not on what the agent can do. + +--- -With Oz, you can: +## Ways to use the Warp Agent -* Run interactive agent conversations in Warp for real-time coding assistance -* Deploy autonomous agents that run in the cloud from triggers, schedules, or integrations -* Coordinate multiple agents concurrently across machines, repos, and teams -* Track, audit, and share agent activity with full visibility into what ran and what it did +* [**In the Warp app**](/agents/local-agents/overview/) - The full experience, with code review, agent management, and the terminal alongside your conversation. Start here if you use Warp as your terminal. +* [**In any terminal, with the Warp Agent CLI**](/agents/cli/) - Run the `warp` command to start an agent conversation in any terminal emulator, over SSH, or on a machine where the Warp app isn't installed. +* [**In the cloud, as a cloud agent**](/platform/) - Run the agent in the background from a trigger, a schedule, or an integration, without keeping a session open. Ideal for PR reviews, issue triage, and routine maintenance. -Oz is fully programmable—launch agents manually or build custom logic around them with triggers, schedules, environments, and your choice of hosting (Warp's cloud or your own). +Your account, plan, model access, rules, and skills carry across all three, and conversations sync to your Warp account so you can move between them. --- -## Key capabilities +## Third-party CLI agents -* [**Local Agents**](/agents/local-agents/overview/) - Interactive agents embedded in Warp. Use natural language to write code, debug issues, run commands, and automate development tasks with full terminal access. -* [**Third-party CLI agents**](/agents/cli-agents/overview/) - Use Claude Code, Codex, OpenCode, and other CLI coding agents in Warp with rich input, notifications, code review, and remote session control. -* [**Cloud Agents**](/platform/) - Autonomous agents that run in the background in response to system events, schedules, or integrations. -* [**Integrations**](/platform/integrations/) - Connect external system events to autonomous agent execution. Use [Slack](/platform/integrations/slack/), [Linear](/platform/integrations/linear/), [GitHub Actions](/platform/integrations/github-actions/), and other integrations to trigger agents in the cloud. -* [**Oz Platform**](/platform/overview/) - The underlying infrastructure that powers Oz, including the CLI, API/SDK, orchestration layer, environments, secrets, and management/observability. +Separately from the Warp Agent, Warp gives third-party CLI coding agents first-class support. Run Claude Code, Codex, OpenCode, and others inside Warp and get rich input, agent notifications, inline code review, and remote session control. + +→ [Learn about third-party CLI agents](/agents/cli-agents/overview/) + +--- + +## The platform behind the agent + +[**Oz**](/platform/overview/) is Warp's programmable platform for running and coordinating agents at scale. It provides the environments, triggers, integrations, orchestration, and observability that cloud agents run on, along with a CLI, API, and SDK for driving agents programmatically. + +The Oz tab covers the platform in full. --- ## Getting started -* [**Agents in Warp**](/agents/getting-started/agents-in-warp/) - Start using agents interactively in Warp -* [**Oz web app**](https://oz.warp.dev) - Create runs, manage schedules, browse skills, and configure integrations -* [**Oz CLI**](/reference/cli/) - Run agents from the command line, in CI, or on remote machines -* [**Oz API & SDK**](/reference/api-and-sdk/) - Programmatically create and monitor agent runs +* [**Agents in Warp**](/agents/getting-started/agents-in-warp/) - A tour of what agents can do, autonomy levels, and profiles +* [**Warp Agent CLI quickstart**](/agents/cli/quickstart/) - Install the CLI and run your first agent conversation +* [**Cloud agents quickstart**](/platform/quickstart/) - Run your first agent in the cloud +* [**Agent capabilities**](/agents/capabilities/) - Skills, planning, rules, MCP servers, and more +* [**Agent FAQs**](/agents/getting-started/faqs/) - Common questions about models, privacy, and limits --- -## Learn more - -* [Warp Agents overview](/agents/local-agents/overview/) - Interactive agents in Warp -* [Third-party CLI agents](/agents/cli-agents/overview/) - Claude Code, Codex, OpenCode, and more -* [Cloud Agents overview](/platform/) - Background agents for automation at scale -* [Agent Capabilities](/agents/capabilities/) - Skills, planning, MCP, rules, and more -* [Oz Platform](/platform/overview/) - CLI, API/SDK, orchestration, environments, and hosts -* [Environments](/platform/environments/) - Configure execution context for cloud agents -* [Integrations](/platform/integrations/) - Slack, Linear, GitHub Actions, and custom integrations -* [Skills as Agents](/platform/skills-as-agents/) - Run agents from reusable skill definitions -* [Managing Cloud Agents](/platform/managing-cloud-agents/) - Monitor and manage agent activity +## Open source + +Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE-AGPL), so the editor and terminal that host your agents are fully auditable. See [Contributing to Warp](/support-and-community/community/contributing/) for the source and contribution flow. diff --git a/src/content/docs/agents/local-agents/overview.mdx b/src/content/docs/agents/local-agents/overview.mdx index 786e16db..09785a58 100644 --- a/src/content/docs/agents/local-agents/overview.mdx +++ b/src/content/docs/agents/local-agents/overview.mdx @@ -1,9 +1,8 @@ --- -title: Warp Agents overview +title: Using the Warp Agent description: >- - Powerful AI features like agents, code review, voice, and active AI - recommendations, fully integrated into the Warp Agentic Development - Environment. + Agents, code review, voice, and active AI recommendations, fully integrated + into the Warp Agentic Development Environment. --- Warp's local agents are interactive agents embedded directly in the terminal that help you write code, debug issues, run commands, and automate development tasks using natural language. Agents operate with full context from your codebase, Warp Drive, and connected tools, while you stay in control of every action. @@ -20,6 +19,14 @@ These features send input data to various LLM providers through their API. Warp Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE-AGPL) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp). The agent surface you're reading about is built in the open — see [Contributing to Warp](/support-and-community/community/contributing/) to read the code, file issues, or shape the roadmap. +## Outside the Warp app + +The same agent runs outside the Warp app. The [Warp Agent CLI](/agents/cli/) is a standalone terminal program that starts an agent conversation from the `warp` command, so you can use it in any terminal emulator, over SSH, or on a machine where the Warp app isn't installed. Your rules, skills, and model access carry over, and conversations sync to your Warp account. + +The capabilities below apply to the agent wherever it runs. Behavior that is specific to the CLI is covered in the [Warp Agent CLI](/agents/cli/) section. + +→ [Get started with the Warp Agent CLI](/agents/cli/quickstart/) + ## What you can do with agents This section covers how to interact with Warp's agents and the capabilities available during agent conversations: diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 72794522..71320e1a 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -32,26 +32,30 @@ Warp is where you work — a fast, modern terminal built for coding with agents. --- -## Oz: The orchestration platform for cloud agents +## Three ways to use the Warp Agent -Oz is the orchestration platform for cloud agents that powers all of Warp's intelligent features. Oz is designed to coordinate agents at scale—understanding your codebase, executing tasks autonomously, and adapting to your workflows. Oz is multi-model by design, giving you flexibility to choose the best LLM for each task. +The **Warp Agent** writes and edits code, debugs issues, runs commands, and works through multi-step tasks. You reach the same agent three ways, and your account, rules, skills, and model access carry across all of them. -Oz operates in two modes: +### In the Warp app -### Local agents - -Run directly in the Warp app for real-time, interactive coding assistance. +Real-time, interactive coding assistance alongside your terminal. * Write and refactor code across your codebase * Debug issues and fix errors * Run commands and interpret results * Plan and execute multi-step tasks -Local agents keep you in control. You can review changes, steer the agent mid-task, and approve actions before they execute. +You stay in control. Review changes, steer the agent mid-task, and approve actions before they execute. + +→ [Get started with agents in Warp](/agents/local-agents/overview/) + +### In any terminal, with the Warp Agent CLI + +The Warp Agent CLI is a standalone terminal program that runs the same agent without the Warp app. Run the `warp` command to start a conversation in whichever terminal you already use, over SSH, or on a machine where Warp isn't installed. -→ [Get started with local agents](/agents/local-agents/overview/) +→ [Get started with the Warp Agent CLI](/agents/cli/quickstart/) -### Cloud agents +### In the cloud, as a cloud agent Cloud agents run in the background on Warp's infrastructure (or your own) for automation at scale. @@ -64,13 +68,19 @@ Cloud agents are ideal for work that doesn't need your immediate attention, like → [Learn about cloud agents](/platform/) +### The platform behind them + +**Oz** is Warp's programmable platform for running and coordinating agents at scale. It provides the environments, triggers, integrations, orchestration, and observability that cloud agents run on, plus a CLI, API, and SDK. + +→ [Learn about the Oz platform](/platform/overview/) + --- ## How they work together Warp and Oz provide a unified experience across local and cloud development: -* **Same agent, anywhere**: Whether you're working interactively in Warp or running agents in the cloud, you're using the same underlying agent capabilities. +* **Same agent, anywhere**: Whether you're working in the Warp app, in another terminal through the Warp Agent CLI, or running agents in the cloud, you're using the same underlying agent capabilities. * **Seamless handoff**: Start a task in the cloud and take over locally in Warp when you want hands-on control, without losing progress or context. * **Shared context**: [Warp Drive](/knowledge-and-collaboration/warp-drive/), [Rules](/agents/capabilities/rules/), and [MCP servers](/agents/capabilities/mcp/) work across both local and cloud agents, so your team's knowledge and tools are always available. * **Team collaboration**: Share agent sessions, review agents' actions, and steer running tasks, regardless of who started them. @@ -104,6 +114,7 @@ Warp's AI features can be globally disabled in **Settings** > **Agents** > **War ## Next steps * [**Quickstart**](/quickstart/): Get Warp installed and start coding -* [**Warp Agents overview**](/agents/local-agents/overview/): Explore all AI features available in Warp +* [**Using the Warp Agent**](/agents/local-agents/overview/): Explore all AI features available in Warp +* [**Warp Agent CLI**](/agents/cli/): Run the Warp Agent in any terminal * [**Cloud Agents overview**](/platform/): Set up background automation * [**Oz Platform**](/platform/overview/): Learn about the CLI, API, SDK, and infrastructure diff --git a/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx b/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx index 2dcbea3a..98508abe 100644 --- a/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx +++ b/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx @@ -263,7 +263,7 @@ Whenever there is an error in the Agent Conversation, there will also be an opti ### Using `/copy-debugging-id` -The [`/copy-debugging-id`](/agents/capabilities/slash-commands/) slash command copies the same information without leaving the input. It works in both the Warp app and the [{VARS.WARP_CLI}](/cli/), and it applies to the conversation you're currently in: +The [`/copy-debugging-id`](/agents/capabilities/slash-commands/) slash command copies the same information without leaving the input. It works in both the Warp app and the [{VARS.WARP_CLI}](/agents/cli/), and it applies to the conversation you're currently in: 1. Run `/copy-debugging-id` in the conversation you want to report. 2. Warp confirms with a "Debugging information copied to clipboard" message. diff --git a/src/data/vars.ts b/src/data/vars.ts index 0df1f6e0..4647ca31 100644 --- a/src/data/vars.ts +++ b/src/data/vars.ts @@ -16,9 +16,15 @@ export const VARS = { PLATFORM_RUN: "Oz run", // future name TBD // Warp Agent CLI — the standalone terminal front-end (the `warp` binary). - // Launch name confirmed via the launch blog draft (2026-07-28). NOTE: the - // WARP_AGENT_CLI key above was reserved for renaming the Oz CLI to the - // same name — that overlap now needs a product/marketing decision. + // Launch name confirmed via the launch blog draft (2026-07-28). + // + // NOTE: the WARP_AGENT_CLI key above was reserved for renaming the Oz CLI to + // this same name. That overlap is now resolved by product direction: at the + // next launch (approximately 2026-08-18) the Oz CLI is retired and wrapped + // into the Warp Agent CLI, leaving a single CLI. The two keys are expected to + // collapse into one at that point. Keeping them separate until the + // convergence ships, since merging them now would rewrite prose across both + // CLI doc surfaces. WARP_CLI: "Warp Agent CLI", // Feature names (stable — keys and values expected to remain unchanged) diff --git a/src/sidebar.ts b/src/sidebar.ts index bb28d8ad..de92280e 100644 --- a/src/sidebar.ts +++ b/src/sidebar.ts @@ -250,7 +250,7 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ { label: 'Warp Agents', items: [ - { slug: 'agents/local-agents/overview', label: 'Warp Agents overview' }, + { slug: 'agents/local-agents/overview', label: 'Overview' }, { label: 'Capabilities', collapsed: true, @@ -322,6 +322,32 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ 'agents/local-agents/generate', ], }, + { + label: 'Warp Agent CLI', + items: [ + { slug: 'agents/cli', label: 'Overview' }, + { slug: 'agents/cli/quickstart', label: 'Quickstart' }, + { + label: 'Using the agent', + collapsed: true, + items: [ + { slug: 'agents/cli/agent-conversations', label: 'Agent conversations' }, + { slug: 'agents/cli/input-and-shell-commands', label: 'Input & shell commands' }, + { slug: 'agents/cli/permissions-and-profiles', label: 'Permissions & profiles' }, + { slug: 'agents/cli/cloud-and-orchestration', label: 'Cloud & orchestration' }, + ], + }, + { + label: 'Context & customization', + collapsed: true, + items: [ + { slug: 'agents/cli/configuration', label: 'Configuration' }, + { slug: 'agents/cli/models-and-usage', label: 'Models & usage' }, + ], + }, + { slug: 'agents/cli/reference', label: 'CLI reference' }, + ], + }, { label: 'Third-Party CLI Agents', items: [ @@ -341,37 +367,6 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ }, ], }, - { - label: 'Agent CLI', - link: '/cli/', - icon: 'right-caret', - items: [ - { slug: 'cli', label: 'Overview' }, - { slug: 'cli/quickstart', label: 'Quickstart' }, - { - label: 'Using the agent', - items: [ - { slug: 'cli/agent-conversations', label: 'Agent conversations' }, - { slug: 'cli/input-and-shell-commands', label: 'Input & shell commands' }, - { slug: 'cli/permissions-and-profiles', label: 'Permissions & profiles' }, - { slug: 'cli/cloud-and-orchestration', label: 'Cloud & orchestration' }, - ], - }, - { - label: 'Context & customization', - items: [ - { slug: 'cli/configuration', label: 'Configuration' }, - { slug: 'cli/models-and-usage', label: 'Models & usage' }, - ], - }, - { - label: 'Reference', - items: [ - { slug: 'cli/reference', label: 'CLI reference' }, - ], - }, - ], - }, { label: 'Oz', link: '/platform/', diff --git a/vercel.json b/vercel.json index f1eff390..e8c2eeef 100644 --- a/vercel.json +++ b/vercel.json @@ -95,6 +95,16 @@ } ], "redirects": [ + { + "source": "/cli/", + "destination": "/agents/cli/", + "statusCode": 308 + }, + { + "source": "/cli/:path(.*)", + "destination": "/agents/cli/:path", + "statusCode": 308 + }, { "source": "/agent-platform/", "destination": "/agents/",