Codebase Index

by KonghaYao

Codebase Index is a Writing skill for Claude Code, published by KonghaYao in peri.

163 stars30 forkson KonghaYao/periAdded 2026/09/08+3% in starsRepository updated 2026/09/07

View source on GitHub Download repo ZIP

acpclaude-codecoding-agentdeepseekglmmcpruststreaming-markdowntui

Install in seconds

Install Codebase Index

Copy Codebase Index into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.

terminal

npx degit https://github.com/KonghaYao/peri/tree/main/.claude/skills/codebase-index ~/.claude/skills/codebase-index

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/KonghaYao/peri.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file: .claude/skills/codebase-index/SKILL.md in KonghaYao/peri
Installs to: ~/.claude/skills/codebase-index
Collection: One of 20 skills cataloged from this repository
Category: Writing — 1361 skills

What Codebase Index does

Codebase Index maps user intents like changing a threshold, tracing an event chain, or finding an entry point to the exact files and functions to open. It is used to quickly locate or rebuild per-crate code indexes for a Rust codebase.

Codebase Index is cataloged under Writing on DirSkills. Codebase Index comes from a repository tagged acp, claude-code, coding-agent, deepseek and glm.

Documentation

README

Excerpt

Codebase Index

索引是什么

位置：docs/code-index/<crate>.md，跨模块链路在 docs/code-index/cross-crate.md
本质：行为 → 文件 的速查表。查询者带着「我想改 X 的 Y」进来，带着文件路径和入口函数出去
原则：只给定位信息 + 一句话关键逻辑；不解释原理、不复制规范正文、不替代设计文档
体积：每个文件 100–200 行，全部读入没有负担。索引存在的意义就是让"找文件"这一步从几十次搜索变成一次读表

查找流程（查询者视角，最常用）

判断行为落在哪个 crate；不确定就 Glob docs/code-index/*.md 并全部读入
在速查表里按行为关键词匹配条目（compact / keepgoing / is_direct / cancel / middleware / prompt …）
打开主文件，跳转到入口函数
索引里的一句话关键逻辑只用于导航；行为细节一律以代码为准
跨模块链路看各索引的「跨模块契约」节或 cross-crate.md，那里指向 docs/standards/architecture-contracts.md 的 ARC 编号（不复制正文）

构建/更新流程（构建者视角）

触发时机：索引缺失、行为变更后索引过期、用户要求重建/扩充。

输入：目标 crate 源码 + 该 crate 的 CLAUDE.md + docs/standards/architecture-contracts.md（跨模块契约）+ 相关 docs/design/ 文档 + spec/issues/ 中最近的相关 issue。

步骤：

This is the opening of the README. Read the full README on GitHub.

Frequently asked about Codebase Index

What else does KonghaYao publish alongside Codebase Index?
Codebase Index is one of 20 skills that DirSkills catalogs from KonghaYao/peri, the repository it ships in. Its siblings there include Adaptive Devflow, Advisor Consultation and Auto Converge. Each one is a separate skill with its own page in this directory, installs the same way Codebase Index does, and is maintained by KonghaYao in that same repository. The rest of the collection is listed on the KonghaYao/peri page.
How does Codebase Index compare to other Writing skills?
Codebase Index ranks #1193 by stars among the 1361 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of Codebase Index against them. Open each page to compare what they document and how they install.