Mission: A Self-Compiling Cognitive Operating System.
Grimoire is not just a collection of prompts; it is a state-machine generator that compiles "Cognitive Spells" into VS Code-compatible prompt files (.prompt.md). These spells allow AI agents to shift reasoning modes (e.g., from "Lateral Thinking" to "Scientific Debugging") on command.
We follow The Exosuit Way:
- Context is King: The
docs/agent-contextis the source of truth. - Phased Execution: Plan -> Implement -> Verify.
- Laws vs. Code: RFCs are laws; the Manual is the code.
- Node.js 24+
- pnpm
pnpm install
pnpm run prepare # Installs git hooksTo compile the Grimoire locally (to .github/prompts):
pnpm run buildTo deploy the Grimoire to your global VS Code user profile:
pnpm run deploy
# or explicitly
pnpm run deploy -- --stable
pnpm run deploy -- --insidersTo enable automatic deployment on commit, create a grimoire.local.json file in the root (this file is gitignored):
{
"autoDeploy": true,
"target": "stable" // or "insiders"
}With this configuration, lefthook will trigger a deployment every time you commit changes.
- Edit
src/data/spellbook.ts. - Add your new spell to the appropriate category.
- Run
pnpm run checkto verify types and linting. - Commit your changes (auto-deploy will handle the rest if configured).
src/data/spellbook.ts: The content (spells, definitions).src/core/: The compiler logic and system axioms.src/scripts/: Utility scripts (auto-deploy, audits).docs/: Project documentation and RFCs.
pnpm run check: Type-check and lint.pnpm run lint: Run ESLint.pnpm run format: Run Prettier.
ISC