docs(cli): agent conversations and conversation management - #399
docs(cli): agent conversations and conversation management#399hongyi-chen wants to merge 8 commits into
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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 Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR replaces the stub src/content/docs/cli/agent-conversations.mdx page with a complete feature doc for agent conversation behavior in the Warp CLI, including transcript streaming, tool calls, diffs, questions, task lists, planning, and copying/exporting output. The content is scoped to the changed page, uses the repository's variable conventions already present in the stub, and links to related agent capabilities.
Concerns
- No blocking correctness, security, or documentation-structure concerns found in the attached diff.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
{{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>
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>
hongyi-chen
changed the title
…launch-cli-cli-agent-conversations
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>
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>
| {/* TODO(cli-agent-conversations): streaming responses, markdown and Mermaid rendering, scrolling. */} | ||
| Your prompt appears in the transcript on a highlighted row marked with `>`, followed by the agent's streaming response. The transcript stays pinned to the newest output while the agent responds. Scroll up with the mouse wheel to review earlier output; scroll back to the bottom to resume following new output. While the agent is working, a progress indicator with elapsed time appears above the input. Press `Ctrl+C` once to stop the current response. | ||
|
|
||
| ### Markdown rendering |
There was a problem hiding this comment.
i don't think it's worth mentioning this markdown rendering stuff, not that useful to an end user
There was a problem hiding this comment.
Done in 05fdfdd — collapsed the bulleted list (and the Markdown rendering H3; nothing links to its anchor) into two sentences that keep only the non-obvious caveats: Mermaid renders as source, images show alt text, very long code blocks truncate.
| ## The conversation transcript | ||
|
|
||
| {/* TODO(cli-agent-conversations): streaming responses, markdown and Mermaid rendering, scrolling. */} | ||
| Your prompt appears in the transcript on a highlighted row marked with `>`, followed by the agent's streaming response. The transcript stays pinned to the newest output while the agent responds. Scroll up with the mouse wheel to review earlier output; scroll back to the bottom to resume following new output. While the agent is working, a progress indicator with elapsed time appears above the input. Press `Ctrl+C` once to stop the current response. |
There was a problem hiding this comment.
i don't think the scrolling stuff is necessary, can we simplify that? feels self-explanatory
There was a problem hiding this comment.
Done in 05fdfdd — cut the scroll-up/scroll-down and pinned-to-newest narration. The section now covers only the prompt row, the progress indicator, and Ctrl+C to stop the response.
| ## Tool calls | ||
|
|
||
| {/* TODO(cli-agent-conversations): how tool calls render (commands, file reads, etc.), expand/collapse. */} | ||
| Every tool call the agent makes appears in the transcript in the order it happens, interleaved with the agent's prose. Most tool calls render as a single status row: a colored state glyph followed by a label describing the call, such as reading a file or searching your codebase. The glyph updates as the call moves from pending to running to finished, and failed or canceled calls are marked accordingly. |
There was a problem hiding this comment.
again, this also feels unnecessary for a user to know, you can mention this high level, but i don't think you need to be super detail oriented here
There was a problem hiding this comment.
Done in 05fdfdd — kept the high-level statement (inline status row with glyph + label) and the four navigation bullets, dropped the pending/running/finished/failed glyph state detail. Also swept the rest of the page with the same lens (menu how-tos, click-to-collapse, and double/triple-click narration removed).
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>
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>
1 participant
Pages changed
src/content/docs/cli/agent-conversations.mdx(full draft replacing the stub; now also absorbs the conversation-management content from PR docs(cli): conversations #397, which will be closed)Features covered
Ctrl+Cto stop a responseeexpand/collapse all during approval, click-to-toggle per file, collapse after applyThinking...while streaming, collapse toThought for <duration>on finish, click to toggleEnterto confirm,(recommended)badge (confirmed shipped on master), multi-select check marks, Other… free-form answer, multi-question advance≡ Tasksheader, status glyphs (pending/in-progress/completed, canceled struck through), expanded by default,✓ Completed (n/m)progress rows; cross-links agent-platform/capabilities/task-lists/plan <task>, inline plan document, Updated plan entries, click header orCtrl+Shift+Pto toggle; cross-links agent-platform/capabilities/planningcopied to clipboardconfirmation, double/triple-click word/row selection, drag auto-scroll, local clipboard vs OSC 52 over SSH/tmux note,/export-to-clipboardand/export-to-fileAbsorbed from PR #397 (Managing conversations)
/new,/agent,/clear(aliases) with optional immediate prompt argument/conversationsmenu and left-arrow-at-empty-input shortcut (incl. the← for conversationsghost hint); type-to-filter, arrow navigation, Enter/Esc; list includes Warp app conversations and completed cloud agent runs; local-only fallback caution when cloud data fails to load/compact: default and custom summarization instructions; collapsed Conversation summary block, expandablewarp --resume <token>for non-empty conversations;--resumerestores at startup; cross-links cli/referenceDropped/unconfirmed
(recommended)marker (APP-5018): NOT dropped; confirmed shipped (badge rendering wired in the ask-question view and option selector on master).Notes for review
ebinding is documented as active while the approval card is focused, matching its keybinding context.Ctrl+Pcontextual plan toggle (terminals without extended keyboard support) is not documented; the page points to the on-screen hint that shows the exact shortcut.Suggested reviewer(s): harry, ian (moira for markdown rendering)
Co-Authored-By: Oz oz-agent@warp.dev