Metadata-Version: 2.4
Name: idmtools_cli
Version: 3.1.1
Summary: CLI for IDM-Tools
Author-email: Sharon Chen <schen@idmod.org>, Clinton Collins <ccollins@idmod.org>, Zhaowei Du <zdu@idmod.org>, Mary Fisher <mfisher@idmod.org>, Clark Kirkman IV <ckirkman@idmod.org>, Benoit Raybaud <braybaud@idmod.org>
Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/idmtools
Keywords: modeling,IDM,cli
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: click~=8.1.7
Requires-Dist: click-plugins
Requires-Dist: colorama~=0.4.6
Requires-Dist: cookiecutter~=2.6
Requires-Dist: idmtools~=3.0
Requires-Dist: pyperclip~=1.8
Requires-Dist: yaspin~=3.0
Provides-Extra: test
Requires-Dist: idmtools[test]; extra == "test"

![Staging: idmtools-cli](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-cli/badge.svg?branch=dev)

# idmtools-cli

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

  - [Installing](#installing)
- [Development tips](#development-tips)
- [Using the CLI](#using-the-cli)
  - [Version command](#version-command)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installing

```bash
pip install idmtools-cli
```

# Development tips

There is a Makefile file available for most common development tasks. Here is a list of commands
```bash
clean       -   Clean up temproary files
lint        -   Lint package and tests
test        -   Run All tests
coverage    -   Run tests and generate coverage report that is shown in browser
```
On Windows, you can use `pymake` instead of `make`

# Using the CLI

`idmtools --help`

## Version command

To determine version of idmtools and related plugins, use the version cli command.


```
idmtools version
```

Example output
```bash
emodpy                               Version: 1.3.0                          
  Plugins:
    EMODTask                  
idmtools                             Version: 3.1.0                 
  Plugins:
    CommandTask               
idmtools-cli                         Version: 3.1.0                
idmtools-models                      Version: 3.1.0                 
  Plugins:
    JSONConfiguredPythonTask  
    JSONConfiguredRTask       
    JSONConfiguredTask        
    PythonTask                
    RTask                     
    ScriptWrapperTask         
    TemplatedScriptTask       
idmtools-platform-comps              Version: 3.1.0                
  Plugins:
    COMPSPlatform             
    SSMTPlatform                        
idmtools-platform-slurm              Version: 3.1.0                  
  Plugins:
    SlurmPlatform             
```

