Skip to content

pypnm-cli.md

Latest commit

 

History

History
105 lines (78 loc) · 2.59 KB

pypnm-cli.md

File metadata and controls

105 lines (78 loc) · 2.59 KB

PyPNM CLI

The pypnm command is the primary CLI entrypoint for PyPNM.

Current command structure:

  • pypnm serve for starting the FastAPI service
  • pypnm config-menu for launching the interactive system configuration menu

Usage

pypnm --help

Expected top-level shape:

usage: pypnm [-h] [-v] {serve,config-menu} ...

Commands

pypnm serve

Starts the FastAPI service (pypnm.api.main:app) through Uvicorn.

Common options:

  • --host (default 127.0.0.1)
  • --host-all (bind to 0.0.0.0)
  • --port (default 8000)
  • --ssl, --cert, --key
  • --log-level {critical,error,warning,info,debug,trace}
  • --workers
  • --limit-max-requests
  • --no-access-log
  • --reload
  • --reload-dir (repeatable)
  • --reload-include (repeatable)
  • --reload-exclude (repeatable)
  • --run-background
  • --background-log-file
  • --background-pidfile
  • --mute-tags
  • --mute-tags-hard

Examples:

pypnm serve
pypnm serve --host-all --port 8080
pypnm serve --reload
pypnm serve --workers 4 --limit-max-requests 2000
pypnm serve --run-background
pypnm serve --run-background --background-log-file /var/log/pypnm.log --background-pidfile /var/run/pypnm.pid
pypnm serve --ssl --cert ./certs/cert.pem --key ./certs/key.pem
pypnm serve --mute-tags "PNM Operations - Multi-Downstream OFDM RxMER"
pypnm serve --mute-tags "Orchestrator,Operational" --mute-tags-hard

Notes:

  • --host-all is a convenience alias for binding on all IPv4 interfaces assigned to the host.
  • Use --host <ip-or-name> when you want to bind to one specific interface or address.
  • When --reload is enabled, --workers is forced to 1.
  • --run-background detaches the service, writes a pidfile, and redirects stdout/stderr to a log file.
  • --run-background cannot be used with --reload.
  • --limit-max-requests passes Uvicorn's worker recycle threshold through to the serve runtime.
  • For production memory safety, prefer multiple workers with a non-zero --limit-max-requests instead of --reload.
  • See PyPNM Worker Sizing for CPU and memory-based defaults by hardware profile.
  • --mute-tags hides matching-tag routes from OpenAPI/docs.
  • --mute-tags-hard additionally enforces 403 for matching routes.

pypnm config-menu

Launches the interactive system configuration menu (same behavior as the legacy helper script).

Example:

pypnm config-menu

Version

pypnm --version

Migration from old syntax

Old:

pypnm --reload
pypnm --host 0.0.0.0 --port 8000

New:

pypnm serve --reload
pypnm serve --host-all --port 8000