Quickstart for developers
Install the CLI, link a repository, and make your first scanned commit.
Follow these steps on your machine, once per repository. When you finish, every commit you make is scanned, and your coding agent can ask Lighthouse for security guidance.
Before you start
- Your admin has invited you and added the repository to Lighthouse.
- An API key is waiting for you under Team › API keys in the dashboard. If there isn't one, ask your admin.
- Python 3.11 or newer and uv are installed.
pipxworks too.
Install the CLI
uv tool install reware-lighthouse
uv tool update-shellOpen a new terminal so reware-lighthouse is on your path.
Copy your API key
In the dashboard, go to Team › API keys and press Reveal once. Copy the key. It's shown one time only.
Sign in
reware-lighthouse loginPaste the key when asked. It's checked, then saved to ~/.config/lighthouse/config.env.
Link the repository
cd your-repo
reware-lighthouse initAnswer yes to each prompt. This installs the pre-commit hook and sets up Claude Code and Codex.
Check the setup
reware-lighthouse statusEvery line should pass. If one doesn't, it tells you what to fix.
Restart your agent
Quit Claude Code or Codex completely and open it again, so it loads the new skill.
Try it
Stage a change and commit:
git add -p
git commit -m "try lighthouse"The hook prints Running Lighthouse scan, then a summary and a link to the report. See Read a scan report.
Then give your agent a request with guidance attached:
/lighthouse-enhance add a password reset endpointSee Prompt enhancement.