Skip to content

Commit ca5373f

Browse files
GaaraZhuclaude
andcommitted
docs: document gate log subcommand
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9d79a71 commit ca5373f

3 files changed

Lines changed: 6 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## [Unreleased]
22

3+
### 🚀 Features
4+
5+
- Add `gate log` — a live feed of interception events (matched, redacted, passed through, rejected, blocked) for confirming gate is actually working. Counts and labels only, never command lines, SQL text, or PII values. Prints recorded events and exits by default; `-f`/`--follow` keeps watching, like `docker logs -f`
6+
37
### 🐛 Bug Fixes
48

59
- Fix AU/NZ international phone numbers not matched when `+` is separated from digits by whitespace (e.g. `+ 640220831619`, `+6 40220831619`) — values are now whitespace-stripped before regex matching

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ The ones you'll use most:
245245
| `gate scan` | PII risk report across your schema |
246246
| `gate allowlist add/remove/list` | Manage column-name false positives |
247247
| `gate retro` | Protection retrospective — total queries & PII fields redacted, breakdown by tool and PII type/category, hit rate with visual progress bar, and low-confidence warnings with allowlist hints |
248+
| `gate log [-f]` | Live feed of interception events — see what gate matched, redacted, or blocked in real time. Counts and labels only, never raw command lines or PII |
248249
| `gate enable` / `gate disable` | Toggle redaction without uninstalling |
249250
| `gate validate` | Check config for errors before the first session |
250251
| `gate protect` / `gate unprotect` *(Unix only)* | Transfer config ownership to root |

docs/commands.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Full reference for every `gate` subcommand. Use `gate --help` and `gate <subcomm
1313
| `gate allowlist remove <col> [col...]` | Remove column names from the allowlist. |
1414
| `gate allowlist list` | Show the current allowlist. |
1515
| `gate retro` | Protection retrospective (a.k.a. stats / audit / report). Prints how many queries gate protected and how many PII fields it redacted, with a top-types breakdown. Reads from the on-disk stats log; disable collection with `stats.enabled: false` in config. |
16+
| `gate log [-f\|--follow] [--json] [--tool <name>] [--path bash\|mcp\|stdin]` | Live feed of interception events — which commands gate matched, redacted, passed through, rejected, or blocked. Counts and labels only, never command lines, SQL text, or PII values. Prints recorded events and exits by default; `-f`/`--follow` keeps watching for new ones, like `docker logs -f`. `--tool`/`--path` filter the feed; `--json` emits raw event lines. |
1617
| `gate enable` | Enable PII redaction (sets `enabled: true` in config). |
1718
| `gate disable` | Disable PII redaction (sets `enabled: false` in config). |
1819
| `gate validate` | Check config for errors and warnings. |

0 commit comments

Comments
 (0)