run-obfsck

Build, run, and test the obfsck secret and PII redaction toolkit binaries.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/89jobrien/obfsck --skill run-obfsck-89jobrien
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: run-obfsck
Source: https://github.com/89jobrien/obfsck/tree/main/.claude/skills/run-obfsck
Command: npx skills add https://github.com/89jobrien/obfsck --skill run-obfsck-89jobrien

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Working with the obfsck Rust workspace requires knowing how to build its five binaries, drive each one correctly, and avoid pitfalls like gitleaks hangs and allowlisted fixture secrets. This Skill provides verified commands and gotchas for building, running, testing, and demoing the entire toolkit. ## Core Features & Use Cases - Build and Test: Compile all five binaries (redact, scan, analyzer, api, obfsck-mcp) with cargo build --release --features analyzer and run the full 203-test suite. - Demo Driver: Tour every binary via uv run demo/demo.py --bin <name>, which exercises redaction levels, diff scanning, the MCP JSON-RPC server, the analyzer CLI, and the REST API. - Direct Invocation: Pipe text through redact at minimal, standard, or paranoid levels, or query obfsck-mcp over line-delimited JSON-RPC. - Use Case: You need to demonstrate secret redaction on a log file — run the demo driver in redact mode to render before/after tables with [REDACTED-*] tokens at three obfuscation levels. ## Quick Start Ask the AI to build obfsck and run the demo driver across all binaries to see each redaction tool in action.

Frequently Asked Questions about run-obfsck

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build and run the obfsck redaction binaries?▼

Run cargo build --release --features analyzer to produce all five binaries in target/release. Then use uv run demo/demo.py --bin all to tour every binary, or invoke target/release/redact directly with piped input.

How do I redact secrets and PII from log files with obfsck?▼

Pipe text into the redact binary or pass a file path, choosing a level: minimal for secrets only, standard to add IPs, emails, and PII, or paranoid to also redact paths and hostnames. Output uses labeled tokens like [REDACTED-AWS-KEY].

Why does the scan command hang in scripted contexts?▼

Without --no-gitleaks, scan spawns the real gitleaks CLI and pipes the diff to it, which can hang past subprocess timeouts. Always pass --no-gitleaks in drivers and scripts; the demo driver does this automatically.

Why does scan report clean on a fixture containing an AWS key?▼

The repo's .obfsck.toml allowlists AKIAIOSFODNN7EXAMPLE, AWS's canonical example key, and every scan invocation loads that allowlist. Check .obfsck.toml and ~/.config/obfsck/allowlist before choosing fixture values.

Does the obfsck api binary require a working Loki backend to start?▼

No. The api binary constructs its backend clients at startup without network calls, so it binds and answers /health even with an unreachable LOKI_URL. Errors only surface on /api/analyze when it actually fetches alerts.