Browse Source

Update cli docs

sh4nks 8 years ago
parent
commit
4a67a5608c
1 changed files with 23 additions and 5 deletions
  1. 23 5
      docs/cli.rst

+ 23 - 5
docs/cli.rst

@@ -16,16 +16,17 @@ commands.
       This is the commandline interface for flaskbb.
       This is the commandline interface for flaskbb.
 
 
     Options:
     Options:
-      --version      Show the FlaskBB version.
-      --config TEXT  Specify the config to use in dotted module notation e.g.
-                     flaskbb.configs.default.DefaultConfig
-      --help         Show this message and exit.
+      --config CONFIG  Specify the config to use in dotted module notation e.g.
+                       flaskbb.configs.default.DefaultConfig
+      --version        Show the FlaskBB version.
+      --help           Show this message and exit.
 
 
     Commands:
     Commands:
       celery           Preconfigured wrapper around the 'celery' command.
       celery           Preconfigured wrapper around the 'celery' command.
       db               Perform database migrations.
       db               Perform database migrations.
       download-emojis  Downloads emojis from emoji-cheat-sheet.com.
       download-emojis  Downloads emojis from emoji-cheat-sheet.com.
       install          Installs flaskbb.
       install          Installs flaskbb.
+      makeconfig       Generates a FlaskBB configuration file.
       plugins          Plugins command sub group.
       plugins          Plugins command sub group.
       populate         Creates the necessary tables and groups for FlaskBB.
       populate         Creates the necessary tables and groups for FlaskBB.
       reindex          Reindexes the search index.
       reindex          Reindexes the search index.
@@ -185,10 +186,27 @@ of their options and arguments.
 
 
         Order by endpoint
         Order by endpoint
 
 
-    .. describe:: --methods, m
+    .. describe:: --methods, -m
 
 
         Order by methods
         Order by methods
 
 
+.. describe:: flaskbb makeconfig
+
+    Generates a FlaskBB configuration file.
+
+    .. describe:: --development, -d
+
+        Creates a development config with DEBUG set to True.
+
+    .. describe:: --output, -o
+
+        The path where the config file will be saved at.
+        Defaults to the flaskbb's root folder.
+
+    .. describe:: --force, -f
+
+        Overwrites any existing config file, if one exsits, WITHOUT asking.
+
 .. describe:: flaskbb reindex
 .. describe:: flaskbb reindex
 
 
     Reindexes the search index.
     Reindexes the search index.