CLI

• CLI COMPS Platform
• CLI Slurm Platform
• CLI Container Platform

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 Found: /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        COMPS platform related commands.
  config       Contains commands related to the creation of idmtools.ini.
  container    Container platform related commands.
  examples     Display a list of examples organized by plugin type.
  file         File platform related commands.
  gitrepo      Contains commands related to examples download.
  info         Troubleshooting and debugging information.
  init         Commands to help start or extend projects through templating.
  init-export  Export list of project templates.
  package      Contains commands related to package versions.
  slurm        Slurm platform related commands.
  version      List version info about idmtools and plugins.