Skip to content

xiaoletian64/obs-code

Repository files navigation

obs-code

让 AI 编程从"盲人摸象"变成"精准手术"

License: MIT MCP TypeScript


你是不是也遇到过这些问题?

  • 🤦 AI 改了 A 文件,结果 B 文件炸了,根本不知道有调用关系
  • 🔍 让 AI 找"登录相关代码",它只搜字符串,完全不懂业务
  • 🤯 项目一大,AI 上下文直接爆了,开始胡说八道
  • 😤 每次改代码前都要手动翻调用链,生怕漏了哪个调用方

obs-code 就是来解决这些的。


30 秒看懂它能干嘛

你:修改用户登录逻辑,增加二次验证

普通 AI:看全部代码 → 迷失 → 乱改

obs-code:
  1. 自动画出代码关系图谱
  2. 找到"登录"相关的 5 个文件、12 个函数
  3. 精准告诉 AI 只看这些代码
  4. AI 精准产出,改一个不漏一个

安装(一条命令搞定)

curl -fsSL https://raw.githubusercontent.com/xiaoletian64/obs-code/main/install.sh | bash

这一条命令会自动完成:拉取代码 → 安装依赖 → 编译 → 注册 obs 命令 → 配置到你的 AI 工具(Claude Code / Cursor / Codex / OpenCode)。

装完重启 AI 工具,obs 的分析能力就直接可用了。也会得到这些 CLI 命令:

  • obs — CLI 主命令
  • obs-code-web — Web 可视化界面

3 步上手

Step 1 索引你的项目

obs index /你的项目路径

它会扫描项目里所有代码,自动识别:

  • 函数、类、方法
  • 谁调用了谁(调用链)
  • 文件之间的依赖关系

Step 2 启动 MCP 服务

obs serve --mcp

这样 Claude Code / Cursor / OpenCode 就能直接用 obs-code 的分析能力了。

Step 3 让 AI 用起来

在你的 AI 工具里直接说:

请用obs分析 用户登录流程

AI 会自动调用 obs-code,精准定位到登录相关的所有代码。


一键配置到 AI 工具

# 安装到所有支持的工具
obs install --tool all

# 或者只装某个
obs install --tool claude    # Claude Code
obs install --tool codex     # OpenAI Codex
obs install --tool cursor    # Cursor
obs install --tool opencode  # OpenCode

它到底帮你做了什么?

🎯 精准上下文

传统:AI 看 1000 个文件 → 迷失 → 写出垃圾
obs-code:分析需求 → 只给 AI 看 10 个相关文件 → 精准产出

🔗 调用链追踪

传统:改了函数 A → 调用方 B 炸了 → 线上事故
obs-code:改之前就知道 A 被谁调用 → 全部检查 → 安全上线

🧠 业务语义理解

传统:搜"登录"→ 搜字符串 → 搜不到 handleAuth
obs-code:搜"登录"→ 理解业务 → 精准找到 handleAuth

支持的语言

TypeScript / JavaScript / Python / Go / Rust / Java / Swift / Kotlin / PHP / Ruby / C# / Dart / C/C++ / Lua


MCP 工具一览

工具 干嘛用的
obs_index 索引项目,建立代码图谱
obs_find 搜索代码符号(支持中文)
obs_impact 分析改动影响哪些地方
obs_plan 需求 → 修改计划
obs_feature_map 功能 → 最优阅读顺序
obs_thread 快速定位入口和目标函数
obs_routes 找到 HTTP 路由注册
obs_deadcode 找到没人调用的死代码

真实效果

项目 规模 节点 索引速度
Express 简单 376 6 15 文件/秒
Axios 中等 636 1,224 267 文件/秒
NestJS 复杂 5,977 11,580 244 文件/秒
Vitest 大型 10,054 6,143 33 文件/秒

Web 可视化

obs-code-web /你的项目路径
# 打开 http://localhost:3456

在浏览器里看代码关系图谱,支持搜索、过滤、高亮。


项目结构

obs-code/
├── server.ts              # 核心:索引器 + Web 服务
├── mcp-server.cjs         # MCP 服务(AI 工具连这个)
├── cli/                   # CLI 命令
├── packages/
│   ├── store/             # SQLite 图数据库
│   ├── mcp/               # MCP 工具实现
│   ├── parser/            # 代码解析器(14 种语言)
│   ├── ai/                # AI 接口封装
│   └── ui/                # Web UI
└── install.sh             # 一键安装脚本

License

MIT


觉得有用?给个 Star 支持一下

让 AI 真正看懂你的代码

About

Obsidian for code — MCP tool that builds a call graph so AI knows what to read before changing anything.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors