Codeindex

Generate and search symbol indexes to navigate codebases with low token usage Use when this capability is needed.

tomevault-io 5e26c70 2 files · 1.9 KB Updated

File contents

Code Index Skill

Use CTags to generate a searchable symbol index for quick navigation.

When to use

  • Exploring an unfamiliar codebase
  • Locating definitions without opening full files
  • Mapping file structure before deep reads

Scripts

Scripts live in scripts/codeindex/:

  • generate-index.sh [project-root]
  • lookup.sh <symbol-pattern> [project-root]
  • file-symbols.sh <file-path> [project-root]

Workflow

  1. Generate the index for a project:
    ./scripts/codeindex/generate-index.sh /path/to/project
    
  2. Search symbols before reading files:
    ./scripts/codeindex/lookup.sh handleAuth /path/to/project
    
  3. Inspect a file's symbols:
    ./scripts/codeindex/file-symbols.sh src/api/auth.ts /path/to/project
    
  4. Regenerate after edits to keep the index fresh.

Index location

Indexes are written to .codex/codeindex/ inside the target project:

  • .codex/codeindex/tags
  • .codex/codeindex/files.txt

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/nathandcornell--nates-codex-toolbelt--codeindex commit 5e26c7030b

Frequently asked questions

npx skillmds@latest add tomevault-io/codeindex