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 a345de5 Updated Getting Started (markdown)
a345de5 is described below
commit a345de5b39d37f153a77349618708513d4f3690b
Author: Rohit Yadav <[email protected]>
AuthorDate: Thu Mar 14 12:53:11 2019 +0530
Updated Getting Started (markdown)
---
Getting-Started.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 59 insertions(+), 2 deletions(-)
diff --git a/Getting-Started.md b/Getting-Started.md
index 7cdf0a5..bd8b75f 100644
--- a/Getting-Started.md
+++ b/Getting-Started.md
@@ -1,4 +1,20 @@
-# First steps
+# Installation
+
+To install the modern Apache CloudStack cloudmonkey or `cmk`, please download
the binary from the latest release:
https://github.com/apache/cloudstack-cloudmonkey/releases
+
+## Install on Linux and Mac OSX
+
+Download the binary for Linux or Mac based on your platform and move it to a
directory that is on `$PATH` such as `/usr/local/bin`. For example:
+```
+sudo wget <file link> -O /usr/local/bin/cmk
+sudo chmod +x /usr/local/bin/cmk
+```
+
+## Install on Windows
+
+Download the Windows specific `.exe` executable file and copy it to a
directory which on the cmd's PATH such as `C:\Windows\System32\`. Launch
cmd.exe or powershell and see if you can run/access `cmk.exe`.
+
+## First steps
The default server profile has the name `localcloud` with defaults (such as
url and credentials) set to a locally running CloudStack server. Start `cmk`,
create a new server profile, configure your CloudStack server's API endpoint
and run `sync`, for example:
@@ -60,4 +76,45 @@ Try autocompletion using tabbing:
]
}
```
-Consult the API docs at http://cloudstack.apache.org/api.html
\ No newline at end of file
+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
+> list users -h
+> help listUsers
+```
+
+A typical help doc for an api will list all available acceptable arguments and
required arguments.
+
+Example help for `listUsers` API:
+```
+> list users -h
+listUsers: Lists user accounts
+API Params Type Description
+========== ==== ===========
+account string list resources by account. Must be used w
+ ith the domainId parameter.
+accounttype long List users by account type. Valid types i
+ nclude admin, domain-admin, read-only-ad
+ min, or user.
+domainid uuid list only resources belonging to the doma
+ in specified
+id uuid List user by ID.
+isrecursive boolean defaults to false, but if true, lists all
+ resources from the parent specified by
+ the domainId till leaves.
+keyword string List by keyword
+listall boolean If set to false, list only resources belo
+ nging to the command's caller; if set to
+ true - list resources that the caller i
+ s authorized to see. Default value is fa
+ lse
+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
