Using the `toolbox` command (with examples)

Run a toolbox subcommand

To run a subcommand with toolbox, you can simply use the following syntax:

toolbox subcommand

subcommand should be replaced with the specific subcommand you want to execute, such as create, enter, rm, rmi, etc.

Motivation: Running a subcommand allows you to perform specific actions within the toolbox container environment.

Explanation: This command runs the specified subcommand within the toolbox container. It enables you to execute various actions like creating a new container, accessing an existing container, or removing containers.

Example output: For example, if you run toolbox create, it will create a new toolbox container and provide you with the relevant output based on the action.

Show help for a toolbox subcommand

If you need help with a specific toolbox subcommand, you can use the help option to get detailed usage information:

toolbox help subcommand

Replace subcommand with the specific subcommand you want help with, such as create, enter, rm, rmi, etc.

Motivation: Sometimes, you may need additional information or clarification on how to use a particular toolbox subcommand. The help option provides comprehensive usage documentation.

Explanation: This command displays the usage documentation for the specified subcommand. It provides detailed information on how to use the subcommand, including available options, arguments, and usage examples.

Example output: If you run toolbox help create, it will display the usage documentation for the create subcommand, explaining how to create a new toolbox container with various options and examples.

Show general help

To get general help for the toolbox command, you can use the --help option:

toolbox --help

Motivation: If you are new to the toolbox command and want to get an overview of its capabilities and available options, the general help option is essential.

Explanation: This command displays the general help documentation for the toolbox command. It provides an overview of the command’s purpose, usage, available options, and subcommands.

Example output: Running toolbox --help will display the general help documentation, including a description of the toolbox command, usage examples, and a list of available subcommands.

Show the toolbox version

To view the version of the toolbox command installed on your system, use the --version option:

toolbox --version

Motivation: Knowing the version of the toolbox command can be useful for troubleshooting purposes or understanding if you have the latest version installed.

Explanation: This command displays the version of the toolbox command installed on your system.

Example output: Running toolbox --version will output the version number of the toolbox command, such as toolbox 0.0.1 indicating you have version 0.0.1 installed.