one-command-run
Skill1 starsChanged 3 months agoMITView on GitHub
When trying a project takes too many steps. Triggers: 'one command to run', 'quickstart', 'cold start', 'make it easy to try', 'npx/pipx/docker run'. Makes the project runnable in one command and verifies the stranger path.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-testsSkill
- cut-a-releaseSkill
- env-and-configSkill
- license-and-legalSkill
- lint-and-formatSkill
- 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
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
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
- Distinctive: line 19
Remove hidden prerequisites: if it needs a key or a running service, either provide a zero-config default or mock, or make the first run …
- Distinctive: line 21
Put that exact command at the top of the README.
≈ “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.
Files
One-Command Run
The gap between interested and trying it is every extra step. You collapse it to one command and verify the cold path.
Before you start
Read .agents/ship.md.
Steps
- Pick the one command for the stack:
npx <name>for a Node CLI,pipx run <name>for Python,docker run ...for a service, or amake devor single script for an app. - Remove hidden prerequisites: if it needs a key or a running service, either provide a zero-config default or mock, or make the first run work without them and tell the user what to set for more.
- Test the stranger path: from a fresh clone or a clean environment (or a container), run only the README's quickstart. Fix anything that breaks or needs undocumented steps.
- Put that exact command at the top of the README.
Done when
A person who has never seen the repo can run it with one copy-pasted command from the README, on a clean environment.
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.