This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git
The following commit(s) were added to refs/heads/master by this push:
new 6a13985 Updated Getting Started (markdown)
6a13985 is described below
commit 6a13985ae71d608eb2e98c0b22eb28b222e3f6a2
Author: Rohit Yadav <[email protected]>
AuthorDate: Thu Mar 14 13:02:43 2019 +0530
Updated Getting Started (markdown)
---
Getting-Started.md | 98 ++++++++++++++++++++++++++++++++----------------------
1 file changed, 58 insertions(+), 40 deletions(-)
diff --git a/Getting-Started.md b/Getting-Started.md
index 3cc7b77..ec4ce11 100644
--- a/Getting-Started.md
+++ b/Getting-Started.md
@@ -39,51 +39,30 @@ Discovered 610 APIs
```
You can also use the `set` command to set the various server profile specific
options. The cloudmonkey configuration is stored at `~/.cmk/config` file. The
`~/.cmk` directory also contains the API cache at `~/.cmk/profiles`.
-## Making API requests
-
-Try autocompletion using tabbing:
-
-```
-> <tab><tab>
-> list <tab><tab>
-> list users <tab><tab> # for options
-> list users <press enter>
-> list users
-{
- "count": 1,
- "user": [
- {
- "account": "admin",
- "accountid": "79665239-3cd4-11e9-bf33-f4d1082409e6",
- "accounttype": 1,
- "apikey": "...redacted...",
- "created": "2019-03-02T15:48:07+0000",
- "domain": "ROOT",
- "domainid": "7965d079-3cd4-11e9-bf33-f4d1082409e6",
- "email": "[email protected]",
- "firstname": "Admin",
- "id": "7966afa9-3cd4-11e9-bf33-f4d1082409e6",
- "iscallerchilddomain": false,
- "isdefault": true,
- "lastname": "User",
- "roleid": "852a28b1-3cd4-11e9-bf33-f4d1082409e6",
- "rolename": "Root Admin",
- "roletype": "Admin",
- "state": "enabled",
- "username": "admin",
- "usersource": "native"
- }
- ]
-}
-```
-Consult the API docs at http://cloudstack.apache.org/api.html
-
## Getting help
Help for any API command can be obtained using `<cmd> -h`, for example:
```
> help
+usage: cmk [flags] [commands|apis] [-h]
+
+CloudMonkey (cmk) 🐵 is a command line interface for Apache CloudStack.
+
+Allowed flags:
+ -h Show this help message or API doc when specified after an API
+ -v Print version
+ -o API response output format: json, text, table, column, csv
+ -p Server profile
+ -d Enable debug mode
+
+Default commands:
+ exit Exits
+ help Help
+ set Configures options for cmk
+ sync Discovers and updates APIs
+ version Version info
+
> list users -h
> help listUsers
```
@@ -117,4 +96,43 @@ page integer
pagesize integer
state string List users by state of the user account.
username string List user by the username
-```
\ No newline at end of file
+```
+
+## Making API requests
+
+Try autocompletion using tabbing:
+
+```
+> <tab><tab>
+> list <tab><tab>
+> list users <tab><tab> # for options
+> list users <press enter>
+> list users
+{
+ "count": 1,
+ "user": [
+ {
+ "account": "admin",
+ "accountid": "79665239-3cd4-11e9-bf33-f4d1082409e6",
+ "accounttype": 1,
+ "apikey": "...redacted...",
+ "created": "2019-03-02T15:48:07+0000",
+ "domain": "ROOT",
+ "domainid": "7965d079-3cd4-11e9-bf33-f4d1082409e6",
+ "email": "[email protected]",
+ "firstname": "Admin",
+ "id": "7966afa9-3cd4-11e9-bf33-f4d1082409e6",
+ "iscallerchilddomain": false,
+ "isdefault": true,
+ "lastname": "User",
+ "roleid": "852a28b1-3cd4-11e9-bf33-f4d1082409e6",
+ "rolename": "Root Admin",
+ "roletype": "Admin",
+ "state": "enabled",
+ "username": "admin",
+ "usersource": "native"
+ }
+ ]
+}
+```
+Consult the API docs at http://cloudstack.apache.org/api.html
\ No newline at end of file
