Skip to content

README_ZH.md

Latest commit

 

History

History
211 lines (146 loc) · 7.5 KB

README_ZH.md

File metadata and controls

211 lines (146 loc) · 7.5 KB

Code Feeder Skill 🚀

Python License Claude

🇬🇧 English Documentation | 🇨🇳 中文文档

智能代码收集器 — 自动化收集项目代码，智能记录用户意图，一键生成 AI 友好的上下文文档。

🙏 鸣谢：本项目灵感来源于 AI_CodeFeeder_by_py，特此感谢原作者的启发。

Code Feeder 是专为 Claude Code 打造的 Skill，它能将你的 CLI Agent 升级为智能上下文收集专家。

旨在解决与 AI 协作时的痛点：如何高效地将项目上下文提供给 LLM? 它能自动化收集代码、生成目录结构、并记录你的意图，让你能直接将生成的 Markdown "喂"给 WEB 端的 AI，无需重复解释背景。

🤔 为什么需要 Code Feeder？

即使你已经拥有 Cursor、GitHub Copilot 或 Claude CLI，此工具依然是深度开发的必备补充：

  1. 🧠 更纯粹的代码洞察力： IDE 和 CLI 中的 AI 往往负载了大量工具（Tools）、MCP 协议和环境上下文。过多的干扰有时会导致模型对代码本身的注意力分散。相比之下，将纯净的代码上下文提供给 Web 端 AI，往往能获得更深刻的逻辑分析和架构建议。

  2. 🚀 官方 Web 端的性能优势： 实践表明，官方 Web 端（如 ChatGPT Plus, Claude.ai, Gemini Web）的模型往往拥有更强的推理能力和隐藏的思维链优化，在处理复杂重构或疑难 Bug 时，表现常优于通过 API 调用的后端模型。

  3. 💰 显著降低 Token 开销： 与其在 CLI 中消耗昂贵的 API 额度进行反复试错和长对话，不如一键生成精准的上下文文档，利用 Web 端（通常是包月制）的算力进行无限制的深度探讨。

✨ 核心特性

  • 🎯 用户意图自动记录：在收集代码时记录你的目的（如"重构认证模块"），生成文档时自动包含意图说明，外部 AI 一看即懂。
  • 🚀 两种收集模式：
    • 批量导入：适合小型项目，一键打包所有相关文件。
    • 智能片段提取：适合大型项目，支持按函数名、类名或行号精准提取，无需手动复制粘贴。
  • 🌲 自动结构可视化：智能生成项目目录树，清晰展示代码组织结构。
  • 🤖 项目类型检测：自动识别 React, Django, Rust, Unity 等 12+ 种项目类型，智能应用最佳过滤规则。
  • 📊 自动统计分析：提供代码行数、语言占比、核心文件识别等统计数据。

🛠 支持的项目类型

系统会自动检测以下类型并优化采集策略（忽略无关文件，优先核心文件）：

前端 后端/系统 其他
React / Next.js Django Unity
Vue / Nuxt FastAPI STM32 Embedded
Node.js Rust / Go 🐍 Python (Generic)

以及 Java, C#, C++, PHP 等通用支持。

🚀 安装说明

全局安装 (推荐)

使 Code Feeder 在所有项目中可用：

  1. 进入 Claude Skills 目录：

    • macOS/Linux: cd ~/.claude/skills
    • Windows (PowerShell): cd $env:USERPROFILE\.claude\skills
    • 如果目录不存在，请先创建它。

  2. 克隆仓库：

    git clone https://github.com/Ecrypted-Data/Code_Feeder_Skill.git code-feeder

  3. 验证安装： 重启 Claude Code，然后询问：

    "What skills do you have available?"

    如果看到 code-feeder 在列表中，说明安装成功！

项目级安装

仅在当前项目中使用： 在项目根目录下创建 .claude/skills 文件夹，然后将代码克隆到其中。

💡 使用方法

在 Claude Code 中

直接与 Agent 对话：

"使用 code-feeder 帮我收集项目代码，我想重构用户登录模块。"

Agent 会自动：

  1. 询问你的具体意图。
  2. 检测项目类型。
  3. 执行收集并生成 markdown 文档。

命令行手动使用

你也可以直接运行 Python 脚本：

1. 批量导入模式 (Batch)

适合收集整个模块或小项目。

python scripts/code_collector.py /path/to/project \
  --mode batch \
  --files src/main.py src/utils.py \
  --intent "分析主逻辑流程" \
  --output context.md

2. 片段提取模式 (Snippets)

适合从大文件中提取特定函数或类。

python scripts/code_collector.py /path/to/project \
  --mode snippets \
  --target src/auth_service.py \
  --ranges "[
    {\"type\": \"function\", \"name\": \"login\"},
    {\"type\": \"class\", \"name\": \"UserSession\"}
  ]" \
  --intent "检查登录安全性" \
  --output context.md

🔍 功能详解

智能片段提取

告别手动滚动几千行代码寻找函数。只需告诉工具函数名，它会自动定位并提取完整代码块（包括缩进）。

支持语言：

  • Python, JavaScript, TypeScript
  • Java, Kotlin, C#
  • C, C++, Go, Rust
  • 更多...

意图驱动的文档生成

生成的 Markdown 文档不仅是代码堆砌，更是任务说明书。

输出示例：

# Project: MyApp
**生成时间**: 2026-01-18
**收集目的**: 重构用户认证模块，分析安全性

## 📁 目录结构
...

## 📄 代码内容
...

## 🎯 收集目的总结
需要重构用户认证模块，希望 AI 分析现有代码的安全性和性能瓶颈。
**提示**：以上代码已根据此目的收集整理，可直接用于相关分析或开发任务。

将此文档发送给 AI，它会立即理解："哦，你需要我分析认证模块的安全性和性能"，无需你再费口舌。

⚙️ 配置指南

配置文件位于 config.json。通常无需修改，系统会自动适配。

默认忽略： .git, node_modules, venv, __pycache__, dist, build 等。

自定义配置： 你可以修改 config.json 来：

  • 添加自定义忽略目录。
  • 设置最大文件大小限制（默认 500KB）。
  • 定义项目的"核心文件"列表。

📂 文件结构

code-feeder/
├── skill.md             # Claude Skill 核心指令与元数据
├── README.md            # 英文说明文档
├── README_ZH.md         # 中文说明文档
├── config.json          # 默认配置文件
├── project-types.json   # 项目类型检测规则
└── scripts/             # 工具脚本目录
    ├── code_collector.py      # 代码收集核心逻辑
    └── detect_project.py      # 项目类型检测工具

🤝 贡献

欢迎提交 Issue 和 Pull Request！

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 提交 Pull Request

📄 许可证

本项目基于 MIT 许可证开源 - 详见 LICENSE 文件。