codebase-context skillA
codebase-context is agent-read markdown (skill) from kingxiaozhe/cm-workflow: 项目代码库上下文管理。通读项目生成参考文档(scan)，或加载文档辅助开发(dev)。.
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# codebase-context — 项目代码库上下文管理
这是一份写给 AI 执行的 SOP。目的：把"每次开发前重读整个代码库"这个昂贵动作**一次性固化成结构化文档缓存**，后续开发直接加载文档当上下文。
- **scan（生产）**：系统通读源码，生成结构化参考文档。
- **dev（消费）**：加载参考文档进上下文辅助开发，开发完成后自动评估并回写更新文档。
## 参数解析
调用格式：`/codebase-context <mode> [project-name] [--full]`
1. 解析第一个参数为 `mode`：
- 值为 `scan` → 进入 scan 模式
- 值为 `dev` → 进入 dev 模式
- 缺失或为其他值 → 输出用法提示 `用法: /codebase-context <scan|dev> [project-name] [--full]` 并终止
2. 解析第二个非 `--` 开头参数为 `project-name`：
- 已提供 → 直接使用
- 未提供 → 用 Bash 执行 `basename "$PWD"`，取当前工作目录最后一段路径名作为 project-name
3. 检查是否存在 `--full` 参数：
- 存在且 mode=scan → 强制全量扫描
- 存在且 mode=dev → 忽略该参数并提示"--full 仅 scan 模式有效"
4. 设定文档目录 `DOC_DIR = {PROJECT_ROOT}/docs/codebase-context/`（存于项目工程内,随 git 提交、团队共享、换机不丢）
5. 设定项目根 `PROJECT_ROOT = 当前工作目录`
## 产物清单（固定 10 份文档 + 1 份元数据）
全部存于 `DOC_DIR` 下，文件名固定，不得增删改名：
| 文件 | 内容 |
| ---- | ---- |
| 00-index.md | 索引与快速导航 |
| 01-overview.md | 项目概述与技术栈 |
| 02-directory.md | 目录结构 |
| 03-architecture.md | 架构设计与模块关系 |
| 04-api-routes.md | API 接口汇总 |
| 05-data-models.md | 数据模型与类型 |
| 06-core-modules.md | 核心模块（组件/Hooks/Store） |
| 07-business-logic.md | 关键业务逻辑 |
| 08-conventions.md | 编码规范与约定 |
| 09-changelog.md | 文档变更记录 |
…Read the whole file at its exact version.
How to install
mdr add kingxiaozhe/cm-workflow/codebase-context@git:20260916.9ebbf71mdr add kingxiaozhe/cm-workflow/codebase-context@sha256:194f8100cdd9e99bPin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_jndxqhuozlhkokzg)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260916.9ebbf71 latest | 2026-09-16 | 9ebbf71 | 18,170 B | A | view · diff |
| git:20260714.33f01ba | 2026-07-14 | 33f01ba | 18,418 B | A | view · diff |
| git:20260714.d430815 | 2026-07-14 | d430815 | 17,342 B | A | view · diff |
| git:20260714.c9bc8f7 | 2026-07-14 | c9bc8f7 | 17,292 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (18170 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
kingxiaozhe/cm-workflow · 29 stars · license MIT · pushed 2026-09-24 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_jndxqhuozlhkokzg GET https://markdownregistry.com/api/v1/resolve?ref=kingxiaozhe/cm-workflow/codebase-context GET https://markdownregistry.com/api/v1/blob/194f8100cdd9e99b96f9510e6792b6aa0e2ccae030eb683a17b7acb215e2a3e5
Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.