Manage agent playbooks (reusable instruction sets assigned to agents)
frontline playbooks [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 playbooks visible to you
frontline playbooks list [options]Options
| Flag | Description | Default |
|---|---|---|
--filter-text <text> | Filter by name, description, or instructions | |
--visibility <visibility> | Filter by visibility (ACCOUNT or PRIVATE) | |
--is-active <bool> | Filter by active status (true or false) | |
--page <n> | Page number | |
--page-size <n> | Page size | |
--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 playbook
frontline playbooks create [options]Options
| Flag | Description | Default |
|---|---|---|
--name <name> | Playbook name | |
--description <description> | When to use this playbook (min 10 chars) | |
--instructions <instructions> | The playbook instructions (min 10 chars) | |
--inactive | Create the playbook inactive (default: active) | |
--tools <json> | JSON array of system tool names available to the playbook | |
--visibility <visibility> | ACCOUNT (shared) or PRIVATE (only you) | |
--selected-record-types <json> | JSON array of record-type tool settings | |
--selected-custom-tools <json> | JSON array of custom-tool settings | |
--connected-account-configs <json> | JSON array of connected-account tool configs | |
--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 playbook
frontline playbooks describe [options] <playbookId>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) |
Update an agent playbook
frontline playbooks update [options] <playbookId>Options
| Flag | Description | Default |
|---|---|---|
--name <name> | Playbook name | |
--description <description> | When to use this playbook (min 10 chars) | |
--instructions <instructions> | The playbook instructions (min 10 chars) | |
--active | Mark the playbook active | |
--inactive | Mark the playbook inactive | |
--tools <json> | JSON array of system tool names available to the playbook | |
--visibility <visibility> | ACCOUNT (shared) or PRIVATE (only you) | |
--selected-record-types <json> | JSON array of record-type tool settings | |
--selected-custom-tools <json> | JSON array of custom-tool settings | |
--connected-account-configs <json> | JSON array of connected-account tool configs | |
--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 playbook
frontline playbooks delete [options] <playbookId>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 playbooks assigned to an agent
frontline playbooks assigned [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <agentId> | Agent ID | |
--filter-text <text> | Filter by name, description, or instructions | |
--is-active <bool> | Filter by active status (true or false) | |
--page <n> | Page number | |
--page-size <n> | Page size | |
--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) |
Set the playbooks assigned to an agent (replaces existing)
frontline playbooks assign [options]Options
| Flag | Description | Default |
|---|---|---|
--agent-id <agentId> | Agent ID | |
--playbook-ids <json> | JSON array of playbook IDs, e.g. [1,2] | |
--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) |