From d58add18fc62491b708b6a2a5ee3deb73675bdc9 Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Wed, 28 Oct 2015 14:47:24 +0100
Subject: [PATCH] Document --list-objects

---
 packages/xo-cli/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/packages/xo-cli/README.md b/packages/xo-cli/README.md
index ab2b7e019..b415a61ff 100644
--- a/packages/xo-cli/README.md
+++ b/packages/xo-cli/README.md
@@ -25,6 +25,9 @@ Usage:
   xo-cli --list-commands [--json]
     Returns the list of available commands on the current XO instance.
 
+  xo-cli --list-objects [<property>=<value>]...
+    Returns a list of XO objects.
+
   xo-cli <command> [<name>=<value>]...
     Executes a command on the current XO instance.
 ```
@@ -38,6 +41,21 @@ Successfully logged with admin@admin.net
 
 Note: only a token will be saved in the configuration file.
 
+#### List available objects
+
+Prints all objects:
+
+```
+> xo-cli --list-objects
+```
+
+It is possible to filter on object properties, for instance to prints
+all VM templates:
+
+```
+> xo-cli --list-objects type=VM-template
+```
+
 #### List available commands
 
 ```