From ec946e1df3fa8d4ba6454c3ac53f8bb5b8372049 Mon Sep 17 00:00:00 2001 From: aviau Date: Sun, 21 Dec 2014 15:54:43 -0500 Subject: [PATCH] Documented CLI in README Change-Id: I5c7142c6c3eb370c8896249fa15e37e0bf9b27a4 --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index cb0ee75..f9286b3 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,19 @@ Python bindings to the Surveil API This is a client library for Surveil built on the Surveil API. +Command-line API +---------------- + +Installing this package gets you a shell command, ``surveil``, that you +can use to interact with the Surveil API. + +You'll need to provide the Surveil API URL. You can do this with the +``--surveil-api-url`` parameter, but it's easier to just set it as environment +variable:: + + export SURVEIL_API_URL=http://localhost:8080/v1 + +You'll find complete documentation on the shell by running ``surveil help``. Python API ----------