@coze/cli 0.1.8-alpha.618a4c → 0.2.0-alpha.094e22

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.
Files changed (40) hide show
  1. package/README.md +344 -25
  2. package/lib/cli.js +3 -3
  3. package/lib/fetch-client-DC0c3ox3.js +1 -0
  4. package/lib/index-CkTEdvpA.js +1 -0
  5. package/lib/send-message.worker.js +1 -1
  6. package/lib/session-task-refresh.worker.js +1 -1
  7. package/lib/{task-worker-CxZeBKqU.js → task-worker-C2ZfSQY6.js} +1 -1
  8. package/package.json +6 -1
  9. package/skills/manifest.json +25 -0
  10. package/skills/using-coze-cli/SKILL.md +448 -0
  11. package/skills/using-coze-cli/coze-claw/MODULE.md +189 -0
  12. package/skills/using-coze-cli/coze-claw/references/coze-claw-agent-routing.md +45 -0
  13. package/skills/using-coze-cli/coze-claw/references/coze-claw-artifacts.md +52 -0
  14. package/skills/using-coze-cli/coze-claw/references/coze-claw-async-followup.md +266 -0
  15. package/skills/using-coze-cli/coze-claw/references/coze-claw-message.md +176 -0
  16. package/skills/using-coze-cli/coze-claw/references/coze-claw-podcast.md +73 -0
  17. package/skills/using-coze-cli/coze-claw/references/coze-claw-ppt.md +78 -0
  18. package/skills/using-coze-cli/coze-claw/references/coze-claw-progress.md +112 -0
  19. package/skills/using-coze-cli/coze-claw/references/coze-claw-session.md +144 -0
  20. package/skills/using-coze-cli/coze-code/MODULE.md +252 -0
  21. package/skills/using-coze-cli/coze-code/references/coze-code-db.md +537 -0
  22. package/skills/using-coze-cli/coze-code/references/coze-code-deploy.md +258 -0
  23. package/skills/using-coze-cli/coze-code/references/coze-code-domain.md +73 -0
  24. package/skills/using-coze-cli/coze-code/references/coze-code-env.md +82 -0
  25. package/skills/using-coze-cli/coze-code/references/coze-code-git.md +181 -0
  26. package/skills/using-coze-cli/coze-code/references/coze-code-message.md +240 -0
  27. package/skills/using-coze-cli/coze-code/references/coze-code-model.md +51 -0
  28. package/skills/using-coze-cli/coze-code/references/coze-code-preview.md +33 -0
  29. package/skills/using-coze-cli/coze-code/references/coze-code-project.md +176 -0
  30. package/skills/using-coze-cli/coze-code/references/coze-code-repo.md +285 -0
  31. package/skills/using-coze-cli/coze-code/references/coze-code-skill.md +117 -0
  32. package/skills/using-coze-cli/coze-code/references/coze-code-tools.md +47 -0
  33. package/skills/using-coze-cli/coze-file/MODULE.md +46 -0
  34. package/skills/using-coze-cli/coze-file/references/coze-file-upload.md +59 -0
  35. package/skills/using-coze-cli/coze-generate/MODULE.md +84 -0
  36. package/skills/using-coze-cli/coze-generate/references/coze-generate-audio.md +105 -0
  37. package/skills/using-coze-cli/coze-generate/references/coze-generate-image.md +80 -0
  38. package/skills/using-coze-cli/coze-generate/references/coze-generate-video.md +125 -0
  39. package/lib/fetch-client-CWYDGe9Z.js +0 -1
  40. package/lib/index-BC9PFu7i.js +0 -1
@@ -0,0 +1,112 @@
1
+ # claw progress commands
2
+
3
+ > **前置条件:** 先阅读 [`../../SKILL.md`](../../SKILL.md) 和 [`coze-claw-message.md`](coze-claw-message.md)。
4
+
5
+ progress 表示 claw 级后台任务。收到 `progress_id` 后,不要继续等待 session reply;如果同轮还拿到了 `task_id`,优先转入 `session task` 查询。
6
+
7
+ 对 Agent 而言,`progress_id` 是当前版本最稳定的长任务句柄。它本身不是最终结果,最终结果通常还要通过 `replies <message_id>` 回查。
8
+
9
+ ## 命令导航
10
+
11
+ | 命令 | 说明 |
12
+ |------|------|
13
+ | `coze session progress list` | 列出当前 claw 后台任务 |
14
+ | `coze session task list` | 列出本地持久化的 session 长任务 |
15
+ | `coze session task show <task_id>` | 读取本地 task 快照 |
16
+ | `coze session task refresh <task_id>` | 刷新一个本地 task |
17
+ | `coze session task watch <task_id>` | 持续观察一个本地 task |
18
+ | `coze session progress show <progress_id>` | 单次查看任务快照 |
19
+ | `coze session progress poll <progress_id>` | 单次轮询,查不到按 finished |
20
+ | `coze session progress watch [progress_id]` | 监听一个或全部 progress 更新 |
21
+
22
+ ## task
23
+
24
+ ```bash
25
+ coze session task list --format json
26
+ coze session task show <task_id> --format json
27
+ coze session task refresh <task_id> --format json
28
+ coze session task watch <task_id> --timeout 300000 --format json
29
+ ```
30
+
31
+ - `task_id` 是 CLI 本地恢复句柄,由 `coze session message --wait` 在命中 `progress_id` 时创建。
32
+ - `show` 只读本地快照,不请求服务端。
33
+ - `refresh` 会基于 `progress_id` 做一次服务端刷新,并把最新状态写回本地 task store。
34
+ - `watch` 是前台轮询封装,适合 Agent 周期跟踪与外部通知闭环。
35
+ - 当 task 进入终态且 CLI 已经补查到 reply 时,快照会带上 `reply_content` 和 `artifacts`,可直接作为用户交付结果使用。
36
+ - 如果宿主支持后台 schedule/job,推荐把 `task refresh/show` 放进独立的 follow-up 定时任务,而不是让当前 agent 持续前台 `watch`。
37
+
38
+ ## list
39
+
40
+ ```bash
41
+ coze session progress list --format json
42
+ ```
43
+
44
+ 用于判断当前 claw 是否有后台任务,或在 `watch` 超时后确认任务是否转入后台。
45
+
46
+ ## show
47
+
48
+ ```bash
49
+ coze session progress show <progress_id> --format json
50
+ ```
51
+
52
+ 单次查看一个任务。查不到时 `found=false`。
53
+
54
+ ## poll
55
+
56
+ ```bash
57
+ coze session progress poll <progress_id> --format json
58
+ ```
59
+
60
+ 脚本轮询优先使用 `poll`。它的特殊语义是:查不到 progress 时按 `finished` 输出。
61
+
62
+ 示例:
63
+
64
+ ```bash
65
+ for i in $(seq 1 60); do
66
+ result=$(coze session progress poll <progress_id> --format json)
67
+ status=$(echo "$result" | grep -o '"progress_status":"[^"]*"' | cut -d'"' -f4)
68
+ [ "$status" = "finished" ] && break
69
+ sleep 10
70
+ done
71
+ ```
72
+
73
+ ## watch
74
+
75
+ ```bash
76
+ coze session progress watch <progress_id> --timeout 300000 --format json
77
+ coze session progress watch --timeout 300000 --format json
78
+ ```
79
+
80
+ - 指定 `progress_id` 时,任务 finished 后会退出。
81
+ - 不指定时监听全部 progress,需要依赖 `--timeout` 退出。
82
+
83
+ ## 完成后下一步
84
+
85
+ task/progress finished 后通常还需要:
86
+
87
+ ```bash
88
+ coze session replies <message_id> -s <session_id> --format json
89
+ ```
90
+
91
+ 如果产物是文件或 PPT,继续阅读:
92
+
93
+ - [`coze-claw-artifacts.md`](coze-claw-artifacts.md)
94
+ - [`coze-claw-ppt.md`](coze-claw-ppt.md)
95
+
96
+ ## Agent 最小恢复集
97
+
98
+ 只要任务已经转入 progress,至少保留这三个 ID:
99
+
100
+ - `session_id`
101
+ - `message_id`
102
+ - `progress_id`
103
+
104
+ 最小恢复流程:
105
+
106
+ 1. 优先用 `task refresh/watch` 跟进是否 finished;没有 `task_id` 时退回 `progress poll/watch`
107
+ 2. finished 后用 `replies <message_id>` 回查最终回复;如果 task 快照已经有 `reply_content` / `artifacts`,也要把这些内容回给用户
108
+ 3. 如果回复里带文件,再进入 artifacts 或 PPT 流程
109
+
110
+ 如果需要“后台查到终态后自动在原消息处通知用户”,继续阅读:
111
+
112
+ - [`coze-claw-async-followup.md`](coze-claw-async-followup.md)
@@ -0,0 +1,144 @@
1
+ # claw session commands
2
+
3
+ > **前置条件:** 先阅读 [`../../SKILL.md`](../../SKILL.md) 了解认证、全局参数和错误处理。
4
+
5
+ 基础 session 命令用于确认 claw 状态、创建会话和找回历史会话。`coze session *` 跳过 org/space check,不需要先切换组织或空间。
6
+
7
+ ## Agent 默认策略
8
+
9
+ - 除非用户明确要求“新建话题”“新增话题”“开新会话”,否则优先复用最近一次成功使用的 `session_id`。
10
+ - CLI 会把最近一次成功使用的 `session_id` 持久化到本地;优先用 `coze session current --format json` 读取,用 `coze session use <session_id> --format json` 切换。
11
+ - 推荐执行顺序:
12
+ 1. 如果已有最近 `session_id`,先执行 `coze session current --format json`
13
+ 2. 再执行 `coze session status -s <session_id> --format json`
14
+ 3. 如果没有最近 `session_id`,执行 `coze session list --limit 20 --format json` 找最近一个可复用 session,并在确认后执行 `coze session use <session_id> --format json`
15
+ 4. 只有用户明确要求新建,或没有任何可复用 session 时,才执行 `coze session create --format json`
16
+ - 不要因为用户发来一条新需求,就默认新建 session。
17
+
18
+ ## 命令导航
19
+
20
+ | 命令 | 说明 |
21
+ |------|------|
22
+ | `coze session status` | 检查 token/claw,并刷新本地 `claw_id` |
23
+ | `coze session status -s <session_id>` | 查看指定 session runtime 状态和 claw 后台任务概览 |
24
+ | `coze session create` | 创建新 claw session |
25
+ | `coze session current` | 查看当前本地默认 session |
26
+ | `coze session use <session_id>` | 切换当前本地默认 session |
27
+ | `coze session list` | 分页列出 claw sessions |
28
+
29
+ ## status
30
+
31
+ 检查当前 token 是否可访问 claw。
32
+
33
+ ```bash
34
+ coze session status --format json
35
+ ```
36
+
37
+ 关键输出:
38
+
39
+ | 字段 | 含义 |
40
+ |------|------|
41
+ | `auth_configured` | 是否配置 token |
42
+ | `auth_valid` | token 是否有效 |
43
+ | `claw_id` | 当前 claw id |
44
+ | `account_id` | fallback account/organization id |
45
+
46
+ 如果 `auth_valid=false`,先执行 `coze auth status`,必要时重新登录。
47
+
48
+ ## status -s
49
+
50
+ 查看指定 session runtime 状态。
51
+
52
+ ```bash
53
+ coze session status -s <session_id> --format json
54
+ ```
55
+
56
+ 关键输出:
57
+
58
+ | 字段 | 含义 |
59
+ |------|------|
60
+ | `display_status` | `idle` / `working` / `offline` |
61
+ | `runtime_status` | 当前进程内记录的 `idle` / `working` |
62
+ | `claw_busy` | 当前 claw 是否有后台任务 |
63
+ | `claw_progress_count` | 当前 claw 后台任务数量 |
64
+
65
+ `status -s` 不返回消息内容。要拿结果用 `watch` 或 `replies`。
66
+
67
+ ## create
68
+
69
+ 创建新 session,并记录 `session_id`。
70
+
71
+ ```bash
72
+ coze session create --format json
73
+ ```
74
+
75
+ 关键输出:
76
+
77
+ ```json
78
+ {
79
+ "status": "created",
80
+ "claw_id": "...",
81
+ "session_id": "..."
82
+ }
83
+ ```
84
+
85
+ Agent 必须保存 `session_id`,后续 `message/watch/replies/ppt edit` 都需要它。
86
+
87
+ 补充:CLI 现在会在 `create` 成功后自动把这个 `session_id` 写入本地默认 session。
88
+
89
+ ## current
90
+
91
+ 查看当前本地默认 session。
92
+
93
+ ```bash
94
+ coze session current --format json
95
+ ```
96
+
97
+ 关键输出:
98
+
99
+ ```json
100
+ {
101
+ "configured": true,
102
+ "session_id": "...",
103
+ "claw_id": "..."
104
+ }
105
+ ```
106
+
107
+ 如果 `configured=false`,说明当前没有本地默认 session;这时先 `list` 找回,或直接 `create` 新建。
108
+
109
+ ## use
110
+
111
+ 显式切换当前本地默认 session。
112
+
113
+ ```bash
114
+ coze session use <session_id> --format json
115
+ ```
116
+
117
+ 适用场景:
118
+
119
+ - `list` 找回了历史 session,准备继续该话题
120
+ - 刚创建了多个 session,需要切换默认上下文
121
+ - Agent 需要确保接下来所有省略 `-s` 的命令都落到同一个 session
122
+
123
+ ## list
124
+
125
+ 找回已有 session。
126
+
127
+ ```bash
128
+ coze session list --limit 20 --format json
129
+ coze session list --offset <next_offset> --limit 20 --format json
130
+ ```
131
+
132
+ 关键输出:
133
+
134
+ | 字段 | 含义 |
135
+ |------|------|
136
+ | `items` | session 列表 |
137
+ | `next_offset` | 下一页 offset |
138
+ | `has_more` | 是否还有更多 |
139
+
140
+ ## 常见恢复
141
+
142
+ - 没有 `session_id`:先 `current` 看本地默认;没有再 `list` 找最近可复用 session,并用 `use` 切换;只有用户明确要求新话题或确实找不到可复用 session 时才 `create`。
143
+ - token 无效:先 `coze auth status`,不要盲目切 org/space。
144
+ - session 仍 working:用 `watch -s <session_id> --timeout <ms>` 或查 `progress list`。
@@ -0,0 +1,252 @@
1
+ ---
2
+ name: coze-code
3
+ version: 0.2.0-alpha.094e22
4
+ description: "Coze Coding 项目开发工作流:创建项目、发送需求消息、查询状态、预览、部署、环境变量管理、域名管理、技能管理、数据库管理。当用户需要创建/管理 Coze 项目、发送开发需求、部署应用、管理数据库、或使用 coze code * 任意命令时触发。"
5
+ metadata:
6
+ requires:
7
+ bins: ["coze"]
8
+ cliHelp: "coze code --help"
9
+ ---
10
+
11
+ # Coze Coding 工作流
12
+
13
+ > **前置条件:** 先阅读 [`../SKILL.md`](../SKILL.md) 完成认证和上下文配置。
14
+ > **执行前必做:** 执行任何 `code` 命令前,必须先阅读对应命令的 reference 文档,再调用命令。
15
+
16
+ ## 核心概念
17
+
18
+ - **Project(项目)**:Coze Coding 的核心实体,包含 AI 编程对话历史和代码仓库。通过 `project create` 创建。
19
+ - **Message(消息)**:发送给项目的需求或指令,由 AI 异步处理。通过 `message send` 发送。
20
+ - **Deploy(部署)**:将项目部署到生产环境。通过 `deploy` 执行。
21
+ - **Preview(预览)**:获取沙盒预览链接。通过 `preview` 获取。
22
+ - **Env(环境变量)**:项目级 Secrets 管理,支持 dev/prod 环境。
23
+ - **Domain(域名)**:项目自定义域名绑定。
24
+ - **Skill(技能)**:项目关联的外部技能,可挂载/解绑到默认会话,也可上传/删除个人技能。
25
+ - **Model(模型)**:项目默认会话使用的模型。通过 `model list/set` 查看与设置(会话维度)。
26
+ - **Tools(工具)**:项目默认会话启用的工具(如联网搜索、图片生成)。通过 `tools list/enable/disable` 管理(会话维度)。
27
+ - **Database(数据库)**:空间级 Supabase 数据库,支持 SQL 执行、类型生成、Schema 导出和 PITR 回滚。
28
+ - **Git(Git 集成)**:Git 平台 OAuth 授权管理和仓库搜索。通过 `git auth` 管理授权,`git search` 搜索仓库。
29
+ - **Repo(远程仓库)**:项目的远程仓库绑定和同步管理。通过 `repo` 命令组进行创建、绑定、推送、拉取等操作。
30
+
31
+ ## Agent 快速执行顺序
32
+
33
+ 1. **判断任务类型**
34
+ - 新建项目 → `project create`
35
+ - 迭代开发 → `message send` → [`message status`](references/coze-code-message.md) → [`preview`](references/coze-code-preview.md) → [`deploy`](references/coze-code-deploy.md)
36
+ - 查询/管理 → `project list/get/delete`
37
+ - 配置管理 → `env` / `domain` / `skill` / `model` / `tools`
38
+ - 数据库管理 → `db create / list / get / query / gen-types / dump / rollback / status / delete`
39
+ 2. **确认前置条件**
40
+ - 已登录? (`coze auth status`)
41
+ - 已选组织和空间?
42
+ - 如果是已有项目: 拿到 projectId
43
+ 3. **执行命令前必读对应 reference**
44
+
45
+ ## 标准 Coze Coding 工作流
46
+
47
+ ### Step 0: 使用 `@` 语法引用本地文件
48
+
49
+ 在 `coze code message send` 中,可直接用 `@文件路径` 引用本地文件,CLI 会自动上传并作为附件发送。
50
+
51
+ - 只支持引用**文件**(不支持目录)。
52
+ - 文件路径可以是相对路径或绝对路径。
53
+
54
+ ```bash
55
+ coze code message send "请使用这张图片作为头像 @./avatar.png" -p <project-id>
56
+ coze code message send "对比 @src/old.ts 和 @src/new.ts 的差异" -p <project-id>
57
+ ```
58
+
59
+ 详细用法参见 [`coze-code-message.md`](references/coze-code-message.md)。
60
+
61
+ ### Step 1: 创建项目
62
+
63
+ 详细参数和示例参见 [`coze-code-project.md`](references/coze-code-project.md)。
64
+
65
+ ```bash
66
+ coze code project create --message "创建一个聊天机器人" --type web --format json
67
+ ```
68
+
69
+ - `--message` 和 `--type` 均为**必填参数**(`--message` 无 `-m` 短别名)。
70
+ - **`--type` 接受**:`agent | workflow | app | skill | web | miniprogram | assistant`(源码 `resolveProjectType` 还兼容 `webapp`)。其中 `web` / `app` 是最常用类型;`assistant` 走模板复制创建。传入未知类型会报 `E1005`。
71
+ - 其它可选项:`--chat-mode <ask|agent|dangerous_confirm|plan>`、`--model-name`、`--tool-name`(可多次传)、`--design`(`--chat-mode plan` 时自动开启)。
72
+ - `--wait` 选项会等待项目创建完成(包括首次 AI 消息响应)后再返回。
73
+ - 记录返回的 `projectId`。
74
+
75
+ ### Step 2: 发送需求
76
+
77
+ 详细参数和示例参见 [`coze-code-message.md`](references/coze-code-message.md)。
78
+
79
+ ```bash
80
+ coze code message send "请优化应用配色..." \
81
+ --project-id <project-id> \
82
+ --format json
83
+ ```
84
+
85
+ - `-p` / `--project-id` 指定项目 ID,也可通过 `COZE_PROJECT_ID` 环境变量设置(仅 `message` 命令组支持该环境变量回退)。
86
+ - 支持 stdin 管道输入,但**必须显式加 `--stdin`**:`cat requirements.txt | coze code message send "请按此需求开发" --stdin -p <id>`。
87
+ - `--format json` 时输出 NDJSON 事件流,每行一个 JSON 对象。**必须按行解析**。
88
+
89
+ ### Step 3: 部署前先查状态
90
+
91
+ 详细说明参见 [`coze-code-message.md`](references/coze-code-message.md)。
92
+
93
+ - 收到"部署"要求时,**必须**先确认 `message status` 已结束。
94
+ - 状态为 `processing` 时禁止直接部署,否则可能出现 `refs/heads/main does not exist` 等错误。
95
+
96
+ ```bash
97
+ coze code message status --project-id <project-id> --format json
98
+ ```
99
+
100
+ - `message status` 是**单次查询**(无 `--wait`,不轮询):状态为 `done` 时自动拉取并返回 answer,否则返回当前状态。需要等待时,请自行轮询调用。
101
+ - `message cancel` 可取消正在进行的消息。
102
+
103
+ ### Step 4: 部署
104
+
105
+ 详细参数和坑点参见 [`coze-code-deploy.md`](references/coze-code-deploy.md)。
106
+
107
+ - `deploy` 直接接收项目 ID 作为**位置参数**,**不要**加 `--project-id`。
108
+
109
+ ```bash
110
+ coze code deploy <project-id> --format json
111
+ ```
112
+
113
+ - `--wait` 会轮询等待部署完成(轮询间隔 3 秒)。
114
+ - 部署前项目必须有 commit 记录,否则会失败。
115
+
116
+ ### Step 5: 查询部署结果 & 获取预览
117
+
118
+ ```bash
119
+ # 查询部署状态
120
+ coze code deploy status <project-id> --format json
121
+
122
+ # 获取预览链接
123
+ coze code preview <project-id>
124
+ ```
125
+
126
+ - 默认查询最新部署记录,也可通过 `--deploy-id <id>` 指定具体部署记录。
127
+ - 直到 `status` 为 `Succeeded`,再把线上地址返回给用户。
128
+ - 沙盒初始化通常需要 1-3 分钟。
129
+
130
+ ## Agent 禁止行为
131
+
132
+ - 不要在 message 仍为 **processing** 时直接部署
133
+ - 不要对 deploy 使用 **`--project-id`**(它是位置参数!)
134
+ - 不要给 project create 的 **`--type`** 传受支持列表(`agent|workflow|app|skill|web|miniprogram|assistant`)以外的值,否则报 `E1005`
135
+ - 不要在没有 `--stdin` 时指望管道输入被读取(`message send` 必须显式加 `--stdin` 才读 stdin)
136
+ - 不要忽略 **NDJSON 事件流的逐行解析要求**
137
+ - 不要把本地路径发给用户(必须走 file upload 返回在线链接)
138
+
139
+ ## 长耗时任务处理
140
+
141
+ | 命令 | 轮询间隔 | 说明 |
142
+ |------|----------|------|
143
+ | `coze code project create --wait` | — | 等待项目创建和首次 AI 响应完成 |
144
+ | `coze code deploy --wait` | 3 秒 | 等待部署到达终态 |
145
+ | `coze code deploy status --wait` | 3 秒 | 复用父级 `deploy --wait`,等待部署到达终态 |
146
+ | `coze code deploy fix --wait` | — | 等待修复消息响应 |
147
+
148
+ > `message status` **没有** `--wait`,需要等待时请自行轮询;`deploy status` 自身不声明 `--wait`,而是读取父命令 `deploy --wait`。
149
+
150
+ 优先使用 `--wait` 让 CLI 自动轮询。到达终态后,必须主动把最终结果反馈给用户。
151
+
152
+ ## 意图 → 命令索引
153
+
154
+ | 意图 | 推荐命令 | 备注 |
155
+ |------|---------|------|
156
+ | 创建新项目 | `coze code project create` | `--type` 支持 agent/workflow/app/skill/web/miniprogram/assistant(常用 web/app) |
157
+ | 列出/查看项目 | `coze code project list/get` | 支持按类型/名称筛选 |
158
+ | 删除项目 | `coze code project delete` | 不可逆操作 |
159
+ | 发送开发需求 | `coze code message send` | 支持 @文件引用;stdin 需加 `--stdin` |
160
+ | 查询任务状态 | `coze code message status` | 单次查询,无 --wait |
161
+ | 取消任务 | `coze code message cancel` | |
162
+ | 查看对话历史 | `coze code message history` | 支持 --before / --after 翻页 |
163
+ | 部署到生产 | `coze code deploy <id>` | **位置参数**, 不用 --project-id;支持 --commit-id/--table-name/--connector-id |
164
+ | 查询部署状态 | `coze code deploy status <id>` | |
165
+ | 列出部署历史 | `coze code deploy list <id>` | 支持 --page-size/--page-token |
166
+ | 修复失败部署 | `coze code deploy fix <id>` | 把部署日志发给 AI 修复,仅 Failed 可修 |
167
+ | 获取预览链接 | `coze code preview <id>` | 沙盒初始化需 1-3 分钟;仅 Web/App 类型可预览 |
168
+ | 管理环境变量 | `coze code env set/list/delete` | list 支持 --env dev\|prod;delete 固定 dev;set 不支持 Skill 项目 |
169
+ | 管理自定义域名 | `coze code domain add/list/remove` | add 仅接受单级域名(如 example.com) |
170
+ | 挂载/解绑技能 | `coze code skill add/remove` | 对默认会话挂载或解绑 |
171
+ | 列出技能 | `coze code skill list` | 支持 --my 列个人技能 |
172
+ | 上传个人技能 | `coze code skill upload <file>` | 上传 .skill 文件,冲突自动覆盖 |
173
+ | 删除个人技能 | `coze code skill delete <id>` | 永久删除技能本体(区别于 remove) |
174
+ | 查看/设置模型 | `coze code model list/set` | 会话维度,set 需校验模型可用 |
175
+ | 启用/禁用工具 | `coze code tools list/enable/disable` | 会话维度 |
176
+ | 创建数据库 | `coze code db create` | 自动生成名称和凭据 |
177
+ | 列出数据库 | `coze code db list` | 支持 --all 自动翻页 |
178
+ | 查看数据库详情 | `coze code db get --db-id <id>` | 含连接 URL 和凭据 |
179
+ | 执行 SQL | `coze code db query --db-id <id> --sql "..."` | 危险 SQL 需 --confirm |
180
+ | 生成 TS 类型 | `coze code db gen-types --db-id <id>` | 基于 PostgREST OpenAPI |
181
+ | 导出 Schema | `coze code db dump --db-id <id>` | 支持 --schema-only / --data-only |
182
+ | 回滚数据库 | `coze code db rollback --db-id <id> --timestamp <ts> --confirm` | PITR 回滚,需 --confirm |
183
+ | 查看数据库状态 | `coze code db status --db-id <id>` | 含回滚进度 |
184
+ | 删除数据库 | `coze code db delete --db-id <id> --confirm` | 不可逆,需 --confirm |
185
+ | 授权 Git 平台 | `coze code git auth login` | 需要浏览器完成 OAuth |
186
+ | 检查 Git 授权状态 | `coze code git auth status` | |
187
+ | 取消 Git 授权 | `coze code git auth logout` | 影响空间下所有项目 |
188
+ | 搜索远程仓库 | `coze code git search` | 需先完成 Git 授权 |
189
+ | 创建远程仓库 | `coze code repo create` | 创建空仓库供绑定 |
190
+ | 绑定远程仓库 | `coze code repo bind` | 仅支持空仓库 |
191
+ | 解绑远程仓库 | `coze code repo unbind` | 不删除远程仓库 |
192
+ | 推送到远程 | `coze code repo push` | 需先绑定仓库 |
193
+ | 拉取远程变更 | `coze code repo pull` | 支持冲突策略 |
194
+ | 查看仓库同步状态 | `coze code repo status` | |
195
+
196
+ ## 命令分组
197
+
198
+ > **执行前必做:** 从下表定位到命令后,务必先阅读对应命令的 reference 文档,再调用命令。
199
+
200
+ | 命令分组 | 说明 | Reference |
201
+ |----------|------|-----------|
202
+ | [`project commands`](references/coze-code-project.md) | `create / list / get / delete / import / db list` | 项目全生命周期管理 |
203
+ | [`message commands`](references/coze-code-message.md) | `send / status / cancel / history` | 需求发送与状态追踪 |
204
+ | [`deploy commands`](references/coze-code-deploy.md) | `deploy / status / list / fix` | 部署、状态查询与失败修复 |
205
+ | [`preview`](references/coze-code-preview.md) | `preview` | 沙盒预览链接 |
206
+ | [`env commands`](references/coze-code-env.md) | `set / list / delete` | 环境变量(Secrets)管理 |
207
+ | [`domain commands`](references/coze-code-domain.md) | `add / list / remove` | 自定义域名管理 |
208
+ | [`skill commands`](references/coze-code-skill.md) | `list / add / remove / upload / delete` | 技能管理 |
209
+ | [`model commands`](references/coze-code-model.md) | `list / set` | 会话模型管理 |
210
+ | [`tools commands`](references/coze-code-tools.md) | `list / enable / disable` | 会话工具管理 |
211
+ | [`db commands`](references/coze-code-db.md) | `create / list / get / query / gen-types / dump / rollback / status / delete` | 数据库管理 |
212
+ | [`git commands`](references/coze-code-git.md) | `auth login / auth status / auth logout / search` | Git 平台 OAuth 授权与仓库搜索 |
213
+ | [`repo commands`](references/coze-code-repo.md) | `create / bind / unbind / push / pull / status` | 远程仓库绑定与同步 |
214
+
215
+ ## 常见错误速查(Code 专用)
216
+
217
+ > 以下为 Code 专用错误(本节内独立编号 1–7);基础类错误(认证、`--format json` 等)见根 [`../SKILL.md`](../SKILL.md)。
218
+
219
+ ### 错误 1:把本地路径发给用户
220
+
221
+ - 问题:`/tmp/...` 只能本机访问,用户无法直接打开。
222
+ - 修正:始终执行 `coze file upload`,把上传后的在线 `URL` 发给用户。
223
+
224
+ ### 错误 2:message 仍在 processing 时直接部署
225
+
226
+ - 问题:项目还没有可部署的代码或 commit,导致部署失败。
227
+ - 修正:始终先执行 `coze code message status -p <id> --format json` 确认状态为完成后再部署。
228
+
229
+ ### 错误 3:deploy 命令使用 --project-id 参数
230
+
231
+ - 问题:`deploy` 命令的项目 ID 是**位置参数**,不是 `--project-id` 选项。
232
+ - 修正:使用 `coze code deploy <project-id>` 而非 `coze code deploy --project-id <id>`。
233
+
234
+ ### 错误 4:project create --type 传了不支持的类型
235
+
236
+ - 问题:`--type` 只接受 `agent | workflow | app | skill | web | miniprogram | assistant`(源码另兼容 `webapp`);传入其它字符串会报 `E1005 Unknown project type`。
237
+ - 修正:从受支持列表中选择类型;常用 `web` / `app`。
238
+
239
+ ### 错误 5:message send 管道输入未加 --stdin
240
+
241
+ - 问题:`message send` 只有显式传 `--stdin` 才会读取标准输入,否则管道内容被忽略。
242
+ - 修正:`cat ctx.txt | coze code message send "..." --stdin -p <id>`。
243
+
244
+ ### 错误 6:db 危险操作未加 --confirm
245
+
246
+ - 问题:`db query`、`db delete`、`db rollback` 涉及危险操作时必须加 `--confirm`,否则 JSON 模式下报错。
247
+ - 修正:始终在执行 DROP/TRUNCATE/DELETE 无 WHERE/UPDATE 无 WHERE 等 SQL 时加 `--confirm`;删除和回滚操作也必须加 `--confirm`。
248
+
249
+ ### 错误 7:数据库未 active 时执行操作
250
+
251
+ - 问题:数据库处于 `creating` 状态时无法执行 SQL、生成类型或导出 Schema。
252
+ - 修正:先执行 `coze code db status --db-id <id>` 确认状态为 `active` 后再操作。