BAIZE AI RESOURCE

代码库索引管理 Skill

Codebase-management

Codebase-management 是 SocratiCode 的代码库管理 Skill,帮助用户建立和维护项目索引、查看索引进度,并管理文件更新与代码关系图。适合需要让项目内容保持可检索、及时发现索引状态问题的开发者。

Codebase-management

资源介绍

Codebase-management 是 SocratiCode 提供的代码库管理 Skill,面向需要为项目建立检索索引并持续维护索引状态的开发者。首次使用时,可以先检查运行条件,再启动后台索引并查询进度;索引完成后,代码关系图会自动建立。在默认模式下,文件监视会自动启动,让后续改动进入索引;也可以按需暂停监视、手动更新,或保留现有索引作为固定快照。除代码外,它还支持将项目中的文本资料配置为上下文资料并建立索引,方便一并管理。索引中断后可从检查点恢复;需要清理项目数据时,也提供索引和关系图的管理操作。

Skill 能力

建立并跟踪代码索引

检查运行条件后启动项目索引,通过状态查询跟踪后台进度;索引中断后可从已有检查点继续。

维护文件更新

默认模式下自动监视文件变动并更新索引,也可停止监视或只对变更文件执行手动增量更新。

管理代码关系图

索引完成后自动建立代码关系图,并可查看构建状态、手动重建或删除关系图。

纳入项目文本资料

通过项目根目录的 `.socraticodecontextartifacts.json` 指定文本文件或目录,将架构文档、API 规格等资料纳入索引。

查看和清理项目索引

列出已索引项目及其状态;需要时可暂停索引,或执行删除索引等清理操作。

资源配置

适用平台

Claude CodeCodex

调用方式

自动触发手动调用

安装与调用

  1. 通过包含该 Skill 的 SocratiCode 插件使用;仅安装 SocratiCode MCP 引擎不会安装插件 Skill。

  2. 先运行 `codebase_health` 检查运行条件,再用 `codebase_index` 启动索引。

  3. 用 `codebase_status` 查看进度;完成后即可使用已建立的索引和代码关系图。

  4. 后续按需使用 `codebase_watch` 管理文件监视,或用 `codebase_update` 手动更新变更文件;如需索引项目文本资料,在项目根目录配置 `.socraticodecontextartifacts.json`。

使用案例

为新项目建立索引

使用场景开发者希望让 SocratiCode 检索一个尚未索引的项目。

先检查运行条件,再启动后台索引并查看完成进度;索引结束后,代码关系图会自动建立。

保留固定的索引快照

使用场景团队希望索引只在指定时机更新,而不随文件改动自动刷新。

将使用该项目的 MCP 进程设置为关闭文件监视和启动时自动恢复;需要刷新时,再手动更新索引和重建关系图。

索引项目说明资料

使用场景开发者希望将架构文档与代码一起纳入项目索引管理。

在项目根目录的 `.socraticodecontextartifacts.json` 中登记文档路径,再对这些资料建立索引。

包含内容

codebase-management-source.zip
README-中文安装说明.md
LICENSE-AGPL-3.0.txt
SHA256.txt

常见问题

只安装 SocratiCode 的 MCP 引擎会包含这个 Skill 吗?
不会。仅安装 MCP 引擎不包含 SocratiCode 的插件 Skill,需要通过包含该 Skill 的插件获取。
索引过程中断后需要从头开始吗?
不需要。再次运行 `codebase_index` 会从上次保存的检查点继续。
如何让索引只在手动操作时更新?
将使用同一项目的 MCP 进程设置为 `SOCRATICODE_WATCHER=off` 和 `SOCRATICODE_AUTO_RESUME=off`;需要刷新时运行 `codebase_update`,并按需运行 `codebase_graph_build`。
能否把代码之外的项目文档纳入索引?
可以。在项目根目录创建 `.socraticodecontextartifacts.json`,登记文本文件或目录;支持架构文档、API 规格等文本资料。