CLI Local Platform¶
IDM includes commands for managing the local platform. To see the list of commands type the following at a command prompt.
$ idmtools local --help You are using a development version of idmtools, version 1.7.1+nightly! INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini Usage: idmtools local [OPTIONS] COMMAND [ARGS]... Commands related to managing the local platform Options: --run-as TEXT Change the default user you run docker containers as. Useful is situations where you need to access docker with sudo. Example values are "1000:1000" --help Show this message and exit. Commands: down Shutdown the local execution platform(and optionally delete data. info restart Restart the local execution platform. start Start the local execution platform. status Check the status of the local execution platform. stop Stop the local platform.
The platform settings are contained in the idmtools.ini file. For more information, see Configuration.