au3 solution installation phase consumption — Command Reference

CLI command group: au3 solution installation phase consumption

Commands for the Consumption phase: managing applications, API keys, tasks, warehouse data access, and MCP servers that expose installation data to consumers.

---

au3 solution installation phase consumption application

au3 solution installation phase consumption application list

List applications

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 phase consumption application view

View application

Option	Type	Required	Default	Notes
--id	string	✅		application 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 phase consumption application create

Create application

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 phase consumption application update

Update application

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: UpdateSolutionInstallationConsumptionApplicationArgumentDto

This section documents the --spec payload accepted by au3 solution installation phase consumption application update. Run solution installation phase consumption application 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 Consumption-Layer application to which to expose installation data — Pattern: ^siconapp-[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
warehouses	array	✅

warehouses (array items)

Field	Type	Required	Notes
id	string	✅	Id by which the warehouse is known to the application — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — e.g. main
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
warehouse	string	✅	Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
scopes	array		Predefined scopes which can be referenced instead of supplying fully in the request
allow_unscoped	boolean		Whether to allow requests which do not reference a predefined scope — Default: True

scopes (array items)

Predefined scopes which can be referenced instead of supplying fully in the request

Field	Type	Required	Notes
id	string	✅	Id by which the scope is known to the application warehouse — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — e.g. some_purpose
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
scope	object	✅

scope

Field	Type	Required	Notes
tables	object
views	object
entitiesOrder	array		Ordered list of all table/view ids for display

tables

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
row_filter	string		Query which filters rows prior to executing the user-provided query. Can be parameterized to refer to group and user attributes. Can also reference fields not made available to users. Must return same schema as original table.
propertiesOrder	array		Ordered list of all field ids for display

views

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Field	Type	Required	Notes
row_filter	string		Query which filters rows prior to executing the user-provided query. Can be parameterized to refer to group and user attributes. Can also reference fields not made available to users. Must return same schema as original view.
propertiesOrder	array		Ordered list of all field ids for display

Example Spec

id: siconapp-123e4567-e89b-41d2-a345-678901234567
name: <string>
description: <string>
warehouses:
- id: main
  name: <string>
  description: <string>
  warehouse: whs-123e4567-e89b-41d2-a345-678901234567

---

au3 solution installation phase consumption application delete

Delete application

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

---

au3 solution installation phase consumption application api-key

au3 solution installation phase consumption application api-key list

List consumption application API keys

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--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 phase consumption application api-key view

View consumption application API key

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--id	string	✅		API key id
--fields	string			comma-separated list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application api-key create

Create consumption application API key

Option	Type	Required	Default	Notes
--name	string	✅		Object name with 2-64 characters
--description	string			Object description with 0 or 2-256 characters
--expiry	string			Datetime of expiration
--ttl				Time to live in milliseconds. Used to compute an expiry.
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application api-key delete

Delete consumption application API key

Option	Type	Required	Default	Notes
--id	string	✅		Service user api key id
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application task

au3 solution installation phase consumption application task list

List tasks

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--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:28:55.909Z	Datetime to start search from
--before	string			Task id to start listing from. Omit for latest in set.
--after	string			Task 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			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 phase consumption application task view

View task

Option	Type	Required	Default	Notes
--id	string	✅		task id
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--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 solution installation phase consumption application task cancel

Cancel task

Option	Type	Required	Default	Notes
--id	string	✅		task id
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application task artifact

au3 solution installation phase consumption application task artifact download

Download task artifact

Option	Type	Required	Default	Notes
--id	string	✅		task id
--artifact	string	✅		artifact id
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse

au3 solution installation phase consumption application warehouse view

View warehouse ERM

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--warehouse	string	✅		Id by which the warehouse is known to the application
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse entity

au3 solution installation phase consumption application warehouse entity list

List warehouse ERM entities

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--warehouse	string	✅		Id by which the warehouse is known to the application
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--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 phase consumption application warehouse entity view

View warehouse ERM entity

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--warehouse	string	✅		Id by which the warehouse is known to the application
--entity	string	✅		Unique id for a table/view within an ERM
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse field

au3 solution installation phase consumption application warehouse field list

List warehouse ERM fields

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--warehouse	string	✅		Id by which the warehouse is known to the application
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--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 phase consumption application warehouse field view

View warehouse ERM field

Option	Type	Required	Default	Notes
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--warehouse	string	✅		Id by which the warehouse is known to the application
--entity	string	✅		Unique id for a table/view within an ERM
--field	string	✅		Unique id for a field within a table/view
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse query

Query Consumption Layer Data Warehouse

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--query	string			SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--query-entity	string			Id of entity to query
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--total	boolean			Whether to calculate total number of rows across all pages
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--fields	string			Comma-separate list of fields to display
--format	enum		json	Choices: "parquet", "ldjson", "json", "csv", "psv", "tsv"
--header	enum		full	Header format to include. Not applicable for "json" or "parquet" format. Choices: "none", "full", "short"
--prefer-synchronous-execution	boolean		false	Whether to prefer executing in new synchronous mode. Only applicable to json format
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse vector-query

Run a consumption layer accelerated warehouse vector query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Consumption application warehouse to run vector query against
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--entity	string	✅		Vector-search-enabled table to query
--field	string	✅		Vector-search text field to query
--content	string	✅		Text content to embed and search for
--dense-weight	number			Dense embedding weight from 0.0 to 1.0. Sparse weight is 1 - dense-weight.
--filter	string			Vector scalar filter in JSON/YAML format or path to file containing filter. Supports {field, op, value}.
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--format	enum		json	Choices: "parquet", "ldjson", "json", "csv", "psv", "tsv"
--header	enum		full	Header format to include. Not applicable for "json" or "parquet" format. Choices: "none", "full", "short"
--prefer-synchronous-execution	boolean		false	Whether to prefer executing in accelerated-worker synchronous mode. Only applicable to json format.
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application warehouse profile-query

Profile Consumption Layer Data Warehouse Query

Option	Type	Required	Default	Notes
--warehouse	string	✅		Warehouse to run query against
--application	string	✅		Id of Consumption-Layer application to which to expose installation data
--request_scope	string			Scope filter in JSON/YAML format or path to file
--application_scope	string			Id of a predefined application scope to apply
--query	string			SQL query to execute. Use "AU('entity')" syntax to refer to tables. Or path to file containing query.
--query-entity	string			Id of entity to query
--limit				Number of rows to limit result to
--skip				Number of rows to skip
--total	boolean			Whether to calculate total number of rows across all pages
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--filter	string			Filter in JSON/YAML format or path to file containing filter
--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 solution installation phase consumption application mcp

au3 solution installation phase consumption application mcp run

Run an MCP server for the consumption layer

Option	Type	Required	Default	Notes
--port		✅		port to listen on
--external-host	string			hostname of the external interface
--secure	boolean		false	whether to use HTTPS
--application	string			application id
--warehouse	string			warehouse id
--use-tb-auth	boolean		true	whether to use toolbelt token & context
--drain-ttl			30000	TTL to wait for active connections to drain
--log-level	enum		debug	Log level Choices: "fatal", "error", "warn", "info", "debug", "trace"
--prefer-synchronous-execution	boolean	✅	false	Whether to prefer executing in new synchronous mode
--tool-filter	string			tool filter in JSON/YAML format or path to file containing filter
--redirect-uris	string			Allowed redirect URIs for OAuth clients
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 solution installation phase consumption application mcp list-tools

List available MCP tools for the consumption layer

Option	Type	Required	Default	Notes
--application	string			application id
--warehouse	string			warehouse id
--tool-filter	string			tool filter in JSON/YAML format or path to file containing filter
--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

---

Generated from au3 solution installation phase consumption --help and subcommand help output.