Skip to main content

reware-lighthouse

reware-lighthouse connects your Git repository to Lighthouse, so your coding agent gets security guidance for your codebase and every commit is scanned before it lands.

It works with Claude Code and Codex on macOS, Linux, and Windows, and needs Python 3.11 or newer. On Windows, the pre-commit hook runs through Git for Windows.

Quickstart

$ uv tool install reware-lighthouse    # or: pipx install reware-lighthouse
$ reware-lighthouse login              # paste the API key from your dashboard
$ cd your-repo
$ reware-lighthouse init
$ reware-lighthouse status

Restart your coding agent afterward so it picks up the new skill and MCP server.

What just happened?

  1. login verified your API key and saved it to ~/.config/lighthouse/config.env.
  2. init linked the repository to its Lighthouse project, installed a pre-commit hook, and added the agent skill.
  3. status checked that your account, project link, and tooling all work.

You'll need an API key first. Create one on the Lighthouse dashboard. It's shown once, so copy it right away.

Enhance a coding request

Enhancement adds your repository's security rules to a request before your agent starts coding. It only runs when you ask for it, so ordinary requests are never changed.

In Claude Code:

/lighthouse-enhance add a password reset endpoint

In Codex, invoke the lighthouse-enhance skill with the same request.

Your agent tells you which branch's rules it used, plus any warnings, such as a branch that has no repository-specific rules yet. If enhancement fails, the agent stops and asks before continuing without it. Every enhancement appears in your dashboard history.

To pick a branch, start the request with --branch:

/lighthouse-enhance --branch release add a password reset endpoint

Without the flag, Lighthouse uses the branch attached to your checkout, then the project's default branch.

Scan commits

The pre-commit hook runs reware-lighthouse scan on your staged changes. Whether a finding blocks the commit depends on the blocking policy saved for your project.

If the API is unreachable or the scan times out, the commit goes through. To change the timeout, set LIGHTHOUSE_SCAN_TIMEOUT to a number of seconds.

What init creates

Path Purpose
~/.config/lighthouse/config.env (mode 0600) Your API key, written by login. Never inside a repository.
.lighthouse/project.toml The link to your project (owner/name). It holds no secret, so it's safe to commit.
.git/hooks/pre-commit A marked block that runs the scan. If a hook already exists, the block is appended.
.mcp.json, .codex/config.toml The MCP server entry that runs reware-lighthouse mcp.
.claude/skills/lighthouse-enhance/, .agents/skills/lighthouse-enhance/ The enhance skill, set to run only when you invoke it.

Use --agent, --no-hook, or --no-mcp to set up less. If a step can't finish, init reports which items were created, which were already in place, and which need you. Rerunning it is safe.

Note that init never edits shared hook setups. If Git uses a shared or global hooks directory (core.hooksPath pointing outside the repository), or you use the pre-commit framework, add reware-lighthouse scan to that hook yourself. Edits you make to files init created are preserved.

Commands

Command What it does
login Saves and verifies your API key. Accepts --api-key, --api-base, and --yes to skip prompts.
logout Removes the saved key. A key set in the environment stays active.
init Links the repository and sets up the hook, MCP config, and skill.
deinit Removes what init created here, as long as you haven't edited it. Your key and scan reports stay.
status Checks your account, project link, and tooling. Exits nonzero if something's wrong.
scan Scans staged changes. Accepts --project, --repo, and --branch. The hook runs it for you.
mcp Runs the MCP server over stdio. Your agent starts it, so you rarely run it by hand.

Run any command with --help for an example.

Environment variables

Variable Meaning
LIGHTHOUSE_API_KEY Your API key. It works without login, and logout doesn't remove it.
LIGHTHOUSE_API_BASE_URL Use a different Lighthouse API endpoint.
LIGHTHOUSE_PROJECT Use this project instead of the link file or Git remote.
LIGHTHOUSE_SCAN_TIMEOUT Scan timeout in seconds.

What leaves your machine

  • Enhancement sends the request you give the skill, plus the repository and branch. Lighthouse stores the original and enhanced prompts and shows them in your dashboard history.
  • Pre-commit scans send your staged diff.

Scanning has known gaps in coverage and reporting that we're still working on. Treat it as one safeguard, not the only one.

Update

$ uv tool upgrade reware-lighthouse    # or: pipx upgrade reware-lighthouse

If the API needs a newer version, commands tell you to upgrade and show the commands above.

Uninstall

Clean up before you remove the tool. Once it's gone, nothing is left to run deinit or logout.

$ reware-lighthouse deinit             # in each repository you set up
$ reware-lighthouse logout
$ uv tool uninstall reware-lighthouse  # or: pipx uninstall reware-lighthouse

logout only removes the key from your machine. To revoke it, ask an admin to rotate or delete it on the dashboard.

License

Proprietary. See LICENSE.

Metadata

Release files for reware-lighthouse 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reware-lighthouse 0.1.0
File Size Uploaded Provenance
reware_lighthouse-0.1.0.tar.gz 31.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for reware-lighthouse 0.1.0
File Interpreter ABI Platform
reware_lighthouse-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 74.3 kB

Release files / reware_lighthouse-0.1.0.tar.gz

Download URL reware_lighthouse-0.1.0.tar.gz
Size 31.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a4944d404b9309eafe1857a716f73774428e82d6808085590e0766b02e8c9bd3
BLAKE2b-256 checksum
How to use checksums
77e1bc69fc68edce620c71a1267171fb14c0cccb3d6ea0d21569a1482ac7a969
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / reware_lighthouse-0.1.0-py3-none-any.whl

Download URL reware_lighthouse-0.1.0-py3-none-any.whl
Size 42.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
424b8252fbe59f655875223cc6979d5f149b758e68bb65cb816805b897030040
BLAKE2b-256 checksum
How to use checksums
aa9a0d34d82e79a82e3befd1ceefd536b765cf844d35095a553689c0c2cad666
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for reware-lighthouse 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page