Skip to content

frontline workflows

Manage workflows

frontline workflows [options] [command]

frontline workflows list

List all workflows (JSON by default; use --pretty/--table for human-readable output)

frontline workflows list [options]

Options

FlagDescriptionDefault
--status <status>Filter by status (e.g. active, inactive, draft)
--prettyPretty human-readable output
--tableRender as table
--jsonOutput 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)
--debugShow debug information (redacted token)

frontline workflows create

Create a workflow automation and select it as the active workflow

frontline workflows create [options]

Options

FlagDescriptionDefault
--name <name>Workflow name
--description <description>Workflow description
--no-useDo not set the created workflow 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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows use

Select the active workflow for commands that omit --workflow-id

frontline workflows use [options] <workflowId>

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows describe

Describe a workflow. Uses the active workflow unless --workflow-id is passed

frontline workflows describe [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--include-nodesInclude workflow 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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows update

Update workflow metadata or status

frontline workflows update [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--name <name>Workflow name
--description <description>Workflow description
--status <status>Workflow status (ACTIVE, DRAFT, 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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows delete

Delete the active workflow or the workflow passed with --workflow-id

frontline workflows delete [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows run

Manually run the active workflow (or --workflow-id). Only available for ACTIVE scheduled workflows

frontline workflows run [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows graph

Get the graph for the active workflow or --workflow-id

frontline workflows graph [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows nodes

Manage workflow nodes

frontline workflows nodes [options] [command]

frontline workflows nodes list

List nodes for the active workflow or --workflow-id

frontline workflows nodes list [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows nodes create

Create a node in the active workflow or --workflow-id

frontline workflows nodes create [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--data <json>Node JSON payload, inline
--file <path>Node JSON payload file; use - for stdin
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows nodes update

Update a node in the active workflow or --workflow-id

frontline workflows nodes update [options] <nodeId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--data <json>Partial node JSON payload, inline
--file <path>Partial node JSON payload file; use - for stdin
--replaceSend --data/--file 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.
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows nodes delete

Delete a node and its connected edges

frontline workflows nodes delete [options] <nodeId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows edges

Manage workflow edges

frontline workflows edges [options] [command]

frontline workflows edges add

Add or replace the outgoing edge for a node

frontline workflows edges add [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows edges remove

Remove an edge

frontline workflows edges remove [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables

Manage variables for the active workflow

frontline workflows variables [options] [command]

Options

FlagDescriptionDefault
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables list

List workflow variables

frontline workflows variables list [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--filter-text <text>Filter by name or description
`--is-default <truefalse>`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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables all

List all workflow variables including defaults

frontline workflows variables all [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables create

Create a workflow variable

frontline workflows variables create [options]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables describe

Describe a workflow variable

frontline workflows variables describe [options] <variableId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables update

Update a workflow variable

frontline workflows variables update [options] <variableId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables delete

Delete a workflow variable

frontline workflows variables delete [options] <variableId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows variables check-name

Check whether a workflow variable name exists

frontline workflows variables check-name [options] <name>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--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)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline workflows analytics

Get analytics for a workflow. Uses the active workflow unless an ID is passed

frontline workflows analytics [options] [workflowId]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--start-date <date>Start date (YYYY-MM-DD)
--end-date <date>End date (YYYY-MM-DD)
--prettyPretty human-readable output
--tableRender as table
--jsonOutput 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)
--debugShow debug information (redacted token)

frontline workflows logs

List a workflow's run logs. Uses the active workflow unless an ID is passed

frontline workflows logs [options] [command] [workflowId]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--status <status>Filter by run status (e.g. SUCCESS, FAILED, RUNNING)
--start-date <date>Start date (YYYY-MM-DD)
--end-date <date>End date (YYYY-MM-DD)
--page <n>Page number
--page-size <n>Page size
--prettyPretty human-readable output
--tableRender as table
--jsonOutput 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)
--debugShow debug information (redacted token)

frontline workflows logs list

List a workflow's run logs (same as bare 'workflows logs')

frontline workflows logs list [options] [workflowId]

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--status <status>Filter by run status (e.g. SUCCESS, FAILED, RUNNING)
--start-date <date>Start date (YYYY-MM-DD)
--end-date <date>End date (YYYY-MM-DD)
--page <n>Page number
--page-size <n>Page size
--prettyPretty human-readable output
--tableRender as table
--jsonOutput 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)
--debugShow debug information (redacted token)

frontline workflows logs get

Get a single workflow run log with its per-node results

frontline workflows logs get [options] <logId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--prettyPretty human-readable output
--tableRender as table
--jsonOutput 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)
--debugShow debug information (redacted token)

frontline workflows logs trace

Get a single node's full execution trace (audit log) within a run

frontline workflows logs trace [options] <logId> <nodeResultId>

Options

FlagDescriptionDefault
--workflow-id <id>Workflow ID. Defaults to the active workflow
--prettyPretty 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)
--debugShow debug information (redacted token)