forked from Gitlink/gitlink-cli
179 lines
9.3 KiB
Markdown
179 lines
9.3 KiB
Markdown
---
|
||
name: gitlink-code-insight
|
||
version: 4.0.0
|
||
description: "功能全景仪表盘：当用户想了解 gitlink-cli 有哪些功能时，生成交互式 HTML 页面并打开浏览器展示。"
|
||
metadata:
|
||
requires:
|
||
bins: ["python3"]
|
||
---
|
||
|
||
# gitlink-code-insight（功能全景仪表盘）
|
||
|
||
## 触发条件
|
||
|
||
用户问以下问题时触发：
|
||
- "gitlink-cli 有哪些功能"
|
||
- "帮我生成一个功能展示页面"
|
||
- "我想浏览所有可用命令"
|
||
|
||
## 执行步骤
|
||
|
||
1. 根据下方 Shortcuts 数据生成单文件 HTML
|
||
2. 写入 `doc/dashboard.html`
|
||
3. 用 `python3 -c "import webbrowser; webbrowser.open('file://$(pwd)/doc/dashboard.html')"` 打开
|
||
|
||
## 页面要求
|
||
|
||
- 暗色主题（GitHub Dark 风格）
|
||
- 顶部：标题 + 统计数字（分类数、Shortcuts 总数）+ 搜索框
|
||
- 主体：分类卡片列表，每个卡片可折叠展开
|
||
- 卡片标题：图标 + 分类名 + 命令计数
|
||
- 展开后显示该分类下所有 shortcut 行
|
||
- 每行：命令（等宽蓝色）+ 认证标签（绿色=需认证，蓝色=公开）+ 描述
|
||
- 点击 shortcut 行展开代码示例
|
||
- 搜索框实时过滤（按命令名和描述匹配），无匹配时隐藏整个分类
|
||
- 纯 CSS + 原生 JS，无外部依赖
|
||
|
||
---
|
||
|
||
## Shortcuts 数据
|
||
|
||
### 一、仓库管理 📦
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `repo +list` | 仓库列表 | 否 | `gitlink-cli repo +list --user zhangsan` |
|
||
| `repo +info` | 仓库详情 | 否 | `gitlink-cli repo +info --owner Gitlink --repo forgeplus` |
|
||
| `repo +create` | 创建仓库 | 是 | `gitlink-cli repo +create --name my-project --description "项目描述"` |
|
||
| `repo +fork` | Fork 仓库 | 是 | `gitlink-cli repo +fork --owner Gitlink --repo forgeplus` |
|
||
| `repo +delete` | 删除仓库（不可逆） | 是 | `gitlink-cli repo +delete --owner myuser --repo old-project` |
|
||
| `repo +batch-create` | 批量创建仓库 | 是 | `gitlink-cli repo +batch-create --from repos.csv` |
|
||
| `repo +batch-update` | 批量更新仓库 | 是 | `gitlink-cli repo +batch-update --from updates.csv` |
|
||
| `repo +add-member` | 添加仓库成员 | 是 | `gitlink-cli repo +add-member --owner myuser --repo myrepo --user newmember --role developer` |
|
||
|
||
### 二、分支管理 🌿
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `branch +list` | 分支列表 | 否 | `gitlink-cli branch +list --owner Gitlink --repo forgeplus` |
|
||
| `branch +create` | 创建分支 | 是 | `gitlink-cli branch +create --name feature/new-feature` |
|
||
| `branch +delete` | 删除分支（不可逆） | 是 | `gitlink-cli branch +delete --name feature/old-feature` |
|
||
| `branch +protect` | 保护分支 | 是 | `gitlink-cli branch +protect --name main` |
|
||
| `branch +unprotect` | 取消保护 | 是 | `gitlink-cli branch +unprotect --name main` |
|
||
|
||
### 三、Issue 管理 🐛
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `issue +list` | Issue 列表 | 否 | `gitlink-cli issue +list --owner Gitlink --repo forgeplus --state open` |
|
||
| `issue +view` | Issue 详情 | 否 | `gitlink-cli issue +view --owner Gitlink --repo forgeplus --number 4` |
|
||
| `issue +create` | 创建 Issue | 是 | `gitlink-cli issue +create --owner myuser --repo myrepo --title "Bug: 登录失败" --body "复现步骤"` |
|
||
| `issue +update` | 更新 Issue | 是 | `gitlink-cli issue +update --number 4 --title "新标题" --body "更新描述"` |
|
||
| `issue +close` | 关闭 Issue | 是 | `gitlink-cli issue +close --number 4` |
|
||
| `issue +batch-close` | 批量关闭 Issue | 是 | `gitlink-cli issue +batch-close --numbers 123,124 --dry-run` |
|
||
| `issue +comment` | 添加评论 | 是 | `gitlink-cli issue +comment --number 4 --body "已修复"` |
|
||
|
||
### 四、Pull Request 🔀
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `pr +list` | PR 列表 | 否 | `gitlink-cli pr +list --owner Gitlink --repo forgeplus --state open` |
|
||
| `pr +view` | PR 详情 | 否 | `gitlink-cli pr +view --id 3` |
|
||
| `pr +create` | 创建 PR | 是 | `gitlink-cli pr +create --title "feat: 新功能" --head feature/x --base master` |
|
||
| `pr +merge` | 合并 PR | 是 | `gitlink-cli pr +merge --id 3 --method squash` |
|
||
| `pr +close` | 关闭 PR | 是 | `gitlink-cli pr +close --id 3` |
|
||
| `pr +files` | 变更文件列表 | 否 | `gitlink-cli pr +files --id 3` |
|
||
| `pr +diff` | 查看提交列表 | 否 | `gitlink-cli pr +diff --id 3` |
|
||
| `pr +comment` | PR 评论 | 是 | `gitlink-cli pr +comment --id 3 --body "LGTM"` |
|
||
| `pr +review` | 代码审查 | 是 | `gitlink-cli pr +review --id 3 --event COMMENT --body "整体 LGTM"` |
|
||
|
||
### 五、版本发布 🚀
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `release +list` | 发布列表 | 否 | `gitlink-cli release +list --owner Gitlink --repo forgeplus` |
|
||
| `release +view` | 发布详情 | 否 | `gitlink-cli release +view --id <version_id>` |
|
||
| `release +create` | 创建发布 | 是 | `gitlink-cli release +create --tag v1.0.0 --name "v1.0.0" --target master` |
|
||
| `release +delete` | 删除发布（不可逆） | 是 | `gitlink-cli release +delete --id <version_id>` |
|
||
|
||
### 六、Wiki 管理 📖
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `wiki +list` | Wiki 页面列表 | 否 | `gitlink-cli wiki +list --owner Gitlink --repo forgeplus` |
|
||
| `wiki +view` | 查看页面内容 | 否 | `gitlink-cli wiki +view --owner Gitlink --repo forgeplus --title "Home"` |
|
||
| `wiki +create` | 创建页面 | 是 | `gitlink-cli wiki +create --owner myuser --repo myrepo --title "API 文档" --file ./api.md` |
|
||
| `wiki +update` | 更新页面 | 是 | `gitlink-cli wiki +update --owner myuser --repo myrepo --title "设计文档" --add "新内容"` |
|
||
| `wiki +delete` | 删除页面 | 是 | `gitlink-cli wiki +delete --owner myuser --repo myrepo --title "废弃页面"` |
|
||
|
||
### 七、CI/CD ⚙️
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `ci +builds` | 构建列表 | 是 | `gitlink-cli ci +builds --owner myuser --repo myrepo` |
|
||
| `ci +logs` | 构建日志 | 是 | `gitlink-cli ci +logs --build 42 --stage 1 --step 1` |
|
||
| `ci +restart` | 重启构建 | 是 | `gitlink-cli ci +restart --build 42` |
|
||
| `ci +stop` | 停止构建 | 是 | `gitlink-cli ci +stop --build 42` |
|
||
|
||
### 八、Webhook 🔔
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `webhook +list` | Webhook 列表 | 是 | `gitlink-cli webhook +list --owner myuser --repo myrepo` |
|
||
| `webhook +info` | Webhook 详情 | 是 | `gitlink-cli webhook +info --owner myuser --repo myrepo --id 123` |
|
||
| `webhook +events` | 支持的事件类型 | 否 | `gitlink-cli webhook +events` |
|
||
| `webhook +create` | 创建 Webhook | 是 | `gitlink-cli webhook +create --url https://example.com/hook --events push` |
|
||
| `webhook +update` | 更新 Webhook | 是 | `gitlink-cli webhook +update --id 123 --events push,pull_request` |
|
||
| `webhook +test` | 测试 Webhook | 是 | `gitlink-cli webhook +test --id 123 --event push` |
|
||
| `webhook +delete` | 删除 Webhook | 是 | `gitlink-cli webhook +delete --id 123` |
|
||
|
||
### 九、组织管理 🏢
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `org +list` | 组织列表 | 否 | `gitlink-cli org +list` |
|
||
| `org +info` | 组织详情 | 否 | `gitlink-cli org +info --id Gitlink` |
|
||
| `org +members` | 成员列表 | 否 | `gitlink-cli org +members --id Gitlink` |
|
||
| `org +create` | 创建组织 | 是 | `gitlink-cli org +create --name my-org --description "我的组织"` |
|
||
| `org +batch-add` | 批量添加成员 | 是 | `gitlink-cli org +batch-add --id my-org --users "user1,user2"` |
|
||
|
||
### 十、用户与搜索 👤
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `user +me` | 当前登录用户 | 是 | `gitlink-cli user +me` |
|
||
| `user +info` | 用户详情 | 否 | `gitlink-cli user +info --login zhangsan` |
|
||
| `search +repos` | 搜索仓库 | 否 | `gitlink-cli search +repos --keyword "machine learning"` |
|
||
| `search +users` | 搜索用户 | 否 | `gitlink-cli search +users --keyword "zhangsan"` |
|
||
|
||
### 十一、安全与合规 🛡️
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `compliance +scan` | 全量扫描 | 否 | `gitlink-cli compliance +scan` |
|
||
| `compliance +license` | 许可证合规检查 | 否 | `gitlink-cli compliance +license` |
|
||
| `compliance +deps` | 依赖许可证检查 | 否 | `gitlink-cli compliance +deps` |
|
||
| `compliance +secrets` | 敏感信息扫描 | 否 | `gitlink-cli compliance +secrets` |
|
||
| `compliance +exposure` | PII 与暴露面扫描 | 否 | `gitlink-cli compliance +exposure` |
|
||
| `compliance +vocab` | 敏感词汇扫描 | 否 | `gitlink-cli compliance +vocab` |
|
||
|
||
### 十二、新人引导 👋
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `onboard +welcome` | 添加引导评论 | 是 | `gitlink-cli onboard +welcome --issues "3,7,15"` |
|
||
|
||
### 十三、团队管理 👥
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `team +list` | 团队列表 | 否 | `gitlink-cli team +list --org my-org` |
|
||
| `team +create` | 创建团队 | 是 | `gitlink-cli team +create --org my-org --name dev-team` |
|
||
| `team +add-member` | 添加成员 | 是 | `gitlink-cli team +add-member --org my-org --team dev-team --user newmember` |
|
||
|
||
### 十四、贡献报告 📊
|
||
|
||
| 命令 | 描述 | 认证 | 示例 |
|
||
|------|------|------|------|
|
||
| `contrib +report` | 贡献统计报告 | 否 | `gitlink-cli contrib +report --owner myuser --repo myrepo` |
|