codebase-indexer

Generate and maintain a living docs/ index for codebases.

18|1|Updated Mar 7, 2026
One-click install
npx skills add https://github.com/heyEdem/codebase-indexer --skill codebase-indexer-heyedem
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-indexer
Source: https://github.com/heyEdem/codebase-indexer/tree/main
Command: npx skills add https://github.com/heyEdem/codebase-indexer --skill codebase-indexer-heyedem

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the need to re-scan a codebase on every Claude Code session by generating and maintaining a living docs/ index (architecture, implementation, patterns, decisions, changelog) that Claude reads automatically in future sessions.

Core Features & Use Cases

  • Initial scan that writes five doc files under docs/ (architecture.md, implementation.md, patterns.md, decisions.md, changelog.md).
  • Automatic updates after features/bugfixes via CLAUDE.md rules, so you never re-run the skill manually.
  • .gitignore integration: docs/ is added to ignore, keeping session artifacts out of git.
  • Simple usage: say "index this codebase" to perform the scan; "update docs"/"re-index" to refresh.
  • Supports multiple project types: Node.js, Java (Maven/Gradle), Go, Python, Rust, .NET, PHP, and polyglot/monorepos.

How it works

  • First run: scan, generate five docs, install CLAUDE.md rules.
  • Subsequent sessions: Claude reads docs/ at session start; no re-scan required.

Quick Start

Open any project and say "index this codebase" to run the initial scan and generate the docs/ files.

Frequently Asked Questions about codebase-indexer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate documentation for my codebase so Claude stops rescanning it?

Automatically generate documentation by running an initial codebase scan to create a living docs index. This builds five files covering architecture, implementation, patterns, decisions, and changelog that Claude reads automatically in future sessions instead of rescanning the codebase.

How do I keep project documentation updated automatically after a bugfix or feature?

Keep project documentation updated automatically through CLAUDE.md rules installed during the initial scan. These rules trigger documentation refreshes after features or bugfixes, so you never need to manually re-run the indexing skill to maintain your docs index.

Does automated codebase indexing work for polyglot monorepos with multiple languages?

Automated codebase indexing works for polyglot monorepos and multiple project types including Node.js, Java, Go, Python, Rust, .NET, and PHP. The scan handles mixed technology stacks and generates a unified documentation index across the entire repository.

How do I prevent generated documentation files from cluttering my git history?

Prevent generated documentation files from cluttering git history through automatic .gitignore integration. The skill adds the docs directory to your gitignore file, keeping these session artifacts out of version control while remaining accessible to Claude.

What is the best way to index an existing codebase for Claude to read?

The best way to index an existing codebase is to open your project and say index this codebase. This triggers a comprehensive scan that writes five documentation files under docs and installs CLAUDE.md rules for automatic future updates.

How to re-index or refresh project documentation when the codebase changes?

Re-index or refresh project documentation by saying update docs or re-index to Claude. This triggers a new scan to regenerate the architecture, implementation, patterns, decisions, and changelog files under the docs directory.