|
| 1 | +# AXME Code — Claude Code Plugin |
| 2 | + |
| 3 | +> **Alpha** — This plugin is in active development. Expect breaking changes between versions. [Report issues](https://github.com/AxmeAI/axme-code/issues). |
| 4 | +
|
| 5 | +Persistent memory, architectural decisions, and safety guardrails for Claude Code. Your agent starts every session with full project context — stack, decisions, patterns, safety rules, and a handoff from the previous session. |
| 6 | + |
| 7 | +[]() |
| 8 | +[]() |
| 9 | +[](LICENSE) |
| 10 | + |
| 11 | +**[Main Repository](https://github.com/AxmeAI/axme-code)** · **[Website](https://code.axme.ai)** · **[Issues](https://github.com/AxmeAI/axme-code/issues)** |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## What It Does |
| 16 | + |
| 17 | +Claude Code forgets your project every session. AXME Code fixes that. |
| 18 | + |
| 19 | +- **Persistent Knowledge Base** — oracle (stack, structure, patterns, glossary), architectural decisions with enforcement levels, accumulated memories from past sessions |
| 20 | +- **Safety Guardrails** — hooks intercept dangerous commands *before* execution (not prompts — hard enforcement at the harness level). Blocks `git push --force`, `rm -rf /`, `npm publish`, direct commits to `main`, and more |
| 21 | +- **Session Continuity** — handoff system tells the next session exactly where work stopped, what's in progress, and what to do next |
| 22 | +- **Automatic Learning** — background auditor extracts memories, decisions, and safety rules from session transcripts when you close the window |
| 23 | +- **19 MCP Tools** — `axme_context`, `axme_save_decision`, `axme_save_memory`, `axme_safety`, `axme_backlog`, and more |
| 24 | + |
| 25 | +You keep using Claude Code exactly as before. AXME Code works transparently in the background. |
| 26 | + |
| 27 | +## Install |
| 28 | + |
| 29 | +### From Claude Code CLI |
| 30 | + |
| 31 | +```bash |
| 32 | +/install axme-code |
| 33 | +``` |
| 34 | + |
| 35 | +### Manual |
| 36 | + |
| 37 | +```bash |
| 38 | +/plugin add AxmeAI/axme-code-plugin |
| 39 | +``` |
| 40 | + |
| 41 | +## First Use |
| 42 | + |
| 43 | +After installing the plugin, open any project in Claude Code. On the first session: |
| 44 | + |
| 45 | +1. The plugin creates a `CLAUDE.md` section that instructs the agent to call `axme_context` |
| 46 | +2. The agent will say the project is not initialized and run `axme-code setup --plugin` |
| 47 | +3. Setup scans your project (uses an LLM to analyze your stack, extract decisions, detect safety patterns) and creates the `.axme-code/` knowledge base |
| 48 | +4. From the next session onward, the agent automatically loads the full knowledge base |
| 49 | + |
| 50 | +**Setup requires a Claude subscription** (the LLM scan uses Claude Sonnet). If the scan fails, a deterministic fallback creates a minimal knowledge base from file system inspection. |
| 51 | + |
| 52 | +## How It Works |
| 53 | + |
| 54 | +### Hooks (automatic, transparent) |
| 55 | + |
| 56 | +| Hook | When | What | |
| 57 | +|------|------|------| |
| 58 | +| **SessionStart** | Session opens | Installs SDK dependency, creates CLAUDE.md if missing | |
| 59 | +| **PreToolUse** | Before every tool call | Checks safety rules, blocks violations | |
| 60 | +| **PostToolUse** | After Edit/Write | Tracks which files changed | |
| 61 | +| **SessionEnd** | Session closes | Spawns background auditor to extract knowledge | |
| 62 | + |
| 63 | +### MCP Server |
| 64 | + |
| 65 | +Provides 19 tools for reading and writing the knowledge base. The agent calls these tools naturally during work — no manual intervention needed. |
| 66 | + |
| 67 | +### Storage |
| 68 | + |
| 69 | +All data lives in `.axme-code/` in your project root (gitignored automatically): |
| 70 | + |
| 71 | +``` |
| 72 | +.axme-code/ |
| 73 | + oracle/ # stack.md, structure.md, patterns.md, glossary.md |
| 74 | + decisions/ # Architectural decisions with enforce levels |
| 75 | + memory/ # Learned mistakes (feedback/) and validated patterns (patterns/) |
| 76 | + safety/rules.yaml # git + bash + filesystem guardrails |
| 77 | + backlog/ # Persistent cross-session task tracking |
| 78 | + sessions/ # Session metadata |
| 79 | + plans/ # Handoff files for session continuity |
| 80 | + worklog.jsonl # Structured event log |
| 81 | +``` |
| 82 | + |
| 83 | +Human-readable markdown and YAML. No database, no external dependencies. |
| 84 | + |
| 85 | +## Requirements |
| 86 | + |
| 87 | +- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (CLI or VS Code extension) |
| 88 | +- Node.js >= 20 |
| 89 | +- Claude subscription (for LLM-powered setup and session auditor) |
| 90 | + |
| 91 | +## Alpha Status |
| 92 | + |
| 93 | +This is alpha software (v0.x.y). What that means: |
| 94 | + |
| 95 | +- **Breaking changes** may happen in minor version bumps (0.x.0 -> 0.x+1.0) |
| 96 | +- **Storage format** may change between versions (`.axme-code/` is local and gitignored, so upgrades won't affect your repo) |
| 97 | +- **Bug reports are welcome** — [open an issue](https://github.com/AxmeAI/axme-code/issues) |
| 98 | +- **Feedback** — we're actively iterating based on user feedback. Tell us what works and what doesn't |
| 99 | + |
| 100 | +## Auto-Sync |
| 101 | + |
| 102 | +This repo is auto-synced from the main [axme-code](https://github.com/AxmeAI/axme-code) repository on each release. **Do not edit files here directly** — changes will be overwritten. |
| 103 | + |
| 104 | +## License |
| 105 | + |
| 106 | +[MIT](LICENSE) |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +[Website](https://code.axme.ai) · [Main Repo](https://github.com/AxmeAI/axme-code) · [Issues](https://github.com/AxmeAI/axme-code/issues) · hello@axme.ai |
0 commit comments