docs: Clarify harness identifiers (claude vs claude-code) and dedupe run-cloud flags - #689
Draft
hongyi-chen wants to merge 1 commit into
Draft
docs: Clarify harness identifiers (claude vs claude-code) and dedupe run-cloud flags#689hongyi-chen wants to merge 1 commit into
hongyi-chen wants to merge 1 commit into
Conversation
Document the exact harness identifier strings per surface (API/SDK, CLI, factory definition files), note claude-code is an alias for claude where accepted, and remove the duplicated --harness / --claude-auth-secret / --codex-auth-secret bullets in the run-cloud flag list. Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collaborator
Author
|
This PR was generated with Warp. Comment |
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
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.


Summary
A user hit
Task ... was created with the unknown harness, but --harness claude was requestedafter a GitHub-synced factory definition mixed theclaudeandclaude-codespellings, and the agent editing the files concluded from the docs/schema that the two were interchangeable everywhere. The identifiers were documented inconsistently across pages, and nothing stated which spelling is canonical on which surface. The server now normalizes the alias before emitting CLI args (warp-server #16769), and this PR makes the docs unambiguous about the identifier strings.Changes
src/content/docs/platform/harnesses/index.mdx
oz,claude,codex), CLI--harness(same, plusclaude-codeas an alias forclaude), and factory definition files (same, plus the alias).src/content/docs/reference/cli/index.mdx
--harness,--claude-auth-secret, and--codex-auth-secretbullets in theoz agent run-cloudkey-flags list (each was documented twice with diverging wording).--harnessbullet now names the accepted values and theclaude-codealias, and links to the harness identifiers section.src/content/docs/factories/factory-as-code.mdx
agentDefaults.harness: clarified thatclaude-codeis an alias and thatclaudeis the canonical identifier shared with the CLI and the Agent API.src/content/docs/platform/harnesses/claude-code.mdx
claude, notclaude-code.Content design plan
Audience and JTBD: An engineer or agent writing a harness value into a factory definition file, an
oz agent run-cloud --harnessflag, or an API agent config, who needs the exact accepted string.Problem:
claudeandclaude-codeboth appear across surfaces with no statement of which is canonical where; a GitHub-backed factory misconfiguration produced runtime "unknown harness" failures, and the CLI reference listed the harness flags twice.Goals:
claudeis canonical and whereclaude-codeis accepted as an alias.Purpose and value: Prevents misconfigured harness strings from GitHub-synced definitions and scripts; no existing page listed identifiers per surface.
Content type: Reference — small identifier lookup added to the existing harnesses feature page, plus corrections to existing reference content.
Skill and template: Inline edits to existing pages; no new page.
High-impact scenarios:
harness.type, CLI--harness, factory fileharness.type.gemini/opencode(not generally available; factory-as-code already listsgeminiwhere the schema accepts it) and internal orchestration tool-call labels, which users never type.Unverified claims
None — all identifier and flag claims were verified against source: the harness enum and config names (
warp-server:model/types/enums/agent_harness.go), the factory file schema generator and published JSON schema (warp-server:logic/factoryfile/schema/common.go,v1alpha1/common.schema.json), the public API enum (warp-server:public_api/openapi.yaml,Harness.type), the CLI value enum andclaude-codealias (warp:crates/warp_cli/src/agent.rs), and the alias normalization fix (warp-server #16769).Documentation risk
Risk: engineering-review-required
Rationale: Documents exact harness identifier strings and CLI flag values (claude vs claude-code) across API, CLI, and factory files; verified against warp-server enums/schema/OpenAPI and the warp CLI, but identifier claims are engineering-owned.
Source files consulted: warp-server:model/types/enums/agent_harness.go@6f30a16fc8b5, warp-server:logic/factoryfile/schema/common.go@6f30a16fc8b5, warp-server:public_api/openapi.yaml@6f30a16fc8b5, warp-server:logic/ai/ambient_agents/workers/common/task_utils.go@6f30a16fc8b5, warp:crates/warp_cli/src/agent.rs@5a6ded1e8413
Requested engineering reviewers: bnavetta, ianhodge
Engineering review status: pending
Docs override: none
Co-Authored-By: Warp agent@warp.dev