CLI for CloudHub Applications | MuleSoft Documentation
# CLI for CloudHub Applications
Use the `cloudhub` commands to automate your CloudHub Applications Processes. For more information about how to use these commands, refer to the CloudHub documentation.
Command | Description  
---|---  
runtime-mgr:cloudhub-alert-history:describe |  Describes the history of the alarm  
runtime-mgr:cloudhub-alert:list |  Lists all alerts in the environment  
runtime-mgr:cloudhub-application:copy |  Copies a CloudHub application  
runtime-mgr:cloudhub:application:delete |  Deletes an application  
runtime-mgr:cloudhub-application:deploy |  Deploys a new application  
runtime-mgr:cloudhub-application:describe |  Shows application details  
runtime-mgr:cloudhub-application:download:logs |  Download application logs to specified directory  
runtime-mgr:cloudhub:application:list |  Lists all applications in the environment  
runtime-mgr:cloudhub-application:modify |  Modifies an existing application, optionally updating the ZIP file  
runtime-mgr:cloudhub-application:restart |  Restarts a running application  
runtime-mgr:cloudhub-application:start |  Starts an application  
runtime-mgr:cloudhub-application:stop |  Stops a running application  
runtime-mgr:cloudhub-application:tail:logs |  Tail application logs  
cloudhub:region:list |  Lists all supported regions  
cloudhub:runtime:list |  Lists all available runtimes  
## runtime-mgr:cloudhub-alert-history:describe
```
> runtime-mgr:cloudhub-alert-history:describe [flags] <name>
```

Describes the history of the alarm passed in `<name>`
Use the `--output` flag to specify the response format. Supported values are `table` (default) and `json`.
This command accepts the default flags.
## runtime-mgr:cloudhub-alert:list
```
> runtime-mgr:cloudhub-alert:list [flags]
```

Lists all alerts associated with your current environment
Use the `--output` flag to specify the response format. Supported values are `table` (default) and `json`.
This command accepts the default flags.
## runtime-mgr:cloudhub-application:copy
```
> runtime-mgr:cloudhub-application:copy <source> <target> [flags]
```

Copies the CloudHub application passed in `source` to the target passed in `target` Arguments `source` and `target` should be formatted as follows: `([group_id]/)<asset_id>/<version>` If `group_id` is not specified, it defaults to the currently selected Organization ID
For example:
```
> runtime-mgr:cloudhub-application:copy Services:QA/application-1 Development:QA/application-2
```

Copies the application named `application-1` from the QA environment of the Services organization to the QA environment of the Development organization. If the Anypoint Platform CLI is using the QA environment in the Services organization, the command can simply take the application name as a `source`:
```
> runtime-mgr:cloudhub-application:copy application-1 Development/QA/application-2
```

Running this command requires your user to have read/write access to the `/tmp` directory of the OS where CLI is installed.   
---  
In addition to the default flags, this command accepts the following flags:
Flag | Description | Example  
---|---|---  
Set a property (`name:value`). |  `--property "salesforce.password:qa\=34534"`  
This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.   
---  
When copying an application containing safely hidden application properties, pass the properties in the `copy` command using the `--property` flag. For information about safely hidden application properties, see Safely Hide Application Properties.   
---  
## runtime-mgr:cloudhub-application:delete
```
> runtime-mgr:cloudhub-application:delete [flags] <name>
```

Deletes the running application you specify in `<name>`
This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation.   
---  
This command accepts the default flags.
## runtime-mgr:cloudhub-application:deploy
```
> runtime-mgr:cloudhub-application:deploy <name> <zipfile> [flags]
```

Deploys the Mule deployable archive ZIP file that you specify in `<zipfile>` using the name you set in `<name>` You will have to provide the absolute or relative path to the deployable ZIP file in your local hard drive and the name you give to your application has to be unique.
If successful, this command’s output includes the deployment status of `UNDEPLOYED`, which indicates that CloudHub uploaded the application successfully.   
---  
In addition to the default flags, this command accepts the following flags:
Flag | Description | Example  
---|---|---  
Name and version of the runtime environment. Use this flag to specify the name and version of the runtime you want to deploy If you don’t specify a runtime version, CloudHub API deploys the latest version available considering the values you select for `--javaVersion` and `--releaseChannel`. |  `--runtime 2.1.1-API-Gateway`, `--runtime 4.6-e-java8` (Edge), `--runtime 4.6-e-java17` (Edge), `--runtime 4.6-java8` (LTS), `--runtime 4.6-java17` (LTS)  
`--releaseChannel` |  Set the name of the release channel to be used for the selected Mule version Supported values are `NONE`, `EDGE`, and `LTS` If you don’t specify a value, CloudHub API imposes the default value. The default release channel is `EDGE` If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error. |  `--releaseChannel EDGE`  
`--javaVersion` |  Set the name of the Java version to be used for the selected Mule version Supported values are `8` and `17` If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'. If you don’t specify a Mule version, the default Mule version for the selected Java version is used. If the Java version you select is not available for the specified Mule version, you get an error. |  `--javaVersion 8`  
Number of workers Default value is '1'  
`--workerSize` |  Size of the workers in vCores (Default value is '1' |  `--workerSize 2`  
Name of the region to deploy to |  `--region Canada`  
Set a property (`name:value`) Character `:` is not supported for the property’s name |  `--property "salesforce.password:qa\=34534"`  
`--propertiesFile |  Overwrite all properties with values from this file The file format is 1 or more lines in `name:value` format Set the absolute path of the properties file in your local hard drive |  `--propertiesFile exampleFile.JSON`  
`--[no-]persistentQueues` |  Enable or disable persistent queues Default value is `disabled` |  `--[no-]persistentQueues`  
`--[no-]persistentQueuesEncrypted ` |  Enable or disable persistent queue encryption Default value is `disabled` |  `--[no-]persistentQueuesEncrypted`  
`--[no-]staticIPsEnabled` |  Enable or disable static IPs Default value is `disabled` |  `--[no-]staticIPsEnabled`  
`--[no-]objectStoreV1` |  Enable or disable Object Store V `objectStoreV2` can’t also be provided when using `objectStoreV1` flag |  `--[no-]objectStoreV1`  
`--[no-]objectStoreV2` |  Enable or disable Object Store V2 `objectStoreV1` can’t also be provided when using `objectStoreV2` flag |  `--[no-]objectStoreV2`  
`--[no-]autoRestart` |  Automatically restart app when not responding Default value is `enabled` |  `--[no-]autoRestart`  
Specify the response format Supported values are `table` (default) and `json` |  `--output json`  
Set the timeout value in miliseconds Can take values between `60000` and `300000` |  `--timeout 90000`  
You won’t be able to allocate static IPs Anypoint Platform CLI. You can simply enable and disable them.   
---  
If you deploy without using any flags, your application deploys using all your default values.  
---  
This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.   
---  
## runtime-mgr:cloudhub-application:describe
```
> runtime-mgr:cloudhub-application:describe [flags] <name>
```
Displays information on the application you pass in `<name>` Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`. The command returns data such as the application’s domain, its status, the last time it was updated, the Mule version, the ZIP file name, the region, monitoring, and workers; as well as `TRUE` or `FALSE` information for persistent queues and static IPs enablement.
Use the `--output` flag to specify the response format. Supported values are `table` (default) and `json`.
This command accepts the default flags.
## runtime-mgr:cloudhub-application:download-logs
```
> runtime-mgr:cloudhub-application:download-logs [flags] <name> <directory>
```

Downloads logs the for application specified in `<name>` to the specified directory
Contrarily to what you see in the UI, the logs you download from the CLI won’t separate system logs from worker logs.
This command accepts the default flags.
## runtime-mgr:cloudhub-application:list
```
> runtime-mgr:cloudhub-application:list [flags]
```

Lists all applications available in your Anypoint Platform CLI It returns your application name, its status, the number of vCores assigned and the last time it was updated.
Use the `--output` flag to specify the response format. Supported values are `table` (default) and `json`.
This command accepts the default flags.
## runtime-mgr:cloudhub-application:modify
```
> runtime-mgr:cloudhub-application:modify <name> [zipfile] [flags]
```

Updates the settings of an existing application Optionally, you can update it by uploading a new ZIP file. This command can take all the same flags as the `deploy` command.
This command’s output includes `Status`, which is the application’s previous deployment status state.   
---  
This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.   
---  
In addition to the default flags, this command accepts the following flags:
Flag | Description | Example  
---|---|---  
Name and version of the runtime environment. Use this flag to specify the name and version of the runtime you want to deploy If you don’t specify a runtime version, CloudHub API deploys the latest version available considering the values you select for `--javaVersion` and `--releaseChannel`. |  `--runtime 2.1.1-API-Gateway`, `--runtime 4.6-e-java8` (Edge), `--runtime 4.6-e-java17` (Edge), `--runtime 4.6-java8` (LTS), `--runtime 4.6-java17` (LTS)  
`--releaseChannel` |  Set the name of the release channel to be used for the selected Mule version Supported values are `NONE`, `EDGE`, and `LTS` If you don’t specify a value, CloudHub API imposes the default value. The default release channel is `EDGE` If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error. |  `--releaseChannel EDGE`  
`--javaVersion` |  Set the name of the Java version to be used for the selected Mule version Supported values are `8` and `17` If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'. If you don’t specify a Mule version, the default Mule version for the selected Java version is used. If the Java version you select is not available for the specified Mule version, you get an error. |  `--javaVersion 8`  
Number of workers Default value is '1'  
`--workerSize` |  Size of the workers in vCores (Default value is '1' |  `--workerSize 2`  
Name of the region to deploy to |  `--region Canada`  
Set a property (`name:value`) Character `:` is not supported for the property’s name |  `--property "salesforce.password:qa\=34534"`  
`--propertiesFile |  Overwrite all properties with values from this file The file format is 1 or more lines in `name:value` format Set the absolute path of the properties file in your local hard drive |  `--propertiesFile exampleFile.JSON`  
`--[no-]persistentQueues` |  Enable or disable persistent queues Default value is `disabled` |  `--[no-]persistentQueues`  
`--[no-]persistentQueuesEncrypted ` |  Enable or disable persistent queue encryption Default value is `disabled` |  `--[no-]persistentQueuesEncrypted`  
`--[no-]staticIPsEnabled` |  Enable or disable static IPs Default value is `disabled` |  `--[no-]staticIPsEnabled`  
`--[no-]objectStoreV1` |  Enable or disable Object Store V `objectStoreV2` can’t also be provided when using `objectStoreV1` flag |  `--[no-]objectStoreV1`  
`--[no-]objectStoreV2` |  Enable or disable Object Store V2 `objectStoreV1` can’t also be provided when using `objectStoreV2` flag |  `--[no-]objectStoreV2`  
`--[no-]autoRestart` |  Automatically restart app when not responding Default value is `enabled` |  `--[no-]autoRestart`  
Specify the response format Supported values are `table` (default) and `json` |  `--output json`  
Set the timeout value in miliseconds Can take values between `60000` and `300000` |  `--timeout 90000`  
## runtime-mgr:cloudhub-application:restart
```
> runtime-mgr:cloudhub-application:restart [flags] <name>
```

Restarts the running application you specify in `<name>`
This command accepts the default flags.
## runtime-mgr:cloudhub-application:start
```
> runtime-mgr:cloudhub-application:start [flags] <name>
```

Starts the running application you specify in `<name>`
This command accepts the default flags.
## runtime-mgr:cloudhub-application:stop
```
> runtime-mgr:cloudhub-application:stop [flags] <name>
```

Stops the running application you specify in `<name>`
This command accepts the default flags.
## runtime-mgr:cloudhub-application:tail-logs
```
> runtime-mgr:cloudhub-application:tail-logs [flags] <name>
```

Tails application logs
This command accepts the default flags.
## cloudhub:region:list
```
> cloudhub:region:list [flags]
```

Lists all supported regions
Use the `--output` flag to specify the response format. Supported values are `table` (default) and `json`.
This command accepts the default flags.
## cloudhub:runtime:list
```
> cloudhub:runtime:list [flags]
```

Lists all supported runtimes
This command accepts the default flags.