summaryrefslogtreecommitdiff
path: root/documentation/user_guide/commands.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/user_guide/commands.rst')
-rw-r--r--documentation/user_guide/commands.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/documentation/user_guide/commands.rst b/documentation/user_guide/commands.rst
index a2db52e..2600007 100644
--- a/documentation/user_guide/commands.rst
+++ b/documentation/user_guide/commands.rst
@@ -6,3 +6,25 @@
########
Commands
########
+
+For documentation on the commands that shrinkwrap supports, add ``--help`` to
+the command line.
+
+For top-level help:
+
+.. code-block:: shell
+
+ shrinkwrap --help
+
+For help on a specific command:
+
+.. code-block:: shell
+
+ shrinkwrap inspect --help
+ shrinkwrap build --help
+ shrinkwrap run --help
+ shrinkwrap process --help
+
+.. todo::
+
+ Automate importing the help pages into this documentation.