~ / rigs / josix / awesome-claude-md

josix/awesome-claude-md

Curated collection of exemplary claude.md files and onboarding patterns from public GitHub projects. Includes analyses, best practices, and templates to help developers create effective AI onboarding documentation for their codebases.

↗ GitHub ★ 599 no license updated 4mo ago collection Claude CodeCodexCopilot
share on X
ARCHETYPE
Pragmatist
A balanced, no-drama setup: some rules, some tools, nothing extreme.
CONTEXT TAX · EVERY TURN
~3.6k tokens
Moderate · median rig: 2.3k · breakdown
GUARDRAILS
0/5
No committed guardrails · details

Copy this rig

# review before running: this installs third-party code
$ npx degit josix/awesome-claude-md/.claude ./rig-awesome-claude-md  # inspect, then merge into .claude/

MCP servers are added to Claude Code at local scope; env vars are shown as YOUR_… placeholders — we never store values. Files are fetched with degit into a separate folder so you can review before merging.

$ curl -fsSL --create-dirs -o .claude/agents/claude-md-expert.md https://raw.githubusercontent.com/josix/awesome-claude-md/main/.claude/agents/claude-md-expert.md
$ curl -fsSL --create-dirs -o .claude/agents/example-curator.md https://raw.githubusercontent.com/josix/awesome-claude-md/main/.claude/agents/example-curator.md
$ curl -fsSL --create-dirs -o .claude/agents/project-docs-curator.md https://raw.githubusercontent.com/josix/awesome-claude-md/main/.claude/agents/project-docs-curator.md
$ curl -fsSL --create-dirs -o .claude/agents/website-developer.md https://raw.githubusercontent.com/josix/awesome-claude-md/main/.claude/agents/website-developer.md

This rig commits no guardrails. Here is the community baseline instead — the deny/ask rules most often found across all 7,204 rigs:

{
  "permissions": {
    "deny": [
      "Read(./.env)",
      "Read(**/.env)",
      "Read(~/.ssh/**)",
      "Bash(rm -rf *)",
      "Read(**/*.pem)",
      "Bash(rm -rf /)",
      "Bash(git push --force:*)",
      "Bash(sudo *)",
      "Read(.env)",
      "Bash(rm -rf /*)",
      "Read(./.env.*)",
      "Read(~/.aws/**)",
      "Bash(git push --force*)",
      "Bash(rm -rf:*)",
      "Read(**/*.key)",
      "Read(**/.env.*)",
      "Bash(sudo:*)",
      "Bash(git reset --hard*)",
      "Bash(git reset --hard:*)",
      "Read(.env.*)"
    ],
    "ask": [
      "Bash(git push:*)",
      "Bash(git push *)",
      "Bash(git commit:*)",
      "Bash(rm *)",
      "Bash(rm:*)",
      "Bash(git rebase *)",
      "Bash(wget *)",
      "Bash(npm publish:*)",
      "Bash(git commit *)",
      "Bash(gh pr merge *)"
    ]
  }
}

Subagents (4)

claude-md-expert—
example-curator—
project-docs-curator
model: inherit
Use this agent when you need to maintain, update, or review project documentation files, especially README.md and CLAUDE.md files. Examples: <example>Context: User has just added a new category to the
website-developer
model: inherit
Use this agent when you need to develop, enhance, or maintain the GitHub Pages static site in the docs/ folder. Examples: <example>Context: User wants to add a new feature to the static site. user: 'A

Slash commands (3)

/evaluate-quality/sync/update-readme-nav

Similar rigs

copied ✓