forked from Gitlink/gitlink-cli
4.5 KiB
4.5 KiB
复现指南(REPRODUCE)
面向评委的"照此即可复现全部成果"手册。四个部分相互独立,可按需选做。 全程约 15–30 分钟(不含等待 Review)。
0. 前置准备
- GitLink 账号(https://www.gitlink.org.cn 注册)
- 任一终端:macOS / Linux / Windows
- 二选一:Node.js 14+(npm 装 CLI)或 Go 1.26+(源码构建)
- GitLink Token:登录后在「个人设置 → 访问令牌」生成,或用
auth login交互登录
git clone https://www.gitlink.org.cn/jiangtx/gitlink-cli.git
cd gitlink-cli
1. 复现 CLI 命令(子任务一)
1.1 安装
# 方式 A:npm
npm install -g @gitlink-ai/cli
# 方式 B:源码(需 Go 1.26+)
go build -o gitlink-cli .
1.2 认证
gitlink-cli auth login # 交互登录;CI 环境用 export GITLINK_TOKEN=xxx
gitlink-cli auth status # 确认登录
1.3 验证新命令(任选)
gitlink-cli pm --help # 项目管理(6 命令)
gitlink-cli wiki --help # Wiki(5 命令)
gitlink-cli export --help # 数据导出(3 命令)
gitlink-cli workflow --help # 工作流分析(4 命令)
gitlink-cli capability +check # 后端能力探测
# 跑一条真实命令
gitlink-cli export +contributors --owner Gitlink --repo gitlink-cli --format json
gitlink-cli workflow +triage --owner Gitlink --repo gitlink-cli --limit 10
1.4 跑单元测试
go test ./... -race # 需 Go 环境;CI 已自动执行
2. 复现 Skill(子任务二)
2.1 加载 Skills 到 Agent 平台
把 skills/ 目录拷贝到 Agent 的 skills 路径,或直接在仓库内调用:
Claude Code:skills/ 放到 ~/.claude/skills/ 或项目 .claude/skills/,重启会话。
2.2 验证已验证 Skill(6 个有运行记录)
# 例:技术调研 Skill
# 在 Agent 对话:「调研 GitLink 上'大模型'相关的活跃项目」
# Agent 会按 skills/gitlink-research-tracker/SKILL.md 执行
# 或看现成验证记录
cat skills/gitlink-research-tracker/EXAMPLES.md # token/耗时/输出
cat skills/gitlink-contributor-insight/EXAMPLES.md
cat skills/gitlink-ci-health/EXAMPLES.md
cat skills/gitlink-issue-triage/EXAMPLES.md
cat skills/gitlink-onboarding/EXAMPLES.md
cat skills/gitlink-notification-digest/EXAMPLES.md
待验证 Skill(20 个)含完整 SKILL.md,按同样方式加载即可运行。
3. 复现端到端工作流(子任务三)
cd examples/workflows/community-ops-automation
# Windows
powershell -File scripts/run_demo.ps1 -Owner Gitlink -Repo gitlink-cli
# Linux/macOS(需 npm 可用,脚本通过 npm exec 调 @gitlink-ai/cli)
node scripts/gitlink_workflow.js --owner Gitlink --repo gitlink-cli
输出:outputs/{owner}_{repo}_{timestamp}_report.md(社区运营报告)+ _release_notes.md。
验证证据见 docs/verification.md(已在 Gitlink/gitlink-cli、puygob236/gitlink-cli 两真项目跑过,含计数与时间戳)。
4. 复现科研服务(子任务四)
4.1 在线体验(无需自部署)
直接访问:http://121.41.212.97/skills/
- 技术调研:输入「大模型」→ 生成调研报告
- 科研实验室:热点追踪 / 项目洞悉 / 合规检查 / 协作匹配 / 进度跟踪
4.2 自部署
cd gitlink-web
pip install -r requirements.txt
export API_KEY="你的 DeepSeek Key"
export API_BASE="https://api.deepseek.com/v1"
export API_MODEL="deepseek-chat"
python app.py --port=5000
# 访问 http://localhost:5000/
或一键部署到服务器:python deploy.py(paramiko SSH,详见 gitlink-web/README.md)。
5. 常见问题
| 问题 | 解决 |
|---|---|
command not found: go |
用 npm 方式装 CLI,或装 Go 1.26+ |
| 认证失败 / 401 | gitlink-cli auth login 重新登录,或检查 GITLINK_TOKEN |
| 命令标 ⚠ | 该模块后端暂不支持,gitlink-cli capability +check 查看详情 |
| 工作流只支持 Windows | 用第 3 节的 node 命令在任意平台跑 |
| 科研服务报 API_KEY 未设置 | 配 API_KEY 环境变量(DeepSeek 或兼容 OpenAI 的接口) |
6. 预期产物清单(复现成功后应得到)
- CLI 可运行,
--help列出 21 个命令组 go test ./...全绿(或 CI 绿)- 至少 1 个 Skill 在 Agent 平台产出结果
- 工作流生成 1 份
_report.md - 科研服务页面可访问并生成 1 份调研报告