Commands

All useful commands are stored and described here.

Run

Run is the most common command you will use. This is simply running your environment on the k8s cluster. It's that simple!

Examples of uses and flags:

$ k8sbox run -f|--file {environment_template.toml}

The -f or --file flag is required. It is simply the path to the environment template.

Get

Get a list of deployed environments with all the boxes inside.

Examples of uses and flags:

$ k8sbox get environment

Describe

Gets full information about the environment. Gets data from the cluster on which the environment is running.

Examples of uses and flags:

$ k8sbox describe environment -i|--id {EnvironmentID}

Delete

Similar to the run command, which performs the reverse action, removing your environment from the cluster.

Examples of uses and flags:

$ k8sbox delete -f|--file {environment_template.toml}

The -f or --file flag is mandatory. It is simply the path to the environment template. The template to be deleted is the same template that you used to start the environment.

You can also delete an environment by its ID by running the command:

$ k8sbox delete -i|--id {RunningEnvironmentID}

Resource aliases

To make k8sbox as user-friendly as possible, we made aliases for each of the entities.

environment / env / environments

application / apps / applications

box / boxes