repo-hygiene-env-docs-agent

Scan a repository for undocumented environment variables, missing .env.example coverage, stale setup docs, risky secret-like defaults, and DevEx hygiene chores; generate a safe remediation report and optional env documentation draft. Use for repo-wide chores, worker-session cleanup, onboarding docs, and boring-but-valuable developer experience automation.

Get this skill

---

name: repo-hygiene-env-docs-agent

description: Scan a repository for undocumented environment variables, missing .env.example coverage, stale setup docs, risky secret-like defaults, and DevEx hygiene chores; generate a safe remediation report and optional env documentation draft. Use for repo-wide chores, worker-session cleanup, onboarding docs, and boring-but-valuable developer experience automation.

---

Repo Hygiene Env Docs Agent

Use this skill for repository-wide environment variable and setup-documentation hygiene.

Workflow

1. Run `scripts/repo_hygiene_env_docs_agent.py <repo> --output repo-hygiene.json`.

2. Compare discovered env vars against `.env.example`, README, docs, and deployment files.

3. Review missing docs, suspicious defaults, and suggested snippets.

4. Only write changes after explicit approval; default mode is report-only.

Parameters

→ `repo`: repository root to scan.

→ `--output`: optional JSON report path.

→ `--write-env-example`: write `.env.example.generated` (never overwrites `.env.example`).

Guardrails

→ Never print secret values from `.env`; report variable names only.

→ Do not edit production config files.

→ Keep generated docs as drafts until reviewed.

Release evidence

Reviewed in the 2026-06-15 GetAgentIQ warehouse propagation cycle.