Skip to content

docs: add screenshots to the Warp Agent CLI pages #474

Description

@rachaelrenk

Summary

The Warp Agent CLI docs (src/content/docs/cli/) have two screenshots across nine pages: the statusline in configuration.mdx and the Agents tab bar in cloud-and-orchestration.mdx. Several pages describe visual surfaces the reader has never seen.

This came out of the editorial review in #473. Screenshots were deliberately deferred there rather than blocking that PR.

Why these were deferred

Every candidate requires an authenticated CLI session. The start screen and every menu, picker, and card only render after login, and login is a browser device-auth flow. The only non-interactive path is a WARP_API_KEY.

The existing tui-statusline.png shows a /workspace/warp working directory, which suggests these were captured in a cloud environment with the warp repo cloned. If that setup still exists, these four should be quick.

Requested screenshots

Ordered by value.

1. Permission card — permissions-and-profiles.mdx

The highest-value gap. The page has no figures, yet it teacheThe higheder to recognize and act on a card: "Select Other", "Press E on a command card to edit it", "Press E on a file-edits card to expand or collapse all diffs". None of that has a visual referent.

Deterministic to stage: set execute_commands = "always_ask" in settings.toml, then prompt the agent to run a command.

2. Conversation transcript — agent-conversations.mdx

The flagship page describing the core product surface, with no figures. The style guide calls for a broad orientation screenshot early when a page explains a new surface. A transcript showing a streamed response with a code block and a tool caThe flagship page describing the core product surface, with no figures. The style guide calls for a broad orientation screenshot early when a page explains a new surface. A transcript showing a streamed response with athaThe flagship page descryour own art, which is impossible to picture from prose. Reachable by launching the CLI. quickstart.mdx describes the same screen at the end of the login step.

4. Slash command menu — input-and-shell-commands.mdx

One keystroke (/ on an empty input). Shows the inline state annotations the prose describes awkwardly, like /theme (currently auto: Dark).

Considered and intentionally excluded

  • Shell mode marker — a > changing to !; prose is clearer than an image.
  • Shortcuts menu (?) — duplicates the shortcut tables already in reference.mdx.
  • /api-keys menu — mostly a list, would show every provider disconnected in a fresh environment, and is credential-adjacent.
  • /statusline panel, history menu, completion menu, thinking blocks — marginal; the statusline result is already shown.
  • Handoff and orchestration cards — valuable, but staging needs a configured cloud environment, burns credits, and the orchestration card is nondeterministic.
  • reference.mdx — lookup pages don't need screenshots.

Notes for whoever picks this up

  • Store PNGs in src/assets/cli/ following the existing tui-*.png naming.
  • Store PNGs in src/assets/cli/ following the existing tbox- Store PNGs in src/assets/cli/following the existingtbox- Store PNGs in src/assets/cli/ following the existing `tbox- Store PNGsd a clean crop but no annotation.
  • Both existing - Both existing - Both existing - Both existing - Both existing - Both existing -ding the intended width convention for CLI/TUI captures while adding these.
  • Follow the caption rules in AGENTS.md: complete sentence, sentence case, ends with a period, roughly 10 words.
  • Avoid real customer data, private repo names, or tokens in the captured terminal.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationimprove or update documentationIncorrect, outdated, missing, or unclear documentation contentpriority/lowTypos, minor formatting, nice-to-have improvementstriageNeeds human review — remove after triaging

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions