CLI Reference¶

Foreman is invoked via the night-brownie command installed by the package.

night-brownie <command> [options]

Commands¶

night-brownie start¶

Start the Foreman harness: load configuration, initialize the memory database, start any configured agent containers, then run the GitHub poller and internal HTTP server concurrently.

night-brownie start --config <CONFIG> [--db <DB_PATH>] [--host <HOST>] [--port <PORT>]

Night Brownie runs until interrupted (SIGINT or SIGTERM). On shutdown, it cancels the poller and stops any containers it started.

Options¶

Examples¶

Start with a config file in the current directory:

night-brownie start --config config.yaml

Store the memory database in a custom location:

night-brownie start --config config.yaml --db /var/lib/night-brownie/memory.db

Bind only to localhost and use a non-default port:

night-brownie start --config config.yaml --host 127.0.0.1 --port 9000

Startup Sequence¶

When night-brownie starts running, it performs these steps in order:

1. Load and validate the configuration file. Exits with a clear error message if the file is missing, the YAML is invalid, a required field is absent, or a referenced environment variable is not set.
2. Open (or create) the SQLite memory database at --db.
3. For each agent configured with an image and a port, pull the Docker image (if not cached locally) and start the container. Exits if Docker is unavailable or a container fails its health check.
4. Log a startup summary to stdout (structured JSON via structlog).
5. Run the GitHub poller and the internal HTTP server concurrently in a single asyncio event loop.

Exit Codes¶