keel-setup
Skill0 starsChanged 27 days agoMITView on GitHub
Set a project up for Keel, or refresh it after a Keel update — runs `keel init` (policy, the keel-v2 rules block, the standing authorization, CONTEXT/GLOSSARY/CODING_STANDARDS/DESIGN/LAWS/LEARNINGS/docs INDEX + ARCHITECTURE/.scratch scaffolds), then walks the human through `keel compile`, the ruleset and `keel doctor`. Run by name in a new repo, or when `keel doctor` says to recompile.
In this repository16 other files it gives its agents.
- skills/keel-v2/CLAUDE.mdCLAUDE.md
- doc-syncSkill
- fused-landingSkill
- keel-contentSkill
- keel-designSkill
- keel-devSkill
- keel-financeSkill
- keel-legalSkill
- keel-marketingSkill
- keel-opsSkill
- keel-qaSkill
- keel-researchSkill
- keel-secureSkill
- keel-v2Skill
- keel-verifySkill
- lazy-loopSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 24
Init: Run keel init from the project root.
- Very specific: line 41
If the project already keeps one of these under another name (e.g.
- Very specific: line 57
Follow the same steps. Then remove any older delegation in CLAUDE.md ("may commit and merge on its own", "applies migrations autonomously") …
≈ “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
Keel setup — plugin install → keel init → keel compile
User-invoked. It writes files the human will commit; nothing here pushes, merges or applies the GitHub ruleset. The gates are theirs to turn on.
Where the CLI is
The plugin ships it. In a session with the plugin installed:
node "${CLAUDE_PLUGIN_ROOT}/plugin/bin/keel.mjs" <command>In the submodule layout it is node .claude/keel/plugin/bin/keel.mjs. The
human can alias either as keel; for the plugin, the marketplace clone is
~/.claude/plugins/marketplaces/keel/plugin/bin/keel.mjs. Node 20+.
Steps (done when the line is true)
- Init. Run
keel initfrom the project root. Done when: it prints the policy, the two CLAUDE.md blocks and the scaffolds it wrote or kept. Existing files are never overwritten; a second run only refreshes the two managed blocks. - Policy. Open
keel.policy.jsonwith the human:approver.github(their handle),agentIdentity.github(the GitHub App's bot login, e.g.name-keel[bot]),surfaces(the project's real danger paths: money, tenancy, auth, migrations, secrets, and the files that enforce its own laws),environments,backPressure+checks(what CI must pass, in order). Done when: no placeholder (YOUR-,your-keel-app) remains and everybackPressurename has a command. Then runkeel initagain so the standing authorization names the approver. - Scaffolds. Fill
CONTEXT.md(what/brand/phase),DESIGN.md(tokens),GLOSSARY.md(terms),CODING_STANDARDS.md(keep the rules that fit),LAWS.md(the project's Iron Laws),LEARNINGS.md(Trap → Rule → Why),docs/INDEX.md(where each doc lives) anddocs/ARCHITECTURE.md(load-bearing pieces, module map). If the project already keeps one of these under another name (e.g.docs/DOMAIN.md), make the scaffold a one-line pointer to it — one fact, one home. Done when: each file is either filled or a pointer. - Compile.
keel compilewrites the lock, deny rules, CODEOWNERS, thekeel.ymlworkflow and.keel/github-ruleset.json. Read its notes aloud (risky allow rules, missing GitHub remote). Done when: it exits 0. - Hand over. Tell the human, in this order: commit everything in one PR
marked
Rigor: HEAVY — governanceand merge it themselves; create the GitHub App (docs/v3/GUIDE.md §0) ifagentIdentitydoesn't exist yet; apply the ruleset (gh api -X POST repos/<owner>/<repo>/rulesets --input .keel/github-ruleset.json, repo admin, once; private repos need a plan that enforces rulesets); thenkeel doctor. Done when: every required doctor line readsENFORCEDorOK, or the human knows exactly whichUNPROVENline waits on them.
Existing projects
Follow the same steps. Then remove any older delegation in CLAUDE.md
("may commit and merge on its own", "applies migrations autonomously") —
the standing authorization block replaces it — and delete project copies of
route, laws, review, spec skills if the project carried the card-set
Keel: the plugin's /keel:* skills and the CLAUDE.md block are the one rule
set now. Projects compiled before the ledger and secrets-write gates existed
need one keel compile; until then the hooks run in strict fallback.
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.

