This is the shortest path from a fresh checkout to a validated local run of the Lighthouse deployment pipeline.

Table of Contents

Install

From the repository root:

python -m pip install -e .

That installs the lighthouse command into the active Python environment.

Runtime Layout

By default, the CLI runs under:

~/.lighthouse/

Important subdirectories:

  • config/ merged *.yml and *.yaml configuration files
  • cache/repos/ cloned repositories
  • states/ per-run state snapshots
  • logs/ append-only run logs

You can override the runtime root with --run-dir.

Configure

Start from the example files:

Copy them into:

~/.lighthouse/config/

Validate

Validate only the merged configuration:

lighthouse validate --config-only

Run the full pre-build validation:

lighthouse validate

Clear the cached checkouts if you want the next run to re-clone every configured repository:

lighthouse clean

Build or Deploy

Build without deployment:

lighthouse build

Deploy a new release:

lighthouse apply

Serve a local build directly:

lighthouse local 4000

More Reading