npm package: @inmation/inmation-compose-cli
Description: inmation-compose command line application
Author: Marc van de Langenberg
Latest version: 0.2.12

# inmation-compose-cli

inmation-compose command line interface is a versatile and powerful tool designed to streamline the configuration process of AspenTech Inmation platforms.

Read the documentation of the Visual Studio Code Extension. See [inmation-compose-vscode-extension](https://marketplace.visualstudio.com/items?itemName=inmation.inmation-compose-vscode-extension) for more information.

## Disclaimer

AspenTech Inmation is a registered trademark of Aspen Technology, Inc. further referred to as AspenTech.

This application, is provided for convenience purposes only and is not an official product of AspenTech. While every effort has been made to ensure its functionality and reliability, it is important to note that this tool has not undergone formal quality assurance testing or approval by AspenTech.

The creators of this application have developed it to facilitate easy and powerful configuration of inmation platforms. However, AspenTech does not endorse or guarantee the accuracy, completeness, or suitability of this application for any particular purpose.

Users of this application should understand that it is provided on an "as-is" basis, and AspenTech shall not be held liable for any direct, indirect, incidental, special, or consequential damages arising from its use. 

By using this application, you acknowledge and agree that you do so at your own risk. While efforts have been made to minimize errors and bugs, AspenTech cannot guarantee that the application will be free from defects or that it will meet your specific requirements.

This disclaimer is subject to change without notice. Please review the latest version of this disclaimer regularly.

Thank you for your understanding.

## Install

Install with `npm install -g @inmation/inmation-compose-cli`

## Commands

- `connect`: Connection test
- `run`: Run an action
- `template`: Generate template files

## Options

| short | option | description |
| --- | --- | ---|
| `-c` | `--connect` | Points to a connection in the inmation-compose.json file
| `-a` | `--action` | Points to an action name in the inmation-compose.json file
| `-u` | `--username` | Username
| `-p` | `--password` | Password
| | `--authority` | Authority (builtin, ad, machine)
| | `--authorization` | Basic or Bearer authentication
| | `--comment` | Audit Trail comment

### Connect

Connect and use the credentials in the inmation-compose.json file.

```cmd
inmation-compose connect -c Server01
```

Connect and override the credentials with the provided username and password.

```cmd
inmation-compose connect -c Server01 -u username -p password
```

Connect and override the credentials with the provided username, password and authority.

```cmd
inmation-compose connect -c Server01 -u username -p password --authority ad
```

Connect and override the credentials with the provided basic token.

```cmd
inmation-compose connect -c Server01 --authorization "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
```

## Run Action

Note: Use in combination with the options above.

Run action with the provided action name.

```cmd
inmation-compose run -c Server01 -a Action1
```

Overrule the comment in the action.

```cmd
inmation-compose run -c Server01 -a Action1 --comment "This is a test"
```

## Template files

```cmd
inmation-compose template
```