Browse Source

Update CLI docs

Matt Robenolt 9 years ago
parent
commit
78fa8ef1fb

+ 1 - 1
docs/cli/cleanup/index.rst

@@ -16,5 +16,5 @@ Options
 - ``--project TEXT``: Limit truncation to only entries from project.
 - ``--concurrency INTEGER``: The number of concurrent workers to run.
   [default: 1]
-- ``--quiet``: Run quietly. No output on success. default off.
+- ``-q, --silent``: Run quietly. No output on success.
 - ``--help``: print this help page.

+ 1 - 0
docs/cli/index.rst.inc

@@ -24,6 +24,7 @@ Subcommands
  repair <repair/index>
  upgrade <upgrade/index>
  help <help/index>
+ queues <queues/index>
  plugins <plugins/index>
  devserver <devserver/index>
  django <django/index>

+ 19 - 0
docs/cli/queues/index.rst

@@ -0,0 +1,19 @@
+`sentry queues`
+---------------
+
+Manage Sentry queues.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ purge <purge/index>
+ list <list/index>
+

+ 11 - 0
docs/cli/queues/list/index.rst

@@ -0,0 +1,11 @@
+`sentry queues list`
+--------------------
+
+List queues and their sizes.
+
+Options
+```````
+
+- ``-S``: Sort by size.
+- ``-r``: Reverse the sort order.
+- ``--help``: print this help page.

+ 10 - 0
docs/cli/queues/purge/index.rst

@@ -0,0 +1,10 @@
+`sentry queues purge QUEUE`
+---------------------------
+
+Purge all messages from a queue.
+
+Options
+```````
+
+- ``-f, --force``: Do not prompt for confirmation.
+- ``--help``: print this help page.

+ 10 - 0
docs/cli/repair/index.rst

@@ -3,7 +3,17 @@
 
 Attempt to repair any invalid data.
 
+This by default will correct some common issues like projects missing
+DSNs or counters desynchronizing.  Optionally it can also synchronize
+the current client documentation from the Sentry documentation server
+(--with-docs) and repair missing or broken callsigns and short IDs
+(--with-callsigns).
+
 Options
 ```````
 
+- ``--with-docs / --without-docs``: Synchronize and repair embedded
+  documentation. This is disabled by default.
+- ``--with-callsigns / --without-callsigns``: Repair and fill callsigns.
+  This is disabled by default.
 - ``--help``: print this help page.