Commands and Flags

Table of Contents


We present the various commands, subcommands and flags available with TFROBOT.


You can run the command tfrobot help at any time to access the help section. This will also display the available commands.

completionGenerate the autocompletion script for the specified shell
helpHelp about any command
versionGet latest build tag

Use tfrobot [command] --help for more information about a command.


You can use subcommands to deploy and cancel workloads on the TFGrid.

  • deploy: used to mass deploy groups of vms with specific configurations
    tfrobot deploy -c path/to/your/config.yaml
  • cancel: used to cancel all vms deployed using specific configurations
    tfrobot cancel -c path/to/your/config.yaml
  • load: used to load all vms deployed using specific configurations
    tfrobot load -c path/to/your/config.yaml


You can use different flags to configure your deployment.

-cused to specify path to configuration file
-oused to specify path to output file to store the output info in
-dallow debug logs to appear in the output logs

Note: Make sure to use every flag once. If the flag is repeated, it will ignore all values and take the last value of the flag.`

Last change: 2024-02-27