Jamesfish/code2context
GitHub: Jamesfish/code2context
零配置一键提取真实代码上下文,自动生成并持续更新 AI 编码助手所需的跨格式规则。
Stars: 1 | Forks: 0
# 🔮 Code2Context
**将你的代码库自动转换为 AI 准备好的上下文。**
**零配置,一键提取上下文,供 AI 编码助手使用。**
[](https://www.npmjs.com/package/code2context)
[](https://opensource.org/licenses/MIT)
[](https://nodejs.org/)
**English** | [中文](./README.zh-CN.md)
## 💡 痛点
当使用 AI 编码助手(Cursor、Claude、Copilot、Cline...)时,生成结果的质量严重依赖于 **它对项目的理解程度**。
但构建和维护这种上下文非常痛苦:
- **手动编写 `.cursorrules` 或 `CLAUDE.md`** 耗时费力
- **上下文会随着代码演进而过时**——你忘记更新它
- **每个 AI 工具需要不同的格式**——适用于 Cursor 的方法对 Claude 不适用
- **大型代码库难以总结**——很难判断哪些内容值得包含
## ✅ Code2Context 的不同之处
Code2Context 不向你提问,也不需要模板。它 **读取你的实际代码并提取真实信息**。
```
# 一个命令。零个问题。真实分析。
npx code2context init
```
仅此而已。Code2Context 会自动:
1. 🔍 **扫描** 项目中的每个文件
2. 🧩 **解析** 模块导入/导出以构建依赖关系图
3. 📐 **检测** 实际代码模式中的编码约定
4. 📊 **分析** Git 历史以识别热点文件和开发方向
5. 🤖 **生成** AI 驱动的架构洞察(可选)
6. 📤 **导出** 为 `.cursorrules`、`CLAUDE.md` 或任何你需要的格式
```
npx code2context export --format cursor # → .cursorrules
npx code2context export --format claude # → CLAUDE.md
npx code2context export --format text # → CONTEXT.txt
# 代码有变更?增量更新(由 git-diff 驱动,快速)
npx code2context update
```
**无需手动编写。无需过时上下文。为所有 AI 工具提供单一事实来源。**
## 🎯 核心优势
### 1. 🔬 真实代码分析,而非模板
Code2Context 不从模板或问卷生成上下文。它 **分析你的实际源代码**:
- 解析 `import`/`export` 语句(ES 模块、CommonJS、Python)
- 构建真实的 **模块依赖图**
- 识别入口点、关键导出者和最常用的依赖项
- 检测命名约定、文件组织模式和代码风格
```
✔ 46 modules parsed, 7 internal + 77 external deps
✔ Naming: PascalCase, 4 scripts, 17 env vars
```
### 2. 📊 Git 感知智能
Code2Context 读取你的 Git 历史以了解 **项目中实际发生的事情**:
- **热点文件**——最常被修改的文件
- **开发方向**——团队是在构建功能、修复 Bug 还是重构?
- **贡献者**——谁在做什么
- **最近提交**——最近发生了什么变化
这意味着生成的上下文反映的是项目的 **当前现实**,而非静态快照。
### 3. ⚡ 零配置,一键运行
无需交互式向导,无需问卷,也不需要配置文件。
```
# 直接运行即可。它会找出所有答案。
npx code2context init
```
Code2Context 会自动检测你的语言、框架、包管理器、入口点和约定——全部来自你的代码。
### 4. 🔄 增量更新(基于 Git Diff)
首次扫描后,更新快速且精准:
```
npx code2context update
```
这使用 `git diff` 检测自上次扫描以来的变更,并仅重新分析受影响区域。无需完整重扫。
### 5. 🤖 可选的 AI 增强洞察
可选地使用任何 LLM 生成更深层洞察:
- **架构决策**——代码为何如此组织
- **编码指南**——AI 助手应遵循的约定
- **AI 陷阱**——该类型项目中 AI 助手常犯的错误
支持 **任何 OpenAI 兼容 API**——OpenAI、DeepSeek、OpenRouter、Ollama、Groq、Mistral 等。
**无需任何 API 密钥,Code2Context 也能完美运行**——所有代码分析均在本地完成,零外部调用。
## 🔍 提取内容
| 层级 | 检测内容 | 方法 |
|------|----------|------|
| 🏗️ **项目结构** | 目录、关键文件、入口点 | 文件系统遍历 |
| 🧩 **模块图** | 导入、导出、依赖关系 | 正则解析 |
| 📐 **编码约定** | 命名模式、文件组织、代码风格 | 模式检测 |
| 🔧 **配置** | 脚本、环境变量、依赖、框架 | 配置文件解析 |
| 📊 **Git 洞察** | 开发方向、热点文件、贡献者 | Git 历史分析 |
| 🤖 **AI 摘要** | 架构决策、编码指南、陷阱 | LLM 驱动(可选) |
### 支持的语言
**完整模块解析**(导入 + 导出):
- TypeScript / JavaScript(ES 模块 + CommonJS)
- Python
**文件检测**(结构 + 约定):
- Rust、Go、Java、Kotlin、Swift、Ruby、PHP、C#、C++、C、Vue、Svelte、Dart、Elixir、Scala、Zig
## 🚀 快速开始
### 1. 初始化上下文
```
npx code2context init
```
这会扫描你的项目并生成:
- `.code2context/context.json` —— 结构化上下文数据
- `.code2context/context.md` —— 人类可读的摘要
### 2. 导出到你的 AI 工具
```
# 适用于 Cursor
npx code2context export --format cursor
# → 在项目根目录创建 .cursorrules
# 适用于 Claude
npx code2context export --format claude
# → 在项目根目录创建 CLAUDE.md
```
### 3. 保持更新
```
npx code2context update
```
### 4. 检查上下文健康状态
```
npx code2context stats
```
## 🤖 可选的 AI 增强分析
### 选项 A:环境变量
```
export CODE2CONTEXT_API_KEY=your-key
export CODE2CONTEXT_BASE_URL=https://api.provider.com/v1 # optional
export CODE2CONTEXT_MODEL=model-name # optional
```
### 选项 B:配置文件
```
npx code2context config init
npx code2context config set ai.provider deepseek
npx code2context config set ai.model deepseek-chat
```
提供者配置(点击展开)
``` # OpenAI(默认) export CODE2CONTEXT_API_KEY=sk-xxx # DeepSeek(最具成本效益) export CODE2CONTEXT_API_KEY=sk-xxx export CODE2CONTEXT_BASE_URL=https://api.deepseek.com export CODE2CONTEXT_MODEL=deepseek-chat # OpenRouter(100+ 模型) export CODE2CONTEXT_API_KEY=sk-or-xxx export CODE2CONTEXT_BASE_URL=https://openrouter.ai/api/v1 export CODE2CONTEXT_MODEL=anthropic/claude-3.5-sonnet # Ollama(本地、免费、私有) export CODE2CONTEXT_API_KEY=ollama export CODE2CONTEXT_BASE_URL=http://localhost:11434/v1 export CODE2CONTEXT_MODEL=llama3 # Groq(最快推理) export CODE2CONTEXT_API_KEY=gsk_xxx export CODE2CONTEXT_BASE_URL=https://api.groq.com/openai/v1 export CODE2CONTEXT_MODEL=llama-3.1-70b-versatile ```
| 微信支付 | 支付宝 |
|----------|--------|
|
|
|
你也可以通过以下方式支持:
- ⭐ **Star 本项目**——帮助他人发现它
- 🐛 **报告 Bug 或提出功能建议**
- 📢 **与开发朋友分享 Code2Context**
## 📄 许可证
MIT © [Jamesfish](LICENSE)
|
|
标签:AI编码助手, CLAUDE.md, Cursor规则, git历史分析, MITM代理, Node.js工具, NPM包, OSV-Scalibr, SEO关键词, 上下文管理, 代码上下文提取, 代码分析工具, 代码理解, 依赖图构建, 单命令工具, 增量更新, 架构洞察, 模块导入解析, 网络安全研究, 自动分析, 自动化攻击, 规则生成, 逆向工具, 零配置