Getting Started

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:

$ cmk
Loaded in-built API cache. Failed to read API cache, please run 'sync'.
Apache CloudStack 🐵 cloudmonkey 6.x.y
Type "help" for details, "sync" to update API cache or press tab to list options
Report issues here: https://github.com/apache/cloudstack-cloudmonkey/issues

(localcloud) 🐱 > set profile mycloud
Loaded server profile: mycloud
Url:         http://localhost:8080/client/api
Username:    admin
Domain:      /
API Key:     

(mycloud) 🐱 > set url http://myprovider.cloud/client/api
(mycloud) 🐱 > login 
✔ Username: myusername
✔ Password: **************
✔ Domain: mydomain
Successfully logged in and saved credentials to the server profile.
(mycloud) 🐱 > sync
⣟ 😺 discovering APIs, please wait...

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 and history files.