wutta/wuttjamaican
3
0
Fork 0
Code Activity

docs: stop documenting wutta command line framwework

Browse source 
as we will be deprecating and removing it at some point.  `typer`
seems to work well but any other framework could be used
This commit is contained in:
Lance Edgar 2024-06-30 20:26:25 -05:00
parent 746bcf18de
commit 4de2e6dc6e
7 changed files with 25 additions and 229 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/narr/cli/overview.rst
View file

@ -2,20 +2,14 @@
Overview
========
The command line interface is an important part of app automation and
may be thought of in a couple ways:
Many apps will need some sort of command line usage, via cron or
otherwise. There are two main aspects to it:
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
:term:`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.
But a "true" command line interface may define
:term:`commands<command>` and :term:`subcommands<subcommand>`, which
are then installed as part of a package. See :doc:`commands` for more
about that.