au3 dataflow — Command Reference

CLI command group: au3 dataflow

Commands for creating, running, previewing, and visualizing dataflows, converting from Au2, and generating operation/expression documentation and usage reports.

---

Sections

Section	Commands
Dataflow (top-level)	15
Report (sub-group)	2

---

au3 dataflow list

List dataflows

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 dataflow view

View dataflow

Option	Type	Required	Default	Notes
--id	string	✅		dataflow id
--fields	string			comma-separate list of fields to display
--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 dataflow create

Create dataflow

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 dataflow update

Update dataflow

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
--validate	boolean		false	whether to validate the dataflow before updating
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

--spec payload reference

Schema ID: UpdateWarehouseDataflowArgumentDto

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

Top-Level Fields

Field	Type	Required	Notes
id	string		Warehouse Dataflow id — Pattern: ^whsdf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whsdf-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 Warehouse Dataflow Script
validate	boolean		Default: False

Example Spec

name: <string>
description: <string>

---

au3 dataflow run

Run dataflow

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

---

au3 dataflow preview

Preview dataflow

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

---

au3 dataflow list-history

List dataflow history

Option	Type	Required	Default	Notes
--id	string	✅		dataflow 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 dataflow delete

Delete a dataflow

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

---

au3 dataflow visualize-script

Visualize script

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

---

au3 dataflow validate

Validate script

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

---

au3 dataflow trace

Trace script

Option	Type	Required	Default	Notes
--id	string			dataflow id
--task	string			dataflow task id
--script	string			dataflow script in JSON/YAML format or path to file containing script
--format	enum	✅		Output format Choices: "full"
--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 dataflow convert-from-au2

Convert from Au2 dataflow

Option	Type	Required	Default	Notes
--au2-id	string	✅		Au2 dataflow id
--au2-url	string		https://api.aunsight.com	Au2 API URL
--au2-token	string	✅		Au2 API token.
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 dataflow operations-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

---

au3 dataflow expressions-to-markdown

Generate documentation about available expressions

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

---

au3 dataflow report

au3 dataflow report operation-usage

Operation usage report

Option	Type	Required	Default	Notes
--since	string		2026-06-03T19:29:52.331Z	Datetime to start task search from; summary task_Xday_count fields are only meaningful when since is at least X days ago
--format	enum		summary	Output format Choices: "full", "summary"
--filter	string			Filter to limit which dataflows, tasks, operations, expressions, etc are in scope 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

---

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