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

package/README.md

@@ -91,6 +91,8 @@ Manage Coze Coding projects. Supports creating, viewing, listing, and deleting p
 | `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)                        |
+| `coze code project import`             | Import a project from GitHub repo or local zip file    |
+| `coze code project db list -p <projectId>` | List the project's database tables                 |
 
 Alias: `coze code proj`
 
@@ -109,13 +111,17 @@ coze code project list --size 20 --has-published
 
 **`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)               |
+| Option                   | Description                                                                                            |
+| ------------------------ | ----------------------------------------------------------------------------------------------------- |
+| `--message <message>`    | **(required)** Project description/requirements in natural language                                   |
+| `--type <type>`          | **(required)** Project type: `agent` \| `workflow` \| `app` \| `skill` \| `web` \| `miniprogram` \| `assistant` |
+| `--wait`                 | Wait for project creation to complete (also waits for the first AI message response)                  |
+| `--chat-mode <chatMode>` | Chat mode: `ask` \| `agent` \| `dangerous_confirm` \| `plan`                                           |
+| `--model-name <name>`    | Model name for the project                                                                            |
+| `--tool-name <toolName>` | Tool name to enable (can be passed multiple times)                                                    |
+| `--design`               | Enable design wizard (auto-enabled when `--chat-mode` is `plan`)                                      |
+| `--org-id <orgId>`       | Organization ID (reads from context if omitted)                                                       |
+| `--space-id <spaceId>`   | Space ID (reads from context if omitted)                                                              |
 
 **`project list`** **options:**
 
@@ -130,7 +136,17 @@ coze code project list --size 20 --has-published
 | `--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                                                                                                         |
+| `--is-fav-filter`        | Filter favorites only                                                                                         |
+
+**`project import`** **options:**
+
+| Option                  | Description                                                          |
+| ----------------------- | ------------------------------------------------------------------- |
+| `-s, --source <source>` | **(required)** Import source: `github` \| `local`                   |
+| `-r, --repo <fullName>` | Remote repo full name, e.g. `user/repo` (required when source is `github`) |
+| `-f, --file <path>`     | Local zip file path, max 500MB (required when source is `local`)    |
+
+> Remote import requires prior OAuth authorization via `coze code git auth login`, and imported projects are automatically bound to the source repo.
 
 #### Message
 
@@ -141,19 +157,23 @@ Send and manage chat messages in Coze Coding projects. The project ID is specifi
 | `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                          |
+| `coze code message history`        | View the conversation history of a project chat    |
 
 ```bash
 # Send a message to a project
 coze code message send "Fix the login bug" -p 123456
 
+# Wait for the chat response before returning
+coze code message send "Fix the login bug" -p 123456 --wait
+
 # Mention local files with @ syntax for upload as context
 coze code message send "Refactor @src/utils.ts to use async/await" -p 123456
 
 # Mention multiple files
 coze code message send "Compare @src/old.ts and @src/new.ts" -p 123456
 
-# Pipe context via stdin
-cat error.log | coze code message send "Analyze this error" -p 123456
+# Pipe additional context via stdin (the --stdin flag is required)
+cat error.log | coze code message send "Analyze this error" --stdin -p 123456
 
 # Check message status (auto-fetches result when completed)
 coze code message status -p 123456
@@ -161,6 +181,9 @@ coze code message status -p 123456
 # Cancel an ongoing message
 coze code message cancel -p 123456
 
+# View conversation history (paginate with --before / --after)
+coze code message history -p 123456
+
 # Use environment variable for project ID
 export COZE_PROJECT_ID=123456
 coze code message send "Hello"
@@ -172,16 +195,31 @@ coze code message send "Hello"
 | ----------------------- | ------------------------------------------ |
 | `-p, --project-id <id>` | Coze project ID (or env `COZE_PROJECT_ID`) |
 
+**`message send`** **options:**
+
+| Option     | Description                                                        |
+| ---------- | ----------------------------------------------------------------- |
+| `--wait`   | Wait for the chat response before returning (otherwise sent in background) |
+| `--stdin`  | Read additional context from stdin (pipe input)                   |
+
+**`message history`** **options:**
+
+| Option              | Description                                       |
+| ------------------- | ------------------------------------------------- |
+| `--after <msg_id>`  | Cursor for fetching newer messages                |
+| `--before <msg_id>` | Cursor for fetching older messages                |
+
 #### 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                   |
-| `coze code deploy status <projectId> --wait` | Check and wait for deployment to complete |
+| 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 list <projectId>`          | List deployment history for a project                  |
+| `coze code deploy fix <projectId>`           | Fix a failed deployment by sending deploy logs to AI   |
 
 ```bash
 # Deploy a project
@@ -190,16 +228,54 @@ coze code deploy <projectId>
 # Deploy and wait for completion
 coze code deploy <projectId> --wait
 
+# Deploy a specific commit and sync database tables to production
+coze code deploy <projectId> --commit-id <commitId> --table-name users --table-name orders
+
 # Check latest deployment status
 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
+# List deployment history
+coze code deploy list <projectId> --page-size 10
+
+# Fix the latest failed deployment with AI
+coze code deploy fix <projectId> --wait
 ```
 
+**`deploy <projectId>`** **options:**
+
+| Option                          | Description                                                                                       |
+| ------------------------------- | ------------------------------------------------------------------------------------------------ |
+| `--commit-id <commitId>`        | Commit ID (queries the latest commit if omitted)                                                 |
+| `--wait`                        | Wait for the deployment to complete (polling interval: 3 seconds)                                |
+| `--table-name <tableName...>`   | Database table name(s) to sync to production (variadic / repeatable)                             |
+| `--encrypt-deploy <string>`     | Pre-encrypted environment variable string (for Skill projects)                                   |
+| `--connector-id <connectorId>`  | Connector ID for mini-program deployment channels, repeatable (e.g. `10000127` WeChat, `10000126` TikTok) |
+
+**`deploy status <projectId>`** **options:**
+
+| Option                  | Description                                              |
+| ----------------------- | ------------------------------------------------------- |
+| `--deploy-id <deployId>` | Deployment history ID (queries the latest if omitted)  |
+
+> `deploy status` reuses the parent `deploy --wait` flag to poll until the deployment reaches a terminal state.
+
+**`deploy list <projectId>`** **options:**
+
+| Option                      | Description                            |
+| --------------------------- | -------------------------------------- |
+| `--page-size <pageSize>`    | Number of records per page (default: 10) |
+| `--page-token <pageToken>`  | Page token for pagination              |
+
+**`deploy fix <projectId>`** **options:**
+
+| Option                   | Description                                                  |
+| ------------------------ | ----------------------------------------------------------- |
+| `--deploy-id <deployId>` | Deployment history ID (queries the latest failed if omitted) |
+| `--wait`                 | Wait for the fix message response                           |
+
 #### Environment Variables
 
 Manage project environment variables (Secrets). Supports development and production environments.
@@ -220,29 +296,47 @@ coze code env list -p <projectId> --env prod
 # Set an environment variable
 coze code env set API_KEY sk-xxxxx -p <projectId>
 
-# Delete an environment variable
+# Delete an environment variable (operates on the dev environment)
 coze code env delete API_KEY -p <projectId>
 ```
 
+> `env list` filters by `--env dev|prod` (default `dev`). `env delete` always targets the dev environment. `env set` is not yet supported for Skill projects.
+
 #### Domain
 
 Manage custom domains for deployed projects.
 
 | Command                                           | Description                                  |
 | ------------------------------------------------- | -------------------------------------------- |
-| `coze code domain list <projectId>`               | List all custom domains bound to the project |
+| `coze code domain list -p <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                       |
 
+> `domain add` validates the format and accepts a single-level domain such as `example.com`.
+
 #### Skill
 
 Manage skills associated with a project to extend its capabilities.
 
-| 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          |
+| Command                                            | Description                                                       |
+| -------------------------------------------------- | ---------------------------------------------------------------- |
+| `coze code skill list -p <projectId>`              | List available skills (shows installed status)                   |
+| `coze code skill add <skillId> -p <projectId>`     | Add (mount) a skill to the project's default conversation        |
+| `coze code skill remove <skillId> -p <projectId>`  | Remove (unmount) a skill from the default conversation           |
+| `coze code skill upload <filePath> -p <projectId>` | Upload a local `.skill` file as a personal skill                 |
+| `coze code skill delete <skillId> -p <projectId>`  | Permanently delete a personal skill (different from `remove`)     |
+
+> `add`/`remove` only mount or unmount a skill on the project's default conversation. `delete` permanently removes the personal skill itself. On naming conflict, `upload` auto-confirms an overwrite.
+
+**`skill list`** **options:**
+
+| Option                 | Description                                        |
+| ---------------------- | -------------------------------------------------- |
+| `-p, --project-id <id>` | **(required)** Project ID                         |
+| `--space-id <spaceId>` | Space ID (reads from config if omitted)            |
+| `--my`                 | List personal skills only                          |
+| `--page <page>`        | Page number (for personal skills, default: 1)      |
+| `--size <size>`        | Page size (for personal skills, default: 20)       |
 
 #### Preview
 
@@ -257,6 +351,231 @@ Get the sandbox preview URL for a project.
 coze code preview <projectId>
 ```
 
+> Preview is available for Web/App project types. Agent, Automation, Skill, Mini-program, and Assistant projects are not previewable from the CLI — use the Web dashboard instead.
+
+#### Git
+
+Manage Git platform integrations including OAuth authorization and repository search. Use `--provider` to specify the Git service provider (default: github).
+
+| Command                          | Description                                          |
+| -------------------------------- | ---------------------------------------------------- |
+| `coze code git auth login`       | Authorize a Git platform via OAuth (opens browser)   |
+| `coze code git auth status`      | Check the current OAuth authorization status         |
+| `coze code git auth logout`      | Revoke OAuth authorization for a Git platform        |
+| `coze code git search`           | Search repositories on the authorized Git platform   |
+
+```bash
+# Authorize GitHub (default provider)
+coze code git auth login
+
+# Check authorization status
+coze code git auth status
+
+# Search repos by keyword
+coze code git search --keyword react
+
+# Paginated search
+coze code git search -k react --page 2 --page-size 10
+
+# Revoke authorization
+coze code git auth logout
+```
+
+**`git`** **options (shared by subcommands):**
+
+| Option                  | Description                                           |
+| ----------------------- | ----------------------------------------------------- |
+| `--provider <provider>` | Git service provider: `github` / `gitlab` (default: `github`) |
+
+#### Repo
+
+Manage remote repository bindings and sync operations for Coze Coding projects.
+
+| Command                                             | Description                                             |
+| --------------------------------------------------- | ------------------------------------------------------- |
+| `coze code repo create --name <name>`               | Create a new repository on the remote Git platform      |
+| `coze code repo bind -p <projectId> -r <fullName>`  | Bind a remote repository to a project                   |
+| `coze code repo unbind -p <projectId>`              | Unbind the remote repository from a project             |
+| `coze code repo push -p <projectId>`                | Push local commits to the bound remote repository       |
+| `coze code repo pull -p <projectId>`                | Pull remote changes from the bound repository           |
+| `coze code repo status -p <projectId>`              | Show remote repository binding and sync status          |
+
+```bash
+# Create a private repository
+coze code repo create --name my-app --private
+
+# Bind a repo to a project
+coze code repo bind -p <projectId> -r user/my-repo
+
+# Check binding and sync status
+coze code repo status -p <projectId>
+
+# Push local changes to remote
+coze code repo push -p <projectId>
+
+# Pull remote changes (auto-resolve conflicts keeping local)
+coze code repo pull -p <projectId> --conflict-strategy ours
+
+# Unbind repository
+coze code repo unbind -p <projectId> --force
+```
+
+**`repo create`** **options:**
+
+| Option              | Description                             |
+| ------------------- | --------------------------------------- |
+| `-n, --name <name>` | **(required)** Repository name          |
+| `--private`          | Create as private repository            |
+
+**`repo bind`** **options:**
+
+| Option                           | Description                                 |
+| -------------------------------- | ------------------------------------------- |
+| `-p, --project-id <projectId>`   | **(required)** Project ID                   |
+| `-r, --repo <fullName>`          | **(required)** Remote repo (e.g. user/repo) |
+
+**`repo pull`** **options:**
+
+| Option                                | Description                                             |
+| ------------------------------------- | ------------------------------------------------------- |
+| `-p, --project-id <projectId>`        | **(required)** Project ID                               |
+| `--conflict-strategy <strategy>`      | Auto conflict resolution: `ours` / `theirs`             |
+
+**`repo unbind`** **options:**
+
+| Option                         | Description               |
+| ------------------------------ | ------------------------- |
+| `-p, --project-id <projectId>` | **(required)** Project ID |
+| `--force`                      | Skip confirmation prompt  |
+
+> `repo push` and `repo pull` are placeholder implementations pending backend wiring — they currently report success without performing a real sync.
+
+#### Database
+
+Manage Supabase-backed databases in the current Coze space. Supports the full database lifecycle, SQL execution, TypeScript type generation, schema/data export, and point-in-time rollback. All `db` subcommands accept `--space-id <spaceId>` (reads from context if omitted).
+
+| Command                                             | Description                                            |
+| --------------------------------------------------- | ----------------------------------------------------- |
+| `coze code db create`                               | Create a new database (name and credentials auto-generated) |
+| `coze code db list`                                 | List databases in the current space                   |
+| `coze code db get --db-id <id>`                     | Get database details (connection URLs and credentials) |
+| `coze code db query --db-id <id> --sql "<sql>"`     | Execute SQL on a database                             |
+| `coze code db gen-types --db-id <id>`               | Generate TypeScript types from the database schema    |
+| `coze code db dump --db-id <id>`                    | Export database schema (DDL) or data as SQL           |
+| `coze code db rollback --db-id <id> --timestamp <ts> --confirm` | Roll back a database to a point in time (PITR) |
+| `coze code db status --db-id <id>`                  | Get database status and restore/rollback info         |
+| `coze code db delete --db-id <id> --confirm`        | Delete a database (irreversible)                      |
+
+```bash
+# Create a database
+coze code db create
+
+# List databases (text mode auto-paginates; use --all in JSON mode)
+coze code db list --all
+
+# Execute SQL (read from --sql, --file, or stdin)
+coze code db query --db-id <id> --sql "SELECT * FROM users LIMIT 10"
+
+# Dangerous SQL (DROP/TRUNCATE/ALTER TABLE/DELETE or UPDATE without WHERE) requires --confirm
+coze code db query --db-id <id> --sql "DROP TABLE old_data" --confirm
+
+# Generate TS types (default output: types/database.ts)
+coze code db gen-types --db-id <id> --include-schema public --include-schema auth
+
+# Export schema only (default) or data only
+coze code db dump --db-id <id> --output db/schema.sql
+coze code db dump --db-id <id> --data-only
+
+# Roll back to a timestamp (milliseconds), --confirm required
+coze code db rollback --db-id <id> --timestamp 1713254400000 --confirm
+```
+
+**`db query`** **options:**
+
+| Option             | Description                                                       |
+| ------------------ | ---------------------------------------------------------------- |
+| `--db-id <dbId>`   | **(required)** Database ID                                       |
+| `--sql <sql>`      | Inline SQL to execute                                            |
+| `--file <path>`    | Read SQL from a file                                             |
+| `--confirm`        | Confirm execution of dangerous SQL (required in JSON mode)       |
+
+> SQL is read from `--sql`, then `--file`, then stdin. Dangerous operations (`DROP`, `TRUNCATE`, `ALTER TABLE`, `DELETE`/`UPDATE` without `WHERE`) require `--confirm`; in JSON mode they error out without it, while text mode prompts interactively.
+
+**`db list`** **options:**
+
+| Option                   | Description                                          |
+| ------------------------ | --------------------------------------------------- |
+| `--limit <limit>`        | Number of databases per page, 1–100 (default: 20)   |
+| `--cursor <cursorId>`    | Cursor for pagination                               |
+| `--all`                  | Fetch all databases across pages                    |
+| `--max-pages <maxPages>` | Max pages to fetch in text mode (default: 10)       |
+
+**`db gen-types`** **options:**
+
+| Option                   | Description                                                |
+| ------------------------ | --------------------------------------------------------- |
+| `--db-id <dbId>`         | **(required)** Database ID                                |
+| `--output <path>`        | Output file path (default: `types/database.ts`)           |
+| `--include-schema <name>` | Schema name, repeatable (default: `public`)              |
+
+**`db dump`** **options:**
+
+| Option                   | Description                                               |
+| ------------------------ | -------------------------------------------------------- |
+| `--db-id <dbId>`         | **(required)** Database ID                               |
+| `--output <path>`        | Output file path (default: `db/schema.sql`)              |
+| `--schema-only`          | Export schema only (the default when neither flag is set) |
+| `--data-only`            | Export data only                                         |
+| `--include-schema <name>` | Schema name, repeatable (default: `public`)             |
+
+**`db rollback`** / **`db delete`** **options:**
+
+| Option                  | Description                                       |
+| ----------------------- | ------------------------------------------------ |
+| `--db-id <dbId>`        | **(required)** Database ID                       |
+| `--timestamp <ts>`      | **(required, rollback only)** Target timestamp in milliseconds |
+| `--confirm`             | **(required)** Confirm the destructive operation |
+
+#### Model
+
+Manage the model used by a Coze Coding project's default conversation.
+
+| Command                                             | Description                                     |
+| --------------------------------------------------- | ----------------------------------------------- |
+| `coze code model list -p <projectId>`               | List available models (marks the active one)    |
+| `coze code model list --type <type>`                | List available models for a project type        |
+| `coze code model set <modelName> -p <projectId>`    | Set the model for the default conversation      |
+
+```bash
+# List available models for a project
+coze code model list -p <projectId>
+
+# List models by project type (when no project ID is available)
+coze code model list --type web
+
+# Set the conversation model
+coze code model set doubao-dev-0213 -p <projectId>
+```
+
+#### Tools
+
+Manage the tools enabled on a project's default conversation (e.g. web search, image generation).
+
+| Command                                                | Description                                    |
+| ------------------------------------------------------ | ---------------------------------------------- |
+| `coze code tools list -p <projectId>`                  | List available tools (shows enabled status)    |
+| `coze code tools enable <toolName> -p <projectId>`     | Enable a tool on the default conversation      |
+| `coze code tools disable <toolName> -p <projectId>`    | Disable a tool on the default conversation     |
+
+```bash
+# List available tools
+coze code tools list -p <projectId>
+
+# Enable / disable a tool
+coze code tools enable enable_image_gen -p <projectId>
+coze code tools disable enable_image_gen -p <projectId>
+```
+
 ### `coze generate` — Media Generation
 
 Generate images, audio, and video using Coze AI models. All `generate` subcommands support `--output-path <path>` to save generated media to disk.