README update.
This commit is contained in:
parent
97ad0483ec
commit
e30a7b3849
@ -1,4 +1,4 @@
|
|||||||
# XO CLI
|
# XO-CLI
|
||||||
[](http://travis-ci.org/vatesfr/xo-cli)
|
[](http://travis-ci.org/vatesfr/xo-cli)
|
||||||
[](https://david-dm.org/vatesfr/xo-cli)
|
[](https://david-dm.org/vatesfr/xo-cli)
|
||||||
[](https://david-dm.org/vatesfr/xo-cli#info=devDependencies)
|
[](https://david-dm.org/vatesfr/xo-cli#info=devDependencies)
|
||||||
@ -18,14 +18,43 @@ npm install -g xo-cli
|
|||||||
#### Register your XO instance
|
#### 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.
|
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).
|
||||||
|
Loading…
Reference in New Issue
Block a user