Tools
Tools and commands
CI calls the four published modules by path. The TS and Go builds offer the same tools as commands. Each has its own page.
Published modules
The four zero-dependency .mjs files in @catesworks/secret-scan. Consumers call them by path: scripts/secret-scan/<file>.mjs inside the installed package.
- 01
patterns.mjs
The classifier and the reviewed exceptions. The other three modules import it; you can too.
- 02
generate-gitleaks-config.mjs
Writes the generated gitleaks config from the private value rules and the whole-file exceptions.
- 03
filter-gitleaks-output.mjs
Reads a gitleaks JSON report, applies the reviewed exceptions and prints a counts-only summary.
- 04
filter-trufflehog-output.mjs
Reads trufflehog NDJSON on stdin, applies the whole-file exceptions and prints a counts-only summary.
CLI commands
Commands of the TS build (secret-scan-ts) and the Go build (secret-scan-go). Both binaries take the same commands; neither is published.
- 01
classify
Classifies a batch of name and value pairs read as JSON from stdin.
- 02
config gitleaks
Writes the generated gitleaks config.
- 03
filter gitleaks
The same JSON output as filter-gitleaks-output.mjs.
- 04
filter trufflehog
The same JSON output as filter-trufflehog-output.mjs, from NDJSON on stdin.
- 05
--version
Prints the package version and the upstream label and pin it was built from.