From ab7fd3d019a80645e20668eade6572aee67fdd2e Mon Sep 17 00:00:00 2001 From: Julien Fontanet Date: Mon, 28 Jul 2014 15:32:55 +0200 Subject: [PATCH] README update. --- packages/xo-cli/README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/packages/xo-cli/README.md b/packages/xo-cli/README.md index 71f7f07a1..c782268a1 100644 --- a/packages/xo-cli/README.md +++ b/packages/xo-cli/README.md @@ -15,10 +15,25 @@ npm install -g xo-cli ## Usage +``` +> xo-cli --help +Usage: + + xo-cli --register [] [] [] + Registers the XO instance to use. + + xo-cli --list-commands [--json] + Returns the list of available commands on the current XO instance. + + xo-cli [=]... + Executes a command on the current XO instance. +``` + #### Register your XO instance ``` -xo-cli --register http://xo.my-company.net/api/ admin@admin.net admin +> xo-cli --register http://xo.my-company.net admin@admin.net admin +Successfully logged with admin@admin.net ``` Note: only a token will be saved in the configuration file. @@ -26,7 +41,7 @@ Note: only a token will be saved in the configuration file. #### List available commands ``` -xo-cli --list-commands +> xo-cli --list-commands ``` #### Execute a command @@ -37,7 +52,7 @@ name>=...` E.g., adding a new server: ``` -xo-cli server.add my.server.net root secret-password +> xo-cli server.add host=my.server.net username=root password=secret-password 42 ```