CLI reference

• Templates
• Simulations
• Experiments
• Platforms
• COMPS
• Examples
• Troubleshooting

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/v1.6.2/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        COMPS Related Commands
  config       Contains commands related to the creation of idmtools.ini...
  examples     Display a list of examples organized by plugin type
  experiment   Contains commands related to experiments Some useful
               examples...

  gitrepo
  info         Troubleshooting and debugging information
  init         Commands to help start or extend projects through templating.
  init-export  Export list of project templates
  local        Commands related to managing the local platform
  simulation   Contains commands related to simulations Some useful
               examples...

  version      List version info about idmtools and plugins