lea · Help

Install from source, uninstall, develop

Install from source #

git clone https://github.com/DavidGodefroid/lea.git ~/.local/share/lea-src
~/.local/share/lea-src/bin/lea init      # builds build/lea and the images (needs only Docker)
lea

lea update in a checkout pulls and rebuilds. make tmux-build builds a static tmux 3.5a into build/tmux for hosts without a recent one.

Uninstall #

lea stop --all --forget
rm -rf ~/.local/bin/lea ~/.local/share/lea-install ~/.local/share/lea ~/.config/lea
docker image ls 'ghcr.io/davidgodefroid/lea*'      # then docker image rm the ones listed

Development #

go test ./...         # Go unit tests (the tmux ones need tmux 3.2+)
make test             # shellcheck + shell unit tests, in a container
make build            # the lea:dev and lea-proxy:dev images
make test-proxy       # proxy rules against fake DNS and decoys
make test-isolation   # isolation checks (needs make build and, on Linux, lea init)
make test-pressure    # host resources on the real engine (ENGINE=podman for rootless Podman)

A tag vX.Y.Z publishes a release: the archives for Linux and macOS (amd64, arm64), their checksums, and the images on ghcr.io/davidgodefroid.

Docs are published at lockfamily.dev/docs from this repo's Markdown. Adding a file under docs/, or renaming or removing a README H2 section, needs a matching change to lockfamily's docs-site/nav.toml: open a lockfamily PR, or the nightly docs build fails.