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
8 changes: 4 additions & 4 deletions src/content/docs/cli/agent-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ For multi-step work, the agent tracks its progress with a task list rendered dir

Canceled tasks appear struck through. As the agent finishes tasks, compact confirmation rows (e.g., `✓ Completed <task> (2/5)`) track progress without repeating the whole list.

Task lists in the CLI reflect the same agent behavior as in the Warp app. Learn more about [how task lists work](/agent-platform/capabilities/task-lists/).
Task lists in the CLI reflect the same agent behavior as in the Warp app. Learn more about [how task lists work](/agents/capabilities/task-lists/).

## Planning

To have the agent first research and produce a plan before making changes, use the `/plan` slash command followed by a description of your task. You can also ask for a plan in natural language.

The plan renders inline in the transcript as a formatted document with its own header row showing the plan's status. An `Updated plan` entry appears when the agent revises it. Press `Ctrl+Shift+P` to expand or collapse the latest plan.

Planning in the CLI follows the same workflow as the Warp app. See [Planning](/agent-platform/capabilities/planning/) to learn how to create, review, and execute plans.
Planning in the CLI follows the same workflow as the Warp app. See [Planning](/agents/capabilities/planning/) to learn how to create, review, and execute plans.

## Selecting and copying output

Expand Down Expand Up @@ -142,5 +142,5 @@ After compaction, a collapsed **Conversation summary** block appears in the tran
* **[Running shell commands](/cli/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.
* **[Planning](/agent-platform/capabilities/planning/)** - The full planning workflow.
* **[Task lists](/agent-platform/capabilities/task-lists/)** - How agents create and update task lists.
* **[Planning](/agents/capabilities/planning/)** - The full planning workflow.
* **[Task lists](/agents/capabilities/task-lists/)** - How agents create and update task lists.
18 changes: 9 additions & 9 deletions src/content/docs/cli/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,16 +107,16 @@ The agent works in your session's current directory. When you `cd`, project rule

Within a project, the CLI picks up the same rule files as the Warp app:

* **Project rules** - `AGENTS.md` (or `WARP.md`) files in your repository apply automatically, starting from the repository root and your current directory. See [Rules](/agent-platform/capabilities/rules/) for the file format, nested rules in subdirectories, and precedence.
* **Project rules** - `AGENTS.md` (or `WARP.md`) files in your repository apply automatically, starting from the repository root and your current directory. See [Rules](/agents/capabilities/rules/) for the file format, nested rules in subdirectories, and precedence.
* **Global rules** - A rule file at `~/.agents/AGENTS.md` applies across all projects on your machine.

Because rules and skills come from the same shared locations, a repository already configured for agents in the Warp app (or any tool that reads `AGENTS.md`) works in the CLI immediately.

## Skills

[Skills](/agent-platform/capabilities/skills/) are reusable instruction sets the agent can invoke to perform specific tasks. The CLI discovers the same skills as the Warp app. Project skills come from your repository's skill directories (e.g., `.agents/skills/`), and personal skills come from your home directory (e.g., `~/.agents/skills/`), scoped to your current working directory.
[Skills](/agents/capabilities/skills/) are reusable instruction sets the agent can invoke to perform specific tasks. The CLI discovers the same skills as the Warp app. Project skills come from your repository's skill directories (e.g., `.agents/skills/`), and personal skills come from your home directory (e.g., `~/.agents/skills/`), scoped to your current working directory.

Run `/skills` to browse every skill in scope. Selecting a skill inserts `/skill-name` into the input so you can add extra instructions before running it. Any text after the skill name is passed along, either as [skill arguments](/agent-platform/capabilities/skills/#skill-arguments) or as additional context for the agent. You can also invoke a skill directly by typing `/` followed by its name, for example `/deploy push the latest changes to staging`.
Run `/skills` to browse every skill in scope. Selecting a skill inserts `/skill-name` into the input so you can add extra instructions before running it. Any text after the skill name is passed along, either as [skill arguments](/agents/capabilities/skills/#skill-arguments) or as additional context for the agent. You can also invoke a skill directly by typing `/` followed by its name, for example `/deploy push the latest changes to staging`.

### Bundled skills

Expand All @@ -127,9 +127,9 @@ The CLI ships with built-in skills that appear in the skills menu alongside your

## MCP servers

[MCP servers](/agent-platform/capabilities/mcp/) extend the agent with external tools and data sources. The CLI keeps its own MCP server configuration, separate from the Warp app's, so each can run its own set of servers.
[MCP servers](/agents/capabilities/mcp/) extend the agent with external tools and data sources. The CLI keeps its own MCP server configuration, separate from the Warp app's, so each can run its own set of servers.

Servers are defined in a JSON config file using the same `mcpServers` format as [file-based MCP servers](/agent-platform/capabilities/mcp/#file-based-mcp-servers) in the Warp app (on macOS, the file is `~/.warp_cli/.mcp.json`). Edit the file to add or remove servers. The CLI picks up changes automatically. Configured servers start automatically once you're logged in.
Servers are defined in a JSON config file using the same `mcpServers` format as [file-based MCP servers](/agents/capabilities/mcp/#file-based-mcp-servers) in the Warp app (on macOS, the file is `~/.warp_cli/.mcp.json`). Edit the file to add or remove servers. The CLI picks up changes automatically. Configured servers start automatically once you're logged in.

:::note
The CLI reads MCP servers from its global config file only. Project-scoped MCP config files in repositories are not detected. To copy global server definitions from the Warp app, use the `/tui-migrate-setup` bundled skill.
Expand All @@ -145,8 +145,8 @@ Press `Enter` on a server to start, stop, or retry it depending on its state. Fa

## Related pages

* [Rules](/agent-platform/capabilities/rules/) - Full guide to project and global rules
* [Skills](/agent-platform/capabilities/skills/) - Authoring skills, skill arguments, and skill locations
* [MCP servers](/agent-platform/capabilities/mcp/) - Config format, server examples, and authentication
* [Codebase Context](/agent-platform/capabilities/codebase-context/) - Codebase indexing in the Warp app
* [Rules](/agents/capabilities/rules/) - Full guide to project and global rules
* [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
52 changes: 40 additions & 12 deletions src/content/docs/cli/index.mdx
Original file line number Diff line number Diff line change
@@ -1,35 +1,63 @@
---
title: "{{WARP_CLI}} overview"
title: "Warp Agent CLI overview"
description: >-
The {{WARP_CLI}} brings Warp's agent to any terminal. Learn what the CLI
The Warp Agent CLI brings Warp's agent to any terminal. Learn what the CLI
does, how it relates to the Warp app and Oz, and how to get started.
Comment thread
hongyi-chen marked this conversation as resolved.
---
import { VARS } from '@data/vars';

{/* TODO(cli-overview): draft per drafts/warp-cli-launch-plan.md — "cli/index.mdx" section. Feature-doc content type. */}

The {VARS.WARP_CLI} documentation for this page is in progress.
The {VARS.WARP_CLI} brings the Warp Agent from the Warp app to the terminal you already use. Run the `warp` command to start an agent conversation: prompt the agent in natural language, review and approve its actions, and run shell commands in the same input, without changing your terminal setup.

## What is the {VARS.WARP_CLI}?

{/* TODO(cli-overview): what it is (agent in any terminal, `warp` command), also referred to as the Warp Agent CLI. */}
The {VARS.WARP_CLI} is a standalone terminal program that runs [Warp Agent](/platform/harnesses/warp-agent/), the same agent that powers the Warp app. It renders conversations as a scrolling transcript in your terminal, with streaming responses, code diffs, tool calls, and permission requests you approve inline.

The CLI is also a native terminal multiplexer: it creates and maintains its own pseudoterminal (PTY). This 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/).

## Key features

{/* TODO(cli-overview): bulleted key features list (bold term - dash - description). */}
* **[Agent conversations](/cli/agent-conversations/)** - Streaming responses with markdown rendering, file-edit diffs, tool calls, plans, and task lists.
* **[Shell commands](/cli/shell-commands/)** - Run shell commands from the same input as agent prompts, including long-running and interactive commands.
* **[Permissions you control](/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)** - Saved to your Warp account, so you can exit and resume later or switch between them.
* **[Cloud handoff and orchestration](/cli/cloud-and-orchestration/)** - Hand a conversation off to a cloud agent, continue cloud runs in the CLI, and coordinate multiple agents.
* **[Project context](/cli/configuration/#project-context-and-rules)** - The agent picks up your project's rules (like `AGENTS.md`), skills, and MCP servers automatically.
* **[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 keybindings. Use your own ASCII art as the silhouette for the rotating start-screen object, and toggle the account, changelog, project, MCP, and animation sections.

## How it relates to the Warp app and Oz

{/* TODO(cli-overview): CLI vs Warp app vs Oz platform; Warp Agent harness cross-link. */}
* **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.

## Supported platforms

{/* TODO(cli-overview): confirm platform availability with eng before merge. */}
The CLI runs on:

* **macOS** - Apple Silicon and Intel.
* **Linux** - x64 and Arm64.
* **Windows** - x64 and Arm64.

## Logging in and out

The first time you run `warp`, the CLI signs you in with a device authorization flow: it shows a verification link and code, opens your browser, and unlocks automatically once you approve the login. For non-interactive environments such as CI, authenticate with a Warp API key instead, using the `WARP_API_KEY` environment variable or the `--api-key` flag. See [logging in](/cli/quickstart/#log-in) in the quickstart for the full flow.

To 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 keeps itself up to date. 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 background updates off, set `general.autoupdate_enabled` to `false` in the [settings file](/cli/configuration/).

## Open source
## Coming from the Warp app

{/* TODO(cli-overview): planned open-sourcing messaging; no dates or license commitments. */}
If you already use the Warp app, most of your setup carries over. Rules and skills are discovered from the same shared paths, and your saved Warp Drive prompts are available after you log in (other Warp Drive object types aren't available in the CLI). To copy compatible settings and global MCP server configurations, run the bundled `/tui-migrate-setup` skill and follow the agent's instructions. Credentials are never copied, so MCP servers that require authentication must be reauthenticated in the CLI.

## Next steps

{/* TODO(cli-overview): links to quickstart and feature pages. */}
* [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.
* [Shell commands](/cli/shell-commands/) - Run shell commands alongside agent prompts.
* [Configuration](/cli/configuration/) - Customize the CLI with the settings file.
* [Reference](/cli/reference/) - Flags, slash commands, and keyboard shortcuts.
Comment thread
hongyi-chen marked this conversation as resolved.
Loading
Loading