Instruction file imported from codekiln/beans (
.github/instructions/rulesync.instructions.md). Copyright stays with the author.
Rulesync in Beans
This repo uses Rulesync to keep AI tool rules, skills, and subagents consistent across editors and agents. It reads the unified Rulesync sources under .rulesync/ and generates tool-specific files with npx rulesync generate.
Rulesync is the AI config system of record for this repository. Treat files under .rulesync/ as the durable source and treat generated agent/editor configs as outputs.
Devcontainer install
The devcontainer installs Rulesync globally for easy CLI access in .devcontainer/postCreate.sh:
npm install -g rulesync
Local usage
Rulesync is also listed in devDependencies, so you can run it with:
npx rulesync generate
Source of truth
- Keep durable AI coding guidance changes in
.rulesync/rules/*.md. - Keep reusable workflow prompts and task abstractions in
.rulesync/skills/*/SKILL.md. - Keep delegated specialist agents in
.rulesync/subagents/*.md. - Generated files like
AGENTS.md,CLAUDE.md,.agents/*,.cursor/*, and.claude/*should be treated as derived output from Rulesync.
Update workflow
- Edit
.rulesync/rules/*.mdfor durable guidance,.rulesync/skills/*/SKILL.mdfor reusable in-context workflows, and.rulesync/subagents/*.mdfor delegated specialist agents. - Run
npx rulesync generate. - Review the generated diffs in
AGENTS.md,CLAUDE.md,.agents/*,.codex/*,.cursor/*,.claude/*,.github/*, and other Rulesync-managed outputs. - If generated output looks wrong, fix the Rulesync source files and regenerate instead of patching generated files directly.