-
Notifications
You must be signed in to change notification settings - Fork 10
docs(cloud-agents): add multi-harness pages (Warp Agent, Claude Code, Codex) #87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
hongyi-chen
merged 10 commits into
hyc/orchestration-launch
from
hyc/orch/multi-harness
May 19, 2026
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
c1d3664
docs(cloud-agents): add multi-harness pages for Oz orchestration launch
hongyi-chen 51e6baa
docs(harnesses): address PR #87 feedback, reframe "Oz harness" termin…
hongyi-chen 7bb42c6
docs(harnesses): drop OpenCode mentions, simplify CLI cross-link, aud…
hongyi-chen 58739b0
docs(harnesses): address audit findings
hongyi-chen 6d57bcd
Tweaking copy
liliwilson f8813d9
Merge branch 'hyc/orchestration-launch' into hyc/orch/multi-harness
hongyi-chen 097b081
docs(harnesses): copy polish on Lili's tweaks
oz-agent 049f41e
docs(harnesses): second polish pass on multi-harness pages
oz-agent c12d74e
docs(harnesses): restore Lili's original Anthropic Console link
hongyi-chen ab92d59
docs(harnesses): final polish pass on multi-harness pages
hongyi-chen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
122 changes: 122 additions & 0 deletions
122
src/content/docs/agent-platform/cloud-agents/harnesses/authentication.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| --- | ||
| title: Third-party cloud agent authentication | ||
| description: >- | ||
| Connect your Anthropic or OpenAI credentials to Oz, then launch Claude Code | ||
| or Codex as cloud agents from the desktop app, Oz web app, or API. | ||
| sidebar: | ||
| label: "Authentication" | ||
| --- | ||
|
|
||
| Third-party cloud agents — [Claude Code](#connecting-claude-code-credentials) and [Codex](#connecting-codex-credentials) — call their provider directly, so you need to store credentials as Warp-managed secrets before launching a run. This page walks through the one-time setup for each. | ||
|
|
||
| Auth secrets can be scoped to a **team** (available to all teammates' runs) or **personal** (only your own runs), just like any other Warp-managed secret. | ||
|
|
||
| :::note | ||
| [Bring Your Own Key (BYOK)](/support-and-community/plans-and-billing/bring-your-own-api-key/) configured in the Warp desktop app applies to local agent runs only. Cloud runs of Claude Code and Codex always use Warp-managed secrets. | ||
| ::: | ||
|
|
||
| ## Connecting Claude Code credentials | ||
|
|
||
| Claude Code is Anthropic's agentic coding tool. For more on Claude Code authentication, see [Anthropic's Claude Code auth docs](https://code.claude.com/docs/en/authentication). | ||
|
|
||
| ### Create an Anthropic API key | ||
|
|
||
| 1. Go to the [Anthropic Console](https://platform.claude.com/login?returnTo=/?) and sign in (or create an account). | ||
| 2. Navigate to **API keys** and create a new key. | ||
| 3. Make sure your account has API credits — Claude Code runs are billed against your Anthropic API balance. | ||
|
|
||
| Oz also supports Bedrock-routed credentials (**Anthropic Bedrock API key** and **Anthropic Bedrock access key**) if your team consumes Anthropic models through AWS. | ||
|
|
||
| ### Store the key in Oz | ||
|
|
||
| #### Warp desktop app | ||
|
|
||
| In Cloud Mode, click the key icon above the input and add your Anthropic credential. | ||
|
|
||
| #### Oz web app | ||
|
|
||
| Start a new run, choose **Claude Code** as the harness, and add a new key in the harness auth secrets dropdown. | ||
|
|
||
| #### Oz CLI | ||
|
|
||
| ```bash | ||
| oz secret create claude api-key --team <KEY_NAME> | ||
| ``` | ||
|
|
||
| Add `--description "..."` to record rotation notes or owner info. Replace `--team` with `--personal` to make the secret available only to your own runs. | ||
|
|
||
| **Expected outcome.** `oz secret list` shows the new secret with the matching Anthropic credential type. The value is never displayed. | ||
|
|
||
| ## Connecting Codex credentials | ||
|
|
||
| Codex is OpenAI's coding agent. For more on Codex authentication, see [OpenAI's Codex auth docs](https://developers.openai.com/codex/auth). | ||
|
|
||
| :::caution | ||
| A ChatGPT subscription (Plus, Pro, Team) does not include API access. You need a separate OpenAI API key with API credits. | ||
| ::: | ||
|
|
||
| ### Create an OpenAI API key | ||
|
|
||
| 1. Go to the [OpenAI Platform](https://platform.openai.com/) and sign in (or create an account). | ||
| 2. Navigate to **API keys** and click **Create new secret key**. | ||
| 3. Make sure your account has API credits — Codex runs are billed against your OpenAI API balance, not a ChatGPT subscription. | ||
|
|
||
| ### Store the key in Oz | ||
|
|
||
| #### Warp desktop app | ||
|
|
||
| In Cloud Mode, click the key icon above the input and add your OpenAI credential. | ||
|
|
||
| #### Oz web app | ||
|
|
||
| Start a new run, choose **Codex** as the harness, and add a new key in the harness auth secrets dropdown. | ||
|
|
||
| #### Oz CLI | ||
|
|
||
| ```bash | ||
| oz secret create codex api-key --team <KEY_NAME> | ||
| ``` | ||
|
|
||
| Add `--description "..."` to record rotation notes or owner info. Replace `--team` with `--personal` to make the secret available only to your own runs. | ||
|
|
||
| **Expected outcome.** `oz secret list` shows the new secret with the matching OpenAI credential type. The value is never displayed. | ||
|
|
||
| ## Managing harness auth secrets | ||
|
|
||
| Auth secrets follow the same management commands as any other Warp-managed secret. See [Cloud agent secrets](/agent-platform/cloud-agents/secrets/) for the full reference. Common tasks: | ||
|
|
||
| ```bash | ||
| # List secrets you can see | ||
| oz secret list | ||
|
|
||
| # Rotate a secret value (prompts for the new value) | ||
| oz secret update --team --value ANTHROPIC_API_KEY | ||
|
|
||
| # Update the description | ||
| oz secret update --team --description "Rotated 2026-05-12; owned by platform team" ANTHROPIC_API_KEY | ||
|
|
||
| # Delete a secret (irreversible) | ||
| oz secret delete --team ANTHROPIC_API_KEY | ||
| ``` | ||
|
|
||
| :::caution | ||
| Deleting an auth secret breaks any scheduled or integration-triggered run that references it by name. Update the schedules and integrations to point at a new secret first. | ||
| ::: | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **Claude Code or Codex run fails with an authentication error.**\ | ||
| Confirm the run was started with a harness auth secret selected. From the Oz web app's run detail pane, the **Harness auth secret** field shows which secret (if any) was used. Re-launch the run with the correct secret selected, or create one if your team doesn't have one yet. | ||
|
|
||
| **The harness auth secret dropdown is empty.**\ | ||
| The dropdown only lists secrets whose type matches the selected harness — Anthropic types for Claude Code, OpenAI for Codex. If you stored the credential as a raw value, recreate it using the typed flow above. | ||
|
|
||
| **The selected harness is disabled.**\ | ||
| Your team admin has disabled the harness for your workspace. Contact your admin or pick a different harness for the run. | ||
|
|
||
| ## Related pages | ||
|
|
||
| * [Harnesses in Oz](/agent-platform/cloud-agents/harnesses/) — overview of third-party harnesses in Oz. | ||
| * [Claude Code in Warp](/agent-platform/cli-agents/claude-code/) — run Claude Code locally in the Warp terminal. | ||
| * [Codex CLI in Warp](/agent-platform/cli-agents/codex/) — run Codex locally in the Warp terminal. | ||
| * [Cloud agent secrets](/agent-platform/cloud-agents/secrets/) — the full Warp-managed secrets reference. |
55 changes: 55 additions & 0 deletions
55
src/content/docs/agent-platform/cloud-agents/harnesses/claude-code.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Claude Code with Oz | ||
| description: >- | ||
| Run Claude Code with Oz. Strong at code review, deep bug investigation, large | ||
| feature planning, and frontend or UI work. | ||
| sidebar: | ||
| label: "Claude Code" | ||
| --- | ||
|
|
||
| Claude Code is Anthropic's agentic coding tool. Running it with Oz puts Claude Code inside a Warp-managed environment and connects it to the rest of the Oz platform — triggers, environments, secrets, observability, and governance — while still behaving like the Claude Code your team already uses. | ||
|
|
||
| :::note | ||
| This page covers Claude Code as a **cloud** harness, dispatched and orchestrated by Oz. To run Claude Code locally in your Warp terminal, see [Claude Code in Warp](/agent-platform/cli-agents/claude-code/) instead. | ||
| ::: | ||
|
|
||
| ## Key features | ||
|
|
||
| * **Cloud orchestration** - Launch Claude Code from any Oz trigger: the Warp app, the Oz web app, the Oz CLI, the REST API, schedules, Slack mentions, Linear issues, or GitHub Actions. | ||
| * **Claude model picker** - Choose the Claude model the harness uses, including the latest pinned Opus, Sonnet, and Haiku releases, the `best`/`opus`/`sonnet`/`haiku` aliases, and 1M-context variants. | ||
| * **First-class subagent** - A Warp Agent parent can dispatch Claude Code subagents to handle code-review-heavy or judgment-heavy steps within a larger orchestration. | ||
|
|
||
| ## Available models | ||
|
|
||
| The Claude Code harness exposes Anthropic's coding-tuned model lineup. Common picks: | ||
|
|
||
| * `best` - Resolves to the current top-of-line Claude model. | ||
| * `opus`, `sonnet`, `haiku` - Aliases that resolve to the current default for that family. | ||
|
|
||
| For the full list — including 1M-context variants for very large codebases and planning-tuned models — open the model picker in the Warp app's Cloud Mode or the **Model** field on the Oz web app's new-run pane. | ||
|
|
||
| ## Credentials and billing | ||
|
|
||
| Claude Code calls Anthropic directly using credentials your team provides. Oz supports three Anthropic credential types, stored as [Warp-managed secrets](/agent-platform/cloud-agents/secrets/): | ||
|
|
||
| * **Anthropic API key** - For direct Anthropic API access. | ||
| * **Anthropic Bedrock API key** - For Bedrock-routed inference using an API key. | ||
| * **Anthropic Bedrock access key** - For Bedrock-routed inference using AWS access credentials. | ||
|
|
||
| Anthropic bills your account directly for inference. Warp credits cover the rest of the platform — environment compute, triggers, and observability. | ||
|
|
||
| For setup steps, see [Connecting Claude Code credentials](/agent-platform/cloud-agents/harnesses/authentication/#connecting-claude-code-credentials). | ||
|
|
||
| ## Starting a Claude Code run | ||
|
|
||
| * **Warp app** - In Cloud Mode, click the **Agent harness** dropdown above the input and choose **Claude Code**. | ||
| * **Oz web app** - On the new run or new schedule pane, choose **Claude Code** in the **Harness** field. A **Claude Code auth secret** field appears below it; pick one of your stored Anthropic secrets. | ||
| * **API and SDK** - Set the agent config `harness` to `claude` and the Anthropic secret name on the matching auth-secret field. See the [API reference](/reference/api-and-sdk/). | ||
|
|
||
| ## Related pages | ||
|
|
||
| * [Harnesses in Oz](/agent-platform/cloud-agents/harnesses/) — pick between Warp Agent, Claude Code, and Codex. | ||
| * [Authentication](/agent-platform/cloud-agents/harnesses/authentication/) — store Anthropic credentials as Warp-managed secrets. | ||
| * [Warp Agent with Oz](/agent-platform/cloud-agents/harnesses/warp-agent/) — Oz's default harness, the only one that can orchestrate Claude Code subagents. | ||
| * [Codex with Oz](/agent-platform/cloud-agents/harnesses/codex/) — Codex as a cloud harness. | ||
| * [Claude Code in Warp](/agent-platform/cli-agents/claude-code/) — Claude Code in your local Warp terminal. |
54 changes: 54 additions & 0 deletions
54
src/content/docs/agent-platform/cloud-agents/harnesses/codex.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Codex with Oz | ||
| description: >- | ||
| Run Codex with Oz. Strong at codebase migrations, release coordination, batch | ||
| test generation, and backend or DevOps automation. | ||
| sidebar: | ||
| label: "Codex" | ||
| --- | ||
|
|
||
| Codex is OpenAI's coding agent. Running it with Oz puts Codex inside a Warp-managed environment and connects it to the rest of the Oz platform — triggers, environments, secrets, observability, and governance — while still behaving like the Codex CLI your team already uses. | ||
|
|
||
| :::note | ||
| This page covers Codex as a **cloud** harness, dispatched and orchestrated by Oz. To run Codex locally in your Warp terminal, see [Codex CLI in Warp](/agent-platform/cli-agents/codex/) instead. | ||
| ::: | ||
|
|
||
| ## Key features | ||
|
|
||
| * **Cloud orchestration** - Launch Codex from any Oz trigger: the Warp app, the Oz web app, the Oz CLI, the REST API, schedules, Slack mentions, Linear issues, or GitHub Actions. | ||
| * **Codex model picker** - Choose the OpenAI model Codex uses, including the GPT-5 lineup, Codex-tuned variants, and a `default` option that lets Codex pick its own recommended model. | ||
| * **First-class subagent** - A Warp Agent parent can dispatch Codex subagents to handle high-volume or well-defined coding steps inside a larger orchestration. | ||
|
|
||
| ## Available models | ||
|
|
||
| The Codex harness exposes OpenAI's Codex-tuned and general coding models. Common picks: | ||
|
|
||
| * `default` - Lets Codex pick its own recommended model based on your OpenAI account access. | ||
| * `gpt-5.5`, `gpt-5.4` - Recent strong coding models from OpenAI with a configurable reasoning level. | ||
| * `gpt-5.4-mini` - A faster, lower-cost option for lighter coding tasks or subagents. | ||
|
|
||
| For the full list — including older Codex-tuned and general models — open the model picker on the Oz web app's new-run pane. For details on each model, see [OpenAI's Codex model docs](https://developers.openai.com/codex/models). | ||
|
|
||
| ## Credentials and billing | ||
|
|
||
| Codex calls OpenAI directly using credentials your team provides. Oz supports one credential type today, stored as a [Warp-managed secret](/agent-platform/cloud-agents/secrets/): | ||
|
|
||
| * **OpenAI API key** - The Codex harness authenticates to OpenAI using this key for every run. | ||
|
|
||
| OpenAI bills your account directly for inference. Warp credits cover the rest of the platform — environment compute, triggers, and observability. | ||
|
|
||
| For setup steps, see [Connecting Codex credentials](/agent-platform/cloud-agents/harnesses/authentication/#connecting-codex-credentials). | ||
|
|
||
| ## Starting a Codex run | ||
|
|
||
| * **Warp app** - In Cloud Mode, click the **Agent harness** dropdown above the input and choose **Codex**. | ||
| * **Oz web app** - On the new run or new schedule pane, choose **Codex** in the **Harness** field. A **Codex auth secret** field appears below it; pick the OpenAI secret your team has stored. | ||
| * **API and SDK** - Set the agent config `harness` to `codex` and the OpenAI secret name on the matching auth-secret field. See the [API reference](/reference/api-and-sdk/). | ||
|
|
||
| ## Related pages | ||
|
|
||
| * [Harnesses in Oz](/agent-platform/cloud-agents/harnesses/) — pick between Warp Agent, Claude Code, and Codex. | ||
| * [Authentication](/agent-platform/cloud-agents/harnesses/authentication/) — store OpenAI credentials as Warp-managed secrets. | ||
| * [Warp Agent with Oz](/agent-platform/cloud-agents/harnesses/warp-agent/) — Oz's default harness, the only one that can orchestrate Codex subagents. | ||
| * [Claude Code with Oz](/agent-platform/cloud-agents/harnesses/claude-code/) — Claude Code as a cloud harness. | ||
| * [Codex CLI in Warp](/agent-platform/cli-agents/codex/) — Codex in your local Warp terminal. |
49 changes: 49 additions & 0 deletions
49
src/content/docs/agent-platform/cloud-agents/harnesses/index.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: Harnesses in Oz | ||
| description: >- | ||
| Run Claude Code or Codex as Oz cloud agents. Both inherit the same triggers, | ||
| environments, secrets, and observability as Warp Agent. | ||
| sidebar: | ||
| label: "Overview" | ||
| --- | ||
|
|
||
| Oz can run third-party agents — [Claude Code](/agent-platform/cloud-agents/harnesses/claude-code/) and [Codex](/agent-platform/cloud-agents/harnesses/codex/) — as cloud agents alongside Warp Agent. You choose the harness (agent runtime) that fits the task; the platform around the run stays the same. | ||
|
|
||
| ## What stays the same | ||
|
|
||
| Third-party harnesses inherit the same Oz platform features as Warp Agent: | ||
|
|
||
| * **Triggers** — Slack, Linear, schedules, CI, and API [triggers](/agent-platform/cloud-agents/triggers/) launch any harness. | ||
| * **Environments and secrets** — Reuse the same [environments](/agent-platform/cloud-agents/environments/) and [agent secrets](/agent-platform/cloud-agents/secrets/). | ||
| * **Skills and Rules** — Saved [Skills](/agent-platform/capabilities/skills/) and [Rules](/agent-platform/capabilities/rules/) apply across harnesses. | ||
| * **Observability** — Every run produces a transcript and shareable session in the [Oz dashboard](/agent-platform/cloud-agents/managing-cloud-agents/). | ||
|
|
||
| ## Billing | ||
|
|
||
| Claude Code and Codex each call their provider directly using credentials you supply, and the provider bills your account for inference. Warp credits cover the orchestration platform — environment compute, triggers, and observability — but not third-party inference. | ||
|
|
||
| ## How to switch harnesses | ||
|
|
||
| ### Warp desktop app | ||
|
|
||
| In Cloud Mode, choose a harness from the **Agent harness** dropdown above the input. | ||
|
|
||
| :::note | ||
| You can enter Cloud Mode by creating a new **Cloud Agent** tab or by using the `/cloud-agent` slash command. | ||
| ::: | ||
|
|
||
| ### Oz web app | ||
|
|
||
| On the new run or new schedule pane, choose the harness in the **Harness** field. | ||
|
|
||
| ### API and SDK | ||
|
|
||
| Set the `harness` field on the agent config. See the [API reference](/reference/api-and-sdk/) for the exact field names. | ||
|
|
||
| ## Related pages | ||
|
|
||
| * [Warp Agent with Oz](/agent-platform/cloud-agents/harnesses/warp-agent/) — Oz's default first-party harness. | ||
| * [Claude Code with Oz](/agent-platform/cloud-agents/harnesses/claude-code/) — Claude Code as a cloud harness. | ||
| * [Codex with Oz](/agent-platform/cloud-agents/harnesses/codex/) — Codex as a cloud harness. | ||
| * [Authentication](/agent-platform/cloud-agents/harnesses/authentication/) — connect credentials and launch Claude Code or Codex. | ||
| * [Third-party CLI agents in the Warp terminal](/agent-platform/cli-agents/overview/) — run Claude Code, Codex, and other CLI agents locally. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
src/sidebar.tsleaves them outside anystarlight-sidebar-topicstopic, sonpm run buildfails; wire the newharnessespages into the Agents sidebar in this PR or remove these pages/links until the sidebar PR lands.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intentionally not addressed in this PR —
src/sidebar.tsis owned by the gating-branch coordination PR (hyc/orchestration-launch), not by any single workstream PR. The sidebar wiring for all the new harness pages will land alongside the gating-branch merge so we're not racing other workstream PRs on the same file.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!