shipcheck-envlisted
Install: claude install-skill vivekbhange-hub/ship-check-skill
# shipcheck-env: make the environment the code needs match the one you documented
Most "works on my machine" deploys are env drift: a variable added to the code and never to
`.env.example`, a stale key nobody removed, a secret value pasted into the example file. This
skill compares what the code reads with what is documented, then fixes the documentation.
## Inputs
- A project folder (default `.`).
- Commands below say `python3`; on Windows use `python` (or `py -3`).
- Permission to edit `.env.example` (never a real `.env`).
## Outputs
- A findings list with rule ids ED001 to ED009, severity, file and line.
- An updated `.env.example` (or `.env.sample`, whichever the project already uses) where every
variable the code reads appears once, with a comment and a placeholder.
- A short note on what the audit cannot see (dynamic reads, framework config files).
## Steps
1. **Run the audit.**
```
python3 "${CLAUDE_SKILL_DIR}/env_audit.py" . --table --fail-on never
```
It reads Python, Node (`process.env`, `import.meta.env`), Go, Ruby, Java/Kotlin, PHP and Rust
sources, then the example files, docker-compose `environment:` and `env_file:`, and CI
`env:` blocks. A real `.env` is reported by key name and emptiness only.
2. **Read the findings.** What each rule means:
- ED001 used but undocumented. "required, no fallback" is the one that breaks a fresh
deploy; "has a fallback" or "set in compose" is housekeeping.
- ED002 documented but unused: stale