agentleFS
Sign inStart free
madeincartelmadeincartel/claude-code-framework/CLAUDE.md

claude-code-framework

CLAUDE.md1 starsChanged 9 months agoMITView on GitHub

  • Reads credentials

The file

We split this CLAUDE.md into the rules it gives an agent

8 rules. About 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    NEVER use AskUserQuestion tool.

    line 10
  2. Distinctive:

    ALL deployments via GitHub CI/CD only.

    line 11
  3. Distinctive:

    Use TodoWrite for multi-step tasks (>1 step)

    line 14
  4. Distinctive:

    When user asks for team/swarm of agents: use TeamCreate, not TaskCreate

    line 15
  5. Distinctive:

    NEVER ask user to write secrets in chat

    line 19
  6. Distinctive:

    Instead: provide instructions where to store them securely

    line 20
  7. Distinctive:

    ALWAYS ask before Deploy/push to main/production

    line 23
  8. Very specific:

    ALWAYS add secrets to .gitignore: .env, *.key, credentials.json, secrets/

    line 24

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

Language

  • Communicate with user, plans, plan-mode: English
  • Tech docs (code, context, rules, CLAUDE.md, skills): English
  • AI prompts: English
  • User-facing docs (README): English

Behavior

  • No "Great question!", no filler, no water.
  • NEVER use AskUserQuestion tool. Ask questions as plain text in chat instead.
  • ALL deployments via GitHub CI/CD only. Direct server access (SSH, container restarts) only for emergency debugging of broken production.

Task Planning

  • Use TodoWrite for multi-step tasks (>1 step)
  • When user asks for team/swarm of agents: use TeamCreate, not TaskCreate

Security

  • NEVER ask user to write secrets in chat
  • Instead: provide instructions where to store them securely
    • Local: .env files, config files
    • CI/CD: GitHub Actions secrets
  • ALWAYS ask before Deploy/push to main/production
  • ALWAYS add secrets to .gitignore: .env, *.key, credentials.json, secrets/
  • Be cautious with external actions (push, deploy, send messages, create PRs). Ask before acting externally when uncertain.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free