Update Management cli doc
@@ -13,12 +13,12 @@ Command Line tool for managing the WSO2 Micro Integrator
5. `cd` into cloned directory and then cd into `micro-integrator/cmd`
6. Execute `go mod vendor` or `go mod download` to download all the dependencies
-- ### Building
+- ### Building from source
cd into micro-integrator home directory
Execute `make install` to build both the **Micro Integrator** and **MIcro Integrator CLI** at once.
- Created packages will be available at build/target directory
+ Created Command Line tool packages will be available at cmd/build/target directory
- ### Running
Extract the compressed archive generated to a desired location.
@@ -32,7 +32,7 @@ Command Line tool for managing the WSO2 Micro Integrator
### Configuration
- ### How to Enable the Management API
- By default the Management API is disabled. To use the Management API you must use the system property `-DenableManagementInternalAPI` when starting the micro integrator
+ By default the Management Api is disabled. To use the Management Api you must use the system property `-DenableManagementApi` when starting the micro integrator
- ### Management API Address and Port
To configure the address and the port of the Management Api in the CLI use the [**init**](#init) command. This will generate a file called server_config.yaml which contains the address and the port. If the init command was not used, the address and the port will have the default values
@@ -60,9 +60,9 @@ Command Line tool for managing the WSO2 Micro Integrator
Examples:
micli init
- Follow the instructions below to configure the CLI
- Enter Host name: abc.com
- Enter Port number: 9595
+ Enter following parameters to configure the cli
+ Host name(default localhost): abc.com
+ Port number(default 9201): 9595
CLI configuration is successful
```
@@ -72,20 +72,13 @@ Command Line tool for managing the WSO2 Micro Integrator
micli show [command] [argument] [flag]
Available Commands:
- api [api-name] Get information about the API specified by argument [apiname]
- If not specified, list all the apis
- carbonapp [app-name] Get information about the Carbon App specified by argument [appname]
- If not specified, list all the carbon apps
- endpoint [endpoint-name] Get information about the Endpoint specified by argument [endpointname]
- If not specified, list all the endpoints
- inboundendpoint [inbound-name] Get information about the Inbound specified by argument [inboundname]
- If not specified, list all the inbound endpoints
- proxyservice [proxy-name] Get information about the Proxy specified by argument [proxyname]
- If not specified, list all the proxies
- sequence [sequence-name] Get information about the Sequence specified by argument [sequencename]
- If not specified, list all the sequences
- task [task-name] Get information about the Task specified by argument [taskname]
- If not specified, list all the tasks
+ api [api-name] Get information about one or more Apis
+ carbonapp [app-name] Get information about one or more Carbon Apps
+ endpoint [endpoint-name] Get information about one or more Endpoints
+ inboundendpoint [inbound-name] Get information about one or more Inbounds
+ proxyservice [proxy-name] Get information about one or more Proxies
+ sequence [sequence-name] Get information about one or more Sequences
+ task [task-name] Get information about one or more Task
Examples:
# To list all the apis
