Skip to content

docs(cli): shell commands - #403

Closed
hongyi-chen wants to merge 2 commits into
hyc/launch-clifrom
hyc/launch-cli-cli-shell-commands
Closed

docs(cli): shell commands#403
hongyi-chen wants to merge 2 commits into
hyc/launch-clifrom
hyc/launch-cli-cli-shell-commands

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Pages changed

  • src/content/docs/cli/shell-commands.mdx (full draft, replaces stub)

Features covered

  • Shell mode: agent-first input, ! prefix to enter, Esc/Backspace to exit, > vs ! prompt marker, Shell mode statusline label, !-prefixed highlighted command rows in the transcript, note that running a command cancels an in-progress agent response
  • Natural language detection: off by default (opt-in), /natural-language-detection toggle persists across sessions, agent-biased classification (single tokens switch only with command evidence)
  • Command history: up-arrow history menu combining prompts + shell commands, ! prefix on command rows, filter/preview/submit/dismiss, commands-only list in shell mode
  • Long-running/interactive commands: input passthrough to the running process, dimmed "ctrl-c to interrupt" hint replacing the input, typed-character carryover into the input on completion (shell type-ahead), one-command-at-a-time notice
  • Full-screen (alt-screen) apps: full-area rendering, keyboard/paste/scroll/mouse forwarding, transcript restored on exit
  • Ctrl+C semantics: interrupt running command (never exits), cancel streaming response, clear input, "ctrl-c again to exit" 1s window for double-press exit; Ctrl+D on empty input and /exit; pointer to conversations page for resume

Dropped/unconfirmed

  • Manual attach (CODE-1915): no commits on master or any branch reference this ticket; not shipped, so it is not documented.
  • Command row color: documented as a ! marker + highlighted row background without naming a color (plan mentioned yellow rows; current master uses a theme-blended tint).

Suggested reviewer(s): Kevin (moira for manual attach)

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

Fill in cli/shell-commands.mdx: shell mode and command styling, opt-in
natural language detection with /natural-language-detection, up-arrow
history with shell commands, long-running/interactive command support
(passthrough, interrupt hint, type-ahead carryover), full-screen
alt-screen apps, and Ctrl+C stop vs double Ctrl+C exit semantics.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jul 28, 2026
@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

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

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

Request Review

@oz-for-oss

oz-for-oss Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

@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 oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR replaces the CLI shell-commands stub with a full feature documentation page covering shell mode, natural language detection, command history, long-running and interactive commands, full-screen terminal apps, and stop/exit behavior. The draft follows the docs style guide structure for feature documentation, uses the existing product variable for the CLI name, and the documented behaviors align with the available source/spec context I checked.

Concerns

  • No blocking concerns found.
  • No security findings; this is a documentation-only change.
  • spec_context.md contains no approved or repository spec context for this PR, so there are no spec-drift findings to report.

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

Frontmatter {{WARP_CLI}} tokens aren't substituted 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>
hongyi-chen added a commit that referenced this pull request Jul 28, 2026
Consolidation: merge the verified content of cli/shell-commands.mdx
(PR #403, branch hyc/launch-cli-cli-shell-commands) into
cli/input-and-editing.mdx as a single "Input and shell commands in the
Warp CLI" page. Adds shell mode, natural language detection,
long-running and interactive commands, full-screen apps, and stopping/
exiting sections; merges the two history sections into one (adopting
the verified submit-on-Enter semantics); rewires shell-mode links to
in-page anchors. File rename to the new slug happens at integration.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen

Copy link
Copy Markdown
Collaborator Author

Content absorbed into #406 (input and shell commands) as part of consolidating the CLI docs from 13 pages to 9. The shell-commands.mdx stub will be deleted in the integration commit.

kevinyang372 added a commit that referenced this pull request Aug 4, 2026
* docs(cli): draft input and editing page

Replace the cli/input-and-editing.mdx stub with full content covering
editing basics, the slash command menu with argument hints, up-arrow
prompt history, shell tab completions, mouse support, selection and
clipboard behavior (incl. OSC 52 over SSH), image attachments, voice
input, and the contextual keyboard hints plus the ? shortcuts menu.

Dropped from the outline after verifying against warp master: Vim mode
(not merged), inline-menu mouse clicks (not shipped), and configurable
keybinding claims (the CLI does not load keybinding overrides yet).

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 (Astro's
content layer parses frontmatter outside Vite), so the built title and
description showed the raw token. Body-prose {VARS.WARP_CLI} is
unchanged. Verified the built dist/cli/input-and-editing <title> now
reads "Input and editing in the Warp CLI".

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

* docs(cli): absorb shell commands page into input page

Consolidation: merge the verified content of cli/shell-commands.mdx
(PR #403, branch hyc/launch-cli-cli-shell-commands) into
cli/input-and-editing.mdx as a single "Input and shell commands in the
Warp CLI" page. Adds shell mode, natural language detection,
long-running and interactive commands, full-screen apps, and stopping/
exiting sections; merges the two history sections into one (adopting
the verified submit-on-Enter semantics); rewires shell-mode links to
in-page anchors. File rename to the new slug happens at integration.

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

* docs(cli): rename Warp CLI to Warp Agent CLI in frontmatter

Launch name confirmed as Warp Agent CLI. Base branch merge picks up the
WARP_CLI var change (e2aebe3) for body prose; this updates the two
literal frontmatter strings (title, description). Verified the built
title reads "Input and shell commands in the Warp Agent CLI".

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

* docs(cli): light editorial polish on input page

Reduce product-name density (prefer "the CLI" after the intro; keep the
full name in the intro and Related pages), drop one banned word
("just"), remove a filler wayfinding sentence from the intro, vary a
repeated cross-reference rhythm, dedupe "lands in the input", and use a
plainer verb for the hints section opener. No heading, fact, or link
target changes.

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

* docs(cli): trim narration of obvious UI mechanics

Per editorial direction: cut the slash-menu usage steps, the Submit and
six-row-scroll narration in editing basics, the history Filter bullet,
completion-menu Enter/Esc narration, cursor-click and scroll-wheel
bullets, the attachment-bar arrow/Enter steps (kept Tab focus,
Backspace remove, Esc return as one sentence), the "Speak your prompt"
voice step, the duplicated long-running interrupt hint, type-and-press-
Enter in shell mode, and the output-streams-in sentence. Kept
non-obvious keys, defaults, and gotchas (submit-on-Enter history
semantics, restore-on-dismiss, OSC 52 note). No heading changes.

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

* docs(cli): address review comments on NLD and interrupt hint

Rename the natural-language-detection bullet lead from "Biased toward
the agent" to "Ambiguous input" so it states the behavior without
characterizing the classifier, and drop the interrupt-hint bullet from
long-running commands (Ctrl+C interrupt is already covered in Stopping
commands and exiting).

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

* docs(cli): apply orchestrator editorial audit

Shorten the editing-basics intro, add the verified macOS/Linux Alt
keybinding note, sharpen the history Submit/Dismiss bullets and drop
the command-history sentence, fold the click-controls bullet into
Selection and clipboard and remove the Mouse support section (no
inbound #mouse-support links), trim the copied-to-clipboard footer
narration, generalize the placeholder-hints bullet, simplify shell-mode
step 2, and remove the transcript-styling sentence.

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

* docs(cli): repoint links to removed context and conversations pages

The base branch merged context.mdx into configuration.mdx and folded
the conversations page into agent-conversations.mdx. Repoint the skills
link to /cli/configuration/#skills, and the two Managing conversations
links to /cli/agent-conversations/#managing-conversations (verified both
anchors exist in the merged base). Related pages now lists a single
agent-conversations entry.

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

* docs(cli): clarify keyboard and voice support

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

* docs(cli): clarify Linux voice packaging

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

* docs(cli): fix renamed agent docs links

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Yunfan Yang <kevin@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant