Quickstart

Install

The npm package installs the native locguard binary:

npm install -g locguard-cli

Native archives and shell/PowerShell installers are also attached to GitHub Releases.

Run it

No initialization or config file is required:

locguard

Inside a Git repository, bare locguard checks staged, unstaged, and nonignored untracked source files. If nothing eligible changed:

✓ no source files changed

When files changed:

✓ 7 files checked

A file above the default 1,000-line limit fails:

FAIL src/runtime.rs  >1000

1 file exceeds the 1000-line limit

Check the whole repository

Use the full scan for CI, pre-push checks, and repository audits:

locguard scan

The scan includes tracked files and nonignored untracked files while skipping high-confidence dependency, vendor, generated, cache, and build-output trees.

Customize only when needed

locguard init is optional. Run it only when the defaults need project-specific customization:

locguard init

It creates .agents/.locguard.toml. Most repositories should not need one.