Bytewax CLI

The Bytewax Command-Line Interface ships with the Python SDK. The CLI has the following available commands.

login

Login to Bytewax. This will authenticate you to start accessing/modifying resources. You will be taken to a browser login screen.

waxctl login

logout

Logout of Bytewax. Destroys your current session.

waxctl logout

deploy

deploy or upgrade a Swarm with a swarm definition file.

waxctl deploy [OPTIONS] SWARM_DEFINITION_FILE

delete-swarm

Delete a Swarm. This is permanent.

waxctl delete-swarm [OPTIONS] SWARM_NAME

get-bee

Get information about a single Bee in a Swarm.

waxctl get-bee [OPTIONS] SWARM_NAME BEE_NAME

get-bee-logs

Get the logs of a Bee, including the logs of a Bee which may have been terminated because of an error.

waxctl get-bee-logs [OPTIONS] SWARM_NAME BEE_NAME

get-bees

Get a summary of all the Bees in a Swarm.

waxctl get-bees [OPTIONS] SWARM_NAME

get-swarm

Get the information associated with a certain Swarm.

waxctl get-swarm [OPTIONS] SWARM_NAME

list-swarms

List all swarms on the cluster.

waxctl list-swarms [OPTIONS]