agiledev-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +190 -0
- package/SKILL.md +98 -0
- package/adev.js +1285 -0
- package/logo.svg +8 -0
- package/package.json +36 -0
- package/skills/adev-login/SKILL.md +41 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 AgileDev CLI contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="logo.svg" alt="AgileDev CLI" width="120"/>
|
|
4
|
+
|
|
5
|
+
# AgileDev-Cli
|
|
6
|
+
|
|
7
|
+
**AgileDev 敏捷研发管理系统的命令行工具**
|
|
8
|
+
|
|
9
|
+
不用打开网页,终端一条命令搞定:提 bug · 修 bug · 提需求 · 看迭代 · 设提测 · 查知识库 · 发周报,也可以直接对 AI 说人话 🗣️
|
|
10
|
+
|
|
11
|
+
[](https://nodejs.org)
|
|
12
|
+
[](LICENSE)
|
|
13
|
+
[]()
|
|
14
|
+
[]()
|
|
15
|
+
|
|
16
|
+
面向所有角色:**开发 · 测试 · 产品**,不需要懂编程 ✨
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 📦 安装
|
|
23
|
+
|
|
24
|
+
前提:电脑装有 [Node.js](https://nodejs.org) 18 或更高版本(下载 LTS 版一路下一步即可;不确定的话找身边开发同事帮忙装一次)。
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install -g agiledev-cli
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
无需任何账号或令牌,装完即用 ✨
|
|
31
|
+
|
|
32
|
+
## 🔐 登录
|
|
33
|
+
|
|
34
|
+
登录方式有两种,选其中任何一种都可以。
|
|
35
|
+
|
|
36
|
+
### 方式一:通过账号密码
|
|
37
|
+
|
|
38
|
+
在终端输入 `adev login`,或者跟 AI 说「登录敏捷系统」,然后按提示输入账号和密码。就是登录敏捷系统(scrum.chitem.com)用的那个账号。输入密码时屏幕不会显示任何字符,正常输完回车即可。
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
adev login
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 方式二:使用 API Key(长期使用推荐)
|
|
45
|
+
|
|
46
|
+
- 在网页打开敏捷系统并登录
|
|
47
|
+
- 右上角点击用户名称 → **API 密钥** → **新建 API Key**
|
|
48
|
+
- 名称:可以随便写,例如 `AgileDev-Cli`
|
|
49
|
+
- 过期时间:可以留空,推荐填个时间
|
|
50
|
+
- 权限:将需要用到的功能勾选上
|
|
51
|
+
- 创建好 API Key 后复制下来,然后在命令行执行:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
adev config set-token 你的ApiKey
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
> 📌 凭证统一保存在用户目录的 `~/.agiledev-cli.json`(含密钥,⚠️ 不要提交到任何仓库或聊天中);Key 的权限在平台上按模块分配,写操作需要对应模块的写权限。两种方式后配置的生效,随时可以换。
|
|
58
|
+
|
|
59
|
+
## 🚀 使用
|
|
60
|
+
|
|
61
|
+
### 🤖 直接和 AI 说
|
|
62
|
+
|
|
63
|
+
先执行一次 `adev setup` 把 AI 技能装好(自动识别 ZCode 等 AI 助手目录),然后就可以直接说人话了。不同岗位的例子:
|
|
64
|
+
|
|
65
|
+
**👥 所有人**
|
|
66
|
+
|
|
67
|
+
- 💬 「帮我登录敏捷系统」
|
|
68
|
+
- 💬 「敏捷系统里有哪些项目」
|
|
69
|
+
- 💬 「我的工作台上有什么待办」
|
|
70
|
+
- 💬 「看看本周的迭代排期」
|
|
71
|
+
|
|
72
|
+
**🧪 测试**
|
|
73
|
+
|
|
74
|
+
- 💬 「看看测试今天提了哪些 bug」
|
|
75
|
+
- 💬 「登记一个 bug:销售订单点导出没反应,P2,复现步骤是……」← AI 会帮你把表单信息组好
|
|
76
|
+
- 💬 「BUG-20260922-011」← 只发编号:AI 会查出来给你看,并**询问**你要不要修,不会擅自动手
|
|
77
|
+
- 💬 「BUG-20260922-008 验证不通过,打回」← 明确说了动作才会执行
|
|
78
|
+
- 💬 「看看待我验证的 bug 还有哪些」
|
|
79
|
+
- 💬 「给需求 401 设置 10 月 1 号提测」
|
|
80
|
+
|
|
81
|
+
**📋 产品**
|
|
82
|
+
|
|
83
|
+
- 💬 「创建一个需求:销售统计增加欠款金额字段,属于海外线下零售项目」
|
|
84
|
+
- 💬 「看看现在开发中的需求有哪些」
|
|
85
|
+
- 💬 「需求 401 的数据源对接清单是什么」
|
|
86
|
+
- 💬 「需求 401 先暂缓」
|
|
87
|
+
|
|
88
|
+
**💻 开发**
|
|
89
|
+
|
|
90
|
+
- 💬 「看看分配给我的 Pending bug」
|
|
91
|
+
- 💬 「帮我修复 BUG-20260922-011」← 明确说了修复才会开始:AI 看详情和截图 → 改代码 → 转待验证
|
|
92
|
+
- 💬 「把这个需求拆成开发任务」← AI 读需求内容,拆解后批量创建任务
|
|
93
|
+
- 💬 「迭代 103 启动开发」
|
|
94
|
+
|
|
95
|
+
### ⌨️ 使用 CLI
|
|
96
|
+
|
|
97
|
+
以下命令都可以直接复制执行,把引号里的内容换成你自己的。忘了命令怎么写就执行 `adev --help`。
|
|
98
|
+
|
|
99
|
+
#### 🔍 查询(所有人)
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
adev projects # 有哪些项目(记住项目名,后面都能用名字代替 id)
|
|
103
|
+
adev dashboard # 我的工作台:待办、即将到期、今日完成
|
|
104
|
+
adev bugs list --status Pending # 待处理的 bug
|
|
105
|
+
adev bugs list --mine # 分配给我的(加 --status ToVerify 看待我验证的)
|
|
106
|
+
adev bugs show BUG-20260922-011 # 看某个 bug 的详情和截图(直接用编号)
|
|
107
|
+
adev reqs list --status 开发中 # 开发中的需求
|
|
108
|
+
adev reqs show 401 # 需求详情(支持 REQ-xxx 编号)
|
|
109
|
+
adev versions list # 版本迭代列表
|
|
110
|
+
adev kb list # 知识库文档列表;adev kb show <id> 看正文
|
|
111
|
+
adev weekly list --mine # 我的周报
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### 🧪 测试同学
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# 登记缺陷(不用打开网页填表单)
|
|
118
|
+
adev bugs create --title "销售订单-导出按钮点击无反应" --project 海外线下零售 --severity P2 --data '{"actual_behavior":"点导出后无任何反应,复现步骤:订单列表→勾选→导出"}'
|
|
119
|
+
|
|
120
|
+
# 级别说明:P0 阻塞 / P1 严重 / P2 一般 / P3 建议
|
|
121
|
+
# 项目名写关键词即可(如"海外线下零售"),不必写全称
|
|
122
|
+
|
|
123
|
+
adev bugs comment BUG-20260922-011 --content "已复现,和 BUG-20260922-008 是同一个问题" # 补充评论
|
|
124
|
+
adev bugs reopen BUG-20260922-008 --notes "验证不通过,问题依旧" # 验证不通过时打回
|
|
125
|
+
adev reqs set-test-date 401 --date 2026-10-01 # 设置需求提测时间
|
|
126
|
+
adev tests list --project 海外线下零售 # 查看测试计划
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### 📋 产品同学
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
# 创建需求
|
|
133
|
+
adev reqs create --title "销售统计增加欠款金额字段" --project 海外线下零售 --data '{"type":"新功能","description":"销售统计列表增加当前欠款金额列"}'
|
|
134
|
+
# 类型:新功能 / 优化 / 技术债 / Bug修复
|
|
135
|
+
|
|
136
|
+
adev reqs list --status 待处理 # 跟踪各状态需求:待处理/已准入/开发中/已发布/暂缓
|
|
137
|
+
adev reqs data-sources 401 # 查看/维护需求的数据源对接清单
|
|
138
|
+
adev versions list # 看各迭代的进度和排期
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
#### 💻 开发同学
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
adev bugs list --status Pending --mine # 今天要修的 bug
|
|
145
|
+
adev bugs claim BUG-20260922-011 # 认领
|
|
146
|
+
adev bugs resolve BUG-20260922-011 --notes "本位币取值字段写反,已修正" # 修复完成,转待验证
|
|
147
|
+
adev bugs reject BUG-20260922-011 --reason "与 BUG-20260922-008 重复" # 拒绝重复/无效缺陷
|
|
148
|
+
|
|
149
|
+
adev tasks list --mine # 我的开发任务
|
|
150
|
+
adev tasks create --title "订单导出接口优化" --project 海外线下零售 --assignee me
|
|
151
|
+
adev versions start 103 # 迭代启动开发(另有 start-testing/complete/accept/release)
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
## ❓ 常见问题
|
|
155
|
+
|
|
156
|
+
| 现象 | 处理 |
|
|
157
|
+
|---|---|
|
|
158
|
+
| 提示"登录已过期" | 重新 `adev login`(账号已记住,回车后只输密码) |
|
|
159
|
+
| 提示"登录失败:用户名或密码错误" | 账号即网页登录账号,确认后重试;忘记密码找管理员重置 |
|
|
160
|
+
| 提示 code=40300 无权限 | 你的账号/凭证没有该模块权限,找系统管理员分配 |
|
|
161
|
+
| 网络请求失败 | 本工具直连公司内网,请确认在办公网络或已连 VPN |
|
|
162
|
+
| 表格文字被截断 | 加 `--json` 查看完整数据,或用 `show` 看单条 |
|
|
163
|
+
| 忘记命令 | `adev --help` 查看全部用法 |
|
|
164
|
+
|
|
165
|
+
## ⚙️ 进阶:脚本与集成
|
|
166
|
+
|
|
167
|
+
- 所有查询命令支持 `--json` 输出原始 JSON;所有写操作支持 `--data '<json>'` / `--json-file <path>` 透传完整请求体
|
|
168
|
+
- 环境变量 `ADEV_BASE_URL` / `ADEV_TOKEN` 可覆盖配置,适合 CI 场景
|
|
169
|
+
- 配置读取顺序:环境变量 > `~/.agiledev-cli.json` > `./adev.config.json`
|
|
170
|
+
|
|
171
|
+
## 🛠️ 开发与扩展(面向维护者)
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
git clone <本仓库> && cd agiledev-cli
|
|
175
|
+
npm install -g . # 本地安装调试
|
|
176
|
+
npm test # 回归测试(node --test)
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
- 单文件 `adev.js`,按资源模块化:接入新接口时在浏览器 F12 → Network 找到 `/api/v1/...` 请求,仿照现有资源增加 handler 与分发,并更新 `SKILL.md`
|
|
180
|
+
- 🐞 Bug 状态:`Pending 待处理 / InProgress 处理中 / ToVerify 待验证 / Reopened 重新打开 / Rejected 已拒绝 / Closed 已关闭`(故障另有 `Released 已发布`);解决方案:`fixed / wontfix / duplicate / cannot_reproduce / by_design / later`
|
|
181
|
+
- 📝 需求状态(中文值):`待处理 / 已准入 / 开发中 / 已发布 / 已拒绝 / 暂缓`;任务状态(中文值):`待开始 / 开发中 / 已暂停 / 已完成 / 不处理`
|
|
182
|
+
- 📦 发布:包托管在 GitHub Packages(`@anyaoqi/agiledev-cli`),发布用 `npm publish`(需 `write:packages` 权限的 GitHub 令牌)
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
<div align="center">
|
|
187
|
+
|
|
188
|
+
用得顺手的话,给项目点个 ⭐ 吧 🎉
|
|
189
|
+
|
|
190
|
+
</div>
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: adev
|
|
3
|
+
description: 操作 AgileDev 敏捷研发管理系统(用户常称"敏捷系统/敏捷开发系统",scrum.chitem.com):查看/登记/修复 bug,查看/创建需求和任务,版本迭代管理,线上故障,知识库,周报,工作台,测试计划等。当用户提到"看bug/拉bug/修bug/登记bug"、"需求/任务/迭代/提测"、"线上故障"、"知识库/周报/工作台/看板"、"测试计划",把"敏捷系统/敏捷开发系统/AgileDev"与其他操作组合(如"敏捷系统里有哪些项目"、"我的敏捷系统待办"),或**直接发送一个编号**(如 BUG-20260922-011、REQ-20260922-003、INC-20260910-001 或纯数字 id)时使用。若用户的话是"登录"与敏捷系统组合(如"帮我登录敏捷系统"),优先使用 adev-login skill。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# adev — AgileDev 敏捷系统操作
|
|
7
|
+
|
|
8
|
+
通过 `adev` 命令行工具(已全局安装)读写公司 AgileDev 系统。无需登录网页复制粘贴。
|
|
9
|
+
|
|
10
|
+
## 收到编号时的行为规则(重要)
|
|
11
|
+
|
|
12
|
+
用户直接发送一个编号(如 `BUG-20260922-011`、`REQ-20260922-003`、`INC-20260910-001` 或纯数字 id)而**没有附带任何动作词**时:
|
|
13
|
+
|
|
14
|
+
1. 按编号前缀查询并展示摘要(BUG → `adev bugs show`,REQ → `adev reqs show`,INC → `adev incidents show`;show 会自动下载截图,用 Read 查看)
|
|
15
|
+
2. 展示后**主动询问**用户下一步想做什么,例如:"这个 bug 当前状态是『待处理』,处理人是你。需要我修复它吗?还是你只想看详情/截图?"
|
|
16
|
+
3. **严禁在用户未明确要求时执行任何写操作**(resolve/claim/reject/reopen/comment/transition 等)。只发编号 ≠ 要修复,查询是只读操作可以放心做。
|
|
17
|
+
4. 只有当用户消息里带明确的动作词("修复 BUG-xxx"、"帮我修复"、"处理一下这个"、"认领"、"拒绝")时,才执行对应写操作。修复标准流程:`show` 拿详情 + Read 截图 → 定位代码修复 → `adev bugs resolve <编号> --notes "修复说明"`,提交信息带编号。
|
|
18
|
+
|
|
19
|
+
## 首次配置(登录)
|
|
20
|
+
|
|
21
|
+
用户说"登录敏捷系统/帮我登录"等话时,优先走 `adev-login` skill 的引导流程。新用户可先执行 `adev setup` 一键安装本 skill(装到用户级共享目录 ~/.agents/skills)。两种登录方式任选:
|
|
22
|
+
- **账号密码**:`adev login`(提示输入账号密码,密码不回显;记住用户名,过期只需重输)
|
|
23
|
+
- **API Key**:平台「个人设置 → API」创建后 `adev config set-token agv1_xxx`
|
|
24
|
+
|
|
25
|
+
**不要代替用户输入账号密码**。token 过期(401)时同样提示重新 `adev login`。`adev whoami` 可确认当前身份。
|
|
26
|
+
|
|
27
|
+
## 命令速查
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
adev me # 当前用户
|
|
31
|
+
adev projects # 项目列表(拿项目 id)
|
|
32
|
+
adev dashboard # 我的工作台(待办/即将到期/今日完成)
|
|
33
|
+
adev kanban [--project 28] # 效能看板
|
|
34
|
+
adev members list # 成员列表(查人用)
|
|
35
|
+
|
|
36
|
+
# ---- 缺陷 ----
|
|
37
|
+
adev bugs list [--status Pending] [--assignee 张三|me] [--severity P1] [--project 28|海外] [--keyword x] [--mine]
|
|
38
|
+
adev bugs show 856 # 详情(自动下载截图到本地,务必 Read 查看截图)
|
|
39
|
+
adev bugs stats [--project 28]
|
|
40
|
+
adev bugs comment <id> --content "已修复" # 评论
|
|
41
|
+
adev bugs comments <id> # 看评论
|
|
42
|
+
# 状态流转(写操作,见下方权限说明):
|
|
43
|
+
adev bugs claim <id> # 认领(自动设自己为处理人)
|
|
44
|
+
adev bugs resolve <id> --notes "修复说明" # 修复(默认 resolution=fixed,转待验证)
|
|
45
|
+
adev bugs reject <id> --reason "无法复现" # 拒绝
|
|
46
|
+
adev bugs reopen <id> --notes "原因" # 重开
|
|
47
|
+
adev bugs create --title "xx" --project 28 --severity P2 --data '{"actual_behavior":"..."}' # 登记缺陷
|
|
48
|
+
|
|
49
|
+
# ---- 需求 ----
|
|
50
|
+
adev reqs list [--mine] [--status 已准入] [--keyword x]
|
|
51
|
+
adev reqs show <id|REQ-编号>
|
|
52
|
+
adev reqs create --title "xx" --project 28 --data '{"type":"新功能","description":"..."}'
|
|
53
|
+
adev reqs set-test-date <id> --date 2026-10-01 # 设置提测时间
|
|
54
|
+
adev reqs data-sources <id> # 查看数据源对接清单(--data 保存)
|
|
55
|
+
adev reqs assign-iteration <id> --iteration 101 # 分配到迭代
|
|
56
|
+
adev reqs shelve|unshelve|reactivate|revoke <id>
|
|
57
|
+
|
|
58
|
+
# ---- 开发任务 ----
|
|
59
|
+
adev tasks list [--mine] [--project 28] [--version 101]
|
|
60
|
+
adev tasks create --title "xx" --project 28 --assignee me --version 101 --backlog 401
|
|
61
|
+
adev tasks update <id> --status 开发中
|
|
62
|
+
adev tasks delete <id>
|
|
63
|
+
adev tasks batch --data '[{"title":"任务1",...},...]' # 批量创建(AI 拆解需求后用)
|
|
64
|
+
|
|
65
|
+
# ---- 版本迭代 ----
|
|
66
|
+
adev versions list [--project 28]
|
|
67
|
+
adev versions start|start-testing|complete|accept|release <id> [--notes "发布说明"]
|
|
68
|
+
|
|
69
|
+
# ---- 线上故障 ----
|
|
70
|
+
adev incidents list [--mine] [--status Pending]
|
|
71
|
+
adev incidents show <id|INC-编号>
|
|
72
|
+
adev incidents claim|resolve|reject|reopen <id>
|
|
73
|
+
adev incidents create --title "xx" --project 28 --severity P1 --data '{...}'
|
|
74
|
+
|
|
75
|
+
# ---- 测试/知识库/周报 ----
|
|
76
|
+
adev tests list [--project 28] # 测试计划
|
|
77
|
+
adev tests cases <版本迭代id> # 某迭代的测试用例
|
|
78
|
+
adev kb categories # 知识库分类树
|
|
79
|
+
adev kb list [--keyword x] | kb show <id> | kb annotations <docId>
|
|
80
|
+
adev weekly list [--mine] | weekly show <id> | weekly draft --week 2026-09-22
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
状态枚举:Bug/故障 `Pending/InProgress/ToVerify/Reopened/Rejected/Closed`(故障另有 `Released`);需求(中文)`待处理/已准入/开发中/已发布/已拒绝/暂缓`;任务(中文)`待开始/开发中/已暂停/已完成/不处理`。
|
|
84
|
+
|
|
85
|
+
## 典型工作流
|
|
86
|
+
|
|
87
|
+
**修 bug:** `adev bugs list --status Pending` → `adev bugs show <id>`(**必须 Read 下载好的截图**,红框即问题现场)→ 改代码 → `adev bugs resolve <id> --notes "修复说明"`,提交信息带编号如 `fix: xxx (BUG-20260922-009)`。
|
|
88
|
+
|
|
89
|
+
**AI 拆解需求:** `adev reqs show <id>` 读需求 → 拆解为任务清单 → `adev tasks batch --data '[...]'` 批量建任务。
|
|
90
|
+
|
|
91
|
+
**写操作的权限:** 当前 API Key 可能仅只读。写操作报 `40300 无权限` 时,提示用户到平台为该 Key 分配对应模块的写权限即可,命令本身无需改动。
|
|
92
|
+
|
|
93
|
+
## 注意事项
|
|
94
|
+
|
|
95
|
+
- 表格长字段会截断,要完整内容用 `--json` 或 `show`
|
|
96
|
+
- `--assignee 名字` 是拉取后本地过滤,数据不全时加大 `--size 200`
|
|
97
|
+
- 写操作通用支持 `--data '<json>'` 透传任意字段(字段名与平台表单一致)
|
|
98
|
+
- token 在 `~/.agiledev-cli.json`;401 时提示用户重新 `adev config set-token`
|