Built-in Commands

WuttJamaican comes with one top-level command, and some subcommands.

It uses Typer for the underlying CLI framework.

wutta

This is the top-level command. Its purpose is to expose subcommands pertaining to WuttJamaican.

It is installed to the virtual environment in the bin folder (or Scripts on Windows):

cd /path/to/venv
bin/wutta --help

Defined in: wuttjamaican.cli

                                                                                
 Usage: wutta [OPTIONS] COMMAND [ARGS]...                                       
                                                                                
 Wutta Software Framework                                                       
                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config              -c      PATH  Config path (may be specified more than  │
│                                     once)                                    │
│                                     [default: None]                          │
│ --install-completion                Install completion for the current       │
│                                     shell.                                   │
│ --show-completion                   Show completion for the current shell,   │
│                                     to copy it or customize the              │
│                                     installation.                            │
│ --help                              Show this message and exit.              │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ make-appdir   Make the app dir for virtual environment                       │
│ make-uuid     Generate a new UUID                                            │
╰──────────────────────────────────────────────────────────────────────────────╯

wutta make-appdir

Make the app dir for the current virtual environment.

Defined in: wuttjamaican.cli.make_appdir

                                                                                
 Usage: wutta make-appdir [OPTIONS]                                             
                                                                                
 Make the app dir for virtual environment                                       
 See also                                                                       
 https://rattailproject.org/docs/wuttjamaican/glossary.html#term-app-dir        
                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --path        PATH  Path to desired app dir; default is (usually) `app` in   │
│                     the root of virtual environment.                         │
│                     [default: None]                                          │
│ --help              Show this message and exit.                              │
╰──────────────────────────────────────────────────────────────────────────────╯

wutta make-uuid

Print a new universally-unique identifier to standard output.

Defined in: wuttjamaican.cli.make_uuid

                                                                                
 Usage: wutta make-uuid [OPTIONS]                                               
                                                                                
 Generate a new UUID                                                            
                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯