@vaultcompass/vault-guard
v1.1.0
Published
Block secrets at commit and in CI. Pre-commit hooks, SARIF output, and fast staged-file scans for AI-native workflows.
Maintainers
Readme
@vaultcompass/vault-guard
Catch secrets at commit and in CI, not after they are in your git history. Pre-commit hooks across every hook manager, fast staged-file scans, and SARIF for GitHub Code Scanning. Built for paste-heavy AI coding workflows.
Install
npm install -g @vaultcompass/vault-guardRequires Node.js 22+.
Quickstart
Scan a repo or file
vault-guard scan .
vault-guard scan --staged # staged files only (hooks / CI)
vault-guard check src/api.ts # single fileBlock secrets at commit time
vault-guard install-hookMachine-readable output (SARIF or JSON)
vault-guard scan . --format sarif
vault-guard scan . --format jsonAI editor integration
Use the MCP server package for Cursor, Claude Desktop, and other MCP-capable editors:
npm install -g @vaultcompass/vault-guard-mcpSee @vaultcompass/vault-guard-mcp for MCP config.
Configuration
Create .vault-guard.json at your repo root to ignore paths, override severities, or add custom patterns. See the full documentation.
Related packages
| Package | Purpose | |---------|---------| | @vaultcompass/vault-guard-core | Programmatic scanning API | | @vaultcompass/vault-guard-mcp | MCP server for AI editors | | @vaultcompass/vault-guard-telemetry | Opt-in local usage telemetry |
Documentation
License
MIT. Vault & Compass LLC
