Manage agents
frontline agents [options] [command]List all agents (JSON by default; use --pretty/--table for human-readable output)
frontline agents list [options]Options
| Flag | Description | Default |
|---|---|---|
--status <status> | Filter by status (e.g. active, inactive, draft) | |
--pretty | Pretty human-readable output | |
--table | Render as table | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug information (redacted token) |
Create an agent and select it as active
frontline agents create [options]Options
| Flag | Description | Default |
|---|---|---|
--name <name> | Agent name | |
--no-use | Do not set the created agent as active | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Select the active agent for flow commands
frontline agents use [options] <agentId>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Describe the active agent or --agent-id
frontline agents describe [options] [agentId]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update the active agent or --agent-id
frontline agents update [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Agent name | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete the active agent or --agent-id
frontline agents delete [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Publish or pause the active agent
frontline agents deploy [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
| `--offline <true | false>` | Set true to pause, false to publish |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage channel settings
frontline agents settings [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get all channel settings or one channel
frontline agents settings get [options] [channel]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update channel settings from JSON
frontline agents settings update [options] <channel>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--data <json> | Channel settings payload JSON | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List configurable channel names
frontline agents settings list-channels [options]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage agent theme
frontline agents theme [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get agent theme
frontline agents theme get [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update agent theme from JSON
frontline agents theme update [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--data <json> | Theme payload JSON | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage agent model, instructions, tools, and connected accounts
frontline agents agent-setting [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get agent setting
frontline agents agent-setting get [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update agent setting from JSON (merges with current settings)
frontline agents agent-setting update [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--data <json> | Agent setting patch JSON | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List flows for a specific agent
frontline agents flows [options] [command] [agentId]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List flows for the active agent or --agent-id
frontline agents flows list [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--status <status> | Filter by flow status | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a flow for the active agent or --agent-id
frontline agents flows create [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Flow name | |
--description <description> | Flow description | |
--no-use | Do not set the created flow as active | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Select the active flow for the active agent or --agent-id
frontline agents flows use [options] <flowId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Describe the active flow or --flow-id
frontline agents flows describe [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--include-nodes | Include flow nodes | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update the active flow or --flow-id
frontline agents flows update [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--name <name> | Flow name | |
--description <description> | Flow description | |
--status <status> | Flow status (ACTIVE, DRAFT, SUSPENDED, DELETED) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete the active flow or --flow-id
frontline agents flows delete [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get the active flow graph
frontline agents flows graph [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage flow nodes
frontline agents flows nodes [options] [command]List nodes for the active flow
frontline agents flows nodes list [options]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow |
Create a node in the active flow
frontline agents flows nodes create [options]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--data <json> | Node JSON payload |
Update a node in the active flow
frontline agents flows nodes update [options] <nodeId>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--data <json> | Partial node JSON payload | |
--replace | Send --data as-is instead of merging data with the node's current config. Without this flag, a partial data (e.g. only { personSource }) is merged onto the existing node data client-side before sending, so unspecified fields are kept. |
Delete a node and its connected edges
frontline agents flows nodes delete [options] <nodeId>Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow |
Manage flow edges
frontline agents flows edges [options] [command]Add or replace an edge by handle
frontline agents flows edges add [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--source <nodeId> | Source node ID | |
--source-handle <handleId> | Source handle ID | |
--target <nodeId> | Target node ID | |
--target-handle <handleId> | Target handle ID | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Remove an edge
frontline agents flows edges remove [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--flow-id <id> | Flow ID. Defaults to the active flow | |
--source <nodeId> | Source node ID | |
--source-handle <handleId> | Source handle ID | |
--target <nodeId> | Target node ID | |
--target-handle <handleId> | Target handle ID | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage variables for the active agent
frontline agents variables [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List agent variables
frontline agents variables list [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--filter-text <text> | Filter by name or description | |
| `--is-default <true | false>` | Filter default variables |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List all agent variables including defaults
frontline agents variables all [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create an agent variable
frontline agents variables create [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Variable name | |
--description <description> | Variable description | |
--pattern <pattern> | Optional validation pattern | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Describe an agent variable
frontline agents variables describe [options] <variableId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an agent variable
frontline agents variables update [options] <variableId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Variable name | |
--description <description> | Variable description | |
--pattern <pattern> | Optional validation pattern | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an agent variable
frontline agents variables delete [options] <variableId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Check whether an agent variable name exists
frontline agents variables check-name [options] <name>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Run an agent: send a message and print its reply (Overview/Playground)
frontline agents run [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--message <text> | Message to send to the agent | |
--conversation-id <id> | Continue an existing conversation | |
--contact-id <id> | Link the conversation to a People record | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Close a conversation
frontline agents run close [options] <conversationId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List an agent's conversations. Uses the active agent unless --agent-id is passed
frontline agents conversations [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--is-closed <bool> | Filter by closed state (true/false) | |
--start-date <date> | Start date (YYYY-MM-DD) | |
--end-date <date> | End date (YYYY-MM-DD) | |
--search <text> | Full-text search over message content and conversation name | |
--channels <list> | Comma-separated channels. Valid: LIVE_CHAT, SHARED, OVERVIEW, API, WHATSAPP, INSTAGRAM, MESSENGER, SLACK, MAX_EXTENSION | |
--feedback <rating> | Filter by feedback rating. Valid: POSITIVE, NEGATIVE | |
--page <n> | Page number | |
--page-size <n> | Page size | |
--pretty | Pretty human-readable output | |
--table | Render as table | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug information (redacted token) |
Get a single conversation with its message transcript
frontline agents conversations get [options] <conversationId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--include-events | Debug view: include non-message events (flow enter/exit, intents, tool calls, errors) in the transcript | |
--pretty | Pretty human-readable output | |
--table | Render as table | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug information (redacted token) |
Get a single message's full execution trace (audit log)
frontline agents conversations trace [options] <conversationId> <messageId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--pretty | Pretty human-readable output | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug information (redacted token) |
Manage intents for the active agent
frontline agents intents [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List agent intents
frontline agents intents list [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--filter-text <text> | Filter by intent name | |
| `--include-used-status <true | false>` | Include intents already used by flows |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List all agent intents
frontline agents intents all [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
| `--include-used-status <true | false>` | Include intents already used by flows |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create an agent intent
frontline agents intents create [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Intent name | |
--description <description> | Intent description | |
--phrases <json> | JSON array of training phrases | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Describe an agent intent
frontline agents intents describe [options] <intentId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update an agent intent
frontline agents intents update [options] <intentId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Intent name | |
--description <description> | Intent description | |
--phrases <json> | JSON array of phrase objects | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete an agent intent
frontline agents intents delete [options] <intentId>Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Generate suggested phrases for an intent
frontline agents intents generate-phrases [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <id> | Agent ID. Defaults to the active agent | |
--name <name> | Intent name | |
--samples <json> | JSON array of sample phrases | |
--amount <number> | Amount of phrases to generate | 10 |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get analytics for a specific agent
frontline agents analytics [options] <agentId>Options
| Flag | Description | Default |
|---|---|---|
--start-date <date> | Start date (YYYY-MM-DD) | |
--end-date <date> | End date (YYYY-MM-DD) | |
--pretty | Pretty human-readable output | |
--table | Render as table | |
--json | Output raw JSON (default behavior — accepted as a no-op) | |
--api-key <key> | Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key) | |
--base-url <url> | Advanced: override Public API base URL for this run | |
--profile <name> | Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list) | |
--debug | Show debug information (redacted token) |