其他
需要减少 AI 编码助手 token 消耗时,用…
适用于让 Claude Code、Cursor、Copilot、Codex 等 AI 编程助手在会话开始时一次性读取项目结构、路由、模型、组件和架构决策,从而减少手动探索代码库的 token 消耗。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 35/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 39/100 ×0.15
适用场景
需要减少 AI 编码助手 token 消特定
解决思路
- 直接运行 `npx codesight`,无需安装;也可先运行 `npm install -g codesight` 再运行 `codesight`;要求 Node.js >= 18,不需要 API key 或配置文件。
- 运行 `npx codesight` 生成默认上下文图到 `.codesight/CODESIGHT.md`,包含项目元数据(技术栈、语言、框架、包管理器)、所有路由及 HTTP 方法和处理器位置、数据库模型及字段和关系、UI 组件及 props、按依赖数量排序的高影响文件、框架和 ORM 检测结果。
- 运行 `npx codesight --wiki` 生成持久 wiki 知识库到 `.codesight/wiki/`,包含 `index.md`、`overview.md`、`auth.md`、`payments.md`、`database.md`、`users.md`、`ui.md`、`log.md`。
- 运行 `npx codesight --init` 生成 AI 工具配置文件:`CLAUDE.md`、`.cursorrules`、`codex.md`、`AGENTS.md`。
- 运行 `npx codesight --open` 在浏览器打开交互式 HTML 报告。
- 运行 `npx codesight --mcp` 以 MCP 服务器启动(13 个工具),供 Claude Code / Cursor 使用。
- 运行 `npx codesight --blast src/lib/db.ts` 查看指定文件的 blast radius。
- 运行 `npx codesight --profile claude-code`、`npx codesight --profile cursor`、`npx codesight --profile copilot`、`npx codesight --profile codex` 为特定 AI 工具生成优化配置。
- 运行 `npx codesight --benchmark` 显示 token 节省明细。
- 运行 `npx codesight --mode knowledge`、`npx codesight --mode knowledge ~/vault`、`npx codesight --mode knowledge ./docs` 映射 markdown 知识库(ADRs、会议纪要、Obsidian vault)。
- 运行 `npx codesight --watch` 在文件变化时重新生成。
- 运行 `npx codesight --hook` 安装 git hook,在每次提交时重新生成。
- 在 Claude Code MCP 配置 `~/.claude/mcp_settings.json` 或项目 `.mcp.json` 中添加 `mcpServers.codesight`,设置 `command` 为 `npx`、`args` 为 `["codesight","--mcp"]`、`cwd` 为 `/path/to/your/project`。
- 在 Cursor 项目根 `.cursor/mcp.json` 中添加 `mcpServers.codesight`,设置 `command` 为 `npx`、`args` 为 `["codesight","--mcp"]`。
- 使用 MCP 工具 `codesight_get_context` 获取完整代码库上下文图。
- 使用 MCP 工具 `codesight_get_routes` 获取所有 API 路由及方法和处理器。
- 使用 MCP 工具 `codesight_get_models` 获取所有数据库模型和 schema。
- 使用 MCP 工具 `codesight_get_components` 获取 UI 组件及 props。
- 使用 MCP 工具 `codesight_get_blast_radius` 对指定文件做影响分析。
- 使用 MCP 工具 `codesight_get_high_impact_files` 获取按依赖数量排序的文件。
- 使用 MCP 工具 `codesight_get_framework_info` 获取检测到的框架和 ORM。
- 使用 MCP 工具 `codesight_get_wiki_index` 获取 wiki 目录(约 200 tokens),用于会话开始。
- 使用 MCP 工具 `codesight_get_wiki_article` 按名称读取一篇 wiki 文章。
- 使用 MCP 工具 `codesight_lint_wiki` 做 wiki 健康检查(孤儿、过期、缺失链接)。
- 使用 MCP 工具 `codesight_get_knowledge` 从 markdown 笔记获取知识地图。
- 使用 MCP 工具 `codesight_benchmark` 做 token 节省分析。
- 使用 MCP 工具 `codesight_get_overview` 获取项目概览摘要。
- 在 Claude Code 或 Cursor 会话开始时,先使用 `codesight_get_wiki_index` 获取项目概览,再使用 `codesight_get_wiki_article` 读取如 "auth" 的文章理解认证。
- 重构共享文件前,运行 `npx codesight --blast src/lib/database.ts`,查看所有导入该目标的文件并按影响排序;修改数据库连接、共享工具或类型前执行。
- 在 `.github/workflows/codesight.yml` 中配置 CI/CD:push 到 `main` 时执行 `actions/checkout@v4`、`actions/setup-node@v4` 并设置 `node-version: '20'`,然后运行 `npx codesight`、`npx codesight --wiki`、`npx codesight --mode knowledge ./docs`,配置 git 用户,运行 `git add .codesight/`,无差异则跳过,有差异则提交 `chore: update AI context [skip ci]` 并 `git push`。
- 运行 `npx codesight --hook` 安装 post-commit hook,每次提交后自动重新生成 `.codesight/CODESIGHT.md`。
- 运行 `npx codesight --mode knowledge ./docs/decisions` 映射 ADR 和架构文档;运行 `npx codesight --mode knowledge ~/vault` 映射完整 Obsidian vault;输出 `.codesight/KNOWLEDGE.md`,包含从 ADR 提取的关键决策、从笔记暴露的开放问题、按日期索引的会议纪要、编目的规格和 PRD。
- 在 Claude Code 中手动加载上下文:提示 `Read .codesight/CODESIGHT.md for project context before answering questions.`
- 在会话开始加载 Wiki:提示 `Read .codesight/wiki/index.md first. Then read the relevant article (e.g. .codesight/wiki/auth.md) only when questions about that domain arise.`
- 加载组合上下文:提示 `Read .codesight/CODESIGHT.md for code structure and .codesight/KNOWLEDGE.md for architectural decisions.`
- 将 `.codesight/` 加入 git,以跨会话和团队成员持久化上下文;wiki 在会话重启后仍存在。
- 路由未检测时,确保从项目根(含 `package.json` 或等价文件)运行;TypeScript 项目会全 AST 解析,其他语言用 regex,检查路由文件是否遵循标准框架约定;Python FastAPI 确保路由文件使用标准 `@app.get()` / `@router.post()` 装饰器。
- MongoDB 模型显示 0 时,这是正确行为——codesight 解析 SQL ORM 声明;没有 Mongoose schema 的 MongoDB 集合不会出现;显式定义 Mongoose schema 以获得模型检测。
- Wiki 文章缺失时,先运行 `npx codesight --wiki` 生成 wiki 目录;使用 `codesight_lint_wiki` MCP 工具或检查 `.codesight/wiki/log.md` 查看生成错误。
- 大型 monorepo(10K+ 文件)慢时,添加 `.codesightignore` 文件(语法同 `.gitignore`)排除构建产物、生成文件和 `node_modules` 子目录;5K 文件以下项目典型扫描时间 186ms–890ms。
- MCP 服务器无法连接时,用 `node --version` 验证 Node.js >= 18;检查 MCP 配置中的 `cwd` 指向实际项目根;先手动运行 `npx codesight --mcp` 确认能无错误启动。
- `--init` 覆盖已有 `CLAUDE.md` 时,在带自定义 AI 指令的项目上运行 `--init` 前备份现有文件;生成文件是增量起点,需与现有内容手动合并。
适用边界 · 注意事项
- 项目主要语言、框架或 ORM 不受支持,或路由、模型不使用标准约定时,检测会缺失或不准确,不宜依赖自动生成结果。
- MongoDB 集合没有显式 Mongoose schema 时,模型不会出现在输出中;不要期望自动解析这类集合。
- 项目已有自定义 `CLAUDE.md`、`.cursorrules` 等 AI 配置时,不要直接运行 `--init`,否则会覆盖;需先备份并手动合并。