CLI reference

IDM includes a command-line interface (CLI) with options and commands to assist with getting started, managing and monitoring, and troubleshooting simulations and experiments. After you’ve installed IDM you can view the available options and commands by typing the following at a command prompt

$ idmtools --help
INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools [OPTIONS] COMMAND [ARGS]...

  Allows you to perform multiple idmtools commands.

Options:
  --debug / --no-debug  When selected, enables console level logging
  --help                Show this message and exit.

Commands:
  comps_subcommand  † Warning: could not load plugin. See `idmtools
                    comps_subcommand --help`.
  config            Contains commands related to the creation of...
  examples          Display a list of examples organized by plugin type
  experiment        Contains commands related to experiments.
  gitrepo           Contains commands related to examples download
  info              Troubleshooting and debugging information
  init              Commands to help start or extend projects through...
  init-export       Export list of project templates
  local             Commands related to managing the local platform
  package           Contains commands related to package versions
  simulation        Contains commands related to simulations.
  version           List version info about idmtools and plugins