added docs for the piccolo shell run

Author: dantownsend

docs/src/piccolo/projects_and_apps/included_apps.rst

@@ -0,0 +1,84 @@
+Included Apps
+=============
+
+Just as you can modularise your own code using :ref:`apps<PiccoloApps>`, Piccolo itself
+ships with several builtin apps, which provide a lot of its functionality.
+
+Auto includes
+-------------
+
+The following are registered with your :ref:`AppRegistry<AppRegistry>` automatically:
+
+app
+~~~
+
+Lets you create new Piccolo apps. See :ref:`PiccoloApps`.
+
+.. code-block:: bash
+
+    piccolo app new
+
+asgi
+~~~~
+
+Lets you scaffold an ASGI web app. See :ref:`ASGICommand`.
+
+.. code-block:: bash
+
+    piccolo asgi new
+
+meta
+~~~~
+
+Tells you which version of Piccolo is installed.
+
+.. code-block:: bash
+
+    piccolo meta version
+
+migrations
+~~~~~~~~~~
+
+Lets you create and run migrations. See :ref:`Migrations`.
+
+playground
+~~~~~~~~~~
+
+Lets you learn the Piccolo query syntax, using an example schema. See
+:ref:`Playground`.
+
+.. code-block:: bash
+
+    piccolo playground run
+
+project
+~~~~~~~
+
+Lets you create a new ``piccolo_conf.py`` file. See :ref:`PiccoloProjects`.
+
+.. code-block:: bash
+
+    piccolo project new
+
+shell
+~~~~~
+
+Launches an iPython shell, and automatically imports all of your registered
+``Table`` classes. It's great for running adhoc database queries using Piccolo.
+
+.. code-block:: bash
+
+    piccolo shell run
+
+-------------------------------------------------------------------------------
+
+Optional includes
+-----------------
+
+These need to be explicitly registered with your :ref:`AppRegistry<AppRegistry>`.
+
+user
+~~~~
+
+Provides a user table, and commands for creating / managing users. See
+:ref:`Authentication`.

docs/src/piccolo/projects_and_apps/index.rst

@@ -11,3 +11,4 @@ application.
 
     ./piccolo_projects
     ./piccolo_apps
+    ./included_apps

docs/src/piccolo/projects_and_apps/piccolo_projects.rst

@@ -61,6 +61,8 @@ The DB setting is an ``Engine`` instance. To learn more Engines, see
 
 -------------------------------------------------------------------------------
 
+.. _AppRegistry:
+
 APP_REGISTRY
 ------------