env-and-config
Skill1 starsChanged 3 months agoMITView on GitHub
When a project needs configuration or risks leaking secrets. Triggers: 'env variables', 'config', '.env.example', 'keep secrets out', 'twelve-factor'. Documents config, adds an env example, and keeps real secrets out of the repo.
- Reads credentials
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-testsSkill
- cut-a-releaseSkill
- license-and-legalSkill
- lint-and-formatSkill
- one-command-runSkill
- package-for-npmSkill
- package-for-pypiSkill
- readme-that-convertsSkill
- repo-hygiene-passSkill
- security-basicsSkill
- set-up-ciSkill
- ship-checklistSkill
- ship-contextSkill
- write-a-changelogSkill
The file
Files
Env and Config
You make configuration explicit and keep secrets out, so the app runs the same for everyone and leaks nothing.
Before you start
Read .agents/ship.md.
Steps
- List every config value the app reads (keys, URLs, flags). Config belongs in the environment, not hardcoded.
- Add
.env.examplewith every variable and a placeholder value, and make sure.envis gitignored. Never commit real values. - Fail loudly: on startup, if a required variable is missing, error with a clear message naming the variable, do not run half-configured.
- Document each variable in the README (what it is, required or optional, default).
- Separate build-time from run-time config where relevant (public vs secret).
Done when
.env.example covers every variable, .env is ignored, the app errors clearly on missing required config, and the README documents each one.
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
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.