docs: Warp Agent CLI launch documentation - #411
Draft
hongyi-chen wants to merge 11 commits into
Draft
Conversation
- New 'Warp CLI' sidebar topic with 13 stub pages under src/content/docs/cli/ - drafts/warp-cli-launch-plan.md: internal feature->page->reviewer analysis - New WARP_CLI content var (distinct from WARP_AGENT_CLI, reserved for the Oz CLI rename) Co-Authored-By: Oz <oz-agent@warp.dev>
- WARP_CLI var value -> "Warp Agent CLI" (body prose updates site-wide) - Sidebar topic label updated - Frontmatter literals fixed in the four stubs pending deletion - drafts doc: naming confirmed; WARP_AGENT_CLI key collision flagged Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
* docs(cli): draft reference, models & usage, and troubleshooting pages
Fill in the three cli-reference pages from the Warp CLI launch skeleton:
- cli/reference: command-line flags with examples, environment variables,
full slash-command table (25 commands verified against the CLI command
registry), and default keyboard shortcuts sourced from the CLI keybinding
definitions.
- cli/models-and-usage: /model picker and footer model entry, BYOK via
/add-api-key + provider flags (OpenAI/Anthropic/Google), custom model
routers in the picker, and cost transparency (footer credits toggle,
/cost per-response summary).
- cli/troubleshooting: /view-logs bundling and log locations, login
troubleshooting, autoupdate behavior with /version and --version, and
support links.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): use literal Warp CLI in frontmatter title/description
Frontmatter {{WARP_CLI}} tokens are not substituted by the build (Astro's
content layer parses frontmatter outside Vite), so built titles showed the
raw token. Body prose keeps {VARS.WARP_CLI}.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): fold troubleshooting into the reference page
Consolidation: the standalone troubleshooting page merges into
cli/reference.mdx as a final Troubleshooting section with problem-oriented
H3 subsections. Existing H2 anchors (#slash-commands, #keyboard-shortcuts)
are unchanged; internal links now point at #updating and
#command-line-flags. troubleshooting.mdx is restored to the base-branch
stub (the orchestrator removes it at integration).
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): rename literal Warp CLI to Warp Agent CLI in frontmatter
Follows the base-branch WARP_CLI var value change; body prose picks up the
new name automatically via {VARS.WARP_CLI}.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): security fixes for API key examples
Address review feedback:
- Make WARP_API_KEY=... warp the primary non-interactive auth example and
document --api-key secondarily with a caution that command-line arguments
can be captured in shell history and process listings.
- Replace the persistent key.txt stdin example with a tool-agnostic
secret-manager pipe and a note against staging keys in plaintext files.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): editorial polish pass
Reduce product-name density after each page's intro (prefer "the CLI"),
vary repeated trailing "See [X]" sentences, and fold two cross-links into
their sentences. No structural, factual, heading, or link-target changes.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): trim menu-mechanics narration
Cut the type-to-filter/arrows/Enter sentence from the model picker prose
and the keep-typing-to-filter clause from the slash-command intro, per the
editorial bar against narrating self-evident UI mechanics. Defaults,
exceptions, and lookup tables are unchanged.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): note macOS Option-as-Alt requirement for Alt shortcuts
Platform audit: every keybinding registration is identical on macOS and
Linux (the only platform-conditional binding is a Windows-only Alt+V
paste, which is not documented since no Windows build ships). Input
arrives as terminal key events, so Alt shortcuts depend on the host
terminal delivering Option as Alt on macOS; add one note to the keyboard
shortcuts section instead of per-row annotations.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): tighten disabled-models sentence in model picker prose
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): update API key docs for /api-keys menu and --auto-approve flag
Address review feedback on the API key flow change (warpdotdev/warp#14472),
which replaced /add-api-key and /clear-provider-api-key with a single inline
/api-keys menu:
- models-and-usage: rewrite the BYOK section around the /api-keys menu —
set/replace/clear provider keys with masked entry, connect or disconnect
X Premium/SuperGrok via browser sign-in, and toggle Warp credit fallback.
The --set-provider-api-key/--clear-provider-api-key flags stay documented
for scripting (they remain supported per the CODE-1930 spec).
- reference: swap the /add-api-key and /clear-provider-api-key slash-command
rows for /api-keys, and point --set-provider-api-key at the in-session menu.
- reference: document the new --auto-approve flag (warpdotdev/warp#14483),
which starts new conversations in that launch with auto-approve enabled.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): editorial trim pass on API key and auto-approve additions
Remove redundant clauses: drop the repeated launch-default sentence in
--auto-approve, the doubled keys-over-credits statement in the fallback
bullet, the repeated browser-sign-in rationale in the scripting paragraph,
and tighten the /api-keys table row to match the terse row pattern.
Co-Authored-By: Oz <oz-agent@warp.dev>
---------
Co-authored-by: Oz <oz-agent@warp.dev>
Replaces the `cli/permissions-and-profiles.mdx` stub with a full draft covering the permission model, permission cards, auto-approve, and settings-file execution profiles. Verified against `warp` master: - Per-action-type permission values and CLI defaults (`AIExecutionProfile::default_profile_for_tui`) - `warp --auto-approve` launch flag (warpdotdev/warp#14483) - `auto_approve_bypasses_command_denylist` defaults to true, so auto-approve bypasses the user command denylist; team-enforced Admin Panel rules are never bypassed (`can_autoexecute_command`) Follow-ups tracked, not included here: - `--auto-approve` needs adding to the flags table on `cli/reference.mdx` (separate stub PR on this stack) - `agent-platform/capabilities/agent-profiles-permissions.mdx` has two now-stale denylist statements given the new bypass default Reviewed by @harryalbert. Co-Authored-By: Oz <oz-agent@warp.dev>
Replaces the cli/cloud-and-orchestration stub with the full draft: /handoff flow and guardrails, resuming cloud runs (browser-first), multi-agent orchestration approval card and permission, child-agent tab bar management, and Ctrl+C kill paths. Includes review feedback from harryalbert and a final editorial pass. Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): draft agent conversations page
Covers the streaming transcript, Markdown/Mermaid rendering, tool-call
rows, file-edit diffs, thinking blocks, interactive agent questions,
task lists, /plan flow, and transcript selection/copy for the Warp CLI.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): use literal Warp CLI in frontmatter
{{WARP_CLI}} tokens are not substituted in MDX frontmatter by the
content layer, so built titles/descriptions showed the raw token.
Body prose keeps {VARS.WARP_CLI}.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): absorb conversation management into agent conversations page
Adds a Managing conversations section group (persistence/restore,
/new /agent /clear, /conversations menu + left-arrow shortcut,
/compact, exit summary + --resume) from the standalone conversations
page, which is being removed in the consolidation. Updates the intro,
description, and related pages accordingly.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): rename to Warp Agent CLI in frontmatter
Follows the launch-name change; body prose picks up the new name via
the WARP_CLI var from the base branch merge.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): editorial polish on agent conversations page
Reduces product-name repetition after the intro, links bold lead terms
in the tool-call list instead of trailing See-X sentences, swaps
'unfolds' for 'appears', fixes 'just', and de-metas the intro's
managing-conversations pointer. No factual, heading, or link-target
changes.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): trim self-evident UI narration per review
Per PR review: cut transcript scrolling narration, collapse the
markdown-features list to its non-obvious caveats (folding the H3),
drop the tool-call glyph state-machine detail, and sweep the rest of
the page with the same lens (menu how-tos, click-to-collapse, and
double/triple-click narration removed). Feature facts, caveats,
shortcuts, and cross-links are unchanged.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): apply editorial audit cuts
Seven targeted trims: intro filler sentence, diff-header bullet detail,
multi-question tail, bold header adjective, copy-confirmation footer
mention, managing-conversations enumeration, and history restore
phrasing.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): address review feedback on agent conversations
- Trim styling narration from the transcript intro (prompt row marker,
elapsed-time progress indicator) that would go stale with small UI
changes; keep the durable behavior (streaming, Ctrl+C to stop).
- Color the task-list status glyphs to match the TUI: yellow in-progress
dot and green completed check, via mode-aware Starlight hue tokens so
they stay legible in dark and light mode.
- Lead "Resuming conversations" with the conversation menu, the primary
way to resume in the CLI, and note type-to-filter in the menu.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs(cli): editorial pass for redundancy and flow
- Collapse three separate "restores the full transcript" statements into
one, in Conversation persistence, where the detail belongs.
- Replace the duplicated "saved automatically" claim with the account vs.
local-machine distinction, which sets up the menu contents and the
offline caution that follow.
- Move Resuming conversations next to Conversation history so the two
cross-referencing sections are adjacent instead of split by Compacting
context.
- Point the intro's resume link at #resuming-conversations directly, and
fix a dangling modifier in the tool-call description.
Co-Authored-By: Oz <oz-agent@warp.dev>
---------
Co-authored-by: Oz <oz-agent@warp.dev>
This was referenced Jul 30, 2026
PR #397 (hyc/launch-cli-cli-conversations) was closed unmerged when #399 absorbed its content into cli/agent-conversations.mdx, but the stub it was meant to fill survived on the launch branch. The sidebar listed it as "Managing conversations" four lines below the real "Agent conversations" page, so the launch would have shipped a nav entry leading to a page that reads "documentation for this page is in progress". - Delete src/content/docs/cli/conversations.mdx. - Drop its sidebar entry in src/sidebar.ts. - Repoint the four inbound links from cloud-and-orchestration.mdx and reference.mdx to the corresponding anchors on cli/agent-conversations. No redirect needed: /cli/conversations has never been published (404 live, and src/content/docs/cli/ does not exist on main). Co-authored-by: Oz <oz-agent@warp.dev>
PR #405 consolidated troubleshooting into cli/reference.mdx (its Troubleshooting section) and reset cli/troubleshooting.mdx back to the skeleton stub, leaving the stub published in the sidebar with no sub-PR left to fill it. Remove the stub and its sidebar entry, matching the treatment #423 gives the conversations stub. No inbound links exist to /cli/troubleshooting/ (checked all merged and open cli sub-PR content), so no repoints are needed. Advances the 'delete 4 orphaned stubs' item on the #411 integration checklist. Validation: npm run build green; internal link check 0 broken. Co-authored-by: Oz <oz-agent@warp.dev>
…, MCP) (#401) * docs(cli): draft the Warp CLI configuration page Cover the local TOML settings file (per-platform locations, hot reload, error fallback, local-only/no cloud sync), editing settings by asking the agent, /theme with terminal background detection, and the statusline with /statusline customization. Drop the keybindings section: custom keybinding overrides are not loaded by the CLI yet. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): use literal Warp CLI in configuration frontmatter {{WARP_CLI}} tokens are not substituted in MDX frontmatter by the build pipeline, so the built title/description showed the raw token. Body prose keeps {VARS.WARP_CLI}. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): absorb agent context content into the customization page Consolidate the CLI docs: fold the context page's rules, skills, bundled skills, and MCP sections into configuration.mdx, retitled "Customizing the Warp CLI". Dedupe the modify-settings bundled skill treatment and switch cross-links to in-page anchors. The context.mdx file itself is removed at integration. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): rename Warp CLI to Warp Agent CLI in customization frontmatter Follows the site-wide WARP_CLI var update on the base branch; body prose picks up the new name via the var automatically. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): qualify settings hot reload for theme edits Address review on PR #401: settings values hot-reload from disk, but the rendered theme only re-applies via /theme or at the next startup, so the settings-file and agent-edit sections no longer promise immediate effect for theme changes. Also scope the Themes section's immediate-apply claim to /theme. Windows path verified to render with single backslashes in source and built HTML; no change needed. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): reduce product-name density on the customization page Editorial polish pass: after the intro's first mention, refer to the product as "the CLI" instead of repeating the full name in every section. The full name stays in the frontmatter, the intro, and the reference link. No structural, factual, heading, or link-target changes. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): trim obvious menu-mechanics narration Per editorial direction: collapse the skills-menu step list into the non-obvious behaviors (selection inserts /skill-name for editing, argument passing, direct invocation) and drop the arrow-select narration in the /mcp view. Keep the statusline config steps since its keys are surprising (Esc saves, arrows reorder). No headings, facts, or link targets changed. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): compress statusline catalog and tighten context and /mcp prose Apply orchestrator audit: keep only statusline items with non-obvious behavior as bullets and fold the self-explanatory ones into one sentence, shorten the working-directory context paragraph, and replace the four per-state /mcp bullets with two lines. Co-Authored-By: Oz <oz-agent@warp.dev> * docs(cli): re-verify statusline items against latest master Master's statusline catalog changed (moira's #14257/#14458): the auto-queue item was removed, and Vim mode indicator and GitHub pull request items were added. Auto-approve and Vim mode indicator are now on by default. Update the item list, defaults, and the auto-approve and git diff descriptions accordingly. Themes, settings paths, and the /statusline config flow re-verified against master and unchanged. Co-Authored-By: Oz <oz-agent@warp.dev> --------- Co-authored-by: Oz <oz-agent@warp.dev>
- Remove orphaned context stub (content lives in configuration.mdx via #401) and its sidebar entry; repoint the reference page link - Fix stale auto-approve statusline claim in permissions page (the indicator is default-on since the statusline catalog update) Co-Authored-By: Oz <oz-agent@warp.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Warp Agent CLI launch
Umbrella/integration branch for the new Warp Agent CLI docs section: a new sidebar topic with 9 pages under
/cli/, plus theWARP_CLIcontent var and internal launch plan (drafts/warp-cli-launch-plan.md).Sub-PRs into this branch (one per page bundle, per-eng review)
(#397, #403, #400 were absorbed during consolidation from 13 pages to 9 and closed.)
Remaining before this merges
input-and-shell-commands,customization), flatten sidebar to 9 entries, cross-link sweep, final buildLinks
Co-Authored-By: Oz oz-agent@warp.dev