docs(cli): overview and quickstart

[hongyi-chen]

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

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview	Jul 31, 2026 11:59pm

[oz-for-oss]

@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

[hongyi-chen]

Reviewed as part of a coherence pass across the hyc/launch-cli sub-PRs (with the four merged ones as the baseline). Content reads well and the technical claims I could verify check out — flagging a few mesh issues with sibling PRs:

Factual (worth fixing here):

• Key features → Project context says the agent picks up "your project's rules (like AGENTS.md), skills, and MCP servers automatically." Per docs(cli): customization (settings, themes, statusline, rules, skills, MCP) #401, the CLI reads MCP servers from its global config file only (~/.warp_cli/.mcp.json) — project-scoped MCP configs are not detected. Suggest limiting the bullet to rules + skills, or qualifying MCP as global.

Links that break as siblings land:

• /cli/conversations/ ×2 (overview Key features → "Persistent conversations"; quickstart → "Exit and resume") — docs(cli): remove orphaned conversations stub, repoint its links #423 deletes that page. Repoint to /cli/agent-conversations/#managing-conversations.
• /cli/context/ ×2 (overview Key features → "Project context"; quickstart Next steps) — superseded by docs(cli): customization (settings, themes, statusline, rules, skills, MCP) #401's consolidation into the customization page. Fine to leave for the docs: Warp Agent CLI launch documentation #411 integration sweep, but noting so it isn't missed.

Plan deltas (flag, not blocking):

• The launch plan calls for a short "Open source" section on the overview (messaging only, pending marketing sign-off). It's absent here and not tracked on the docs: Warp Agent CLI launch documentation #411 checklist — deliberate deferral?

Verified: general.autoupdate_enabled + WARP_TUI_DISABLE_AUTOUPDATE match crates/warp_tui/src/autoupdate.rs (note the setting is read once at startup); /cli/quickstart/#log-in anchor exists; frontmatter uses literal product name per convention.