NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README update.

Browse Source
This commit is contained in:
Julien Fontanet 2014-05-26 14:22:08 +02:00
parent 97ad0483ec
commit e30a7b3849
1 changed files with 34 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
packages/xo-cli/README.md
View File

@ -1,4 +1,4 @@
# XO CLI
# XO-CLI
[![Build Status](https://img.shields.io/travis/vatesfr/xo-cli/master.svg)](http://travis-ci.org/vatesfr/xo-cli)
[![Dependency Status](https://david-dm.org/vatesfr/xo-cli/status.svg?theme=shields.io)](https://david-dm.org/vatesfr/xo-cli)
[![devDependency Status](https://david-dm.org/vatesfr/xo-cli/dev-status.svg?theme=shields.io)](https://david-dm.org/vatesfr/xo-cli#info=devDependencies)
@ -18,14 +18,43 @@ npm install -g xo-cli
#### Register your XO instance
```
xo-cli register --host http://xo.my-company.net/api/ --email admin@admin.net --password admin
xo-cli --register http://xo.my-company.net/api/admin@admin.net admin
```
Note: only a token will be saved in the configuration file.
#### Adds a new Xen server
#### List available commands
```
xo-cli add-server --host xen1.my-company.net --user root --password secure%password
xo-cli --list-commands
```
#### Execute a command
The same syntax is used for all commands: `xo-cli <command> <param
name>=<value>...`
E.g., adding a new server:
```
xo-cli server.add my.server.net root secret-password
42
```
The return value is the identifier of this new server in XO.
## Contributing
Contributions are *very* welcome, either on the documentation or on
the code.
You may:
- report any [issue](https://github.com/vatesfr/xo-cli/issues)
you've encountered;
- fork and create a pull request.
## License
XO-CLI is released under the [AGPL
v3](http://www.gnu.org/licenses/agpl-3.0-standalone.html).