用途:通过 zentao 命令行工具查询和操作禅道数据,支持对项目集、产品、项目、执行、需求、Bug、任务、测试用例、测试单、产品计划、版本、发布、反馈、工单、应用、用户、附件等模块的增删改查及状态流转。CLI 自动处理认证和分页,支持工作区上下文与数据过滤/排序。
安装:npm install -g zentao-cli,也可用 bun install -g zentao-cli 或 pnpm install -g zentao-cli,免安装可运行 npx zentao-cli。
认证:首次执行任意 zentao 命令会自动提示登录,也可显式登录:zentao login -s https://zentao.example.com -u admin -p 123456。支持环境变量 ZENTAO_URL、ZENTAO_ACCOUNT、ZENTAO_PASSWORD、ZENTAO_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'。部分模块列表需指定所属范围,如 zentao story --product=1、zentao task --execution=1;设置工作区后可省略。数据处理支持摘取字段 --pick、过滤 --filter(运算符含 :、!=、> < >= <=、~、!~)、模糊搜索 --search、排序 --sort、分页 --page/--recPerPage、--all、--limit。输出默认 Markdown 表格或列表,加 --format=json 返回结构化 JSON;删除操作可加 --yes 跳过确认。
适用场景:查询项目进展、获取 Bug、创建需求、创建并解决 Bug、创建启动完成任务、查看测试用例/测试单/产品计划/版本/发布/反馈/工单/用户等。
限制与注意:不确定模块参数时先执行 zentao <module> help;browseType 常用值 all、doing、closed;静默模式 --silent 只输出错误;多账号切换用 zentao profile。错误码包括 E1001 未登录、E1004 Token 失效、E2001 模块不存在、E2002 对象不存在、E2003 缺少必要参数、E2006 无权限、E5001 请求超时。写操作前建议先向用户确认操作内容。