agentleFS
flurdyflurdy/agent-skills/skills/artifact-hygiene/SKILL.md

artifact-hygiene

Skill9 starsChanged 3 months agoMITView on GitHub

Run a local-only, read-only advisory audit of publishable working-tree files and unpublished branch history with redaction-safe findings.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the local-only proof of concept that checks whether repository content is safe to publish.

    line 14
  2. Distinctive:

    Only valid IDs from clone-local Git configuration are honored.

    line 131
  3. Distinctive:

    After independently reviewing the unscanned content, a clone may allow exactly that blob:

    line 146
  4. Distinctive:

    Only lowercase, full-length IDs matching the repository object format are accepted (multi-valued or comma-separated).

    line 152
  5. Distinctive:

    If status is partial or failed, name the unavailable coverage and stop short of publication assurance.

    line 261
  6. Distinctive:

    Never recover raw evidence by reading a reported file, commit, scanner output, temporary file, or repository configuration.

    line 264

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Artifact Hygiene

Run the local-only proof of concept that checks whether repository content is safe to publish. The helper is the only component allowed to read candidate content. The active model receives normalized, redacted findings and coverage—not raw candidate content. Claude Code uses the Sonnet alias for this bounded interpretation; Pi continues to route by model-tier.

This skill is advisory and read-only. It never fetches, follows links, calls remote services, validates credentials, installs hooks, blocks CI, edits files, changes Git state, rewrites history, or creates tracker or remote state.

Placement and enforcement

The helper and skill remain together under ~/.agents/skills/ as the portable, client-neutral audit discovered by Pi, Claude Code, and Codex. The model can render its redacted advisory report; a hook cannot. Enforcement therefore stays in thin client-specific hooks that call the helper and map its result to allow or deny, such as the Claude Code push gate in ai-tools, without copying detectors or report logic.

Scope

The proof of concept scans:

  • the full publishable working tree: tracked regular text files plus staged, unstaged, and untracked-not-ignored regular text files; and
  • unpublished branch commit messages and per-path patches relative to a locally available default-branch ref, without fetching. If no remote-backed base is available, it scans all commits reachable from HEAD rather than treating the current local branch as published.

History is scanned through bounded per-record stdin calls, not an unrestricted scanner Git walk. Patches use uncolored, separate-parent unified diffs with root-commit patches enabled, regardless of local presentation settings. Hunk-aware, LF-delimited extraction preserves added content beginning with ++, including lines resembling file headers; unsupported hunk formats produce partial coverage, never a clean result. Hunk offsets map every added line back to its file line, so history findings report the file line rather than the position among a commit's added lines. Blob sizes are checked before generating patches; deletions introduce no content. When a large predecessor becomes a small file, the full new file is scanned conservatively instead of building a huge deletion patch. Such findings can include unchanged lines. Repository diff attributes cannot hide text, and paths are treated literally.

It uses an audit-owned Gitleaks configuration and empty ignore file, scrubs scanner configuration from the environment, ignores inline scanner allow-comments, and never passes a baseline. Repository scanner configuration cannot suppress the audit. Before any clean result, a private runtime canary must prove that the selected scanner and audit configuration can detect the pinned secret shape. The helper also reports known session-share links, Bead references, email addresses, name-like personal data (personal names), AI attribution trailers or boilerplate, and scanner-suppression controls without exposing matched values.

The custom-detectors coverage source proves every built-in non-secret detector still matches its private canary. Missing detector coverage produces a partial result, never a clean result. Personal-name detection is advisory and contextual: it detects direct requests to contact a named person or handle, not capitalized technical phrases. Expected Co-authored-by: and Signed-off-by: trailers are excluded from personal-data findings. Bead-reference, personal-data, and AI-attribution detectors scan unpublished history only—commit messages and added patch lines—rather than re-reporting content already published on the base branch. Bead references and personal-data matches in dependency lockfiles are ignored, as are email addresses under reserved example domains. Email addresses in the owner, created_by, and assignee fields of Beads .beads/issues.jsonl records are treated as structural attribution; unrelated fields remain reportable.

The Bead-reference detectors are split by certainty. beads.reference matches known prefixes with any 3–8 character base36 suffix and optional .N children, and blocks new content. beads.generic-shape matches any other hyphenated word whose 3–8 character suffix contains both letters and digits (for example non-auth0); it is a low-confidence advisory finding whose remediation names git config --local --add artifactHygiene.beadPrefixes <prefix>, so ordinary words never block while declared prefixes do. It never re-reports a known prefix, so a checked-in file can only widen detection. Generic matching ignores numeric-only fixture values such as test-stt-123 and member-uuid-123; known prefixes still match numeric-only IDs. Unknown-prefix numeric-only and digitless IDs are not detected by this heuristic. Generic prefixes require each hyphen-separated segment to start with a letter, so prefixes such as project-2 need to be known explicitly. This is not a blanket test-file exemption: mixed-suffix fixtures can still match. Known prefixes come from clone-local artifactHygiene.beadPrefixes (multi-valued or comma-separated), ARTIFACT_HYGIENE_BEAD_PREFIXES, and the repository's own .beads/config.yaml issue-prefix and .beads/issues.jsonl IDs; target.beadPrefixSource reports which. Plain hyphenated words such as dry-run are not reported, nor are <prefix>-beads Dolt remote repository names. Email matches immediately followed by : are treated as scp-style Git URLs and matches immediately preceded by :// as URL userinfo (git+ssh://git@host/…). Complete scoped or unscoped npm package@version tokens enclosed in single backticks are excluded only when the token is at most 512 bytes, its version is strict SemVer, and the email-like domain's last label starts with a digit. Alphabetic-ending prerelease domains remain reportable, even in scoped specs. The same strict version and 512-byte token limits apply to scoped or unscoped npm specifiers in URL paths: the complete specifier must follow / and end at /, end-of-input, whitespace, a quote/backtick, or a surrounding bracket delimiter. Recognition is lexical, not URL fetching or full URL parsing; a bounded 512-byte preceding token context rejects query/fragment content and malformed scopes, and unbounded prefixes remain reportable. Bare specs, ranges, malformed tokens, and adjacent email matches receive no new exemption. Only the validated npm match is skipped; line reporting, audit deadlines, canaries, and secret scanning remain active. This built-in exemption adds no clone-local override or target.policy allowance. In unpublished history only, the detector also recognizes strictly versioned uses: references on added lines in top-level .github/workflows/*.yml or .yaml files. This is bounded lexical recognition, not full YAML parsing: the entire owner/repository/path plus SemVer token must fit the 512-byte limit, excluding matching quotes, trailing whitespace and comments. Only email-shaped spans contained in a validated reference whose last matched domain label starts with a digit are exempt; alphabetic-ending prerelease domains remain reportable. Recognition and the forward-only span lookup check the audit deadline, including exempt matches. Adjacent comments, expressions, malformed references, other paths, and secret scanning remain unchanged. The detector sees added lines rather than full YAML, so it does not validate surrounding YAML context. This does not skip whole lines or arbitrary code spans. Personal-name matches stop at identifier boundaries, and paths under an artifact-hygiene/ directory are exempt from the non-secret detectors because the audit's own source and fixtures necessarily contain canary shapes; secret scanning still covers them.

A clone may allow Bead references only with local, unshared configuration:

git config --local artifactHygiene.allowBeadReferences true
# or ARTIFACT_HYGIENE_ALLOW_BEAD_REFERENCES=1 artifact_hygiene.py --pretty

The selected override is reported in target.policy; a checked-in configuration file cannot disable a detector.

A clone may allow one exact public-by-design client key using the redacted finding's allowId:

git config --local --add artifactHygiene.allowSecretFingerprints ah1:<fingerprint>

The fingerprint is bound to the scanner rule and exact matched value, not its path or line, so replacing the key produces a new finding. Matching findings remain visible under suppressed and in the summary. Only valid IDs from clone-local Git configuration are honored; repository files, environment variables, global Git configuration, paths, and scanner rule names cannot grant this allowance. The helper hashes the scanner match in private process memory and never emits the raw value.

Oversized blobs

Files over 1,000,000 bytes (including binary files) are not scanned. The helper hashes working-tree bytes incrementally using Git's raw blob format, without running filters or writing objects. Index and history entries use their exact Git blob IDs. SHA-1 and SHA-256 repositories are supported.

  • A blob reachable anywhere in the locally available remote-backed default base's history is skipped-by-policy with reason published-base-history, including renamed or reintroduced blobs. This proves local remote-tracking reachability, not live remote state; the helper never fetches.
  • An unpublished blob remains partial (file-too-large) and denies publication, with its path, blob ID, and required manual override in sizeDecisions.
  • After independently reviewing the unscanned content, a clone may allow exactly that blob:

    git config --local --add artifactHygiene.allowLargeBlobs <full-blob-id>

    Only lowercase, full-length IDs matching the repository object format are accepted (multi-valued or comma-separated). Changed bytes require another allowance. Only direct clone-local Git configuration is honored: checked-in files, Git config includes, environment variables, and global configuration cannot grant it. Active allowances appear as +allow-large-blobs in target.policy; applied skips have reason local-blob-allowance.

sizeDecisions records each skipped or denied source/path/commit/blob combination, the byte size, reason, and safe remediation. Policy skips keep coverage complete and do not consume the scanned-byte budget; they do not claim content was inspected. A missing base cannot prove publication. Failed or bounded-out reachability checks produce publication-proof-failed; scanner failures, history-read failures, file changes, timeouts, and other resource limits still deny, even with a blob allowance. Reachability first reads one bounded base-tip tree, then uses a cached, bounded git log --find-object proof for each distinct blob absent from that tree. Checks use the remote-backed base commit, with replace refs, grafts, repository log presentation, commit graphs, renames, signatures, and path limits disabled. Git 2.31 or newer is required for published-blob skips. The shared command output and audit deadline still apply; proof failures deny. Size decisions are capped at 2,000, with overflow reported as partial rather than silently omitted.

GitHub pull requests, Jira, comments, attachments, linked pages, other repositories, full-history remediation, policy authoring, and enforcement are out of scope.

Graded publication policy

The v2 report separates coverage status from publication verdict: clean, advisory, or block. policy.grade is the single finding-grade authority. Severity and confidence remain visible; grading never relabels a secret match as a verified false positive or a confirmed live credential.

Condition (first matching row)Grade
Partial/failed coverage, unknown category/severity/confidence/location, or failed publication proofblock
Critical severityblock
Informational scanner-control findingadvisory
Generic-shape Bead reference (beads.generic-shape)advisory
Already-published, non-critical findingadvisory
New working-tree/index or branch-history findingblock

Known confidence levels (high, medium, low) are recorded and validated; lower confidence alone never permits a new finding. Unknown and future categories fail closed. Complete reports with no unsuppressed findings are clean; any blocking finding yields block; otherwise they are advisory. Suppressed exact fingerprint matches remain separately visible and do not count toward the verdict.

location.publication distinguishes working-tree, branch-history, and already-published. Working-tree includes staged/index candidates: each occurrence is bound to its containing blobId, so a published file cannot mask different staged bytes at the same path and line. Proof that the exact blob is reachable from the remote-backed default base permits already-published. So does line proof: the finding's own line text appears contiguously in the same path at the default-base tip, so an old finding on an unchanged line of an edited file stays advisory while new or changed lines still block. Line proof reads only that one base-tip blob (at most 1 MB) and never walks history. Hashes use raw bytes without Git filters; CRLF conversion, LFS, or other filters can therefore conservatively leave a working-tree finding blocking even when its index copy is published. Branch history without line proof remains conservatively blocking even if a commit was pushed to a feature branch: the scan range is relative to the default base, not a claim that all those commits are unpushed. Full local history fallback is reported as coverage.base: all-reachable, not as a coverage error when that scan completes. The informational scanner-control row is the explicit exception to new-content blocking; repository controls still cannot suppress the scan.

Repository visibility is not an input: an already-published finding is advisory whatever the audience, because pushing the branch cannot expose it further. The advisory is still rendered and deserves review, and rotation when a credential is live, but it is no reason to rewrite history or block the push. The former artifactHygiene.remoteVisibility setting is ignored and the report no longer carries target.remoteVisibility. Checked-in files, included or global Git config, and environment variables cannot supply grading rules.

Consumers must validate artifact-hygiene/v2, complete coverage, and the verdict's consistency with finding grades. A v1/v2 mismatch denies; deploy the helper and gate contracts together. Advisory output never authorizes a push by itself. Grading rules live only in this installed helper.

Requirements

  • Python 3.10 or newer
  • Git 2.31 or newer
  • Gitleaks; the proof of concept is locally verified with Gitleaks 8.30.1

A missing or failed scanner produces partial coverage rather than a clean result.

Run

From the repository to inspect:

~/.agents/skills/artifact-hygiene/scripts/artifact_hygiene.py --pretty

The helper always emits artifact-hygiene/v2 JSON to stdout and emits no candidate or child-process text to stderr. The audit has one 600-second deadline, configurable for manual runs with --timeout from 1 to 600 seconds. A deadline expiry is reported only as deadline-exceeded on affected coverage sources; it remains partial and denies publication. summary.truncated states whether reported finding counts are incomplete because the deadline or report-size cap stopped collection.

Exit codes:

  • 0 — every required local source completed; verdict may be clean, advisory, or block.
  • 2 — coverage is partial; verdict is block, never clean.
  • 3 — the audit failed before it could establish usable coverage; verdict is block.

Report

Render coverage before findings:

  1. State the overall status and verdict exactly.
  2. List each source and its complete, partial, or failed status plus safe error codes. If summary.truncated is true, state explicitly that finding counts are incomplete.
  3. Group findings by grade, severity, and category, using only the normalized location, evidence token, and remediation supplied by the helper. Show location.publication. An advisory does not mean the content was verified harmless.
  4. Report any suppressed count and state that clone-local fingerprint allowances were applied; use only normalized fields and never attempt to recover the matched value.
  5. Render sizeDecisions, including every skipped-by-policy entry and its reason/blob ID. For denied entries, name the file and show the exact clone-local override supplied by the helper; never apply it automatically or describe skipped content as scanned.
  6. If status is partial or failed, name the unavailable coverage and stop short of publication assurance.

Never recover raw evidence by reading a reported file, commit, scanner output, temporary file, or repository configuration. Remediation is a separate explicitly approved task. This skill never mutates the audited repository.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.