# CLI Commands

`roostgpt ` (for mac) & `./roostGPT-win.exe `(for windows)

This command is used to run the RoostGPT CLI on your operating system.

- `-h, --help`: Displays the help message that provides information about the available options and usage.
- `roostgpt version update`: Update roostgpt version.
- `roostgpt config create`: Creates roostgpt configuration file. The configuration file contains environment variables used by RoostGPT application.  
    
    - `--output-dir, -o <path>`: Creates a configuration file in a specific directory. The configuration file contains environment variables used by the RoostGPT application. Default path is pwd.
    - `--name <name>`: Creates the configuration file with specific name. Default name is default.env.

- `roostgpt config update`: Updates the roostgpt configuration file.
    
    
    - `--config, -c <path>`: Specifies the location of the environment configuration file. The configuration file contains environment variables used by the RoostGPT application.
    - `--name <name>`: loads pwd/$name.env. It is ignored if the --file is provided.

- `roostgpt test create`: Triggers the test generation.
    
    
    - `--config,-c <path>`: Path to the configuration file if provided, Default value is pwd/default.env.
    - `--docker,-d`: Generate tests in a docker environment, see [supported features](https://docs.roost.ai/topics/trying-roostgpt/page/supported-features) to see what tool/language versions are supported.
    - `--verbose,-v`: Enable verbose logging(Debug mode).
    - <span class="s1">`--interactive, -i`: Enable interactive mode.  
        </span>
- `roostgpt test improve`: Improve the selected test based on user feedback. 
    - `--docker,-d`: Improve tests in a docker environment, see [supported features](https://docs.roost.ai/topics/trying-roostgpt/page/supported-features) to see what tool/language versions are supported.
    - `--verbose,-v`: Enable verbose logging(Debug mode).
    - <span class="s1">`--interactive, -i`: Enable interactive mode.  
          
        </span>
- `roostgpt test retrigger`: Re-trigger the chosen test from where it left off during its last execution.  
    
    - `--docker,-d`: Re-trigger tests in a docker environment, see [supported features](https://docs.roost.ai/topics/trying-roostgpt/page/supported-features) to see what tool/language versions are supported.
    - `--verbose,-v`: Enable verbose logging(Debug mode).
    - <span class="s1">`--interactive, -i`: Enable interactive mode.</span>
- <span class="s1">roostgpt test support :<span class="Apple-converted-space"> </span>Involve RoostGPT support to improve the selected test.</span>
    
    
    - <span class="s1">`--verbose,-v`: Enable verbose logging(Debug mode).  
          
        </span>
- <span class="s1">roostgpt test execute : Execute the selected test  
    </span>
    
    
    - `--docker,-d`: Re-trigger tests in a docker environment, see [supported features](https://docs.roost.ai/topics/trying-roostgpt/page/supported-features) to see what tool/language versions are supported.
    - `--verbose,-v`: Enable verbose logging(Debug mode).
    - <span class="s1">`--interactive, -i`: Enable interactive mode.</span><span class="s1">  
        </span>
    
    <span class="s1">  
    </span>
- <span class="s1">`roostgpt test view`: View all recent test plans and their triggers  
    </span>
- `roostgpt analysis`: Analyse the existing tests and scenarios and generate a report.
    
    
    - `--config,-c <path>`: Path to the configuration file if provided, Default value is pwd/default.env.
    - `--docker,-d`: Re-trigger tests in a docker environment, see [supported features](https://docs.roost.ai/topics/trying-roostgpt/page/supported-features) to see what tool/language.
    - `--verbose,-v`: Enable verbose logging(Debug mode).