Browse Source

Update CLI docs

Refs GH-2512
Matt Robenolt 9 years ago
parent
commit
193d48b9a1

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

@@ -3,10 +3,16 @@
 
 Delete a portion of trailing data based on creation date.
 
+All data that is older than `--days` will be deleted.  The default for
+this is 30 days.  In the default setting all projects will be truncated
+but if you have a specific project you want to limit this to this can be
+done with the `--project` flag which accepts a project ID or a string
+with the form `org/project` where both are slugs.
+
 Options
 ```````
 
 - ``--days INTEGER``: Numbers of days to truncate on.
-- ``--project INTEGER``: Limit truncation to only entries from project.
+- ``--project TEXT``: Limit truncation to only entries from project.
 - ``--concurrency INTEGER``: The number of concurrent workers to run.
 - ``--help``: print this help page.

+ 10 - 0
docs/cli/config/delete/index.rst

@@ -0,0 +1,10 @@
+`sentry config delete OPTION`
+-----------------------------
+
+Delete/unset a configuration option.
+
+Options
+```````
+
+- ``--no-input``: Do not show confirmation.
+- ``--help``: print this help page.

+ 10 - 0
docs/cli/config/get/index.rst

@@ -0,0 +1,10 @@
+`sentry config get OPTION`
+--------------------------
+
+Get a configuration option.
+
+Options
+```````
+
+- ``--silent``: Suppress extraneous output.
+- ``--help``: print this help page.

+ 20 - 0
docs/cli/config/index.rst

@@ -0,0 +1,20 @@
+`sentry config`
+---------------
+
+Manage runtime config options.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ delete <delete/index>
+ set <set/index>
+ get <get/index>
+

+ 9 - 0
docs/cli/config/set/index.rst

@@ -0,0 +1,9 @@
+`sentry config set OPTION VALUE`
+--------------------------------
+
+Set a configuration option to a new value.
+
+Options
+```````
+
+- ``--help``: print this help page.

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

@@ -3,6 +3,11 @@
 
 Sentry is cross-platform crash reporting built with love.
 
+The configuration file is looked up in the `~/.sentry` config
+directory but this can be overridden with the `SENTRY_CONF`
+environment variable or be explicitly provided through the
+`--config` parameter.
+
 Options
 ```````
 
@@ -19,6 +24,7 @@ Subcommands
  repair <repair/index>
  upgrade <upgrade/index>
  help <help/index>
+ plugins <plugins/index>
  devserver <devserver/index>
  django <django/index>
  celery <celery/index>
@@ -29,4 +35,5 @@ Subcommands
  createuser <createuser/index>
  import <import/index>
  shell <shell/index>
+ config <config/index>
 

+ 18 - 0
docs/cli/plugins/index.rst

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

+ 9 - 0
docs/cli/plugins/list/index.rst

@@ -0,0 +1,9 @@
+`sentry plugins list`
+---------------------
+
+List all installed plugins
+
+Options
+```````
+
+- ``--help``: print this help page.