Built-in Commands¶
Sideshow comes with one top-level command, and some subcommands.
It uses Typer for the underlying CLI framework.
sideshow¶
This is the top-level command. Its purpose is to expose subcommands pertaining to Sideshow.
It is installed to the virtual environment in the bin folder (or
Scripts on Windows):
cd /path/to/venv
bin/sideshow --help
Defined in: sideshow.cli
Usage: sideshow [OPTIONS] COMMAND [ARGS]...
Sideshow -- Case/Special Order Tracker
╭─ 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 ───────────────────────────────────────────────────────────────────╮
│ install Install the Sideshow app │
╰──────────────────────────────────────────────────────────────────────────────╯
sideshow install¶
Install the web app, generating config files based on interactive prompting.
Defined in: sideshow.cli.install
Usage: sideshow install [OPTIONS]
Install the Sideshow app
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯