readme2skill — Auto-Generate AI Agent Skills from Any Project README
The agent skills ecosystem is exploding — Addy Osmani’s agent-skills repo hit 77K stars, Matt Pocock’s skills at 165K, and every major AI coding tool (Claude Code, Codex, Cursor, Gemini CLI) now supports SKILL.md files. These files tell the agent how to interact with a project, what commands to use, and what conventions to follow.
But there’s a problem: nobody wants to write a SKILL.md by hand. If you have 20 repos, that’s a lot of tedious YAML.
Enter readme2skill
readme2skill is a CLI tool that scans your project directory — README, docs, config files, scripts, workflows — and auto-generates a complete SKILL.md. Point it at any repo and it figures out:
- Project identity — name, description, language detection
- Key commands — extracted from
package.jsonscripts,pyproject.tomlentry points,Makefiletargets - File patterns — relevant globs based on detected languages and project structure
- Usage instructions — from README sections and config file analysis
Three output formats
| Format | Flag | When to use |
|---|---|---|
| agent-skills | -f agent-skills (default) | Direct SKILL.md for agent workflows |
| pocock | -f pocock | Matt Pocock-style prompt-centric format |
| yaml | -f yaml | Machine-readable for pipelines |
Quick start
# Install
pip install readme2skill
# Generate a skill for any project
readme2skill /path/to/project -o SKILL.md
# Watch mode — auto-regenerate when docs change
readme2skill /path/to/project -o SKILL.md --watch
# Different formats
readme2skill /path/to/project -f yaml
The dogfooding moment
The fun part: I used readme2skill to generate skills for all 9 of my own open-source repos in under 10 seconds. It then saved them directly into my agent’s skill system — now my own coding agent has full context on every tool I’ve built.
Try it
pip install readme2skill
# or
npx readme2skill
readme2skill . -o SKILL.md
Enjoy Reading This Article?
Here are some more articles you might like to read next:
- skill-vault: One MCP Endpoint for Every Skill Your Agent Will Ever Need
- mcp-apps-render — Your MCP Apps UI, Right in the Terminal
- doc-inject-guard: Detecting Prompt Injection in Documents Before They Reach Your AI
- agent-knowledge-graph: Persistent Graph Memory for AI Agents
- eu-act-check — EU AI Act Compliance Scanner, With 3 Days Until Article 50 Takes Effect
- no-slop — Stop Your AI Agent From Writing Generic Code
- mcp-app-suite — The MCP Apps Toolchain That Ships With Today's Spec
- Agent-Creds-Scanner — Stop Leaking API Keys in Agent Configs
- mcp-scan — CLI Security Scanner for MCP Servers
- cache-smith — Benchmark LLM Caching Before You Buy the Gateway