Skip to content
Subako Docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

subako agent

Agents: the unit of work a session runs, and its published versions

CLI reference

subako agent

Agents: the unit of work a session runs, and its published versions

Usage

Usage: subako agent <COMMAND>

Subcommands

Options

--help

Print help

  • Short option: -h.

subako agent create

Create an agent in the selected workspace. An agent holds no configuration of its own; its versions do

Usage

Usage: subako agent create [OPTIONS] --name <NAME>

Options

--name <NAME>

  • Required.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent list

List the selected workspace’s agents

Usage

Usage: subako agent list [OPTIONS]

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent show

Read one agent’s row

Usage

Usage: subako agent show [OPTIONS] <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent publish

Publish a configuration as the agent’s next version

Usage

Usage: subako agent publish [OPTIONS] --config <CONFIG> --model-provider <MODEL_PROVIDER> <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--config <CONFIG>

JSON file holding the version’s configuration. Its shape is the server’s: it names the model, and may grant mcp servers and skills. The provider is named by –model-provider, not in here

  • Required.

--model-provider <MODEL_PROVIDER>

Provider the version runs against, as model-provider list shows it. Its format must match the one the config’s model speaks

  • Required.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent config-example

Print a configuration that publishes as it stands, to redirect into a file and edit. Needs no server

Usage

Usage: subako agent config-example --format <FORMAT>

Options

--format <FORMAT>

Which format the example’s model speaks. It must match the format of the provider the version is published against

  • Required.
  • Possible values:
    • anthropic
    • openai_responses

--help

Print help

  • Short option: -h.

subako agent versions

List an agent’s versions, marking the one a new session would bind

Usage

Usage: subako agent versions [OPTIONS] <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent rename

Rename an agent, leaving its versions alone

Usage

Usage: subako agent rename [OPTIONS] --name <NAME> <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--name <NAME>

New name for the agent

  • Required.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent security

Read an agent’s security document: how its sessions answer a browser

Usage

Usage: subako agent security [OPTIONS] <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent set-security

Replace an agent’s security document. Every field is stated in full, so a flag left out resets that field: with no flags at all the agent returns to refusing every browser

Usage

Usage: subako agent set-security [OPTIONS] <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--allowed-origin <ORIGIN>

Browser origin whose pages may call the agent’s sessions, repeated for each one: a scheme, a host, and an optional port, exactly as a browser sends Origin (https://app.example.com, no path and no trailing slash)

  • May be repeated to supply multiple values.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako agent delete

Permanently delete an agent, its versions, and every session that ran them. Billing history is retained; the transcripts are not

Usage

Usage: subako agent delete [OPTIONS] <AGENT_ID>

Arguments

<AGENT_ID>

  • Required.

Options

--yes

Skip the typed confirmation. For scripts that have already asked

  • Default: false.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

Was this page helpful?