docs(cli): overview and quickstart by hongyi-chen · Pull Request #398 · warpdotdev/docs

hongyi-chen · 2026-07-28T21:27:43Z

Pages changed

src/content/docs/cli/index.mdx — Warp CLI overview
src/content/docs/cli/quickstart.mdx — Warp CLI quickstart

Features covered

What the Warp CLI is (with "Warp Agent CLI" mentioned once as the alternate name); relationship to the Warp app and Oz, with a cross-link to /platform/harnesses/warp-agent/
Key features list linking out to the other cli/ pages
Supported platforms: macOS (Apple Silicon and Intel) and Linux (x64 and Arm64), confirmed via the release pipeline on master
Login: device authorization flow (verification link + code, auto-opens browser, unlocks without restart); --api-key / WARP_API_KEY for non-interactive auth (linked to /reference/cli/api-keys/); /logout behavior (returns to login screen and opens web sign-out)
Start screen (zero state): version + update status, "What's new" list, project rules/skills, MCP status
Automatic updates: background check, staged install, applied on next launch, "update installed, restart to apply" notice, opt-out via general.autoupdate_enabled
Bundled migration skill for users coming from the Warp app (settings + global MCP config migration; credentials never copied; rules/skills shared automatically; Drive syncs after login)
Open source section (plans only, no dates or license commitments)
Quickstart flow: install → login → first prompt (with permission requests) → shell command (! shell mode, Backspace to exit) → exit (Ctrl+C twice or /exit) and resume (warp --resume)

Dropped/unconfirmed

Install commands/channels: no official install instructions confirmable from the repo (install script lives server-side; distribution channels are an open question in the launch plan). The quickstart install section uses the one allowed placeholder {/* PENDING: install instructions from eng */} plus a warp --version verification step.
Windows support: dropped; no Windows TUI release/bundling job exists in the release pipeline on master (macOS and Linux jobs exist).
Autoupdate opt-out environment variable: intentionally omitted from the overview; its current name is TUI-derived and may be renamed with the binary. The settings-file opt-out is documented instead; reference/troubleshooting pages can pick it up once the name is final.

Suggested reviewer(s): Kevin

Co-Authored-By: Oz oz-agent@warp.dev

Fill in cli/index.mdx (what the CLI is, key features, relationship to the Warp app and Oz, supported platforms, login/logout, automatic updates, migration from the Warp app, open source) and cli/quickstart.mdx (install placeholder, device-auth login, first prompt, shell command, exit and resume). Co-Authored-By: Oz <oz-agent@warp.dev>

vercel · 2026-07-28T21:27:48Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview, Comment	Jul 28, 2026 10:09pm

oz-for-oss · 2026-07-28T21:27:54Z

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

oz-for-oss

Overview

This PR replaces placeholder CLI overview and quickstart content with launch-oriented documentation for the Warp CLI. The pages cover the intended concepts, but the quickstart is not yet runnable because the install step is hidden, there are broken Reference links, and the API-key guidance should avoid recommending command-line secret exposure.

Concerns

The quickstart's install section renders without actual installation instructions, so readers cannot complete the first required step.
Both Next steps sections link to /cli/reference/, but the CLI reference content lives under /reference/cli/.

Security

The quickstart recommends warp --api-key YOUR_API_KEY; for CI or remote servers, prefer WARP_API_KEY so the secret is not written into shell history or exposed via process listings.

Verdict

Found: 2 critical, 2 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

oz-for-oss · 2026-07-28T21:30:52Z

 ## Install the {VARS.WARP_CLI}

-{/* TODO(cli-overview): install command(s) — confirm distribution channels with eng before merge. */}
+{/* PENDING: install instructions from eng */}


⚠️ [IMPORTANT] This MDX comment is hidden in the rendered page, so the Install section has no install instructions and readers cannot complete the quickstart. Add the confirmed install commands before publishing, or keep this page out of navigation until they are available.

oz-for-oss · 2026-07-28T21:30:52Z

+When login completes, the CLI shows its start screen: the version, a short "What's new" list, and the rules, skills, and MCP servers it discovered for your current directory.
+
+:::note
+On machines without a browser, such as CI or remote servers, authenticate with a Warp API key instead: run `warp --api-key YOUR_API_KEY` or set the `WARP_API_KEY` environment variable. See [API keys](/reference/cli/api-keys/) for how to create one.


⚠️ [IMPORTANT] [SECURITY] Passing API keys on the command line can expose them through shell history or process listings; make WARP_API_KEY the primary non-interactive recommendation and mention --api-key only for controlled local use.

Suggested change

On machines without a browser, such as CI or remote servers, authenticate with a Warp API key instead: run `warp --api-key YOUR_API_KEY` or set the `WARP_API_KEY` environment variable. See [API keys](/reference/cli/api-keys/) for how to create one.

On machines without a browser, such as CI or remote servers, authenticate with a Warp API key instead. Prefer setting the `WARP_API_KEY` environment variable for non-interactive environments so the key does not appear in shell history or process listings; use `warp --api-key YOUR_API_KEY` only when that exposure is acceptable. See [API keys](/reference/cli/api-keys/) for how to create one.

oz-for-oss · 2026-07-28T21:30:52Z

+* [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.


🚨 [CRITICAL] This link points to /cli/reference/, but the CLI reference pages are under /reference/cli/; the current URL will 404.

Suggested change

* [Reference](/cli/reference/) - Flags, slash commands, and keyboard shortcuts.

* [Reference](/reference/cli/) - Flags, slash commands, and keyboard shortcuts.

oz-for-oss · 2026-07-28T21:30:52Z

+* [Agent conversations](/cli/agent-conversations/) - Work with the transcript, code diffs, plans, and tasks.
+* [Context](/cli/context/) - Give the agent rules, skills, and MCP servers.
+* [Configuration](/cli/configuration/) - Set your theme, statusline, and keybindings.
+* [Reference](/cli/reference/) - All flags, slash commands, and keyboard shortcuts.


🚨 [CRITICAL] This link points to /cli/reference/, but the CLI reference pages are under /reference/cli/; the current URL will 404.

Suggested change

* [Reference](/cli/reference/) - All flags, slash commands, and keyboard shortcuts.

* [Reference](/reference/cli/) - All flags, slash commands, and keyboard shortcuts.

Frontmatter {{WARP_CLI}} tokens are not substituted by the build pipeline, so built titles showed the raw token. Body prose keeps {VARS.WARP_CLI}. Co-Authored-By: Oz <oz-agent@warp.dev>

…cli-cli-overview

Update literal frontmatter titles/descriptions for the confirmed launch name and rework the overview intro now that Warp Agent CLI is the primary name (positioning: the Warp Agent from the Warp app, in any terminal). Body {VARS.WARP_CLI} usages pick up the new name from the merged var change. Co-Authored-By: Oz <oz-agent@warp.dev>

cla-bot Bot added the cla-signed label Jul 28, 2026

vercel Bot deployed to Preview July 28, 2026 21:29 View deployment

oz-for-oss Bot reviewed Jul 28, 2026

View reviewed changes

docs(cli): use literal Warp CLI in frontmatter titles and descriptions

9b0cd7c

Frontmatter {{WARP_CLI}} tokens are not substituted by the build pipeline, so built titles showed the raw token. Body prose keeps {VARS.WARP_CLI}. Co-Authored-By: Oz <oz-agent@warp.dev>

vercel Bot deployed to Preview July 28, 2026 21:46 View deployment

hongyi-chen and others added 2 commits July 28, 2026 15:03

Merge remote-tracking branch 'origin/hyc/launch-cli' into hyc/launch-…

854b779

…cli-cli-overview

vercel Bot deployed to Preview July 28, 2026 22:09 View deployment

hongyi-chen mentioned this pull request Jul 29, 2026

docs: Warp Agent CLI launch documentation #411

Draft

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(cli): overview and quickstart - #398

docs(cli): overview and quickstart#398
hongyi-chen wants to merge 4 commits into
hyc/launch-clifrom
hyc/launch-cli-cli-overview

hongyi-chen commented Jul 28, 2026

Uh oh!

vercel Bot commented Jul 28, 2026 •

edited

Loading

Uh oh!

oz-for-oss Bot commented Jul 28, 2026 •

edited

Loading

Uh oh!

oz-for-oss Bot left a comment

Uh oh!

oz-for-oss Bot Jul 28, 2026

Uh oh!

oz-for-oss Bot Jul 28, 2026

Uh oh!

oz-for-oss Bot Jul 28, 2026

Uh oh!

oz-for-oss Bot Jul 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	On machines without a browser, such as CI or remote servers, authenticate with a Warp API key instead: run `warp --api-key YOUR_API_KEY` or set the `WARP_API_KEY` environment variable. See [API keys](/reference/cli/api-keys/) for how to create one.
	On machines without a browser, such as CI or remote servers, authenticate with a Warp API key instead. Prefer setting the `WARP_API_KEY` environment variable for non-interactive environments so the key does not appear in shell history or process listings; use `warp --api-key YOUR_API_KEY` only when that exposure is acceptable. See [API keys](/reference/cli/api-keys/) for how to create one.

	* [Reference](/cli/reference/) - Flags, slash commands, and keyboard shortcuts.
	* [Reference](/reference/cli/) - Flags, slash commands, and keyboard shortcuts.

	* [Reference](/cli/reference/) - All flags, slash commands, and keyboard shortcuts.
	* [Reference](/reference/cli/) - All flags, slash commands, and keyboard shortcuts.

Uh oh!

Conversation

hongyi-chen commented Jul 28, 2026

Pages changed

Features covered

Dropped/unconfirmed

Uh oh!

vercel Bot commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oz-for-oss Bot commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oz-for-oss Bot left a comment

Choose a reason for hiding this comment

Overview

Concerns

Security

Verdict

Uh oh!

oz-for-oss Bot Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

oz-for-oss Bot Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

oz-for-oss Bot Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

oz-for-oss Bot Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel Bot commented Jul 28, 2026 •

edited

Loading

oz-for-oss Bot commented Jul 28, 2026 •

edited

Loading