Point it at a repo.
It follows the README like a new user and checks every step against the repo: OK, BROKEN, MISSING or UNVERIFIED, with evidence and the README edits that fix it.
Before and after
Real public data, anonymised. Taken from the skill's README.
The README of a small public React tutorial app says to run yarn && yarn start.
After (skill output, excerpt):
Short answer: no. The one command the README gives,yarn && yarn start, stops at the second half, because the project has nostartscript.
4 |yarn start| BROKEN |package.jsonscripts are onlydev,build,lintandpreview. There is nostart.
1 | Install Node.js | MISSING version |.nvmrcsaysv24. The README gives no version.
Run command: yarn / yarn dev
See it run

What it does
Point it at a repository. It follows the README like a new user would and checks every step against the repo: versions, scripts, files, environment variables, ports and links. You get each step marked OK, BROKEN, MISSING or UNVERIFIED with evidence, the first-run path a newcomer would actually take, and the README edits that fix it.
How it was tested
1 real-data run on a public MDN tutorial repository (Claude Sonnet). The missing start script, the .nvmrc version and the stale Create React App text were all real.
Tested on a real example before release. The example is shown in the Before and after section above.
How we test, what we do not do, and which assistants we ran it on.
Limits
- Read-only by default, so some steps stay UNVERIFIED.
- It cannot see what is not in the repo.
- It proposes README edits; it does not make them.
Works with
Works with any assistant that reads SKILL.md skills (Claude, Codex, Gemini CLI, Cursor and others), plus a paste-in prompt version for ChatGPT or any chatbot. A repo to read, or the README and manifests pasted.
Install
- Run
npx skills add proskillpacks/skillsin your project and pick this skill. Or copy thereadme-first-run-checkfolder from GitHub (https://github.com/proskillpacks/skills/tree/main/skills/developers/readme-first-run-check). - Put the
readme-first-run-checkfolder where your assistant looks for skills. The generic path is.agents/skills/(ornpx skills addfrom a folder). Tool-specific paths:- Claude Code:
~/.claude/skills/(or.claude/skills/inside one project) - OpenAI Codex, Gemini CLI, Cursor and others:
.agents/skills/or the skills folder their docs name - claude.ai: zip the skill folder yourself, then Customize, Skills, the plus button, Create skill, Upload a skill (code execution must be on in Settings, Capabilities)
- ChatGPT or any chatbot: open the skill's
prompt.md, paste it into the chat, then paste your own text or link - Steps for each tool, with links to its official docs: how to install Agent Skills
- Claude Code:
- Ask for the job in plain words, for example: "Check the getting started steps in the README. Don't install anything.". The skill loads by itself.
Get it
MIT licence. Use it, change it, share it.
Related
- Free guide to do it by hand: How do I check that my README's setup steps actually work?
- Free paste-in prompt for any chatbot: README first-run check prompt for any chatbot
- Accessibility Quick Audit (Free): Give it a page's HTML or components. Get accessibility issues ranked by impact, with the WCAG criterion, the code and a fix. Free, MIT-licensed.
- Changelog from Commits (Free): Give it a commit range or a pasted git log. Get a user-facing changelog with the commit behind every line, and the vague commits flagged.
- PR Description and Review Prep (Free): Run it on your branch. Get a PR title, summary, risk notes and test plan from the diff, plus the questions a reviewer will ask. Free, MIT-licensed.
- More for developers: Developers
Report a problem with this skill (GitHub, or write to kaiventura.founder@gmail.com).