@coze/cli 0.1.0-alpha.cb1d83 → 0.1.0-alpha.d26823

package/README.md

@@ -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,22 +44,15 @@ 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 |
+| `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 |
 
@@ -103,22 +93,22 @@ 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 |
+| `--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) |
@@ -132,11 +122,12 @@ coze code project list --size 20 --has-published true
 | `--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 |
+| `--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) |
-| `--is-fav-filter <bool>` | Filter favorites only |
+| `--order-by <n>` | Order by (0=updated_at, 1=created_at) |
+| `--is-fav-filter` | Filter favorites only |
 
 #### Message
 
@@ -187,6 +178,7 @@ Deploy projects to the production environment. Supports multiple project types i
 | `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,6 +192,9 @@ 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
@@ -242,7 +237,7 @@ 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 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 |
 
@@ -324,6 +319,7 @@ coze generate audio "Hello" --speaker zh_female_xiaohe_uranus_bigtts --audio-for
 | `--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
@@ -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,13 +428,33 @@ 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`) |
+| `--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 |
@@ -456,19 +472,22 @@ The CLI reads configuration from multiple sources with the following priority (h
 
 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**
+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) |
+| `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
 
@@ -486,28 +505,6 @@ The CLI reads configuration from multiple sources with the following priority (h
 | `9` | `QUOTA_EXCEEDED` | Quota exceeded |
 | `10` | `CONFLICT` | Resource conflict |
 
-## CI/CD Usage
-
-```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
-
-# Check deployment status
-coze code deploy status <projectId> --format json
-```
-
 ## License
 
 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.

package/bin/main

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 
-const isCompletion = process.argv.includes('--compzsh') ||
+const isCompletion =
+  process.argv.includes('--compzsh') ||
   process.argv.includes('--compbash') ||
+  process.argv.includes('--comppwsh') ||
   process.argv.includes('--completion') ||
   process.argv.includes('completion');