au3 solution installation — Command Reference¶
CLI command group: au3 solution installation
Commands that operate on a solution installation for the current toolbelt context: configuration, workgraph execution, monitorables, state, settings, reports, and installation drafts. For phase-level commands (acquisition, mapping, delivery, etc.), see the au3 solution installation phase references.
Sections¶
| Section | Commands |
|---|---|
| View / delete installation | 1 |
| update-version | 1 |
| delete | 1 |
| Configuration | 4 |
| Workgraph | 31 |
| Monitorable | 5 |
| Action | 2 |
| State | 4 |
| Settings | 3 |
| Report | 8 |
| Draft | 8 |
au3 solution installation view¶
View solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation update-version¶
Update solution version for current installation context and synchronize linked draft/execution records
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--solution-version |
string | ✅ | solution version id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation delete¶
Delete solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--force |
boolean | Force deletion without confirmation | ||
--delete-project |
boolean | false | Delete project after deleting solution installation | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation configuration¶
Sub-commands:
au3 solution installation configuration view¶
View solution installation configuration for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation configuration update-temporary¶
Temporary command to update configuration in solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--configuration |
string | ✅ | configuration in JSON/YAML format or path to file containing configuration | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation configuration list-history¶
List configuration history
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph¶
Sub-commands:
au3 solution installation workgraph view¶
View workgraph
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--path-filter |
string | filter in JSON/YAML format or path to file containing filter | ||
--node-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 solution installation workgraph visualize¶
Visualize
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--script |
string | workgraph in JSON/YAML format or path to file containing script | ||
--format |
enum | graphviz | Output format Choices: "graphviz", "mermaid-gantt" | |
--stored-run |
string | Id of stored run | ||
--node-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 | ||
--include-unmatched |
boolean | Whether to include nodes which did not match the filters | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph run¶
Run workgraph
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--stored-run |
string | Id of stored-run to use instead of manually specifying filter | ||
--path-filter |
string | filter in JSON/YAML format or path to file containing filter | ||
--node-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 solution installation workgraph recovery¶
Sub-commands:
au3 solution installation workgraph recovery generate-filter¶
Generate workgraph recovery filter
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--task |
string | Task(s) to generate filter relative to. Uses latest workgraph task if omitted. | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph recovery run¶
Run workgraph
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--task |
string | Id of prior task to recover from | ||
--path-filter |
string | filter in JSON/YAML format or path to file containing filter | ||
--node-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 solution installation workgraph stored-run¶
Sub-commands:
au3 solution installation workgraph stored-run list¶
List stored runs
| 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 solution installation workgraph stored-run view¶
View stored run
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | stored run 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 solution installation workgraph stored-run create¶
Create stored run
| 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 solution installation workgraph stored-run update¶
Update stored run
| 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: UpdateSolutionInstallationStoredRunResultDto
This section documents the --spec payload accepted by au3 solution installation workgraph stored-run update. Run solution installation workgraph stored-run update --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields¶
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | ✅ | Id of stored run — Pattern: ^sistrun-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ |
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 |
|
path_filter |
object | Filter to determine workgraph paths to run | |
node_filter |
object | Filter to determine workgraph nodes to run. Filter is applied after path_filter if present. | |
schedule |
object | ||
notification |
object | ||
completion_targets |
object | ||
post_run_reports |
array | Reports dispatched automatically when a submission for the stored run reaches a configured state | |
recovery_ttl |
integer | How long the stored run will stay in awaiting recovery before transitioning to expired in milliseconds. — Min 0 | |
created_at |
string | ✅ | Datetime the object was created at — Format: date-time — e.g. 2026-09-03T19:50:55.379Z |
created_by |
object | ✅ | |
created_req |
string | ✅ | Request the object was created by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10 |
updated_at |
string | ✅ | Datetime the object was updated at — Format: date-time — e.g. 2026-09-03T19:50:55.379Z |
updated_by |
object | ✅ | |
updated_req |
string | ✅ | Request the object was updated by — Pattern: ^req-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(\.[0-9]+)*$ — e.g. req-123e4567-e89b-41d2-a345-678901234567.0.10 |
schedule¶
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the schedule is enabled — Default: False |
cadence |
object | ✅ |
cadence
The cadence object is a discriminated union. One of the following 1 shapes applies.
1. cron
| Field | Type | Required | Notes |
|---|---|---|---|
type |
const | ✅ | cron |
minute |
string | ✅ | Portion of the cron governing the minute |
hour |
string | ✅ | Portion of the cron governing the hour |
day_of_month |
string | ✅ | Portion of the cron governing the day of month |
month |
string | ✅ | Portion of the cron governing the month |
day_of_week |
string | ✅ | Portion of the cron governing the day of week |
timezone |
string | Timezone to evaluate cadence relative to. Values goverened by the "tz database" — Default: UTC |
notification¶
| Field | Type | Required | Notes |
|---|---|---|---|
inflight_warning |
object | Sends notification when warnings are observed during run execution | |
inflight_error |
object | Sends notification when errors are observed during run execution | |
run_failed |
object | Sent after task reaches final state which is not SUCCEEDED. Contains information about errors encountered during execution. | |
run_succeeded |
object | Sent after task reaches final state which is SUCCEEDED. Contains information about run execution, including noting whether automatic or manual retries were done. |
inflight_warning
Sends notification when warnings are observed during run execution
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the notification is enabled |
warning_filter |
object | Filter to narrow the returned results in filter JSON format | |
recurring |
boolean | ✅ | Whether to only send on first set of warnings encountered or periodically during execution as new warnings are encountered & collected |
priority_default |
enum | ✅ | Choices: P1, P2, P3, P4, P5 |
priority_filters |
object | ||
notifiers |
array |
✅ |
priority_filters
| Field | Type | Required | Notes |
|---|---|---|---|
P1 |
object | Filter to narrow the returned results in filter JSON format | |
P2 |
object | Filter to narrow the returned results in filter JSON format | |
P3 |
object | Filter to narrow the returned results in filter JSON format | |
P4 |
object | Filter to narrow the returned results in filter JSON format | |
P5 |
object | Filter to narrow the returned results in filter JSON format |
inflight_error
Sends notification when errors are observed during run execution
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the notification is enabled |
error_filter |
object | Filter to narrow the returned results in filter JSON format | |
recurring |
boolean | ✅ | Whether to only send on first set of errors encountered or periodically during execution as new errors are encountered & collected |
priority_default |
enum | ✅ | Choices: P1, P2, P3, P4, P5 |
priority_filters |
object | ||
notifiers |
array |
✅ |
priority_filters
| Field | Type | Required | Notes |
|---|---|---|---|
P1 |
object | Filter to narrow the returned results in filter JSON format | |
P2 |
object | Filter to narrow the returned results in filter JSON format | |
P3 |
object | Filter to narrow the returned results in filter JSON format | |
P4 |
object | Filter to narrow the returned results in filter JSON format | |
P5 |
object | Filter to narrow the returned results in filter JSON format |
run_failed
Sent after task reaches final state which is not SUCCEEDED. Contains information about errors encountered during execution.
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the notification is enabled |
notifiers |
array |
✅ | |
priority |
enum | ✅ | Choices: P1, P2, P3, P4, P5 |
run_succeeded
Sent after task reaches final state which is SUCCEEDED. Contains information about run execution, including noting whether automatic or manual retries were done.
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the notification is enabled |
notifiers |
array |
✅ | |
priority |
enum | ✅ | Choices: P1, P2, P3, P4, P5 |
completion_targets¶
| Field | Type | Required | Notes |
|---|---|---|---|
internal_target |
string | ✅ | Time when solution provider would like to deliver by. Uses timezone of schedule cadence or UTC if omitted. — Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ |
soft_target |
string | ✅ | Time when client expects delivery by. Uses timezone of schedule cadence or UTC if omitted. — Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ |
hard_target |
string | ✅ | Time when client requires delivery by. Uses timezone of schedule cadence or UTC if omitted. — Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ |
grace_target |
string | ✅ | Time when client tolerates delivery by in rare circumstances. Uses timezone of schedule cadence or UTC if omitted. — Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ |
post_run_reports (array items)¶
Reports dispatched automatically when a submission for the stored run reaches a configured state
| Field | Type | Required | Notes |
|---|---|---|---|
enabled |
boolean | ✅ | Whether the report is sent — Default: False |
label |
string | Label identifying the report in logs and activity records, e.g. "client" or "support" | |
action |
enum | ✅ | Choices: send-post-run-report-general-email |
argument |
object | ✅ | Argument passed to the report action. "stored_run" is set to the stored run the report is configured on; a configured value is ignored. |
on_states |
array |
Submission states which trigger the report. Omit to default to ["SUCCEEDED"]. |
created_by¶
The created_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
| Field | Type | Required | Notes |
|---|---|---|---|
Variant 2
| Field | Type | Required | Notes |
|---|---|---|---|
updated_by¶
The updated_by object is a discriminated union. One of the following 2 shapes applies.
Variant 1
| Field | Type | Required | Notes |
|---|---|---|---|
Variant 2
| Field | Type | Required | Notes |
|---|---|---|---|
Example Spec¶
id: sistrun-123e4567-e89b-41d2-a345-678901234567
name: <string>
created_at: '2026-09-03T19:50:55.379Z'
created_by: {}
created_req: req-123e4567-e89b-41d2-a345-678901234567.0.10
updated_at: '2026-09-03T19:50:55.379Z'
updated_by: {}
updated_req: req-123e4567-e89b-41d2-a345-678901234567.0.10
description: <string>
au3 solution installation workgraph stored-run delete¶
Delete stored run
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | stored run id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph task¶
Sub-commands:
au3 solution installation workgraph task trace¶
Sub-commands:
au3 solution installation workgraph task trace view¶
View workgraph task trace
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | workgraph task id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph task trace visualize¶
Visualize workgraph task trace
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | workgraph task id | |
--format |
enum | graphviz | Output format Choices: "graphviz", "full", "mermaid-gantt", "graphviz-entities" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph submission¶
Sub-commands:
au3 solution installation workgraph submission list¶
List workgraph submissions
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--limit |
Number of items to return in the requested page. The server limit may be less than the requested limit. | |||
--since |
string | 2026-08-31T19:25:22.356Z | Datetime to start search from | |
--before |
string | Submission id to start listing from. Omit for latest in set. | ||
--after |
string | Submission id to start listing after. If before is not present, last task will be the next id after the specified id. | ||
--fields |
string | Comma-separate list of fields to display | ||
--filter |
string | Filter in JSON/YAML format or path to file containing filter | ||
--search |
string | Search in JSON/YAML format or path to file containing search | ||
--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 solution installation workgraph submission view¶
View workgraph submission
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | submission id | |
--fields |
string | comma-separate list of fields to display | ||
--node-summary |
boolean | false | Include completed and remaining workgraph node summaries | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph submission trace¶
Sub-commands:
au3 solution installation workgraph submission trace view¶
View workgraph submission trace
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | submission id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph submission trace visualize¶
Visualize workgraph submission trace
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | submission id | |
--format |
enum | graphviz | Output format Choices: "graphviz", "full", "mermaid-gantt" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph submission recover¶
Recover workgraph submission
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | submission id | |
--mode |
enum | Recovery mode: remaining (default) excludes already-succeeded nodes; full includes them Choices: "remaining", "full" | ||
--node-filter |
string | Node filter in JSON/YAML format or path to file. Limits recovery to matching nodes. | ||
--path-filter |
string | Path filter in JSON/YAML format or path to file. Limits recovery to nodes on matching paths. | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph submission cancel¶
Cancel workgraph submission
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | submission id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph notifier¶
Sub-commands:
au3 solution installation workgraph notifier list¶
List notifiers
| 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 solution installation workgraph notifier view¶
View notifier
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | Notifier 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 solution installation workgraph notifier create¶
Create notifier
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--name |
string | ✅ | Object name with 2-64 characters | |
--description |
string | Object description with 0 or 2-256 characters | ||
--method |
enum | ✅ | Choices: "ops-genie", "brevo" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation workgraph notifier update¶
Update notifier
| 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: UpdateSolutionInstallationNotifierArgumentDto
This section documents the --spec payload accepted by au3 solution installation workgraph notifier update. Run solution installation workgraph notifier 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 | ✅ | Id of notifier — Pattern: ^sinot-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ |
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 |
|
enabled |
boolean | ✅ | Whether the notifier is enabled |
api_key |
string | ✅ | |
team_name |
string | OpsGenie team name (method=ops-genie) | |
sender_email |
string | Email sender address (method=brevo) |
Example Spec¶
id: sinot-123e4567-e89b-41d2-a345-678901234567
name: <string>
enabled: true
api_key: <string>
description: <string>
au3 solution installation workgraph notifier delete¶
Delete notifier
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | Notifier id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation monitorable¶
Sub-commands:
au3 solution installation monitorable list¶
List monitorables
| 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 solution installation monitorable update¶
Update attribute values for monitorables in an installation
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--monitorables |
string | ✅ | monitorable attributes in JSON/YAML format or path to file containing configuration | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation monitorable history¶
List tasks
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--limit |
Number of items to return in the requested page. The server limit may be less than the requested limit. | |||
--since |
string | 2026-08-31T19:25:43.648Z | Datetime to start search from | |
--before |
string | Task id to start listing from. Omit for latest in set. | ||
--fields |
string | Comma-separate list of fields to display | ||
--filter |
string | Filter in JSON/YAML format or path to file containing filter | ||
--search |
string | Seach in JSON/YAML format or path to file containing search | ||
--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 solution installation monitorable visualize-graph¶
Visualize graph
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--graph |
string | monitorables graph in JSON/YAML format or path to file containing script | ||
--format |
enum | graphviz | Output format Choices: "graphviz", "mermaid-gantt" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation action¶
Sub-commands:
au3 solution installation action run¶
Run solution installation action for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--action |
string | ✅ | Action to run | |
--argument |
string | ✅ | Argument to pass to the action in JSON/YAML format or path to file containing argument | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation state¶
Sub-commands:
au3 solution installation state view¶
View solution installation state for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation state update¶
Update state in solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--state |
string | ✅ | JSON string of state object | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation state list-history¶
List state history
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation settings¶
Sub-commands:
au3 solution installation settings view¶
View solution settings
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation settings update¶
Update solution settings
| 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: UpdateSolutionInstallationDraftSolutionSettingsArgumentDto
This section documents the --spec payload accepted by au3 solution installation settings update. Run solution installation settings 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 |
|---|---|---|---|
solution_settings |
object | ✅ | Installation-specific base settings per solution_settings_schema |
Example Spec¶
{}
au3 solution installation report¶
Sub-commands:
au3 solution installation report data-dictionary¶
Generate data-dictionary report
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--phase |
enum | ✅ | Pipeline phase to analyze Choices: "mapping" | |
--level |
enum | ✅ | Level of granularity to analyze Choices: "entity", "field" | |
--format |
enum | ✅ | Format to output result report as Choices: "full", "destination-table" | |
--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 solution installation report phase-entity-metadata¶
Generate phase entity metadata report
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--format |
enum | ✅ | Format to output result report as Choices: "full" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation report mapping-fields¶
Generate mapping fields report
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--level |
enum | ✅ | Format to output result report as Choices: "entity", "field", "dataflow-operation" | |
--format |
enum | ✅ | Format to output result report as Choices: "full", "tsv" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation report phase-fields¶
Generate phase-fields report
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--format |
enum | ✅ | Choices: "tsv" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation report implementation-status¶
Generate data field implementation report
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--format |
enum | full | Report format where simple is a targeted subset of full Choices: "full", "simple" | |
--report-spec |
boolean | false | Whether to print the report structure schema instead of computing the report | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation report implementation-status-sql¶
Generate data field implementation report by querying a metadata export via SQL
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--format |
enum | full | Report format where simple is a targeted subset of full Choices: "full", "simple" | |
--report-spec |
boolean | false | Whether to print the report structure schema instead of computing the report | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation report export-metadata¶
Run metadata export
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--format |
enum | ✅ | Choices: "sqlite", "duckdb" | |
--field-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 solution installation draft¶
Sub-commands:
au3 solution installation draft create¶
Create draft from solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--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 solution installation draft run-validate¶
Run solution installation draft validate
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation draft run-apply¶
Run solution installation draft apply
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation draft run-publish¶
Run solution installation draft publish
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--change-filter |
string | Subset of detected changes to include in selective publish. When omitted, a full publish is performed. In JSON/YAML format or path to file containing change filter. | ||
--detected-changes |
Full detected change list. Required when | |||
--change-filter |
string | is provided. In JSON/YAML format or path to file containing detected changes. | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation draft sync-data¶
Sync data from the execution project to the current draft context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--containers |
string | Data containers to clone in JSON/YAML format or path to file containing | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation draft delete¶
Delete draft from solution installation for current context
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--delete-project |
boolean | false | Delete project after deleting draft | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 solution installation draft detect-changes¶
Detect solution installation draft changes
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
Generated from au3 solution installation --help and subcommand help output.