npm - @coze/cli - Versions diffs - 0.1.0-alpha.429e52 → 0.1.0-alpha.5751ff - Mend

@coze/cli 0.1.0-alpha.429e52 → 0.1.0-alpha.5751ff

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 (6) hide show

package/README.md +193 -192
package/lib/cli.js +1 -1
package/lib/index-Ck7eq-dU.js +1 -0
package/lib/send-message.worker.js +1 -1
package/package.json +4 -7
package/lib/index-DLgV1inZ.js +0 -1

package/README.md CHANGED Viewed

@@ -1,18 +1,18 @@
-# @coze/coding-cli
+# @coze/cli
-Coze Coding CLI — A command-line tool for interacting with [Coze](https://www.coze.cn) services. Manage organizations, workspaces, projects, deployments, and generate media — all from your terminal.
+Coze CLI — A command-line tool for interacting with [Coze](https://www.coze.cn) services. Manage organizations, workspaces, projects, deployments, and generate media — all from your terminal.
 ## Installation
 ```bash
-npm install -g @coze/coding-cli
+npm install -g @coze/cli
 ```
 ## Quick Start
 ```bash
 # 1. Login to your Coze account
-coze auth login --oauth
+coze auth login
 # 2. Select your organization
 coze organization list
@@ -23,7 +23,7 @@ coze space list
 coze space use <space_id>
 # 4. Start using Coze Coding
-coze code project create -m "Build an intelligent assistant" --type web
+coze code project create --message "Build an intelligent assistant" --type web
 ```
 ## Authentication
@@ -32,10 +32,7 @@ Before using most commands, you need to authenticate with Coze.
 ```bash
 # Interactive login via browser (recommended)
-coze auth login --oauth
-# Non-interactive login with Personal Access Token (for CI/CD)
-coze auth login --token <YOUR_PAT>
+coze auth login
 # Check current login status
 coze auth status
@@ -47,44 +44,40 @@ coze auth status --format json
 coze auth logout
 ```
-You can also authenticate via environment variables for CI/CD pipelines:
-```bash
-export COZE_API_TOKEN=<YOUR_PAT>
-```
 ## Commands
 ### `coze auth` — Authentication
-Manage the full authentication lifecycle. Supports interactive OAuth login via browser and non-interactive login via Personal Access Token (PAT) for CI/CD pipelines.
+Manage the full authentication lifecycle. Supports interactive OAuth login via browser.
-| Command | Description |
-|---|---|
-| `coze auth login --oauth` | Interactive login via browser |
-| `coze auth login --token <PAT>` | Login with a Personal Access Token |
+| Command            | Description                                        |
+| ------------------ | -------------------------------------------------- |
+| `coze auth login`  | Interactive login via browser                      |
 | `coze auth status` | Check current login status and credential validity |
-| `coze auth logout` | Logout and clear stored credentials |
+| `coze auth logout` | Logout and clear stored credentials                |
 ### `coze organization` — Organization Management
-View and switch organizations to set the default Organization ID for subsequent commands.
+View and switch organizations to set the default Organization ID for subsequent commands. Supports switching to personal account by omitting the org_id.
-| Command | Description |
-|---|---|
-| `coze organization list` | List all accessible organizations and their enterprises |
-| `coze organization use <org_id>` | Set the default organization (auto-saves Enterprise ID) |
+| Command                            | Description                                                      |
+| ---------------------------------- | ---------------------------------------------------------------- |
+| `coze organization list`           | List all accessible organizations and their enterprises          |
+| `coze organization use <org_id>`   | Set the default organization (auto-saves Enterprise ID)          |
+| `coze organization use`            | Switch to personal account (clears Organization and Enterprise)  |
 Alias: `coze org`
+> When switching to a different organization, the saved Space ID will be cleared automatically. If the specified org_id is not found, the command will fail without modifying the configuration.
 ### `coze space` — Workspace Management
 View and switch workspaces to set the default Space ID for subsequent commands.
-| Command | Description |
-|---|---|
-| `coze space list` | List all spaces under the current organization |
-| `coze space use <space_id>` | Set the default workspace |
+| Command                     | Description                                    |
+| --------------------------- | ---------------------------------------------- |
+| `coze space list`           | List all spaces under the current organization |
+| `coze space use <space_id>` | Set the default workspace                      |
 ### `coze code` — Coze Coding
@@ -92,61 +85,62 @@ View and switch workspaces to set the default Space ID for subsequent commands.
 Manage Coze Coding projects. Supports creating, viewing, listing, and deleting projects across various types.
-| Command | Description |
-|---|---|
-| `coze code project create` | Create a new project from natural language description |
-| `coze code project list` | List all projects in the current space |
-| `coze code project get <projectId>` | Get project details |
-| `coze code project delete <projectId>` | Delete a project (irreversible) |
+| Command                                | Description                                            |
+| -------------------------------------- | ------------------------------------------------------ |
+| `coze code project create`             | Create a new project from natural language description |
+| `coze code project list`               | List all projects in the current space                 |
+| `coze code project get <projectId>`    | Get project details                                    |
+| `coze code project delete <projectId>` | Delete a project (irreversible)                        |
 Alias: `coze code proj`
 ```bash
 # Create a Web project
-coze code project create -m "Create a chatbot" --type web
+coze code project create --message "Create a chatbot" --type web
 # Create and wait for the initial build to complete
-coze code project create -m "Create a data dashboard" --type app --wait
+coze code project create --message "Create a data dashboard" --type app --wait
 # List projects with filters
 coze code project list --type agent --type workflow
 coze code project list --name "customer service"
-coze code project list --size 20 --has-published true
+coze code project list --size 20 --has-published
 ```
-**`project create` options:**
-| Option | Description |
-|---|---|
-| `-m, --message <message>` | **(required)** Project description in natural language |
-| `--type <type>` | **(required)** Project type: `web` \| `app` |
-| `--wait` | Wait for project creation to complete |
-| `--org-id <orgId>` | Organization ID (reads from context if omitted) |
-| `--space-id <spaceId>` | Space ID (reads from context if omitted) |
-**`project list` options:**
-| Option | Description |
-|---|---|
-| `--size <size>` | Number of projects to return (default: 10) |
-| `--cursor-id <cursorId>` | Cursor for pagination |
-| `--type <type>` | Filter by type (can pass multiple times): `agent` \| `workflow` \| `webapp` \| `app` \| `web` \| `miniprogram` \| `assistant` |
-| `--name <name>` | Filter by project name |
-| `--has-published <bool>` | Filter by publish status |
-| `--search-scope <n>` | Created by (0=All, 1=CreatedByMe, 2=AllWithCollaborator) |
-| `--folder-id <id>` | Filter by folder |
-| `--order-type <n>` | Sort type (0=descending, 1=ascending) |
-| `--is-fav-filter <bool>` | Filter favorites only |
+**`project create`** **options:**
+| Option                 | Description                                            |
+| ---------------------- | ------------------------------------------------------ |
+| `--message <message>`  | **(required)** Project description in natural language |
+| `--type <type>`        | **(required)** Project type: `web` \| `app`            |
+| `--wait`               | Wait for project creation to complete                  |
+| `--org-id <orgId>`     | Organization ID (reads from context if omitted)        |
+| `--space-id <spaceId>` | Space ID (reads from context if omitted)               |
+**`project list`** **options:**
+| Option                   | Description                                                                                                                   |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
+| `--size <size>`          | Number of projects to return (default: 10)                                                                                    |
+| `--cursor-id <cursorId>` | Cursor for pagination                                                                                                         |
+| `--type <type>`          | Filter by type (can pass multiple times): `agent` \| `workflow` \| `webapp` \| `app` \| `web` \| `miniprogram` \| `assistant` |
+| `--name <name>`          | Filter by project name                                                                                                        |
+| `--has-published`        | Filter by publish status                                                                                                      |
+| `--search-scope <n>`     | Created by (0=All, 1=CreatedByMe, 2=AllWithCollaborator)                                                                      |
+| `--folder-id <id>`       | Filter by folder                                                                                                              |
+| `--order-type <n>`       | Sort type (0=descending, 1=ascending)                                                                                         |
+| `--order-by <n>`         | Order by (0=updated\_at, 1=created\_at)                                                                                       |
+| `--is-fav-filter`        | Filter favorites only                                                                                                         |
 #### Message
 Send and manage chat messages in Coze Coding projects. The project ID is specified on the `message` parent command and shared by all subcommands.
-| Command | Description |
-|---|---|
-| `coze code message send [message]` | Send a prompt message to a project chat |
-| `coze code message status` | Query message status and get result when completed |
-| `coze code message cancel` | Cancel an ongoing message |
+| Command                            | Description                                        |
+| ---------------------------------- | -------------------------------------------------- |
+| `coze code message send [message]` | Send a prompt message to a project chat            |
+| `coze code message status`         | Query message status and get result when completed |
+| `coze code message cancel`         | Cancel an ongoing message                          |
 ```bash
 # Send a message to a project
@@ -172,21 +166,22 @@ export COZE_PROJECT_ID=123456
 coze code message send "Hello"
 ```
-**`message` options (shared by all subcommands):**
+**`message`** **options (shared by all subcommands):**
-| Option | Description |
-|---|---|
+| Option                  | Description                                |
+| ----------------------- | ------------------------------------------ |
 | `-p, --project-id <id>` | Coze project ID (or env `COZE_PROJECT_ID`) |
 #### Deploy
 Deploy projects to the production environment. Supports multiple project types including Agent, Workflow, Skill, Web, Mini-program, etc.
-| Command | Description |
-|---|---|
-| `coze code deploy <projectId>` | Deploy a project to production |
-| `coze code deploy <projectId> --wait` | Deploy and wait for completion |
-| `coze code deploy status <projectId>` | Check deployment status |
+| Command                                      | Description                               |
+| -------------------------------------------- | ----------------------------------------- |
+| `coze code deploy <projectId>`               | Deploy a project to production            |
+| `coze code deploy <projectId> --wait`        | Deploy and wait for completion            |
+| `coze code deploy status <projectId>`        | Check deployment status                   |
+| `coze code deploy status <projectId> --wait` | Check and wait for deployment to complete |
 ```bash
 # Deploy a project
@@ -200,17 +195,20 @@ coze code deploy status <projectId>
 # Check a specific deployment record
 coze code deploy status <projectId> --deploy-id <deployHistoryId>
+# Check and wait for deployment to complete
+coze code deploy status <projectId> --wait
 ```
 #### Environment Variables
 Manage project environment variables (Secrets). Supports development and production environments.
-| Command | Description |
-|---|---|
-| `coze code env list -p <projectId>` | List environment variables |
-| `coze code env set <key> <value> -p <projectId>` | Set an environment variable |
-| `coze code env delete <key> -p <projectId>` | Delete an environment variable |
+| Command                                          | Description                    |
+| ------------------------------------------------ | ------------------------------ |
+| `coze code env list -p <projectId>`              | List environment variables     |
+| `coze code env set <key> <value> -p <projectId>` | Set an environment variable    |
+| `coze code env delete <key> -p <projectId>`      | Delete an environment variable |
 ```bash
 # List dev environment variables (default)
@@ -230,28 +228,28 @@ coze code env delete API_KEY -p <projectId>
 Manage custom domains for deployed projects.
-| Command | Description |
-|---|---|
-| `coze code domain list <projectId>` | List all custom domains bound to the project |
-| `coze code domain add <domain> -p <projectId>` | Add a custom domain |
-| `coze code domain remove <domain> -p <projectId>` | Remove a custom domain |
+| Command                                           | Description                                  |
+| ------------------------------------------------- | -------------------------------------------- |
+| `coze code domain list <projectId>`               | List all custom domains bound to the project |
+| `coze code domain add <domain> -p <projectId>`    | Add a custom domain                          |
+| `coze code domain remove <domain> -p <projectId>` | Remove a custom domain                       |
 #### Skill
 Manage skills associated with a project to extend its capabilities.
-| Command | Description |
-|---|---|
-| `coze code skill list <projectId>` | List all skills (shows installed status) |
-| `coze code skill add <skillId> -p <projectId>` | Add a skill to the project |
-| `coze code skill remove <skillId> -p <projectId>` | Remove a skill from the project |
+| Command                                           | Description                              |
+| ------------------------------------------------- | ---------------------------------------- |
+| `coze code skill list -p <projectId>`             | List all skills (shows installed status) |
+| `coze code skill add <skillId> -p <projectId>`    | Add a skill to the project               |
+| `coze code skill remove <skillId> -p <projectId>` | Remove a skill from the project          |
 #### Preview
 Get the sandbox preview URL for a project.
-| Command | Description |
-|---|---|
+| Command                         | Description                 |
+| ------------------------------- | --------------------------- |
 | `coze code preview <projectId>` | Get the project preview URL |
 ```bash
@@ -285,18 +283,18 @@ coze generate image "Similar style" --image https://example.com/ref.png
 coze generate image "A storyboard" --sequential auto --max-images 5
 ```
-**`generate image` options:**
+**`generate image`** **options:**
-| Option | Default | Description |
-|---|---|---|
-| `--size <size>` | `2K` | Image size: `2K` \| `4K` \| `WIDTHxHEIGHT` |
-| `--no-watermark` | enabled | Disable watermark |
-| `--image <url>` | — | Reference image URL (repeatable) |
-| `--response-format <fmt>` | `url` | Response format: `url` \| `b64_json` |
-| `--optimize-prompt-mode <mode>` | `standard` | Prompt optimization mode |
-| `--sequential <mode>` | `disabled` | Group image generation: `auto` \| `disabled` |
-| `--max-images <n>` | `15` | Maximum group images (1–15) |
-| `--output-path <path>` | — | Directory to save generated images |
+| Option                          | Default    | Description                                  |
+| ------------------------------- | ---------- | -------------------------------------------- |
+| `--size <size>`                 | `2K`       | Image size: `2K` \| `4K` \| `WIDTHxHEIGHT`   |
+| `--no-watermark`                | enabled    | Disable watermark                            |
+| `--image <url>`                 | —          | Reference image URL (repeatable)             |
+| `--response-format <fmt>`       | `url`      | Response format: `url` \| `b64_json`         |
+| `--optimize-prompt-mode <mode>` | `standard` | Prompt optimization mode                     |
+| `--sequential <mode>`           | `disabled` | Group image generation: `auto` \| `disabled` |
+| `--max-images <n>`              | `15`       | Maximum group images (1–15)                  |
+| `--output-path <path>`          | —          | Directory to save generated images           |
 #### Audio Generation (TTS)
@@ -314,17 +312,18 @@ echo "<speak>Hello</speak>" | coze generate audio --ssml
 coze generate audio "Hello" --speaker zh_female_xiaohe_uranus_bigtts --audio-format ogg_opus
 ```
-**`generate audio` options:**
+**`generate audio`** **options:**
-| Option | Default | Description |
-|---|---|---|
-| `--speaker <speaker>` | `zh_female_xiaohe_uranus_bigtts` | Voice speaker |
-| `--audio-format <fmt>` | `mp3` | Audio encoding: `pcm` \| `mp3` \| `ogg_opus` |
-| `--sample-rate <n>` | `24000` | Sample rate |
-| `--speech-rate <n>` | `0` | Speech rate (-50 to 100) |
-| `--loudness-rate <n>` | `0` | Loudness (-50 to 100) |
-| `--ssml` | `false` | Treat input as SSML instead of plain text |
-| `--output-path <path>` | — | Directory to save generated audio |
+| Option                 | Default                          | Description                                  |
+| ---------------------- | -------------------------------- | -------------------------------------------- |
+| `--speaker <speaker>`  | `zh_female_xiaohe_uranus_bigtts` | Voice speaker                                |
+| `--audio-format <fmt>` | `mp3`                            | Audio encoding: `pcm` \| `mp3` \| `ogg_opus` |
+| `--sample-rate <n>`    | `24000`                          | Sample rate                                  |
+| `--speech-rate <n>`    | `0`                              | Speech rate (-50 to 100)                     |
+| `--loudness-rate <n>`  | `0`                              | Loudness (-50 to 100)                        |
+| `--ssml`               | `false`                          | Treat input as SSML instead of plain text    |
+| `--uid <uid>`          | `cli_user`                       | User UID                                     |
+| `--output-path <path>` | —                                | Directory to save generated audio            |
 #### Video Generation
@@ -341,9 +340,8 @@ coze generate video create "A dancing kitten" --wait --output-path ./video.mp4
 # Custom resolution and aspect ratio
 coze generate video create "A landscape" --resolution 1080p --ratio 16:9
-# Use reference images
+# Use first frame / last frame
 coze generate video create "Animate this" --first-frame https://example.com/frame.png
-coze generate video create "In this style" --reference-image https://example.com/ref.png
 # Query task status later
 coze generate video status task_123
@@ -351,11 +349,10 @@ coze generate video status task_123
 Use `coze generate video create` to submit generation tasks, and `coze generate video status <taskId>` to query existing tasks.
-**`generate video create` options:**
+**`generate video create`** **options:**
 | Option | Default | Description |
 |---|---|---|
-| `--model <model>` | `doubao-seedance-1-5-pro-251215` | Video generation model |
 | `--callback-url <url>` | — | Callback URL for task status changes |
 | `--resolution <res>` | `720p` | Resolution: `480p` \| `720p` \| `1080p` |
 | `--ratio <ratio>` | `16:9` | Aspect ratio (e.g., `16:9`, `9:16`, `1:1`) |
@@ -367,23 +364,22 @@ Use `coze generate video create` to submit generation tasks, and `coze generate
 | `--no-generate-audio` | generates audio | Do not generate accompanying audio |
 | `--first-frame <url>` | — | First frame image URL |
 | `--last-frame <url>` | — | Last frame image URL |
-| `--reference-image <url>` | — | Reference image URL (repeatable) |
 | `--return-last-frame` | `false` | Return last frame URL in output |
 | `--wait` | `false` | Poll until completion instead of returning `taskId` immediately |
 | `--output-path <path>` | — | Directory to save generated video |
-**`generate video status` options:**
+**`generate video status`** **options:**
-| Option | Default | Description |
-|---|---|---|
-| `--output <format>` | `text` | Output format: `text` \| `json` |
+| Option              | Default | Description                     |
+| ------------------- | ------- | ------------------------------- |
+| `--output <format>` | `text`  | Output format: `text` \| `json` |
 ### `coze file` — File Operations
 Upload local files to Coze for use as attachments or context in projects.
-| Command | Description |
-|---|---|
+| Command                   | Description         |
+| ------------------------- | ------------------- |
 | `coze file upload <path>` | Upload a local file |
 ```bash
@@ -395,12 +391,12 @@ coze file upload ./document.pdf
 Manage CLI configuration stored in `~/.coze/config.json` (global) and `.cozerc.json` (project-level).
-| Command | Description |
-|---|---|
-| `coze config list` | List all configuration items with sources |
-| `coze config get <keys...>` | Get one or more configuration values |
-| `coze config set <key> <value>` | Set a configuration value |
-| `coze config delete <keys...>` | Delete one or more configuration items |
+| Command                         | Description                               |
+| ------------------------------- | ----------------------------------------- |
+| `coze config list`              | List all configuration items with sources |
+| `coze config get <keys...>`     | Get one or more configuration values      |
+| `coze config set <key> <value>` | Set a configuration value                 |
+| `coze config delete <keys...>`  | Delete one or more configuration items    |
 ```bash
 # List all configurations with their sources (env, local, global, default)
@@ -422,7 +418,7 @@ coze config delete spaceId apiBaseUrl
 ### `coze completion` — Shell Autocompletion
-Set up or remove shell autocompletion for bash/zsh.
+Set up or remove shell autocompletion (supports bash/zsh/fish/powershell).
 ```bash
 # Install shell completion script
@@ -432,82 +428,87 @@ coze completion --setup
 coze completion --cleanup
 ```
+### `coze upgrade` — CLI Upgrade
+Upgrade Coze CLI to the latest version. Detects the package manager used for the original installation (npm/pnpm/yarn) and runs the appropriate global install command.
+```bash
+# Upgrade to latest version
+coze upgrade
+# Force check and upgrade
+coze upgrade --force
+# Upgrade to a specific tag
+coze upgrade --tag beta
+```
+| Option        | Description                                            |
+| ------------- | ------------------------------------------------------ |
+| `--force`     | Force upgrade even if already on the latest version    |
+| `--tag <tag>` | Specify the dist-tag to upgrade to (default: `latest`) |
 ## Global Options
-| Option | Description |
-|---|---|
-| `-h, --help` | Show help |
-| `-v, --version` | Show version |
-| `--format <fmt>` | Output format: `json` or `text` (default: `json`) |
-| `--no-color` | Disable ANSI color output |
-| `--config <path>` | Use a custom configuration file |
-| `--org-id <id>` | Override the default Organization ID |
-| `--space-id <id>` | Override the default Space ID |
-| `--verbose` | Enable verbose mode with detailed process information |
-| `--debug` | Enable debug mode with all log output for diagnosing issues |
-| `--log-file <path>` | Write logs to a file |
-| `--man` | Show full manual information |
-| `--schema` | Output the command's JSON Schema |
-| `--commands` | Output the list of subcommands |
+| Option              | Description                                                 |
+| ------------------- | ----------------------------------------------------------- |
+| `-h, --help`        | Show help                                                   |
+| `-v, --version`     | Show version                                                |
+| `--format <fmt>`    | Output format: `json` or `text` (default: `text`)           |
+| `--no-color`        | Disable ANSI color output                                   |
+| `--config <path>`   | Use a custom configuration file                             |
+| `--org-id <id>`     | Override the default Organization ID                        |
+| `--space-id <id>`   | Override the default Space ID                               |
+| `--verbose`         | Enable verbose mode with detailed process information       |
+| `--debug`           | Enable debug mode with all log output for diagnosing issues |
+| `--log-file <path>` | Write logs to a file                                        |
+| `--man`             | Show full manual information                                |
+| `--schema`          | Output the command's JSON Schema                            |
+| `--commands`        | Output the list of subcommands                              |
 ## Configuration
 The CLI reads configuration from multiple sources with the following priority (highest to lowest):
 1. **Environment variables**
-2. **Command-line `--config` file**
-3. **Project-level config** (`.cozerc.json` in current directory)
-4. **Global config** (`~/.coze/config.json`)
-5. **Built-in defaults**
+2. **Command-line** **`--config`** **file**
+3. **`COZE_CONFIG_FILE`** **environment variable file**
+4. **Project-level config** (`.cozerc.json` in current directory)
+5. **Global config** (`~/.coze/config.json`)
+6. **Built-in defaults**
 ### Environment Variables
-| Variable | Description |
-|---|---|
-| `COZE_API_TOKEN` | Personal Access Token for authentication |
-| `COZE_ORG_ID` | Default Organization ID |
-| `COZE_ENTERPRISE_ID` | Default Enterprise ID |
-| `COZE_SPACE_ID` | Default Space ID |
-| `COZE_PROJECT_ID` | Default Project ID (used by `message` commands) |
+| Variable                 | Description                                         |
+| ------------------------ | --------------------------------------------------- |
+| `COZE_ORG_ID`            | Default Organization ID                             |
+| `COZE_ENTERPRISE_ID`     | Default Enterprise ID                               |
+| `COZE_SPACE_ID`          | Default Space ID                                    |
+| `COZE_PROJECT_ID`        | Default Project ID (used by `message` commands)     |
+| `COZE_CONFIG_FILE`       | Custom configuration file path                      |
+| `COZE_CONFIG_SCOPE`      | Config write scope: `global` or `local`             |
+| `COZE_AUTO_CHECK_UPDATE` | Enable/disable auto update check: `true` or `false` |
 ## Exit Codes
-| Code | Name | Description |
-|---|---|---|
-| `0` | `SUCCESS` | Command completed successfully |
-| `1` | `GENERAL_ERROR` | General error |
-| `2` | `AUTH_FAILED` | Authentication failed |
-| `3` | `RESOURCE_NOT_FOUND` | Requested resource not found |
-| `4` | `INVALID_ARGUMENT` | Invalid argument or option |
-| `5` | `PERMISSION_DENIED` | Permission denied |
-| `6` | `NETWORK_ERROR` | Network error |
-| `7` | `SERVER_ERROR` | Server error |
-| `8` | `TIMEOUT` | Operation timed out |
-| `9` | `QUOTA_EXCEEDED` | Quota exceeded |
-| `10` | `CONFLICT` | Resource conflict |
-## CI/CD Usage
+| Code | Name                 | Description                    |
+| ---- | -------------------- | ------------------------------ |
+| `0`  | `SUCCESS`            | Command completed successfully |
+| `1`  | `GENERAL_ERROR`      | General error                  |
+| `2`  | `AUTH_FAILED`        | Authentication failed          |
+| `3`  | `RESOURCE_NOT_FOUND` | Requested resource not found   |
+| `4`  | `INVALID_ARGUMENT`   | Invalid argument or option     |
+| `5`  | `PERMISSION_DENIED`  | Permission denied              |
+| `6`  | `NETWORK_ERROR`      | Network error                  |
+| `7`  | `SERVER_ERROR`       | Server error                   |
+| `8`  | `TIMEOUT`            | Operation timed out            |
+| `9`  | `QUOTA_EXCEEDED`     | Quota exceeded                 |
+| `10` | `CONFLICT`           | Resource conflict              |
-```bash
-# Authenticate with a PAT
-export COZE_API_TOKEN=<YOUR_PAT>
-export COZE_ORG_ID=<ORG_ID>
-export COZE_SPACE_ID=<SPACE_ID>
-# Create a project and wait for completion
-coze code project create -m "Build a chatbot" --type web --wait --format json
-# Send a message to a project
-export COZE_PROJECT_ID=<PROJECT_ID>
-coze code message send "Fix the authentication module" --format json
-# Deploy a project and wait for completion
-coze code deploy <projectId> --wait --format json
+## License
-# Check deployment status
-coze code deploy status <projectId> --format json
-```
+This project is licensed under the **MIT License**. When running, it calls Coze Platform APIs. To use these APls, you must comply with the following agreements and privacy policies:
-## License
+- [Privacy Policy](https://docs.coze.cn/guides/privacy)
+- [Terms of Service](https://docs.coze.cn/guides/terms-of-service)
-See the [LICENSE](LICENSE.md) file and [THIRD-PARTY-LICENSES](THIRD-PARTY-LICENSES.md) included in the package for full terms, conditions, and third-party notices.