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
/mnt/buildbot/worker/sideshow/build/.tox/docs/lib/python3.11/site-packages/pyramid/path.py:5: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
import pkg_resources
Usage: sideshow [OPTIONS] COMMAND [ARGS]...
Sideshow -- Case/Special Order Tracker
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config -c <path> Config path (may be specified more │
│ than once) │
│ --runas <str> Username responsible for running the │
│ command (where applicable). │
│ --comment -m <str> Comment to apply to the transaction │
│ (where applicable). │
│ --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
/mnt/buildbot/worker/sideshow/build/.tox/docs/lib/python3.11/site-packages/pyramid/path.py:5: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
import pkg_resources
Usage: sideshow install [OPTIONS]
Install the Sideshow app
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯