基本能力
产品定位
ctx是一个Context as Code (CaC)工具,旨在为开发者提供一个高效的方式,将代码库的上下文信息整合并传递给大型语言模型(LLM),如ChatGPT或Claude,以提升开发效率和AI辅助编程的质量。
核心功能
- 自动构建上下文文件:从代码文件、GitHub仓库、Git提交和差异、网页(URL)以及纯文本中自动构建上下文文件。
- 模式匹配与过滤:通过文件模式、内容搜索、大小或日期过滤来定位特定文件。
- 内容修饰:应用修饰符(如提取PHP签名而不包含实现细节)来优化上下文内容。
- 结构化输出:将内容组织成结构化的Markdown文档。
- MCP服务器支持:内置MCP服务器,允许AI助手(如Claude)直接访问项目信息。
适用场景
- 代码重构辅助:为AI提供干净的、结构化的代码文件,帮助进行代码重构。
- 多轮迭代开发:自动化更新上下文,支持多轮开发迭代。
- 文档生成:将代码库转化为全面的文档,结合源代码和自定义解释生成用户指南、API参考或开发者文档。
- 无缝AI集成:通过MCP服务器直接连接Claude AI,实现实时、上下文感知的辅助。
工具列表
- ctx命令:主工具,用于生成和管理上下文文件。
- MCP服务器:内置服务器,用于直接连接AI助手。
- JSON Schema:提供JSON模式,支持IDE中的自动完成和验证。
常见问题解答
- 如何安装ctx? 使用提供的安装脚本或参考完整安装指南。
- 如何配置ctx? 通过
ctx init
生成配置文件,并根据需要编辑。 - 如何连接Claude AI? 通过内置MCP服务器配置,参考MCP服务器文档。
使用教程
使用依赖
无特殊依赖,只需支持运行shell脚本的环境。
安装教程
bash
curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sh
调试方式
- 生成上下文文件:
bash
ctx - 启动MCP服务器:
bash
ctx server -c /path/to/your/project - 查看日志:使用
-v
、-vv
或-vvv
参数获取详细输出。