禅道 CLI

通过 zentao 命令行工具查询和操作禅道数据。CLI 自动处理认证、分页，支持工作区上下文和数据过滤/排序。

前置准备

安装

npm install -g zentao-cli
# 或 bun install -g zentao-cli
# 或 pnpm install -g zentao-cli
# 或免安装运行：npx zentao-cli

如果用户没有安装，引导用户进行全局安装使用，如果系统存在 bun 或 pnpm 则优先使用 bun 或 pnpm 进行全局安装。

认证

首次执行任意 zentao 命令会自动提示登录。也可显式登录：

zentao login -s https://zentao.example.com -u admin -p 123456

环境变量（优先级低于命令行参数）：

变量	说明
ZENTAO_URL	禅道服务地址
ZENTAO_ACCOUNT	用户账号
ZENTAO_PASSWORD	密码
ZENTAO_TOKEN	直接指定 Token（有此变量可省略密码）

登录成功后凭证缓存在 ~/.config/zentao/zentao.json，后续无需重复登录。

命令格式

使用简写方式（推荐）：

操作	命令
列表	zentao <module>
详情	zentao <module> <id>
创建	zentao <module> create --field=value
更新	zentao <module> update <id> --field=value
删除	zentao <module> delete <id>
动作	zentao <module> <action> <id>
帮助	zentao <module> help

也支持 --data='JSON' 传入 JSON 数据。

模块与操作速查

模块名	中文	支持的操作
program	项目集	CRUD
product	产品	CRUD
project	项目	CRUD
execution	执行/迭代	CRUD
story	需求	CRUD + activate / change / close
epic	业务需求	CRUD + activate / change / close
requirement	用户需求	CRUD + activate / change / close
bug	Bug	CRUD + activate / close / resolve
task	任务	CRUD + activate / close / finish / start
testcase	测试用例	CRUD
testtask	测试单	CUD（按产品/项目/执行查列表）
productplan	产品计划	CUD（按产品查列表）
build	版本	CUD（按项目/执行查列表）
release	发布	CUD（按产品查列表）
feedback	反馈	CRUD + activate / close
ticket	工单	CRUD + activate / close
system	应用	CU（按产品查列表）
user	用户	CRUD
file	附件	编辑名称 + 删除

CRUD = 列表 + 详情 + 创建 + 更新 + 删除；CUD = 无独立列表接口，需指定所属范围

列表范围参数

部分模块的列表需要指定所属范围：

zentao story --product=1                # 产品 #1 的需求
zentao bug --product=1                  # 产品 #1 的 Bug
zentao task --execution=1               # 执行 #1 的任务
zentao execution --project=5            # 项目 #5 的执行
zentao build --project=5                # 项目 #5 的版本
zentao testtask --product=1             # 产品 #1 的测试单
zentao release --product=1              # 产品 #1 的发布
zentao productplan --product=1          # 产品 #1 的计划
zentao feedback --product=1             # 产品 #1 的反馈
zentao ticket --product=1               # 产品 #1 的工单

设置工作区后可省略这些参数（见下方工作区章节）。

AI 使用策略

输出格式

• 展示给用户：不加 --format 参数，默认输出 Markdown 表格（列表）或列表（单个对象）
• 需要程序化处理：加 --format=json，返回结构化 JSON

交互确认

AI 场景下执行删除操作时加 --yes 跳过确认提示：

zentao bug delete 1 --yes

不知道 ID 时

先查列表获取 ID，再操作具体对象：

zentao product --pick=id,name           # 查看产品列表
zentao bug --product=1 --pick=id,title  # 查看 Bug 列表
zentao bug 42                           # 查看具体 Bug

写操作前确认

执行创建、更新、删除等写操作前，先向用户确认操作内容。用户明确要求不确认时可跳过。

数据处理

摘取字段

zentao product --pick=id,name,status

过滤

zentao bug --product=1 --filter='status:active'
zentao bug --product=1 --filter='severity<=2,pri<=2'    # AND
zentao bug --product=1 --filter='status:active' --filter='status:resolved'  # OR

支持的运算符：: 等于、!= 不等于、> < >= <=、~ 包含、!~ 不包含。

模糊搜索

zentao bug --product=1 --search=登录 --search-fields=title,steps

排序

zentao bug --product=1 --sort=pri_asc,severity_asc

分页

zentao bug --product=1 --page=1 --recPerPage=50
zentao bug --product=1 --all            # 获取全部
zentao bug --product=1 --limit=10       # 只取前 10 条

常用操作示例

查看进行中的项目和执行

zentao project --filter='status:doing' --pick=id,name,status
zentao execution --project=5 --pick=id,name,status

创建需求并关联计划

zentao story create --product=1 --title="需求标题" --assignedTo=admin --pri=3
zentao story update 11 --title="需求标题" --plan=1

创建并解决 Bug

zentao bug create --product=1 --title="Bug标题" --severity=2 --pri=2 --type=codeerror --openedBuild=trunk
zentao bug resolve 42

创建、启动并完成任务

zentao task create --execution=1 --name="任务名" --type=devel --assignedTo=admin --estimate=4
zentao task start 100
zentao task finish 100 --consumed=4

查看帮助

zentao bug help          # 查看 Bug 模块的参数和操作
zentao story update help # 查看需求更新操作的参数和操作
zentao help              # 查看所有命令

意图识别

用户意图	CLI 命令
所有产品/项目/项目集	zentao product / zentao project / zentao program
进行中的项目	zentao project --filter='status:doing'
某产品的 Bug	zentao bug --product=<id>
某执行的任务	zentao task --execution=<id>
创建/新增 Bug	zentao bug create ...
解决 Bug	zentao bug resolve <id>
关闭 Bug	zentao bug close <id>
激活 Bug	zentao bug activate <id>
创建需求	zentao story create ...
变更/关闭/激活需求	zentao story change/close/activate <id>
业务需求	zentao epic ...（同 story）
用户需求	zentao requirement ...（同 story）
创建/启动/完成/关闭任务	zentao task create/start/finish/close ...
测试用例	zentao testcase ...
测试单	zentao testtask ...
产品计划	zentao productplan ...
版本/Build	zentao build ...
发布	zentao release ...
反馈	zentao feedback ...
工单	zentao ticket ...
用户列表	zentao user
当前用户信息	zentao profile

错误处理

错误码	含义	处理方式
E1001	未登录/凭证缺失	执行 zentao login
E1004	Token 失效	执行 zentao login 重新登录
E2001	模块不存在	执行 zentao help 查看可用模块
E2002	对象不存在	检查 ID 是否正确
E2003	缺少必要参数	执行 zentao <module> help 或 zentao <module> <action> help 查看操作参数
E2006	无权限	提示用户检查权限
E5001	请求超时	检查网络或禅道服务状态

注意事项

• 不确定模块参数时，先执行 zentao <module> help 查看帮助，不确定操作参数时，先执行 zentao <module> <action> help 查看帮助
• browseType 常用值：all（全部）、doing（进行中）、closed（已关闭）
• 多账号切换：zentao profile 查看和切换账号