Skip to content

docs: document named-agent base prompt flag in CLI reference - #387

Open
hongyi-chen wants to merge 3 commits into
mainfrom
docs/cli-named-agent-base-prompt
Open

docs: document named-agent base prompt flag in CLI reference#387
hongyi-chen wants to merge 3 commits into
mainfrom
docs/cli-named-agent-base-prompt

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

What

Documents the base prompt attribute of named agents in the Oz CLI reference (reference/cli/index.mdx):

  • Adds --prompt to the oz agent create example and the named-agent attribute list.
  • Adds the --prompt <TEXT> / --remove-prompt pair to the "Common oz agent update flags" list.

Why

Surfaced by the missing_docs drift-watch audit. The diff detected a new public CLI flag --remove-prompt in crates/warp_cli/src/agent.rs (oz agent update). The base prompt attribute (--prompt on create, --prompt/--remove-prompt on update) is a GA, public-repo (warpdotdev/warp) surface that was missing from the CLI reference, so this fills that gap.

Validation

  • npm run build passes (349 pages built).

Deferred findings (from this drift-watch run)

These were triaged but intentionally not addressed in this PR:

  • 44 undocumented API endpoints (/agent/* messaging/events/schedules/artifacts, /factory/*) — warp-server is private and these are not in the released OpenAPI spec. Route released endpoints through the sync-openapi-spec skill; the rest are internal/unreleased. Not hand-documentable.
  • evaluations / evaluations/:evaluationId Oz web app routes + factory/scorers API routes — Factory/Evaluations preview surface, not publicly documented yet. Deferred.
  • WellKnownMcpIds feature flag — dogfood; snapshot-tracked only, no docs needed until promotion.
  • 32 potentially_stale_docs (LOW terminology) — owned by the style_lint skill; many are legitimate ("Warp Terminal" distinguishing from Oz, billing "AI credits").

Surface-map (/theme, appearance.theme → internal) and snapshot bookkeeping are handled in a separate companion PR.

Conversation: https://staging.warp.dev/conversation/5113be3f-fb48-437d-9e4e-59fd0269e2ee
Run: https://oz.staging.warp.dev/runs/019fa484-f76e-7a51-a25b-58112517462a

This PR was generated with Oz.

Add the base prompt attribute (`--prompt` / `--remove-prompt`) to the
`oz agent create`/`oz agent update` documentation in the Oz CLI reference.
Surfaced by the missing_docs drift-watch audit (new CLI flag --remove-prompt
in warp_cli/src/agent.rs).

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

vercel Bot commented Jul 27, 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 5:31pm

Request Review

@oz-for-oss

oz-for-oss Bot commented Jul 27, 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

@hongyi-chen
hongyi-chen requested a review from ianhodge July 27, 2026 17:15

@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 updates the Oz CLI reference to document the named-agent base prompt field across the overview, oz agent create example, and common oz agent update flags. The changes align with the public CLI surface shown in the attached context and do not introduce security-sensitive behavior.

Concerns

  • No blocking concerns found.

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

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