au3 project — Command Reference¶
CLI command group: au3 project
Commands for managing projects and project system configuration.
au3 project list¶
List projects
| 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 project view¶
View project
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | ||
--fields |
string | comma-separate list of fields to display | ||
--update-spec |
boolean | print only the fields which are usable for the update command | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 project create¶
Create project
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--name |
string | ✅ | Object name with 2-64 characters | |
--description |
string | Object description with 0 or 2-256 characters | ||
--type |
string | |||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 project update¶
Update project
| 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: UpdateProjectArgumentDto
This section documents the --spec payload accepted by au3 project update. Run project 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 | Project id — Pattern: ^proj-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. proj-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 |
|
logo |
object | ||
type |
enum | Choices: custom, solution, solution-draft |
logo¶
The logo 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¶
name: <string>
description: <string>
au3 project visualize¶
Visualize project
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--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 project system-configuration¶
au3 project system-configuration view¶
View project system config
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | ||
--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 project system-configuration update¶
Update project system config
| 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: UpdateProjectSystemConfigArgumentDto
This section documents the --spec payload accepted by au3 project system-configuration update. Run project system-configuration update --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields¶
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | ✅ | Project id — Pattern: ^proj-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. proj-123e4567-e89b-41d2-a345-678901234567 |
system_config |
object | ✅ |
system_config¶
| Field | Type | Required | Notes |
|---|---|---|---|
tenant |
string | ✅ | Compute Environment Tenant id — Pattern: ^cet-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. cet-e0305f9e-55f6-4e86-8998-40e40bc784dd |
Example Spec¶
id: proj-123e4567-e89b-41d2-a345-678901234567
system_config:
tenant: cet-e0305f9e-55f6-4e86-8998-40e40bc784dd
Generated from au3 project --help and subcommand help output.