au3 workflow — Command Reference

CLI command group: au3 workflow

Commands for creating, running, and visualizing workflows, and generating operation documentation.

---

au3 workflow list

List workflows

Option	Type	Required	Default	Notes
--fields	string			Comma-separate list of fields to display
--filter	string			Filter in JSON/YAML format or path to file containing filter
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search	string			Search in JSON/YAML format or path to file containing search
--limit			100	Number of results to fetch
--skip				Number of results to skip
--all	boolean		false	Whether to fetch results from all pages
--stream	boolean		false	Whether to print results as they are received without buffering (as JSON)
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow view

View workflow

Option	Type	Required	Default	Notes
--id	string	✅		workflow id
--fields	string			comma-separate list of fields to display
--path-filter	string			filter in JSON/YAML format or path to file containing filter
--operation-filter	string			filter in JSON/YAML format or path to file containing filter
--update-spec	boolean			print in the form which is usable for the update command
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow create

Create workflow

Option	Type	Required	Default	Notes
--name	string	✅		Object name with 2-64 characters
--description	string			Object description with 0 or 2-256 characters
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow update

Update workflow

Option	Type	Required	Default	Notes
--spec-schema	boolean			view the schema for update
--spec	string			spec in JSON/YAML format or path to file containing spec
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

--spec payload reference

Schema ID: UpdateWorkflowArgumentDto

This section documents the --spec payload accepted by au3 workflow update. Run workflow update --spec-schema to fetch this schema live from the CLI at any time.

Tip: additionalProperties: false — the schema rejects any field not listed below.

Top-Level Fields

Field	Type	Required	Notes
id	string		Workflow id — Pattern: ^wf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. wf-123e4567-e89b-41d2-a345-678901234567
name	string		Object name with 2-64 characters — 2–64 characters
description	string		Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
tags	array		List of tags
script	string		Stringified Workflow Script

Example Spec

name: <string>
description: <string>

---

au3 workflow run

Run workflow

Option	Type	Required	Default	Notes
--id	string	✅		Id of workflow to run
--options	string			Options in JSON/YAML format or path to file containing options
--path-filter	string			filter in JSON/YAML format or path to file containing filter
--operation-filter	string			filter in JSON/YAML format or path to file containing filter
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow list-history

List workflow history

Option	Type	Required	Default	Notes
--id	string	✅		workflow id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow delete

Delete a workflow

Option	Type	Required	Default	Notes
--id	string	✅		Workflow id
--trash	string
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow visualize-script

Visualize script

Option	Type	Required	Default	Notes
--id	string			workflow id
--task	string			workflow task id
--script	string			workflow script in JSON/YAML format or path to file containing script
--format	enum		graphviz	Output format Choices: "graphviz", "mermaid-gantt"
--operation-filter	string			filter in JSON/YAML format or path to file containing filter
--path-filter	string			filter in JSON/YAML format or path to file containing filter
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow validate

Validate script

Option	Type	Required	Default	Notes
--id	string			workflow id
--task	string			workflow task id
--script	string			workflow script in JSON/YAML format or path to file containing script
--operation-filter	string			filter in JSON/YAML format or path to file containing filter
--path-filter	string			filter in JSON/YAML format or path to file containing filter
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 workflow ops-to-markdown

Generate documentation about available operations

Option	Type	Required	Default	Notes
--include	string			List of operations to include
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

Generated from au3 workflow --help and subcommand help output.