wutta/wuttjamaican
3
0
Fork 0
Code Activity

Add a large chunk of the docs for command line interface

Browse source 
will have to finish subcommands later
This commit is contained in:
Lance Edgar 2023-11-22 21:40:26 -06:00
parent 8a4438c725
commit af4c28b286
15 changed files with 371 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/narr/cli/overview.rst Normal file
View file

@ -0,0 +1,21 @@
Overview
========
The command line interface is an important part of app automation and
may be thought of in a couple ways:
First there is the :term:`ad hoc script` which is a single file and
can be placed anywhere, but is not installed as part of a package.
See :doc:`scripts`.
But the "real" command line interface uses :term:`commands<command>`
and :term:`subcommands<subcommand>`; these are installed as part of a
package.
Top-level commands are mostly just a way to group subcommands. Most
custom apps would define their own top-level command as well as
multiple subcommands. See :doc:`commands` for top-level details.
Subcommands on the other hand are the real workhorse since they define
the action logic. See :doc:`subcommands` for more about those.