📌 Skill基础信息
- Skill名称:SourceSage CLI
- 简称:sourcesage-cli
- 来源:社区第三方(Sunwood-ai-labs)
- 运行宿主:Claude-Code CLI
- 核心定位:自动生成AI友好的代码仓库文档摘要,适用于代码仓库分析、项目文档自动生成和团队知识传承场景。
🧩 内部核心组成
本Skill主要通过命令行工具实现核心功能,包含以下核心组件:
命令行工具集:
| 命令/参数 | 功能简述 |
|---|---|
sage | 生成当前仓库标准摘要文档 |
sage --lite | 生成精简版仓库摘要(忽略文件内容详情) |
sage -l ja/en | 指定输出语言(日语/英语) |
sage --repo <target-repo> | 分析指定本地仓库 |
sage -o <output-dir> | 指定输出目录 |
sage --diff | 生成过时的标签差异发布报告(已弃用) |
目录结构依赖:
- 输出目录:
.SourceSageAssets/ - 核心文档:
Repository_summary.md - 差异报告:
RELEASE_REPORT/Report_<latest-tag>.md(弃用功能) - 忽略文件:
.SourceSageignore
🛠 安装与启用方式
安装命令:
skills install --user Sunwood-ai-labs/SourceSage
前置依赖:
- UV Python包管理器(必需)
- 本地SourceSage仓库检出(优先使用)
启动方式:
- 确保本地有SourceSage仓库检出
- 在目标仓库目录或指定仓库路径执行:
uv run --directory <sourcesage-root> sage [参数]
📋 标准工作流
- 环境检测:Skill首先检测当前工作目录是否为SourceSage仓库本身
- 路径解析:如果不是,则定位到SourceSage工具根目录
- 命令构建:根据用户需求选择最小化命令组合(lite模式、语言选项、目标仓库等)
- 执行生成:通过uv运行sage命令,生成仓库摘要文档
- 结果验证:自动检查生成的markdown文件是否存在并读取内容
- 结果汇报:向用户报告生成的文件路径和内容摘要,而非仅仅确认命令执行
⚠️ 关键限制、缺陷、注意事项
平台限制:
- 仅支持本地仓库分析,不支持远程仓库直接操作
- 依赖UV包管理器,无法在无Python环境系统中使用
Token消耗:
- 完整模式会生成详细文件内容,可能产生较大输出
- Lite模式显著减少输出大小,适合初步探索
适用项目:
- 中小型代码仓库文档生成
- 需要快速了解项目结构的场景
不适用场景:
- 超大型仓库(可能生成过大的摘要文档)
- 需要实时协作的文档编辑需求
已知坑点:
--use-ignore参数当前CLI未暴露,无法使用--diff参数已弃用,功能可能不稳定- 不能静默覆盖已存在的输出文件
生产环境:建议在测试环境验证后再上生产,注意输出文件的管理策略
✅ 适用场景 & ❌ 不适合场景
适用场景:
- 新接手项目需要快速了解代码结构
- 为AI辅助编程提供仓库上下文文档
- 团队知识管理和传承的文档自动化
- 多语言项目的文档生成(支持日英双语)
不适合场景:
- 需要实时协作编辑的文档需求
- 超大型单体仓库的完整分析
- 需要高度定制化文档格式的场景
- 无本地代码仓库的远程分析需求
如何安装
skills install --user Sunwood-ai-labs/SourceSage通用安装教程:在哪里输入上面的命令
上面的命令本质是在「终端 / 命令行」中调用技能管理器,把该 Skill 下载并注册到你的 AI 工具。各主流工具打开终端的位置不同,按下面操作即可:
- 打开工具自带的终端面板,或系统终端(macOS「终端」、Windows「PowerShell」、Linux「Terminal」)。
- 把上面的安装命令复制进去,回车运行,等待下载与注册完成。
- 重启或重新加载 AI 工具,让新安装的 Skill 被识别。
- 新建对话并触发:直接描述用途,或通过该工具的技能 / 斜杠菜单选中此 Skill。
Claude 桌面版(macOS / Windows)
桌面版没有内置命令行,Skill 需通过 Claude Code CLI 安装。打开系统终端,先执行 npm install -g @anthropic-ai/claude-code,再运行上面的安装命令;完成后完全退出并重新打开 Claude。
Claude Code(终端 CLI)
直接在项目目录的终端里运行上面的命令即可。也可先输入 claude 启动交互界面,再在对话中引用该 Skill(/ 斜杠菜单或直接描述用途)。
VS Code(含 GitHub Copilot)
打开终端面板:菜单「终端 → 新建终端」,或快捷键 Ctrl+`(macOS 为 ⌃+`)。在终端里运行上面的命令;装完后执行「重新加载窗口」(Ctrl+Shift+P → Reload Window),让 Copilot 等扩展识别新技能。
Cursor
底部「终端」面板(Ctrl+`)即是内置终端。粘贴运行上面的命令,完成后在命令面板执行「Reload Window」刷新,再开始对话。
Windsurf
底部「终端」面板运行命令;也可直接使用其内置 Agent 终端,在对话侧执行安装。
其他工具(ChatGPT、本地脚本等)
不支持本地终端的产品,可先在本机终端完成安装,再在对话中描述该 Skill 的能力让其调用;不同工具的命令格式请以其官方文档为准。
风险提示
自动扫描未发现高危命令、隐私抓取或数据外传行为。仍建议安装前快速浏览仓库代码。
Aitishiku.com