Browse files

Expand command line documentation

  • Loading branch information...
dcramer committed Sep 7, 2012
1 parent 3e9fd3e commit b19b51bf9d928b3345bc0d095e5c1c919268d4b8
Showing with 8 additions and 0 deletions.
  1. +8 −0 docs/cli/index.rst
@@ -4,6 +4,11 @@ Command Line Usage
Sentry installs a command line script under the name ``sentry``. This will allow you to
perform most required operations that are unachievable within the web UI.
+If you're using a non-standard configuration location, you'll need to prefix every command with
+--config (excluding init, which is a special case). For example::
+ sentry --config=/etc/ help
For a list of commands, you can also use ``sentry help``, or ``sentry [command] --help``
for help on a specific command.
@@ -23,6 +28,9 @@ Builtin Commands
sentry init /etc/
+ .. note:: The init command requires you to pass the configuration value as the parameter whereas other
+ commands require you to use --config for passing the location of this file.
.. data:: start [services]
Starts a Sentry service. By default this value is 'http'.

0 comments on commit b19b51b

Please sign in to comment.