Skip to content

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

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

Open
hongyi-chen wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c66fa7
docs: document named-agent base prompt flag in CLI reference
hongyi-chen Jul 27, 2026
1819dae
Merge branch 'main' into docs/cli-named-agent-base-prompt
hongyi-chen Jul 27, 2026
b0a1998
Merge branch 'main' into docs/cli-named-agent-base-prompt
hongyi-chen Jul 28, 2026
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
4 changes: 3 additions & 1 deletion src/content/docs/reference/cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ The following commands are available for managing and inspecting Oz resources.

### Managing named agents

[Named agents](/platform/agents/) are reusable agent configurations — a name, description, skills, secrets, base model, and default environment — that you can run with `oz agent run-cloud --agent <UID>` and scope API keys to.
[Named agents](/platform/agents/) are reusable agent configurations — a name, description, base prompt, skills, secrets, base model, and default environment — that you can run with `oz agent run-cloud --agent <UID>` and scope API keys to.

List the named agents on your team, optionally sorting by name or creation time:

Expand All @@ -417,6 +417,7 @@ Create a named agent. Only `--name` is required; attach skills and secrets by re
oz agent create \
--name "release-notes" \
--description "Drafts release notes from merged PRs" \
--prompt "Draft concise release notes grouped by feature area." \
--skill "myorg/repo:release-notes" \
--secret GITHUB_TOKEN \
--base-model <MODEL_ID> \
Expand All @@ -438,6 +439,7 @@ Common `oz agent update` flags:

* `--name <NAME>` (`-n`) — rename the agent.
* `--description <TEXT>` / `--remove-description` — set or clear the description.
* `--prompt <TEXT>` / `--remove-prompt` — set or clear the base prompt applied to the agent's runs.
* `--add-secret <NAME>` / `--remove-secret <NAME>` / `--remove-all-secrets` — manage attached secrets.
* `--add-skill <SKILL>` / `--remove-skill <SKILL>` / `--remove-all-skills` — manage attached skills.
* `--base-model <MODEL_ID>` / `--remove-base-model` — set or clear the base model.
Expand Down
Loading