CLI commands
Every reware-lighthouse command and flag.
Run any command with --help for an example. reware-lighthouse --version prints the installed version.
login
Saves and checks your API key. See Sign in.
| Flag | Meaning |
|---|---|
--api-key KEY | Use this key instead of prompting. Or set LIGHTHOUSE_API_KEY. |
--api-base URL | Use a different Lighthouse API address. |
--yes, -y | Never prompt. |
logout
Deletes the saved key from this machine. A key in LIGHTHOUSE_API_KEY keeps working. Doesn't revoke the key.
init
Links the current repository and sets up the pre-commit hook and coding agents. Safe to run again. See Link a repository.
| Flag | Meaning |
|---|---|
--project owner/name | Link to this repository instead of reading the Git remote. |
--yes, -y | Accept every prompt. |
--no-hook | Skip the pre-commit hook. |
--no-mcp | Skip the agent MCP config and skill. |
--agent claude, codex, or both | Set up only this agent. |
deinit
Deletes the files init created in this repository, unless you've edited them. Keeps your key and scan reports.
status
Checks your account, repository link, and tooling. Exits non-zero when something fails. See Check your setup.
scan
Scans your staged changes. The pre-commit hook runs it. Exits with 1 only when the scan blocks the commit. Every other problem lets the commit through.
| Flag | Meaning |
|---|---|
--repo owner/name | Scan as this repository, ignoring the link file. |
--project slug | Scan as this Lighthouse project. |
--branch name | File the scan under this branch. |
--api URL | Use a different Lighthouse API address. |
--timeout SECONDS | How long to wait. Default 1,100, or LIGHTHOUSE_SCAN_TIMEOUT. |
mcp
Runs the MCP server that gives your coding agent the lighthouse_enhance_prompt tool. Your agent starts it.