babylon

babylon¶

CLI used for cloud interactions between CosmoTech and multiple cloud environment

Usage:

babylon [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--verbosity`, `-v`	text	Either CRITICAL, ERROR, WARNING, INFO or DEBUG	`INFO`
`-n`, `--dry-run`	boolean	Will run commands in dry-run mode.	`False`
`--version`	boolean	Print version number and return.	`False`
`--log-path`	directory	Path to the directory where log files will be stored. If not set, defaults to current working directory.	`/home/runner/work/Babylon/Babylon`
`--help`	boolean	Show this message and exit.	`False`

Subcommands

api: Cosmotech API
apply: Macro Apply
destroy: Macro Destroy
init:
namespace: Babylon namespace

api¶

Cosmotech API

Usage:

babylon api [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

about: Get API about information
datasets: Dataset - Cosmotech API
organizations: Organization - Cosmotech API
runners: Runner - Cosmotech API
runs: Run - Cosmotech API
solutions: Solution - Cosmotech API
workspaces: Workspace - Cosmotech API

about¶

Get API about information

Usage:

babylon api about [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

datasets¶

Dataset - Cosmotech API

Usage:

babylon api datasets [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create:
create-part: Create dataset part
delete: Delete a dataset by ID
delete-part: Delete dataset part by ID
download-part: Download dataset part
get: Get dataset
get-part: Get dataset part
list:
list-parts: List dataset parts
query-data: Query data from a dataset part
update: Update dataset
update-part: Update dataset part

create¶

Create a dataset using a YAML payload file.

Usage:

babylon api datasets create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

create-part¶

Create dataset part

Usage:

babylon api datasets create-part [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete¶

Delete a dataset by ID

Usage:

babylon api datasets delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete-part¶

Delete dataset part by ID

Usage:

babylon api datasets delete-part [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--dpid`	text	Dataset Part ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

download-part¶

Download dataset part

Usage:

babylon api datasets download-part [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--dpid`	text	Dataset Part ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get dataset

Usage:

babylon api datasets get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get-part¶

Get dataset part

Usage:

babylon api datasets get-part [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--dpid`	text	Dataset Part ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List all datasets

Usage:

babylon api datasets list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list-parts¶

List dataset parts

Usage:

babylon api datasets list-parts [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

query-data¶

Query data from a dataset part

Usage:

babylon api datasets query-data [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--dpid`	text	Dataset Part ID	`Sentinel.UNSET`
`--selects`	text	Column names that should be part of the response data.	`Sentinel.UNSET`
`--sums`	text	Column names to sum by.	`Sentinel.UNSET`
`--avgs`	text	Column names to average by.	`Sentinel.UNSET`
`--counts`	text	Column names to count by.	`Sentinel.UNSET`
`--mins`	text	Column names to min by.	`Sentinel.UNSET`
`--maxs`	text	Column names to max by.	`Sentinel.UNSET`
`--offset`	integer	The query offset	`Sentinel.UNSET`
`--limit`	integer	The query limit	`Sentinel.UNSET`
`--group-bys`	text	Column names to group by	`Sentinel.UNSET`
`--order-bys`	text	Column names to order by. Default order is ascending.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update¶

Update dataset

Usage:

babylon api datasets update [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update-part¶

Update dataset part

Usage:

babylon api datasets update-part [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--did`	text	Dataset ID	`Sentinel.UNSET`
`--dpid`	text	Dataset Part ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

organizations¶

Organization - Cosmotech API

Usage:

babylon api organizations [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create:
delete:
get: Get organization
list:
update:

create¶

Create an organization using a YAML payload file.

Usage:

babylon api organizations create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete¶

Delete an organization by ID

Usage:

babylon api organizations delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get organization

Usage:

babylon api organizations get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List all organizations

Usage:

babylon api organizations list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update¶

Update organization

Usage:

babylon api organizations update [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

runners¶

Runner - Cosmotech API

Usage:

babylon api runners [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create:
delete: Delete a runner by ID
get: Get runner
list: List runners
start: Start a run
stop: Stop a run
update: Update runner

create¶

Create a runner using a YAML payload file.

Usage:

babylon api runners create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--sid`	text	Solution ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete¶

Delete a runner by ID

Usage:

babylon api runners delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get runner

Usage:

babylon api runners get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List runners

Usage:

babylon api runners list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

start¶

Start a run

Usage:

babylon api runners start [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

stop¶

Stop a run

Usage:

babylon api runners stop [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update¶

Update runner

Usage:

babylon api runners update [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

runs¶

Run - Cosmotech API

Usage:

babylon api runs [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

delete: Delete a run
get: Get a run
get-logs: Get run logs
get-status: Get run status
list: List runs

delete¶

Delete a run

Usage:

babylon api runs delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--rnid`	text	Run ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get a run

Usage:

babylon api runs get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--rnid`	text	Run ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get-logs¶

Get run logs

Usage:

babylon api runs get-logs [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--rnid`	text	Run ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get-status¶

Get run status

Usage:

babylon api runs get-status [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--rnid`	text	Run ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List runs

Usage:

babylon api runs list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--rid`	text	Runner ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

solutions¶

Solution - Cosmotech API

Usage:

babylon api solutions [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create:
delete: Delete a solution by ID
get: Get solution
list: List solutions
update: Update solution

create¶

Create a solution using a YAML payload file.

Usage:

babylon api solutions create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete¶

Delete a solution by ID

Usage:

babylon api solutions delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--sid`	text	Solution ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get solution

Usage:

babylon api solutions get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--sid`	text	Solution ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List solutions

Usage:

babylon api solutions list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update¶

Update solution

Usage:

babylon api solutions update [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--sid`	text	Solution ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

workspaces¶

Workspace - Cosmotech API

Usage:

babylon api workspaces [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create:
delete: Delete a workspace by ID
get: Get workspace
list:
update: Update workspace

create¶

Create a workspace using a YAML payload file.

Usage:

babylon api workspaces create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--sid`	text	Solution ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

delete¶

Delete a workspace by ID

Usage:

babylon api workspaces delete [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

get¶

Get workspace

Usage:

babylon api workspaces get [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

list¶

List all workspaces

Usage:

babylon api workspaces list [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

update¶

Update workspace

Usage:

babylon api workspaces update [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`-o`, `--output`	choice (`json` \| `yaml` \| `wide`)	Output format. One of: json, yaml, or wide	`Sentinel.UNSET`
`-f`, `--file`	text	Path to the file to save the response	`Sentinel.UNSET`
`--oid`	text	Organization ID	`Sentinel.UNSET`
`--wid`	text	Workspace ID	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

apply¶

Macro Apply

Usage:

babylon apply [OPTIONS] DEPLOY_DIR

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--var-file`	path	Specify the path of your variable file. By default, it takes the variables.yaml file.	`['./variables.yaml']`
`--include`	text	Specify the resources to deploy.	`Sentinel.UNSET`
`--exclude`	text	Specify the resources to exclude from deployment.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

destroy¶

Macro Destroy

Usage:

babylon destroy [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name without any special character	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Id without any special character	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--include`	text	Specify the resources to destroy.	`Sentinel.UNSET`
`--exclude`	text	Specify the resources to exclude from destroction.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

init¶

Scaffolds a new Babylon project structure using YAML templates.

Usage:

babylon init [OPTIONS]

Options:

Name	Type	Description	Default
`--project-folder`	text	Name of the project folder to create (default: 'project').	`project`
`--variables-file`	text	Name of the variables file (default: 'variables.yaml').	`variables.yaml`
`--help`	boolean	Show this message and exit.	`False`

namespace¶

Babylon namespace

Usage:

babylon namespace [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

get-contexts: Display the currently active namespace
get-states: Display all states in your local machine
use: Switch to a specific Babylon namespace or create a new one

get-contexts¶

Display the currently active namespace

Usage:

babylon namespace get-contexts [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

get-states¶

Display all states in your local machine

Usage:

babylon namespace get-states [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

use¶

Switch to a specific Babylon namespace or create a new one

Usage:

babylon namespace use [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--context`	text	Context Name	`Sentinel.UNSET`
`-t`, `--tenant`	text	Tenant Name	`Sentinel.UNSET`
`-s`, `--state-id`	text	State Id	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`