Stats
Actions
Available In
Tags
Plugin
codeindex
Claude Code integration for the codeindex CLI: skills for code navigation (arch), repository indexing (index), git-hook setup (hooks), and CLAUDE.md maintenance (update-guide). Requires the ai-codeindex CLI on PATH — install with `pipx install ai-codeindex`.
What's Inside
Skills4
arch
/arch
Query code architecture using README_AI.md index files generated by codeindex. Use when user asks about project structure, where features are implemented, how modules work, or wants to understand codebase architecture. Triggered by questions like "what does this do", "where is X implemented", "how does module Y work".
hooks
/hooks
Set up codeindex Git hooks for automatic README_AI.md updates on commit. Use when user wants auto-updating documentation, git hook setup for codeindex, or automatic index refresh when code changes. Triggered by "set up auto-update", "install hooks", "auto-update README_AI.md", "keep docs in sync".
index
/index
Generate AI-friendly code index using the codeindex CLI. Use when user wants to index a project, generate README_AI.md files, create code documentation, or make codebase searchable. Triggered by "index this project", "generate code index", "create documentation", "scan codebase".
update-guide
/update-guide
Refresh the codeindex section in your project's CLAUDE.md to the latest version, with project-specific suggestions. Use when user upgrades codeindex and wants their CLAUDE.md guidance updated, or asks "is my CLAUDE.md current".
README
codeindex-claude
Claude Code plugin that brings the codeindex CLI into your Claude Code workflow as a set of skills.
Prerequisites
This plugin requires the codeindex CLI on your PATH. The plugin's skills shell out to it.
pipx install ai-codeindex
(If you don't have pipx: python3 -m pip install --user pipx && pipx ensurepath.)
The plugin's SessionStart hook will warn you if codeindex isn't found.
What's in the plugin
Four skills (auto-namespaced under the plugin):
| Skill | Invoked when | What it does |
|---|---|---|
codeindex:arch | User asks about project structure, "where is X implemented", "how does module Y work" | Reads README_AI.md index files to answer architecture questions |
codeindex:index | User asks to index/scan a project, generate documentation | Walks user through codeindex init → scan-all setup |
codeindex:hooks | User asks to auto-update docs on commit, set up git hooks | Walks user through codeindex hooks install and .codeindex.yaml hook config |
codeindex:update-guide | User wants to refresh CLAUDE.md to latest codeindex guidance | Delegates to codeindex claude-md update with project-aware suggestions |
Plus one SessionStart hook that verifies codeindex is on PATH.
Installation
Option 1: Via this repo as a private marketplace (current)
/plugin marketplace add dreamlx/codeindex-claude
/plugin install codeindex@codeindex-claude
Option 2: Via the official community marketplace (planned)
Once accepted into anthropics/claude-plugins-community:
/plugin install codeindex@claude-community
Option 3: Local development
Clone this repo and run Claude Code with --plugin-dir:
git clone https://github.com/dreamlx/codeindex-claude
claude --plugin-dir ./codeindex-claude
Updates
/plugin update codeindex@codeindex-claude
The CLI itself is updated independently via pipx upgrade ai-codeindex.
Uninstall
/plugin uninstall codeindex@codeindex-claude
Removing the plugin does NOT uninstall the ai-codeindex CLI — that's pipx uninstall ai-codeindex.
Architecture
This plugin is the Claude-Code-facing layer of a deliberate two-artifact split (see codeindex ADR-006):
ai-codeindex(PyPI) — the Python CLI. Pure tool, zero Claude Code coupling. Cursor / Continue / bare-CLI users install only this.codeindex-claude(this repo) — Claude Code skills + hooks. Installs / updates / uninstalls cleanly via the platform's plugin mechanism, no~/.claude/mutation magic.
License
MIT. See LICENSE.
Stats
Version0.1.0
LanguageShell
Stars0
MaintenanceGood
LicenseMIT
Last Commit
Added
Available In
Tags
Categories
