Skip to content

docs: document oz agent run-cloud harness flags #322

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.

Sign up for GitHub

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

Draft
hongyi-chen wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: document oz agent run-cloud harness flags #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/content/docs/reference/cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,9 @@ oz agent run-cloud \
* `--attach <PATH>` — attach an image file to the agent query. Can be repeated (maximum 5).
* `--computer-use` / `--no-computer-use` — enable or disable [Computer Use](/agent-platform/capabilities/computer-use/) for this run.
* `--file <PATH>` (`-f`) — load run configuration from a YAML or JSON file.
* `--harness <HARNESS>` — choose the [execution harness](/platform/harnesses/) for the run: `oz` (default, Warp's built-in agent infrastructure), `claude` (Claude Code), or `codex`.
* `--claude-auth-secret <NAME>` — name of the [Warp-managed secret](/platform/harnesses/authentication/) that authenticates the Claude Code harness. Only valid with `--harness claude`.
* `--codex-auth-secret <NAME>` — name of the [Warp-managed secret](/platform/harnesses/authentication/) that authenticates the Codex harness. Only valid with `--harness codex`.

**Key differences from `run`**

Expand Down Expand Up @@ -317,6 +320,20 @@ oz agent run-cloud \

You can reuse saved prompts with `--saved-prompt`, and reference notebooks, workflows, and rules inline in any `--prompt` string. See [Referencing Warp Drive objects](/reference/cli/warp-drive/) for details.

#### Choosing an execution harness

By default, cloud runs use Warp's built-in `oz` harness. To delegate the run to a third-party coding agent, pass `--harness` with `claude` (Claude Code) or `codex`, along with the matching auth secret:

```sh
oz agent run-cloud \
--environment <ENVIRONMENT_ID> \
--harness claude \
--claude-auth-secret <SECRET_NAME> \
--prompt "review the latest PR"
```

Create the auth secret first with `oz secret create claude api-key <SECRET_NAME>` (or `oz secret create codex api-key <SECRET_NAME>` for Codex). See [Third-party cloud agent authentication](/platform/harnesses/authentication/) for the full setup.

## Using agent profiles

Agent profiles control what the agent can do, how it behaves, and where it can act. Use the `--profile` flag with `oz agent run` to apply a specific profile.
Expand Down
Loading