@vaultcompass/vault-guard 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @vaultcompass/vault-guard
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @vaultcompass/vault-guard
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Requires **Node.js 22+**.
|
|
12
|
+
|
|
13
|
+
## Quickstart
|
|
14
|
+
|
|
15
|
+
**Scan a repo or file**
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
vault-guard scan .
|
|
19
|
+
vault-guard scan --staged # staged files only (hooks / CI)
|
|
20
|
+
vault-guard check src/api.ts # single file
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Block secrets at commit time**
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
vault-guard install-hook
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Machine-readable output (SARIF or JSON)**
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
vault-guard scan . --format sarif
|
|
33
|
+
vault-guard scan . --format json
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## AI editor integration
|
|
37
|
+
|
|
38
|
+
Use the MCP server package for Cursor, Claude Desktop, and other MCP-capable editors:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm install -g @vaultcompass/vault-guard-mcp
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
See [@vaultcompass/vault-guard-mcp](https://www.npmjs.com/package/@vaultcompass/vault-guard-mcp) for MCP config.
|
|
45
|
+
|
|
46
|
+
## Configuration
|
|
47
|
+
|
|
48
|
+
Create `.vault-guard.json` at your repo root to ignore paths, override severities, or add custom patterns. See the [full documentation](https://github.com/vaultcompasshq/vault-guard#configuration).
|
|
49
|
+
|
|
50
|
+
## Related packages
|
|
51
|
+
|
|
52
|
+
| Package | Purpose |
|
|
53
|
+
|---------|---------|
|
|
54
|
+
| [@vaultcompass/vault-guard-core](https://www.npmjs.com/package/@vaultcompass/vault-guard-core) | Programmatic scanning API |
|
|
55
|
+
| [@vaultcompass/vault-guard-mcp](https://www.npmjs.com/package/@vaultcompass/vault-guard-mcp) | MCP server for AI editors |
|
|
56
|
+
| [@vaultcompass/vault-guard-telemetry](https://www.npmjs.com/package/@vaultcompass/vault-guard-telemetry) | Opt-in local usage telemetry |
|
|
57
|
+
|
|
58
|
+
## Documentation
|
|
59
|
+
|
|
60
|
+
- [GitHub repository](https://github.com/vaultcompasshq/vault-guard)
|
|
61
|
+
- [Detection rules](https://github.com/vaultcompasshq/vault-guard/blob/main/docs/RULES.md)
|
|
62
|
+
- [GitHub Action](https://github.com/vaultcompasshq/vault-guard/blob/main/docs/GITHUB_ACTION.md)
|
|
63
|
+
- [Privacy & telemetry](https://github.com/vaultcompasshq/vault-guard/blob/main/docs/PRIVACY.md)
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT. [Vault & Compass LLC](https://vaultcompass.io)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaultcompass/vault-guard",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.0.4",
|
|
4
|
+
"description": "Block secrets at commit and in CI. Pre-commit hooks, SARIF output, and fast staged-file scans for AI-native workflows.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"chalk": "^4.1.2",
|
|
38
38
|
"commander": "^12.0.0",
|
|
39
|
-
"@vaultcompass/vault-guard-core": "1.0.
|
|
40
|
-
"@vaultcompass/vault-guard-telemetry": "1.0.
|
|
39
|
+
"@vaultcompass/vault-guard-core": "1.0.4",
|
|
40
|
+
"@vaultcompass/vault-guard-telemetry": "1.0.4"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@types/jest": "^30.0.0",
|