@super-coding/cli 0.2.2 → 0.2.4

package/dist/pingcode/builtin/reference-ship.md

@@ -0,0 +1,282 @@
+# ship 命令速查（产品 / 需求 / 工单）
+
+ship 是 PingCode 的**产品与客户反馈**模块：`product` 是父级，其下挂 `idea`（需求 / 想法）与
+`ticket`（工单 / 客户问题）。本文件是该模块的完整命令表，通用约定见 `reference.md`。
+
+## 层级与 ID 关系
+
+```
+product（产品）
+├── product-member / product-tag / product-suite / product-plan / product-user / product-customer
+├── idea（需求池）
+│   └── idea-state / idea-type 相关字典都按「产品」维度配置
+└── ticket（工单）
+    └── ticket-state / ticket-type / ticket-solution 同样按「产品」维度配置
+```
+
+- **列表基本都要按产品过滤**：`idea list --product-id <PID>`、`ticket list --product-id <PID>`。
+  这两处 `--product-id` 语法上虽然可选，但**不传会跨产品混在一起**，基本等于查错了对象；
+  先 `pc ship product list --keywords "产品名"` 拿 ID。
+- **状态 / 类型 / 优先级字典按产品查**，不同产品可能不一样，不要跨产品复用 ID：
+  `idea-state list --product-id <PID>`、`ticket-state list --product-id <PID>`。
+- `*-plan` 类命令（`idea-plan` / `product-plan` / `idea-property-plan` …）是「方案」对象，
+  要按位置参数 `<ID>` 或 `--product-id` 查，不是全局列表。
+
+## 写操作的必知事项
+
+- **`idea` 与 `ticket` 没有 `delete` 子命令**。要「关闭」它们只能 `update` 改 `state_id`，
+  不要重复尝试 `delete`。
+- `idea` / `ticket` 的 `create` / `update` 都用 `--data '<JSON>'`，字段名以接口为准；
+  不确定时先 `get` 一条同类对象，照着它的字段结构写。
+- `ticket-solution`（解决方案）是独立字典，工单解决时用它填 `solution_id`。
+- `product-customer` / `product-user` 是客户与使用者，和 `organization user`（内部成员）不是一回事。
+
+## 命令表
+
+### `ship idea` — 需求（想法）（list / get / create / update / search）
+
+```bash
+pc ship idea list [--product-id <ID>] [--state-id <ID>] [--priority-id <ID>] \
+    [--keywords <KEYWORDS>] [--include-public-image-token <FIELDS>] [--page-index <INDEX>] \
+    [--page-size <SIZE>]
+pc ship idea get <IDEA_ID> [--include-public-image-token <FIELDS>] [--include-deleted]
+pc ship idea create --data <JSON>
+pc ship idea update --data <JSON> <IDEA_ID>
+pc ship idea search --data <JSON>
+```
+
+### `ship idea-plan` — 需求排期（list-for-product）
+
+```bash
+pc ship idea-plan list-for-product <ID>
+```
+
+### `ship idea-priority` — 需求优先级（list / list-for-product / get）
+
+```bash
+pc ship idea-priority list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship idea-priority list-for-product <ID>
+pc ship idea-priority get <PRIORITY_ID>
+```
+
+### `ship idea-property` — 需求属性定义（list / list-for-product / get / create / update）
+
+```bash
+pc ship idea-property list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship idea-property list-for-product <ID>
+pc ship idea-property get <PROPERTY_ID>
+pc ship idea-property create --data <JSON>
+pc ship idea-property update --data <JSON> <PROPERTY_ID>
+```
+
+### `ship idea-property-plan` — 需求属性方案（list / get / add-property / list-properties / get-property / remove-property）
+
+```bash
+pc ship idea-property-plan list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship idea-property-plan get <PROPERTY_PLAN_ID>
+pc ship idea-property-plan add-property --data <JSON> <PROPERTY_PLAN_ID>
+pc ship idea-property-plan list-properties <PROPERTY_PLAN_ID>
+pc ship idea-property-plan get-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+pc ship idea-property-plan remove-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+```
+
+### `ship idea-state` — 需求状态（list / list-for-product / get）
+
+```bash
+pc ship idea-state list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship idea-state list-for-product <ID>
+pc ship idea-state get <IDEA_STATE_ID>
+```
+
+### `ship idea-suite` — 需求集（list-for-product）
+
+```bash
+pc ship idea-suite list-for-product <ID>
+```
+
+### `ship idea-transition` — 需求流转（list / get）
+
+```bash
+pc ship idea-transition list <IDEA_ID>
+pc ship idea-transition get <IDEA_ID> <TRANSITION_HISTORY_ID>
+```
+
+### `ship product` — 产品（list / get / create / update）
+
+```bash
+pc ship product list [--scope-type <SCOPE_TYPE>] [--scope-id <ID>] [--keywords <KEYWORDS>] \
+    [--member-type <TYPE>] [--member-id <ID>] [--created-between <RANGE>] \
+    [--updated-between <RANGE>] [--include-deleted] [--include-archived] \
+    [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship product get <PRODUCT_ID> [--include-deleted] [--include-archived]
+pc ship product create --data <JSON>
+pc ship product update --data <JSON> <PRODUCT_ID>
+```
+
+### `ship product-channel` — 客户渠道（list / get）
+
+```bash
+pc ship product-channel list <PRODUCT_ID>
+pc ship product-channel get <PRODUCT_ID> <CHANNEL_ID>
+```
+
+### `ship product-customer` — 客户（list / get / create / update）
+
+```bash
+pc ship product-customer list <PRODUCT_ID>
+pc ship product-customer get <PRODUCT_ID> <CUSTOMER_ID>
+pc ship product-customer create --data <JSON> <PRODUCT_ID>
+pc ship product-customer update --data <JSON> <PRODUCT_ID> <CUSTOMER_ID>
+```
+
+### `ship product-member` — 产品成员（list / get / add / remove）
+
+```bash
+pc ship product-member list <PRODUCT_ID>
+pc ship product-member get <PRODUCT_ID> <MEMBER_ID>
+pc ship product-member add --data <JSON> <PRODUCT_ID>
+pc ship product-member remove <PRODUCT_ID> <MEMBER_ID>
+```
+
+### `ship product-plan` — 产品计划（list / get）
+
+```bash
+pc ship product-plan list <PRODUCT_ID>
+pc ship product-plan get <PRODUCT_ID> <PLAN_ID>
+```
+
+### `ship product-suite` — 产品集（list / get / create / delete）
+
+```bash
+pc ship product-suite list <PRODUCT_ID>
+pc ship product-suite get <PRODUCT_ID> <SUITE_ID>
+pc ship product-suite create --data <JSON> <PRODUCT_ID>
+pc ship product-suite delete <PRODUCT_ID> <SUITE_ID>
+```
+
+### `ship product-tag` — 产品标签（list / get / create / delete）
+
+```bash
+pc ship product-tag list <PRODUCT_ID>
+pc ship product-tag get <PRODUCT_ID> <TAG_ID>
+pc ship product-tag create --data <JSON> <PRODUCT_ID>
+pc ship product-tag delete <PRODUCT_ID> <TAG_ID>
+```
+
+### `ship product-ticket-type` — 产品工单类型（list / get）
+
+```bash
+pc ship product-ticket-type list <PRODUCT_ID>
+pc ship product-ticket-type get <PRODUCT_ID> <TICKET_TYPE_ID>
+```
+
+### `ship product-user` — 产品用户（list / get / create / update / delete）
+
+```bash
+pc ship product-user list <PRODUCT_ID>
+pc ship product-user get <PRODUCT_ID> <USER_ID>
+pc ship product-user create --data <JSON> <PRODUCT_ID>
+pc ship product-user update --data <JSON> <PRODUCT_ID> <USER_ID>
+pc ship product-user delete <PRODUCT_ID> <USER_ID>
+```
+
+### `ship ticket` — 工单（list / get / create / update / search）
+
+```bash
+pc ship ticket list [--product-id <ID>] [--type-id <ID>] [--state-id <ID>] \
+    [--priority-id <ID>] [--keywords <KEYWORDS>] [--include-public-image-token <FIELDS>] \
+    [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket get <TICKET_ID> [--include-public-image-token <FIELDS>] [--include-deleted]
+pc ship ticket create --data <JSON>
+pc ship ticket update --data <JSON> <TICKET_ID>
+pc ship ticket search --data <JSON>
+```
+
+### `ship ticket-channel` — 工单渠道（list-for-product）
+
+```bash
+pc ship ticket-channel list-for-product <ID>
+```
+
+### `ship ticket-priority` — 工单优先级（list / list-for-product / get）
+
+```bash
+pc ship ticket-priority list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-priority list-for-product <ID>
+pc ship ticket-priority get <PRIORITY_ID>
+```
+
+### `ship ticket-property` — 工单属性定义（list / list-for-product / get / create / update）
+
+```bash
+pc ship ticket-property list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-property list-for-product <ID>
+pc ship ticket-property get <PROPERTY_ID>
+pc ship ticket-property create --data <JSON>
+pc ship ticket-property update --data <JSON> <PROPERTY_ID>
+```
+
+### `ship ticket-property-plan` — 工单属性方案（list / get / add-property / list-properties / get-property / remove-property）
+
+```bash
+pc ship ticket-property-plan list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-property-plan get <PROPERTY_PLAN_ID>
+pc ship ticket-property-plan add-property --data <JSON> <PROPERTY_PLAN_ID>
+pc ship ticket-property-plan list-properties <PROPERTY_PLAN_ID>
+pc ship ticket-property-plan get-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+pc ship ticket-property-plan remove-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+```
+
+### `ship ticket-solution` — 工单解决方案（list / list-for-product / get）
+
+```bash
+pc ship ticket-solution list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-solution list-for-product <ID>
+pc ship ticket-solution get <TICKET_SOLUTION_ID>
+```
+
+### `ship ticket-state` — 工单状态（list / list-for-product / get / create / update）
+
+```bash
+pc ship ticket-state list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-state list-for-product <ID>
+pc ship ticket-state get <TICKET_STATE_ID>
+pc ship ticket-state create --data <JSON>
+pc ship ticket-state update --data <JSON> <TICKET_STATE_ID>
+```
+
+### `ship ticket-state-plan` — 工单状态方案与流转（list / get / add-state / list-states / get-state / remove-state / add-flow / list-flows / get-flow / remove-flow）
+
+```bash
+pc ship ticket-state-plan list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-state-plan get <STATE_PLAN_ID>
+pc ship ticket-state-plan add-state --data <JSON> <STATE_PLAN_ID>
+pc ship ticket-state-plan list-states <STATE_PLAN_ID>
+pc ship ticket-state-plan get-state <STATE_PLAN_ID> <STATE_ID>
+pc ship ticket-state-plan remove-state <STATE_PLAN_ID> <STATE_ID>
+pc ship ticket-state-plan add-flow --data <JSON> <STATE_PLAN_ID>
+pc ship ticket-state-plan list-flows <STATE_PLAN_ID>
+pc ship ticket-state-plan get-flow <STATE_PLAN_ID> <STATE_FLOW_ID>
+pc ship ticket-state-plan remove-flow <STATE_PLAN_ID> <STATE_FLOW_ID>
+```
+
+### `ship ticket-tag` — 工单标签（list-for-product）
+
+```bash
+pc ship ticket-tag list-for-product <ID>
+```
+
+### `ship ticket-transition` — 工单流转（list / get）
+
+```bash
+pc ship ticket-transition list <TICKET_ID>
+pc ship ticket-transition get <TICKET_ID> <TRANSITION_HISTORY_ID>
+```
+
+### `ship ticket-type` — 工单类型（list / list-for-product / get）
+
+```bash
+pc ship ticket-type list [--page-index <INDEX>] [--page-size <SIZE>]
+pc ship ticket-type list-for-product <ID>
+pc ship ticket-type get <TICKET_TYPE_ID>
+```

package/dist/pingcode/builtin/reference-testhub.md

@@ -0,0 +1,172 @@
+# testhub 命令速查（测试库 / 用例 / 计划 / 执行）
+
+testhub 是 PingCode 的**测试管理**模块。本文件是该模块的完整命令表，通用约定见 `reference.md`。
+
+## 层级与 ID 关系
+
+```
+library（测试库）
+├── library-member / library-suite（用例目录树）
+├── testcase（测试用例）
+│   └── testcase-state / testcase-type / testcase-important-level 按「测试库」维度配置
+├── testplan（测试计划）
+└── testrun（测试执行记录：某计划下某用例的一次执行）
+    └── testrun-status 按「测试库」维度配置
+```
+
+- 典型链路：`library list` → `library-suite list <LIBRARY_ID>` → `testcase list --library-id` →
+  `testplan create` → `testrun list --testplan-id` 看执行情况。
+- **状态字典按库查**：`testcase-state list-for-library --library-id <LID>`、
+  `testrun-status list-for-library --library-id <LID>`。不同库的 ID 不能混用。
+- `testcase list` 的 `--library-id` 是**可选**的：不传会跨库返回，容易误判「用例属于哪个库」，
+  拿不准时先确认库再查。
+- `testrun list` 用 `--testplan-id` / `--testcase-id` / `--suite-id` / `--status-id` 过滤，
+  **没有** `--library-id`；要按库筛就先从计划入手。
+- `testcase histories <ID>` / `testrun histories <ID>` / `testrun get-history <ID> <HISTORY_ID>`
+  是变更历史，只读。
+- `testrun plan-batch --data <JSON> <LIBRARY_ID> <TESTPLAN_ID>` 用于批量把执行记录并入计划。
+- 批量写（`bulk-create` / `bulk-update`）的请求体形态各接口不一致：**先用 1~2 条验证结构再放大**，
+  不要一次性把上百条推进去。
+
+## 命令表
+
+### `testhub library` — 测试库（list / get / create / update）
+
+```bash
+pc testhub library list [--scope-type <SCOPE>] [--scope-id <ID>] [--keywords <KEYWORDS>] \
+    [--member-type <TYPE>] [--member-id <ID>] [--created-between <RANGE>] \
+    [--updated-between <RANGE>] [--include-deleted] [--include-archived]
+pc testhub library get <LIBRARY_ID> [--include-deleted] [--include-archived]
+pc testhub library create --data <JSON>
+pc testhub library update --data <JSON> <LIBRARY_ID>
+```
+
+### `testhub library-member` — 测试库成员（list / get / add / update / remove）
+
+```bash
+pc testhub library-member list <LIBRARY_ID>
+pc testhub library-member get <LIBRARY_ID> <MEMBER_ID>
+pc testhub library-member add --data <JSON> <LIBRARY_ID>
+pc testhub library-member update --data <JSON> <LIBRARY_ID> <MEMBER_ID>
+pc testhub library-member remove <LIBRARY_ID> <MEMBER_ID>
+```
+
+### `testhub library-suite` — 用例目录（list / get / create / update / remove）
+
+```bash
+pc testhub library-suite list <LIBRARY_ID> [--parent-id <PARENT>]
+pc testhub library-suite get <LIBRARY_ID> <SUITE_ID>
+pc testhub library-suite create --data <JSON> <LIBRARY_ID>
+pc testhub library-suite update --data <JSON> <LIBRARY_ID> <SUITE_ID>
+pc testhub library-suite remove <LIBRARY_ID> <SUITE_ID>
+```
+
+### `testhub testcase` — 测试用例（list / get / create / update / delete / search / bulk-create / bulk-update / histories）
+
+```bash
+pc testhub testcase list [--library-id <ID>] [--maintenance-id <ID>] [--state-id <ID>] \
+    [--important-level-id <ID>] [--tag-id <ID>] [--keywords <KEYWORDS>] \
+    [--include-public-image-token <FIELDS>] [--include-deleted]
+pc testhub testcase get <TESTCASE_ID> [--include-public-image-token <FIELDS>] \
+    [--include-deleted]
+pc testhub testcase create --data <JSON>
+pc testhub testcase update --data <JSON> <TESTCASE_ID>
+pc testhub testcase delete <TESTCASE_ID>
+pc testhub testcase search --data <JSON>
+pc testhub testcase bulk-create --data <JSON>
+pc testhub testcase bulk-update --data <JSON>
+pc testhub testcase histories <TESTCASE_ID>
+```
+
+### `testhub testcase-important-level` — 重要程度（list / get）
+
+```bash
+pc testhub testcase-important-level list
+pc testhub testcase-important-level get <IMPORTANT_LEVEL_ID>
+```
+
+### `testhub testcase-property` — 用例属性定义（list / list-for-library / get / create / update）
+
+```bash
+pc testhub testcase-property list
+pc testhub testcase-property list-for-library --library-id <ID>
+pc testhub testcase-property get <PROPERTY_ID>
+pc testhub testcase-property create --data <JSON>
+pc testhub testcase-property update --data <JSON> <PROPERTY_ID>
+```
+
+### `testhub testcase-property-plan` — 用例属性方案（list / get / list-properties / get-property / add-property / remove-property）
+
+```bash
+pc testhub testcase-property-plan list [--library-id <ID>]
+pc testhub testcase-property-plan get <PROPERTY_PLAN_ID>
+pc testhub testcase-property-plan list-properties <PROPERTY_PLAN_ID>
+pc testhub testcase-property-plan get-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+pc testhub testcase-property-plan add-property --data <JSON> <PROPERTY_PLAN_ID>
+pc testhub testcase-property-plan remove-property <PROPERTY_PLAN_ID> <PROPERTY_ID>
+```
+
+### `testhub testcase-state` — 用例状态（list / list-for-library / get）
+
+```bash
+pc testhub testcase-state list
+pc testhub testcase-state list-for-library --library-id <ID>
+pc testhub testcase-state get <STATE_ID>
+```
+
+### `testhub testcase-type` — 用例类型（list / list-for-library / get）
+
+```bash
+pc testhub testcase-type list
+pc testhub testcase-type list-for-library --library-id <ID>
+pc testhub testcase-type get <TYPE_ID>
+```
+
+### `testhub testplan` — 测试计划（list / get / create / update）
+
+```bash
+pc testhub testplan list <LIBRARY_ID> [--name <NAME>] [--created-between <RANGE>] \
+    [--updated-between <RANGE>]
+pc testhub testplan get <LIBRARY_ID> <TESTPLAN_ID> [--include-deleted]
+pc testhub testplan create --data <JSON> <LIBRARY_ID>
+pc testhub testplan update --data <JSON> <LIBRARY_ID> <TESTPLAN_ID>
+```
+
+### `testhub testplan-state` — 计划状态（list / get）
+
+```bash
+pc testhub testplan-state list
+pc testhub testplan-state get <STATE_ID>
+```
+
+### `testhub testplan-type` — 计划类型（list / get）
+
+```bash
+pc testhub testplan-type list <LIBRARY_ID>
+pc testhub testplan-type get <LIBRARY_ID> <TESTPLAN_TYPE_ID>
+```
+
+### `testhub testrun` — 测试执行（list / get / create / update / replace / search / bulk-create / bulk-update / histories / get-history / plan-batch）
+
+```bash
+pc testhub testrun list [--testplan-id <ID>] [--testcase-id <ID>] [--suite-id <ID>] \
+    [--status-id <ID>] [--keywords <KEYWORDS>]
+pc testhub testrun get <TESTRUN_ID> [--include-deleted]
+pc testhub testrun create --data <JSON>
+pc testhub testrun update --data <JSON> <TESTRUN_ID>
+pc testhub testrun replace --data <JSON> <TESTRUN_ID>
+pc testhub testrun search --data <JSON>
+pc testhub testrun bulk-create --data <JSON>
+pc testhub testrun bulk-update --data <JSON>
+pc testhub testrun histories <TESTRUN_ID>
+pc testhub testrun get-history <TESTRUN_ID> <HISTORY_ID>
+pc testhub testrun plan-batch --data <JSON> <LIBRARY_ID> <TESTPLAN_ID>
+```
+
+### `testhub testrun-status` — 执行状态（list / list-for-library / get）
+
+```bash
+pc testhub testrun-status list
+pc testhub testrun-status list-for-library --library-id <ID>
+pc testhub testrun-status get <STATUS_ID>
+```