README.md in cloudstack-cli-0.0.5 vs README.md in cloudstack-cli-0.1.0
- old
+ new
@@ -1,8 +1,8 @@
# Cloudstack CLI
-Cloudstack CLI gives command line access to the CloudStack API commands.
+Cloudstack CLI is a [CloudStack](http://cloudstack.apache.org/) API client written in Ruby.
## Installation
Install the cloudstack-cli gem:
@@ -10,11 +10,11 @@
## Setup
Create the initial configuration:
- cs setup
+ $ cs setup
cloudstack-cli expects to find a configuartion file with the API URL and your CloudStack credentials in your home directory named .cloudstack-cli.yml. If the file is located elsewhere you can specify the loaction using the --config option.
Example content of the configuration file:
@@ -38,27 +38,27 @@
### Example 2
Run a custom API command:
- cs command listAlerts type=8
+ $ cs command listAlerts type=8
### Example 3
Sort all computing offerings by CPU and Memory grouped my Domain:
- cs offering sort
+ $ cs offering sort
### Example 4
Stop all virtual routers of project Demo (you could filter by Zone too):
(This command is helpful if you have to deploy new versions of Cloudstack when using redumdant routers)
- cs router list --project Demo --status running --redundant-state BACKUP --command stop
+ $ cs router list --project Demo --status running --redundant-state BACKUP --command stop
Hint: You can watch the status of the command with watch.
- watch -n cs router list --project Demo
+ $ watch -n cs router list --project Demo
## References
- [Cloudstack API documentation](http://cloudstack.apache.org/docs/api/apidocs-4.1/TOC_Root_Admin.html)
- This tool was inspired by the Knife extension for Cloudstack: [knife-cloudstack](https://github.com/CloudStack-extras/knife-cloudstack)