@coze/cli 0.0.4 → 0.1.0-alpha.391559

package/README.md

@@ -1,40 +1,241 @@
-# coze-cli
+# @coze/coding-cli
 
-> command-line tool for coze component development
+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.
 
-**Currently, it only supports the `cn` region.**
+## Installation
 
-# Installation
+```bash
+npm install -g @coze/coding-cli
+```
+
+## Quick Start
 
 ```bash
-npm install -g @coze/cli
+# 1. Login to your Coze account
+coze auth login --oauth
+
+# 2. Select your organization
+coze organization list
+coze organization use <org_id>
+
+# 3. Select your workspace
+coze space list
+coze space use <space_id>
+
+# 4. Start using Coze Coding
+coze code project create --message "Build an intelligent assistant" --type web
 ```
 
+## Authentication
+
+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>
 
-# Usage
+# Check current login status
+coze auth status
 
-## Login
+# Logout
+coze auth logout
+```
 
-The `login` command will open a browser page for you to authorize. After authorization, you can use other commands. 
+You can also authenticate via environment variables for CI/CD pipelines:
 
 ```bash
-coze login
+export COZE_API_TOKEN=<YOUR_PAT>
 ```
 
-The command will save the token and related registry info to `~/.npmrc` automatically. You can check it in the file.
+## Commands
+
+### `coze auth` — Authentication
+
+| Command | Description |
+|---|---|
+| `coze auth login --oauth` | Interactive login via browser |
+| `coze auth login --token <PAT>` | Login with a Personal Access Token |
+| `coze auth status` | Check current login status |
+| `coze auth logout` | Logout and clear stored credentials |
+
+### `coze organization` — Organization Management
+
+| Command | Description |
+|---|---|
+| `coze organization list` | List all accessible organizations |
+| `coze organization use <org_id>` | Set the default organization |
+
+Alias: `coze org`
 
-## Logout
+### `coze space` — Workspace Management
 
-The `logout` command will clear the login status.
+| 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
+
+#### Project
+
+| Command | Description |
+|---|---|
+| `coze code project create` | Create a new project from natural language description |
+| `coze code project list` | List all projects |
+| `coze code project get <id>` | Get project details |
+| `coze code project delete <id>` | Delete a project |
 
 ```bash
-coze logout
+# Create an Agent project
+coze code project create --message "Create a customer service bot" --type agent
+
+# Supported types: agent, workflow, app, skill, web, miniprogram, assistant
 ```
 
-## Install
+#### Message
 
-you can install the component by `npm`, `pnpm` or `yarn` directly.
+| Command | Description |
+|---|---|
+| `coze code message send [message]` | Send a prompt message to a project chat |
+| `coze code message status` | Check message status |
+| `coze code message cancel` | Cancel an ongoing message |
 
 ```bash
-npm install @coze-kit/xxx
+# Send a message to a project
+coze code message send "Fix the login bug" --project-id 123456
+
+# Pipe context via stdin
+cat error.log | coze code message send "Analyze this error" --project-id 123456
 ```
+
+#### Deploy
+
+| 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 |
+
+#### Environment Variables
+
+| Command | Description |
+|---|---|
+| `coze code env list` | List environment variables |
+| `coze code env set <key> <value>` | Set an environment variable |
+| `coze code env delete <key>` | Delete an environment variable |
+
+#### Domain
+
+| Command | Description |
+|---|---|
+| `coze code domain list` | List custom domains |
+| `coze code domain add <domain>` | Add a custom domain |
+| `coze code domain remove <domain>` | Remove a custom domain |
+
+#### Skill
+
+| Command | Description |
+|---|---|
+| `coze code skill list` | List skills |
+| `coze code skill add` | Add a skill |
+| `coze code skill remove` | Remove a skill |
+
+#### Preview
+
+| Command | Description |
+|---|---|
+| `coze code preview` | Preview the project |
+
+### `coze generate` — Media Generation
+
+```bash
+# Generate an image
+coze generate image "A sunset over the mountains"
+
+# Generate audio
+coze generate audio "Hello, welcome to Coze"
+
+# Generate a video
+coze generate video "A cat playing piano"
+
+# Save to a specific directory
+coze generate image "A logo design" --output-path ./assets
+```
+
+### `coze file` — File Operations
+
+```bash
+# Upload a file
+coze file upload ./document.pdf
+```
+
+### `coze config` — Configuration
+
+Configuration is 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 <key>` | Get a configuration value |
+| `coze config set <key> <value>` | Set a configuration value |
+| `coze config delete <key>` | Delete a configuration item |
+
+### `coze completion` — Shell Autocompletion
+
+```bash
+# Set up shell autocompletion
+coze completion --setup
+```
+
+## Global Options
+
+| 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 logging |
+| `--debug` | Enable debug mode |
+| `--log-file <path>` | Write logs to a file |
+
+## 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**
+
+### 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 |
+
+## 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>
+
+# Deploy a project
+coze code deploy <projectId> --wait --format json
+```
+
+## License
+
+MIT

package/bin/main

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+const isCompletion = process.argv.includes('--compzsh') ||
+  process.argv.includes('--compbash') ||
+  process.argv.includes('--completion') ||
+  process.argv.includes('completion');
+
+if (isCompletion) {
+  process.env.DOTENV_CONFIG_QUIET = 'true';
+}
+
+process.env.NODE_ENV = 'production';
+
+const isDebug = process.argv.includes('--debug');
+
+// 如果不是 debug 模式，默认关闭 dotenv 的所有控制台输出
+if (!isDebug) {
+  process.env.DOTENV_CONFIG_QUIET = 'true';
+}
+
+require('../lib/cli.js');