diff --git a/demo/sanitize-repro-bundle.sh b/demo/sanitize-repro-bundle.sh new file mode 100755 index 0000000..a1834b9 --- /dev/null +++ b/demo/sanitize-repro-bundle.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash +set -u + +ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +OUT_DIR="${TMPDIR:-/tmp}/logveil-demo" +MARKDOWN_OUT="$OUT_DIR/repro-safe.md" +JSON_OUT="$OUT_DIR/evidence.json" +AUDIT_OUT="$OUT_DIR/audit.json" + +mkdir -p "$OUT_DIR" +cd "$ROOT_DIR" + +npm run build + +node dist/cli.js redact examples/agent-session.log \ + --out "$MARKDOWN_OUT" \ + --json-out "$JSON_OUT" + +node dist/cli.js audit examples/agent-session.log \ + --format json \ + --fail-on none > "$AUDIT_OUT" + +test -s "$MARKDOWN_OUT" +test -s "$JSON_OUT" +test -s "$AUDIT_OUT" +grep -q "REDACTED" "$MARKDOWN_OUT" +grep -q "findings" "$AUDIT_OUT" + +echo "Markdown repro bundle: $MARKDOWN_OUT" +echo "JSON evidence: $JSON_OUT" +echo "Audit report: $AUDIT_OUT" diff --git a/docs/promo/repro-bundle-video-brief.md b/docs/promo/repro-bundle-video-brief.md new file mode 100644 index 0000000..7d8c260 --- /dev/null +++ b/docs/promo/repro-bundle-video-brief.md @@ -0,0 +1,25 @@ +# Short Video Brief: Sanitized Repro Bundle + +## Angle + +Show the handoff moment after an agent run fails: the log has useful evidence, +but it also contains paths, email addresses, or token-shaped strings. + +## Demo beats + +1. Open `examples/agent-session.log` and point out that it is a local fixture. +2. Run `bash demo/sanitize-repro-bundle.sh`. +3. Open `/tmp/logveil-demo/repro-safe.md` and show masked values. +4. Open `/tmp/logveil-demo/audit.json` to show automation-friendly findings. +5. Mention that source files are never mutated. + +## What to say plainly + +LogVeil is a local deterministic sanitizer for reviewable repro bundles. It is +not a complete DLP system, so sanitized output still deserves human review +before publishing. + +## Caption draft + +Agent failure logs can be useful and sensitive at the same time. LogVeil turns a +local session log into a masked repro bundle plus JSON evidence. diff --git a/docs/tutorials/sanitize-repro-bundle.md b/docs/tutorials/sanitize-repro-bundle.md new file mode 100644 index 0000000..97f926d --- /dev/null +++ b/docs/tutorials/sanitize-repro-bundle.md @@ -0,0 +1,28 @@ +# Sanitize a Repro Bundle + +This tutorial shows the smallest local workflow for turning an agent session log +into shareable Markdown plus machine-readable evidence. + +## Run it + +```sh +bash demo/sanitize-repro-bundle.sh +``` + +The script builds the CLI, redacts `examples/agent-session.log`, writes a +Markdown repro bundle, writes JSON evidence, and runs an audit report with +`--fail-on none`. + +## Outputs + +The generated files are written under `/tmp/logveil-demo`: + +- `repro-safe.md`: Markdown bundle with masked evidence. +- `evidence.json`: structured redaction evidence. +- `audit.json`: audit report for automation. + +## Review checklist + +Before publishing a repro bundle, check that the Markdown output has the +expected context, verify that sensitive values are masked, and keep the original +log private.