Wizard-style codebase explainer and documentation generator. Accepts any codebase, spec, or markdown artifact and explains it through conversational Q&A — with code-block anchors, plain-English explanations, and follow-up predictions. Two modes: Describe (repo owner documents their codebase) and Explore (new developer gets a learning-order tour). Sessions auto-captured and synthesizable as CODEBASE.md or TOUR.md.
npx claudepluginhub spillwavesolutions/codebase-mentor --plugin codebase-wizardSynthesize captured session logs into CODEBASE.md, TOUR.md, or FILE-NOTES.md.
One-time setup: install Agent Rulez hooks and write session-agent permissions.
Start a wizard session — explain, explore, or document any codebase or artifact.
Pre-authorized agent for the Codebase Wizard. Covers scanning, Q&A, capture, synthesis, and export. Zero approval prompts during sessions.
Pre-authorized agent for Codebase Wizard setup. Covers storage creation, Agent Rulez install, hook registration, and settings.local.json write. Broader permissions than the session agent — only used during /codebase-wizard-setup.
One-time setup for the Codebase Wizard. Use when the user runs /codebase-wizard-setup, says "set up the wizard", "install wizard", or "configure codebase wizard". Installs Agent Rulez hooks, creates storage directories, writes config.json, and sets scoped write permissions.
Universal explainer for codebases, specs, design docs, and markdown files. Activates when a user wants to understand how their code works, explore a new codebase, document an existing one, or get walked through any markdown artifact (specs, roadmaps, design docs, milestone plans). Trigger on: "explain this codebase", "walk me through this", "describe this code", "I'm new to this repo", "how does X work", "what calls this", "where does this get used", "explain this spec", "walk me through this roadmap", "what does this milestone mean", "explain this design doc", "--describe", "--explore", "--file <path>". Also triggers when user pastes code or a markdown file and asks questions about it — treat as a micro-artifact. Produces (written to {resolved_storage}/docs/{session_id}/): - SESSION-TRANSCRIPT.md (all modes — always generated) - CODEBASE.md (describe mode) - TOUR.md (explore mode) - FILE-NOTES.md (file mode)
Synthesizes raw wizard session JSON into structured documentation. Use when the user runs /codebase-wizard-export, says "export session", "generate docs", "create CODEBASE.md", or "turn the session into docs".
Uses power tools
Uses Bash, Write, or Edit tools
Share bugs, ideas, or general feedback.
Own this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge.
Sign in to claimOwn this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge.
Sign in to claimHelps Claude read a planning document and explore related files to get familiar with a topic. Asking Claude to prepare to discuss seems to work better than asking it to prepare to do specific work. This is followed by Plan, then Execute.
Code documentation with automated doc generation, code explanation, and tutorial engineering
Auto-document entire codebase with inline comments and API docs
Codebase learning through knowledge extraction, code knowledge graph, challenges, and spaced repetition. Prevents knowledge atrophy for experienced developers and accelerates onboarding for new ones.
Commands for loading context and priming Claude for specific tasks
A Claude Code guide — skills for interactive onboarding and Q&A on setup, best practices, automation, and effective workflows
Codebase Wizard is a Claude Code plugin that explains any codebase, spec, or markdown artifact through a wizard-style conversational Q&A interface. Every answer is anchored to actual code shown inline. Sessions are auto-captured and synthesizable as structured documentation.
CODEBASE.mdTOUR.mdpip install ai-codebase-mentor
ai-codebase-mentor install --for claude
This copies the Codebase Wizard plugin to ~/.claude/plugins/codebase-wizard/.
For a per-project install:
ai-codebase-mentor install --for claude --project
After installing, in any Claude Code session:
/codebase-wizard-setup # one-time setup: installs hooks and writes permissions
/codebase-wizard # start a wizard session
/codebase-wizard-export # synthesize captured sessions into docs
ai-codebase-mentor uninstall --for claude
ai-codebase-mentor status
ai-codebase-mentor install --for [claude|all] [--project]
ai-codebase-mentor uninstall --for [claude|all] [--project]
ai-codebase-mentor status
ai-codebase-mentor version
| Command | Description |
|---|---|
/codebase-wizard | Start a wizard session (Describe, Explore, or Ask mode) |
/codebase-wizard-setup | One-time onboarding: install Agent Rulez hooks, write scoped permissions |
/codebase-wizard-export | Synthesize captured session JSON into CODEBASE.md, TOUR.md, or FILE-NOTES.md |
The plugin follows a 5-phase conversational flow:
| Phase | Trigger | What loads |
|---|---|---|
| 1 — Repo Scan | User shares repo | scan-patterns.md |
| 2 — Question Handling | "how does X work?" | (none extra) |
| 3 — Navigation | "rewind", "jump to" | navigation-commands.md |
| 4 — Tutorial Mode | README found, or "teach me" | tutorial-mode.md |
| 5 — Persistence | "save", "export" | persistence.md |
Every answer follows the same loop:
src/auth/middleware.ts → validate() → L14-31)| Version | Runtime | Status |
|---|---|---|
| v1.0 | Claude Code | Complete |
| v1.2 | OpenCode + PyPI publish | Planned |
| v1.3 | Codex (subagent-aware) | Planned |
| v1.4 | Gemini CLI | Planned |
| v1.5 | LangChain DeepAgent standalone | Planned |
git clone https://github.com/SpillwaveSolutions/codebase-mentor
cd codebase-mentor
pip install -e .
pytest tests/
MIT — Spillwave Solutions