lighthouse
lighthouse is the deployment and content-materialization CLI for
Peisong's Lighthouse. It pulls configured repositories, discovers
tracked Markdown, rewrites local references into site URLs, generates
Jekyll-ready posts, builds the site, deploys timestamped releases, and
optionally emails run logs through SMTP.
Table of Contents
Docs
- Start here:
docs/quickstart.mdInstall the CLI, lay out the runtime directory, validate config, and run local or deploy builds. - Design:
docs/design.mdPipeline stages, state model, deployment layout, and content rewrite rules. - Configuration:
docs/configuration.mdFull YAML schema, defaults, validation rules, and command behavior.
Installation
Install into the local Python environment:
python -m pip install .
For development:
python -m pip install -e .
Command Summary
lighthouse --help
lighthouse --version
lighthouse [--run-dir PATH] [--config PATH] [--verbose] [--dry-run] [--email-log] validate [--config-only] [--no-sync]
lighthouse [--run-dir PATH] [--config PATH] [--verbose] [--dry-run] [--email-log] build [--no-sync]
lighthouse [--run-dir PATH] [--config PATH] [--verbose] [--dry-run] [--email-log] apply [--no-sync]
lighthouse [--run-dir PATH] [--config PATH] [--verbose] [--dry-run] clean
lighthouse [--run-dir PATH] [--config PATH] [--verbose] status
lighthouse [--run-dir PATH] [--config PATH] [--verbose] list-backups
lighthouse [--run-dir PATH] [--config PATH] [--verbose] [--dry-run] local 4000 [--no-sync]
lighthouse [--run-dir PATH] [--config PATH] [--verbose] email-test you@example.com
Default Runtime Layout
~/.lighthouse/
config/
*.yml
*.yaml
cache/
repos/
states/
state-<timestamp>.json
logs/
<timestamp>.log
lock
Examples
Example configuration fragments: