Cloud Platform

CLI commands for interacting with the Silverback Platform.

silverback cluster

Manage a Silverback hosted bot cluster

For clusters on the Silverback Platform, please provide a name for the cluster to access under your platform account via -c WORKSPACE/NAME

silverback cluster [OPTIONS] COMMAND [ARGS]...

new

Create a new cluster in WORKSPACE

silverback cluster new [OPTIONS] WORKSPACE

Options

-n, --name <cluster_name>: Name for new cluster (Defaults to random)

-s, --slug <cluster_slug>: Slug for new cluster (Defaults to name.lower())

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

WORKSPACE: Required argument

update

Update name and slug for a CLUSTER

silverback cluster update [OPTIONS] CLUSTER_PATH

Options

-n, --name <name>: Update name for cluster

-s, --slug <slug>: Update slug for cluster

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

CLUSTER_PATH: Required argument

list

List available clusters in a WORKSPACE

silverback cluster list [OPTIONS] WORKSPACE

Options

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

WORKSPACE: Required argument

info

Get Configuration information about a CLUSTER

silverback cluster info [OPTIONS]

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

health

Get Health information about a CLUSTER

silverback cluster health [OPTIONS]

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

silverback cluster workspaces

View and Manage Workspaces on the Silverback Platform

silverback cluster workspaces [OPTIONS] COMMAND [ARGS]...

new

Create a new workspace

silverback cluster workspaces new [OPTIONS]

Options

-n, --name <workspace_name>: Name for new workspace

-s, --slug <workspace_slug>: Slug for new workspace

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

list

List available workspaces for your account

silverback cluster workspaces list [OPTIONS]

Options

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

info

Get Configuration information about a WORKSPACE

silverback cluster workspaces info [OPTIONS] WORKSPACE

Options

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

WORKSPACE: Required argument

update

Update name and slug for a workspace

silverback cluster workspaces update [OPTIONS] WORKSPACE

Options

-n, --name <name>: Update name for workspace

-s, --slug <slug>: Update slug for workspace

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

WORKSPACE: Required argument

delete

Delete an empty Workspace on the Silverback Platform

silverback cluster workspaces delete [OPTIONS] WORKSPACE

Options

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

WORKSPACE: Required argument

silverback cluster vars

Manage groups of environment variables in a CLUSTER

silverback cluster vars [OPTIONS] COMMAND [ARGS]...

new

Create a new group of environment variables in a CLUSTER

silverback cluster vars new [OPTIONS] NAME

Options

-e, --env <NAME=VAL>: Environment variable key and value to add (Multiple allowed)

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

list

List latest revisions of all variable groups in a CLUSTER

silverback cluster vars list [OPTIONS]

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

info

Show latest revision of a variable GROUP in a CLUSTER

silverback cluster vars info [OPTIONS] NAME

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

update

Update a variable GROUP in CLUSTER

NOTE: Changing the values of variables in GROUP by create a new revision, since variable groups are immutable. New revisions do not automatically update bot configuration.

silverback cluster vars update [OPTIONS] NAME

Options

--new-name <new_name>

-e, --env <NAME=VAL>: Environment variable key and value to add/update (Multiple allowed)

-d, --del <NAME>: Environment variable name to delete (Multiple allowed)

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

remove

Remove a variable GROUP from a CLUSTER

NOTE: Cannot delete if any bots reference any revision of GROUP

silverback cluster vars remove [OPTIONS] NAME

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

silverback cluster registry auth

Manage private container registry credentials

silverback cluster registry auth [OPTIONS] COMMAND [ARGS]...

new

Add registry private registry credentials. This command will prompt you for a username and password.

silverback cluster registry auth new [OPTIONS] NAME REGISTRY

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

REGISTRY: Required argument

list

List container registry credentials

silverback cluster registry auth list [OPTIONS]

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

info

Show info about registry credentials

silverback cluster registry auth info [OPTIONS] NAME

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

update

Update registry registry credentials

silverback cluster registry auth update [OPTIONS] NAME

Options

-r, --registry <registry>

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

remove

Remove a set of registry credentials

silverback cluster registry auth remove [OPTIONS] NAME

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

silverback cluster bots

Manage bots in a CLUSTER

silverback cluster bots [OPTIONS] COMMAND [ARGS]...

new

Create a new bot in a CLUSTER with the given configuration

silverback cluster bots new [OPTIONS] NAME

Options

-i, --image <image>: Required

-n, --network <network>: Required

-a, --account <account>

-g, --group <vargroups>

-r, --registry-credentials <registry_credentials_name>: registry credentials to use to pull the image

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

NAME: Required argument

list

List all bots in a CLUSTER (Regardless of status)

silverback cluster bots list [OPTIONS]

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

info

Get configuration information of a BOT in a CLUSTER

silverback cluster bots info [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

update

Update configuration of BOT in CLUSTER

NOTE: Some configuration updates will trigger a redeploy

silverback cluster bots update [OPTIONS] BOT

Options

--new-name <new_name>

-i, --image <image>

-n, --network <network>

-a, --account <account>

-g, --group <vargroups>

-r, --registry-credentials <registry_credentials_name>: registry credentials to use to pull the image

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

remove

Remove BOT from CLUSTER (Shutdown if running)

silverback cluster bots remove [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

health

Show current health of BOT in a CLUSTER

silverback cluster bots health [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

start

Start BOT running in CLUSTER (if stopped or terminated)

silverback cluster bots start [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

stop

Stop BOT from running in CLUSTER (if running)

silverback cluster bots stop [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

logs

Show runtime logs for BOT in CLUSTER

silverback cluster bots logs [OPTIONS] BOT

Options

-l, --log-level <log_level>: Minimum log level to display.

-s, --since <since>: Return logs since N ago.

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

errors

Show unacknowledged errors for BOT in CLUSTER

silverback cluster bots errors [OPTIONS] BOT

Options

-c, --cluster <WORKSPACE/NAME>: NAME of the cluster in WORKSPACE you wish to access

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

BOT: Required argument

silverback cluster pay

Pay for CLUSTER with Crypto using ApePay streaming payments

silverback cluster pay [OPTIONS] COMMAND [ARGS]...

create

Create a new streaming payment for a given CLUSTER

NOTE: This action cannot be cancelled! Streams must exist for at least 1 hour before cancelling.

silverback cluster pay create [OPTIONS] CLUSTER_PATH

Options

--account <account>

-t, --tier <NAME>

Named set of options to use for cluster as a base (Defaults to Standard)

Options:: Standard | Premium

-c, --config <KEY VALUE>: Config options to set for cluster (overrides values from -t/–tier selection)

--token <ADDRESS>: Token Symbol or Address to use to fund stream

--amount <VALUE>: Token amount to use to fund stream

--time <TIMESTAMP or TIMEDELTA>: Time to fund stream for

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

CLUSTER_PATH: Required argument

add-time

Fund an existing streaming payment for the given CLUSTER

NOTE: You can fund anyone else’s Stream!

silverback cluster pay add-time [OPTIONS] CLUSTER

Options

--account <account>

--amount <VALUE>: Token amount to use to fund stream

--time <TIMESTAMP or TIMEDELTA>: Time to fund stream for

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

CLUSTER: Required argument

cancel

Shutdown CLUSTER and refund all funds to Stream owner

NOTE: Only the Stream owner can perform this action!

silverback cluster pay cancel [OPTIONS] CLUSTER

Options

--account <account>

-p, --profile <PROFILE>: The authentication profile to use (Advanced)

Arguments

CLUSTER: Required argument

Cloud Platform

silverback login

silverback cluster

new

update

list

info

health

silverback cluster workspaces

new

list

info

update

delete

silverback cluster vars

new

list

info

update

remove

silverback cluster registry auth

new

list

info

update

remove

silverback cluster bots

new

list

info

update

remove

health

start

stop

logs

errors

silverback cluster pay

create

add-time

cancel