WeChat Cloud Run

https://github.com/weixincloud/wxcloud
Admin
WeChat Cloud Run is a serverless cloud hosting platform that enables deployment of WeChat Mini...
Tokens:18,342
Snippets:190
Trust Score:8.5
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### List Cloud Hosting Versions

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/version.md

Use this command to view a list of available cloud hosting versions. No specific setup is required beyond having the wxcloud CLI installed.

```bash
wxcloud version:list
```

--------------------------------

### Install @wxcloud/cli

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/cli/README.md

Install the CLI tool globally using npm.

```bash
npm install -g @wxcloud/cli
```

--------------------------------

### List Cloud Hosting Services

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Use this command to view a list of your deployed cloud hosting services. No specific setup is required beyond having the wxcloud CLI installed.

```bash
wxcloud service:list
```

--------------------------------

### Deploy with Library Image and Specific Ports

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Deploy a service version using a specified library image, container port, and release type. This example also includes remark, noConfirm, and detach options for customized deployment.

```bash
wxcloud run:deploy --envId wxrun-id --serviceName demo --libraryImage demo-001-20220425111535 --containerPort 80 --releaseType FULL --remark 测试备注 --noConfirm --detach
```

--------------------------------

### Interactive Service Deployment

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/deploy.md

Run this command to start an interactive deployment process where the CLI prompts for necessary information like service and environment.

```bash
wxcloud deploy
```

--------------------------------

### Node.js Dockerfile Instruction Example

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/terminology/dockerpacks.md

When Node.js is detected via package.json, Dockerpacks inserts a RUN npm install command into the Dockerfile.

```dockerfile
RUN npm install
```

--------------------------------

### Java Dockerfile Instruction Example

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/terminology/dockerpacks.md

For Java projects, if settings.xml is detected, Dockerpacks adds a RUN mvn package command to the Dockerfile.

```dockerfile
RUN mvn package
```

--------------------------------

### Default wxcloud.config.js Configuration

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/features/config.md

This is a default configuration example for a universal project type. It specifies the server build directory and client-side custom domain.

```json
{
    "type": "universal",
    "server": ".",
    "client": {
        "customDomain": "cdn.example.com"
    }
}
```

--------------------------------

### GET env:list

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/env.md

Lists all environments associated with the current application. Requires authentication before execution.

```APIDOC
## GET env:list

### Description
Lists the environment information for the current App. Authentication is required.

### Method
GET

### Endpoint
env:list

### Parameters
#### Query Parameters
- **--json** (boolean) - Optional - Whether to display the result in JSON format.
- **--region** (string) - Optional - The region to query (ap-shanghai, ap-guangzhou, or ap-beijing). Defaults to ap-shanghai.

### Request Example
wxcloud env:list --json
```

--------------------------------

### Upload Cloud Functions with wxcloud CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Uploads cloud function code to the cloud development environment, supporting cloud-side dependency installation. Use '--remoteNpmInstall' to install dependencies on the server.

```bash
# 上传云函数
wxcloud function:upload ./functions/hello \
  --envId prod-xxxxxx \
  --name hello \
  --remoteNpmInstall

# 本地安装依赖后上传
wxcloud function:upload ./functions/api \
  --envId prod-xxxxxx \
  --name api \
  --no-remoteNpmInstall
```

--------------------------------

### Get Current Count API Call Example

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/dockerpacks/test/java/fixtures/wxcloudrun-sprintboot/README.md

Use this curl command to call the API endpoint that retrieves the current count. Replace `<云托管服务域名>` with your actual service domain.

```bash
curl https://<云托管服务域名>/api/count
```

--------------------------------

### Adding Runtime Dependencies in Dockerfile

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/terminology/dockerpacks.md

Install additional runtime dependencies or language-specific packages by modifying the RUN instructions in the Dockerfile.

```dockerfile
RUN apt-get update && apt-get install -y --no-install-recommends some-package
```

--------------------------------

### Update Count API Call Example (Increment)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/dockerpacks/test/java/fixtures/wxcloudrun-sprintboot/README.md

This curl command demonstrates how to call the API to increment the counter. Remember to replace `<云托管服务域名>` with your service's domain.

```bash
curl -X POST -H 'content-type: application/json' -d '{"action": "inc"}' https://<云托管服务域名>/api/count
```

--------------------------------

### Update Count API Request Example (Increment)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/dockerpacks/test/java/fixtures/wxcloudrun-sprintboot/README.md

Send a POST request with this JSON body to increment the counter. Ensure the `content-type` header is set to `application/json`.

```json
{
  "action": "inc"
}
```

--------------------------------

### Initialize New Projects

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Bootstrap a new project using official templates for various programming languages.

```bash
# 交互式初始化
wxcloud init ./my-new-project

# 使用指定模板
wxcloud init ./my-new-project --template wxcloudrun-express
```

--------------------------------

### Get Current Count API Response Example

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/dockerpacks/test/java/fixtures/wxcloudrun-sprintboot/README.md

This JSON structure represents the successful response when retrieving the current count from the API.

```json
{
  "code": 0,
  "data": 42
}
```

--------------------------------

### 迁移项目到云托管

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/basics.md

自动识别框架并生成 Dockerfile 和 wxcloud.config.js 配置文件。

```bash
wxcloud migrate
```

--------------------------------

### Create Cloud Services

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Initialize a new service within a specified environment, with options to enable public access.

```bash
# 交互式创建服务
wxcloud service:create

# 指定参数创建
wxcloud service:create --envId prod-xxxxxx --serviceName my-api --isPublic
```

--------------------------------

### Display help information

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/help.md

Executes the help command to view CLI version and system information.

```bash
wxcloud help
```

--------------------------------

### GET /api/count

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/dockerpacks/test/java/fixtures/wxcloudrun-sprintboot/README.md

Retrieves the current value of the counter.

```APIDOC
## GET /api/count

### Description
Retrieves the current counter value.

### Method
GET

### Endpoint
/api/count

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **code** (integer) - Error code (0 indicates success).
- **data** (integer) - The current counter value.

#### Response Example
```json
{
  "code": 0,
  "data": 42
}
```

#### Error Response
(Details not provided in source text)

#### Call Example
```bash
curl https://<云托管服务域名>/api/count
```
```

--------------------------------

### Environment and Resource Listing

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/cli/README.md

Commands to list environments, services, and versions.

```bash
wxcloud env:list
```

```bash
wxcloud service:list --envId=<环境ID>
```

```bash
wxcloud version:list --envId=<环境ID> -serviceName=<服务名>
```

--------------------------------

### wxcloud CLI Deploy Options

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/deploy.md

Lists the available command-line options for the `wxcloud deploy` command, including environment ID, port, service name, and a dry-run flag.

```text
OPTIONS
  -e, --envId=envId              环境ID
  -p, --port=port                [default: 3000] 端口号
  -s, --serviceName=serviceName  服务名
  --dryRun                       不执行实际部署指令
```

--------------------------------

### CLI Command: version:list

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/version.md

Lists the available versions for a specific cloud hosting service.

```APIDOC
## CLI Command: version:list

### Description
Lists all versions associated with a cloud hosting service.

### Method
CLI Command

### Endpoint
wxcloud version:list

### Parameters
#### Options
- **-e, --envId** (string) - Optional - The environment ID.
- **-h, --help** (boolean) - Optional - Show CLI help.
- **-p, --page** (number) - Optional - The page number for pagination.
- **-s, --serviceName** (string) - Optional - The name of the service.
- **--json** (boolean) - Optional - Whether to display the result in JSON format.

### Request Example
wxcloud version:list --envId=my-env --serviceName=my-service --json
```

--------------------------------

### 执行项目迁移与容器化

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/features/detection.md

运行迁移命令以自动分析项目并生成 Dockerfile。该命令会根据 package.json 等文件自动选择合适的构建器和镜像。

```bash
$ wxcloud migrate

Wxcloud CLI 2.0.1-beta.15
✔ 分析项目文件
✔ 构建容器化文件
✔ 写入相关文件

› 信息 即将使用 Node npm 构造器（含 build 阶段）
› 信息 没有在 package.json 中找到 Node 版本约束，将使用推荐版本的 Node 镜像
› 信息 将使用镜像 lts-alpine (16.15.0-alpine)
› 警告 收集到 0 条环境变量
› 信息 写入 /path/to/project/.dockerignore
› 信息 写入 /path/to/project/Dockerfile



✔ 项目容器化成功，执行 `wxcloud deploy` 立即部署
```

--------------------------------

### Deploy Using Previous Configuration with Override

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Deploy a service version, inheriting the project directory and port configurations from the last deployment by using the --override flag.

```bash
wxcloud run:deploy --envId=wxrun-id --serviceName=demo --override
```

--------------------------------

### Cloud Hosting Service Command-Line Arguments

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Reference for common command-line arguments used with wxcloud service commands, including environment ID, service name, and output formatting options.

```bash
OPTIONS
  -e, --envId=envId              环境ID
  -h, --help                     查看帮助
  -p, --page=page
  -s, --serviceName=serviceName  服务名称
  --json                         是否以json格式展示结果
```

```bash
OPTIONS
  -e, --envId=envId              环境ID
  -h, --help                     查看帮助
  -s, --serviceName=serviceName  服务名称
  --isPublic                     是否开通外网访问
  --json                         是否以json格式展示结果
```

```bash
ARGUMENTS
  ACTION  [default: read] 操作模式，默认为 read，更新配置 update

OPTIONS
  -c, --cpu=cpu                                 CPU
  -e, --envId=envId                             环境ID
  -h, --help                                    查看帮助
  -l, --customLogs=customLogs                   自定义日志采集路径
  -m, --mem=mem                                 内存
  -n, --minNum=minNum                           最小实例数
  -p, --envParams=envParams                     环境变量，格式aa=bb&cc=dd
  -s, --serviceName=serviceName                 服务名称
  -x, --maxNum=maxNum                           最大实例数
  --cpuThreshold=cpuThreshold                   CPU 使用率调度策略阈值
  --memThreshold=memThreshold                   内存使用率调度策略阈值
  --noConfirm                                   更新配置时跳过二次确认
  --region=ap-shanghai|ap-guangzhou|ap-beijing  [default: ap-shanghai] 地域
```

```bash
OPTIONS
  -e, --envId=envId                             环境ID
  -h, --help                                    查看帮助
  -s, --serviceName=serviceName                 服务名称
  --noConfirm                                   跳过删除确认
  --region=ap-shanghai|ap-guangzhou|ap-beijing  [default: ap-shanghai] 地域
```

--------------------------------

### Run migration command

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/migrate.md

Execute the migration process for a specified project directory.

```bash
wxcloud migrate <项目目录>
```

--------------------------------

### wxcloud version:list Command Options

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/version.md

Understand the available command-line arguments for the `wxcloud version:list` command to filter and format the output. Options include specifying environment ID, page, service name, and JSON output format.

```bash
OPTIONS
  -e, --envId=envId
  -h, --help                     show CLI help
  -p, --page=page
  -s, --serviceName=serviceName
  --json                         是否以json格式展示结果

```

--------------------------------

### 登录微信云托管 CLI (交互式)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

运行此命令以进行交互式登录。大多数 CLI 命令需要先登录才能使用。

```bash
wxcloud login
```

--------------------------------

### Create a New Cloud Hosting Service

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Initiate the creation of a new cloud hosting service. You can specify environment and service names, and whether to enable public access.

```bash
wxcloud service:create
```

--------------------------------

### CLI Login Options

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/login.md

These are the available command-line options for the `wxcloud login` command. The `appId` is required, and `privateKey` can be used for authentication.

```text
OPTIONS
  -a, --appId=appId            微信 AppID
  -h, --help                   show CLI help
  -k, --privateKey=privateKey  微信云服务私钥
```

--------------------------------

### Migrate Project with wxcloud CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Automatically analyzes an existing project and generates Dockerfile and configuration files. Supports various languages like Node.js, Java, Python, Go, and PHP.

```bash
wxcloud migrate

# 迁移指定目录
wxcloud migrate ./existing-project
```

--------------------------------

### View wxcloud env:list command options

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/env.md

Lists the available flags and parameters for the env:list command.

```text
OPTIONS
  -h, --help                                    查看帮助
  --json                                        是否以json格式展示结果
  --region=ap-shanghai|ap-guangzhou|ap-beijing  [default: ap-shanghai] 地域
```

--------------------------------

### Deploy with Dockerfile and Target Directory

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Deploy a service using a Dockerfile from the current directory and specify the target directory for the deployment. The container port and environment are also configured.

```bash
wxcloud run:deploy --targetDir=. --dockerfile=Dockerfile --containerPort=80 --envId=wxrun-id --serviceName=demo
```

--------------------------------

### List environments with wxcloud

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/env.md

Displays the list of environments associated with the current application.

```bash
wxcloud env:list
```

--------------------------------

### Deploy with Override and No Confirmation

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Deploy a service version using previous configurations and skip the confirmation step for immediate deployment.

```bash
wxcloud run:deploy --noConfirm --envId=wxrun-id --serviceName=demo --override
```

--------------------------------

### 登录微信云托管 CLI (指定参数)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

通过指定微信 AppId 和私钥进行登录。请妥善保管您的私钥。

```bash
wxcloud login --appId <微信 AppId> --privateKey <秘钥>
```

--------------------------------

### Configure Service Settings

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Read or update service resource allocations, environment variables, and scaling policies.

```bash
# 查看服务配置
wxcloud service:config read --envId prod-xxxxxx --serviceName my-api

# 更新服务配置
wxcloud service:config update --envId prod-xxxxxx --serviceName my-api \
  --cpu 0.5 \
  --mem 1 \
  --minNum 1 \
  --maxNum 10 \
  --cpuThreshold 60 \
  --memThreshold 80 \
  --envParams "DATABASE_URL=mysql://localhost:3306/mydb&API_KEY=secret" \
  --customLogs "/app/logs/*.log" \
  --noConfirm
```

--------------------------------

### Deploying with CloudKit

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Uses execAllKits to handle deployment for frameworks like Next.js or Nuxt.js. Requires a CloudConfig object and lifecycle hooks for monitoring deployment stages.

```typescript
import { execAllKits, Kits } from '@wxcloud/cloudkit';
import { CloudConfig } from '@wxcloud/core';

// 云托管配置
const config: CloudConfig = {
  type: 'universal',  // 'run' | 'static' | 'universal' | 'custom'
  server: {
    port: 3000,
    buildDir: '.',
    versionRemark: 'v1.0.0'
  },
  client: {
    customDomain: 'static.example.com'
  }
};

// 执行所有适用的 Kit
async function deployWithCloudKit() {
  const result = await execAllKits({
    fullPath: process.cwd(),
    config,
    port: 3000,
    staticDomain: 'https://static.example.com',
    fileToIgnore: ['node_modules', '.git'],
    lifecycleHooks: {
      enterStage(stage) {
        console.log(`开始: ${stage}`);
      },
      leaveStage(stage) {
        console.log(`完成: ${stage}`);
      }
    }
  });

  console.log('部署结果:', result);
  // {
  //   runTarget: '/path/to/package.zip',  // 云托管产物
  //   staticTarget: {                      // 静态资源映射
  //     'public': '',
  //     '.next/static': '_next/static/'
  //   }
  // }
}

// 可用的 Kit 类型:
// - RunKit: 通用云托管部署
// - StaticKit: 静态资源部署
// - NextKit: Next.js 混合部署
// - Nuxt2Kit: Nuxt 2.x 混合部署
// - Nuxt3Kit: Nuxt 3.x 混合部署
```

--------------------------------

### 登出微信云托管 CLI

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

完成使用后，推荐手动运行此命令登出您的账号。

```bash
wxcloud logout
```

--------------------------------

### Deploy Service with Specific Environment and Name

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/deploy.md

Use this command to manually specify the environment ID and service name for deployment, bypassing interactive prompts.

```bash
wxcloud deploy -e <环境 ID> -s <服务名称>
```

--------------------------------

### List Files in Cloud Storage with wxcloud CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Queries the file list in cloud storage, supporting prefix filtering and pagination. Can output in JSON format and specify maximum keys.

```bash
# 列出所有文件
wxcloud storage:list --envId prod-xxxxxx

# 按前缀查询
wxcloud storage:list images/ --envId prod-xxxxxx --mode storage

# 详细信息（JSON 格式）
wxcloud storage:list assets/ --envId prod-xxxxxx --json --max-keys 100

# 使用分隔符列出目录
wxcloud storage:list --envId prod-xxxxxx --delimiter /
```

--------------------------------

### List Service Versions

Source: https://context7.com/weixincloud/wxcloud/llms.txt

View all versions associated with a specific service.

```bash
# 查看版本列表
wxcloud version:list --envId prod-xxxxxx --serviceName my-api

# JSON 格式输出
wxcloud version:list --envId prod-xxxxxx --serviceName my-api --json
```

--------------------------------

### 创建 Next.js 应用

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/basics.md

使用 npx 初始化一个新的 Next.js 项目。

```bash
npx create-next-app next-app-demo --use-npm
```

--------------------------------

### Deploy Project with wxcloud CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Intelligent deployment command that automatically detects project type and executes the appropriate deployment process. Supports cloud hosting, static hosting, and hybrid deployments.

```bash
# 一键部署
wxcloud deploy

# 指定参数部署
wxcloud deploy \
  --envId prod-xxxxxx \
  --serviceName my-api \
  --port 3000

# 演练模式（不实际部署）
wxcloud deploy --dryRun
```

--------------------------------

### Deployment Commands

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/cli/README.md

Commands and options for deploying services to WeChat Cloud Hosting.

```bash
wxcloud run:deploy [目标目录]
```

```bash
OPTIONS
  -e, --envId=envId              环境ID
  -h, --help                     查看帮助信息
  -s, --serviceName=serviceName  服务名
  --containerPort=containerPort  监听端口
  --dockerfile=dockerfile        Dockerfile文件名
  --noConfirm                    发布前是否跳过二次确认
  --override                     缺省的参数是否沿用旧版本配置
  --targetDir=targetDir          目标目录
```

--------------------------------

### Deploy Cloud Hosting Service

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Use this command to deploy or update your cloud hosting services. Specify the environment, service name, and deployment details.

```bash
wxcloud run:deploy [PATH]
```

--------------------------------

### 进入项目目录并启动开发服务器

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/basics.md

进入项目文件夹并启动本地开发环境。

```bash
cd next-app-demo
```

```bash
npm run dev
```

--------------------------------

### CloudKit Deployment API

Source: https://context7.com/weixincloud/wxcloud/llms.txt

The execAllKits function automates the deployment process for various frameworks by handling static assets and server-side rendering configurations.

```APIDOC
## CloudKit Deployment

### Description
Executes deployment kits for specific frameworks (Next.js, Nuxt.js, etc.) to handle hybrid deployments.

### Request Body
- **fullPath** (string) - Required - The root directory of the project.
- **config** (CloudConfig) - Required - Deployment configuration object.
- **port** (number) - Required - Server port.
- **staticDomain** (string) - Optional - Domain for static assets.
- **fileToIgnore** (string[]) - Optional - List of files/folders to ignore during deployment.
- **lifecycleHooks** (object) - Optional - Hooks for stage transitions (enterStage, leaveStage).

### Response
- **runTarget** (string) - Path to the cloud deployment artifact.
- **staticTarget** (object) - Mapping of local directories to static asset paths.
```

--------------------------------

### List Cloud Environments

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Retrieve a list of available cloud environments with options for region filtering and JSON output.

```bash
# 查看环境列表
wxcloud env:list

# 指定区域查看
wxcloud env:list --region ap-shanghai

# JSON 格式输出
wxcloud env:list --json
```

--------------------------------

### List and Manage Services

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Retrieve details for services in an environment, including status and domain information.

```bash
# 查看服务列表
wxcloud service:list --envId prod-xxxxxx

# 分页查看
wxcloud service:list --envId prod-xxxxxx --page 0

# JSON 格式输出
wxcloud service:list --envId prod-xxxxxx --json
```

--------------------------------

### Configuring wxcloud.config.js

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Defines deployment behavior for the project. Supports run, static, universal, and custom deployment types.

```javascript
// wxcloud.config.js
/** @type {import("@wxcloud/core").CloudConfig} */
const cloudConfig = {
  // 部署类型: 'run'(云托管) | 'static'(静态托管) | 'universal'(混合部署) | 'custom'(自定义)
  type: 'universal',

  // 服务端配置
  server: {
    port: 3000,           // 监听端口
    buildDir: '.',        // 构建目录
    versionRemark: ''     // 版本备注
  },

  // 客户端配置（静态资源）
  client: {
    customDomain: 'static.example.com'  // 自定义域名
  },

  // 自定义部署目标（type 为 'custom' 时使用）
  custom: {
    runTarget: './dist/server.zip',
    staticTarget: {
      './dist/client': 'assets/'
    }
  }
};

module.exports = cloudConfig;
```

--------------------------------

### 安装微信云托管 CLI 工具 (yarn)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

使用 yarn 安装最新版微信云托管 CLI 工具。请确保您的 Node.js 版本不低于 v16。

```bash
yarn global add @wxcloud/cli
```

--------------------------------

### List files with storage:list

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/storage.md

Queries the file list in cloud storage. Supports pagination and JSON output formatting.

```bash
wxcloud storage:list [路径前缀]
```

```bash
OPTIONS
  -c, --concurrency=concurrency       并发上传数量
  -e, --envId=envId                   环境ID
  -h, --help                          查看帮助信息
  -m, --mode=(staticstorage|storage)  上传模式
  -d, --delimiter                     分隔符
  --max-keys                          最大查询数量
  --marker                            起始对象建标记
  -j, --json                          是否以 JSON 输出
```

--------------------------------

### 安装微信云托管 CLI 工具 (npm)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

使用 npm 安装最新版微信云托管 CLI 工具。请确保您的 Node.js 版本不低于 v16。

```bash
npm i -g @wxcloud/cli
```

--------------------------------

### Basic Login Command

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/login.md

Use this command to log in to the WeChat Cloud Hosting CLI. Replace `<appid>` with your WeChat AppID.

```bash
wxcloud login --appid <appid>
```

--------------------------------

### Cloud Function Command Options

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/function.md

Lists the available command-line arguments for configuring the cloud function upload process.

```text
OPTIONS
  -e, --envId=envId   环境ID
  -h, --help          查看帮助信息
  -n, --name=name     函数名
  --remoteNpmInstall  是否云端安装依赖
```

--------------------------------

### Configure docker-compose.yml for Live Coding

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/vscode-extension/src/livecoding/README.md

Use this structure to map local directories to the container and configure environment variables for local debugging.

```yaml
version: '3'
services:
  app:
    build: 
      context: . # 构建上下文
      dockerfile: Dockerfile.development
    volumes:
      - .:/app # 需要映射的目录（即代码目录）
      - /app/node_modules # 映射 node_modules 目录
    ports:
      - 27081:80 # 监听端口，主机端口：容器端口
    container_name: wxcloud_wxcloudrun-express
    labels: # 容器标签，一般不需改动
      - wxPort=27082
      - hostPort=27081
      - wxcloud=wxcloudrun-express
      - role=container
    environment:
      # 使用本地调试 MySQL 时，需要填入如下环境变量，并启动 MySQL 代理服务
      - MYSQL_USERNAME=
      - MYSQL_PASSWORD=
      - MYSQL_ADDRESS=
# 容器网络打通，一般不需改动
networks:
  default:
    external:
      name: wxcb0
```

--------------------------------

### 配置混合部署模式

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/terminology/cloudkit.md

在 wxcloud.config.json 中将部署类型设置为 universal 以启用混合部署。

```json
{
  "type": "universal",
  "server": {}
}
```

--------------------------------

### Deploy Service Versions

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Deploy code or images as new versions, supporting various configurations and release types.

```bash
# 交互式部署当前目录
wxcloud run:deploy

# 指定目录和参数部署
wxcloud run:deploy ./my-project \
  --envId prod-xxxxxx \
  --serviceName my-api \
  --containerPort 8080 \
  --dockerfile Dockerfile \
  --targetDir . \
  --releaseType FULL \
  --remark "v1.0.0 新功能上线" \
  --noConfirm

# 使用环境变量部署
wxcloud run:deploy \
  --envId prod-xxxxxx \
  --serviceName my-api \
  --envParams "NODE_ENV=production&PORT=8080" \
  --envParamsJson '{"DATABASE_URL":"mysql://localhost/db"}'

# 使用已有镜像部署
wxcloud run:deploy \
  --envId prod-xxxxxx \
  --serviceName my-api \
  --libraryImage v1.0.0

# 后台部署（不显示日志）
wxcloud run:deploy --detach
```

--------------------------------

### Create Service

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Create a new Weixin Cloud service within a specified environment.

```APIDOC
## POST /api/service/create

### Description
Creates a new service in the Weixin Cloud.

### Method
POST

### Endpoint
/api/service/create

### Query Parameters
- **envId** (string) - Required - The ID of the environment where the service will be created.
- **serviceName** (string) - Required - The name for the new service.
- **isPublic** (boolean) - Optional - Specifies whether the service should be publicly accessible over the internet.
- **json** (boolean) - Optional - If true, the output will be in JSON format.

### Request Body
(No specific request body defined, parameters are typically passed as query parameters or form data)

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the service was created successfully.

#### Response Example
```json
{
  "message": "Service 'my-new-service' created successfully."
}
```
```

--------------------------------

### Upload Files to Cloud Storage with wxcloud CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Uploads local files to cloud storage or static resource storage, supporting concurrent uploads. Specify the remote path and environment ID.

```bash
# 上传到对象存储
wxcloud storage:upload ./dist --envId prod-xxxxxx --remotePath /assets/

# 上传到静态资源存储
wxcloud storage:upload ./public \
  --envId prod-xxxxxx \
  --remotePath /static/ \
  --mode staticstorage \
  --concurrency 10
```

--------------------------------

### Upload files with storage:upload

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/storage.md

Uploads files to cloud storage. Use the --mode flag to specify between staticstorage or storage.

```bash
wxcloud storage:upload [PATH]
```

```bash
OPTIONS
  -c, --concurrency=concurrency       并发上传数量
  -e, --envId=envId                   环境ID
  -h, --help                          查看帮助信息
  -m, --mode=(staticstorage|storage)  上传模式
  -r, --remotePath=remotePath         目标目录
```

```bash
wxcloud storage:upload /foo/bar/baz --envId=wxrun-id --mode=storage --remotePath=/
```

--------------------------------

### Generate Dockerfile with Custom PromptIO and MessageHandler

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Demonstrates using the Dockerpacks API to programmatically detect a project type and build a Dockerfile. Requires implementing custom IO and message handling for interactive prompts.

```typescript
import {
  Dockerpacks,
  MessageHandler,
  MessageLevel,
  PromptIO,
  HardCodedPromptIO
} from '@wxcloud/dockerpacks';

// 实现自定义提示 IO
class CustomPromptIO extends PromptIO {
  async ok(id: string, caption: string): Promise<boolean> {
    // 实现确认对话框
    return true;
  }

  async input(id: string, caption: string): Promise<string> {
    // 实现输入对话框
    return '3000';
  }

  async select(id: string, caption: string, options: [string, ...string[]]): Promise<number> {
    // 实现选择对话框
    return 0;
  }
}

// 实现消息处理器
class CustomMessageHandler implements MessageHandler {
  pass(level: MessageLevel, message: string) {
    console.log(`[${level}] ${message}`);
  }
}

async function generateDockerfile() {
  const dockerpacks = new Dockerpacks();

  // 检测项目类型
  const builder = await dockerpacks.detect(
    '/path/to/your/project',
    new CustomPromptIO(),
    new CustomMessageHandler(),
    (groups) => 0  // 选择第一个匹配的构建器
  );

  if (!builder) {
    console.error('无法识别项目类型');
    return;
  }

  console.log(`使用构建器: ${builder.group.label}`);

  // 构建 Dockerfile
  const result = await builder.build();

  console.log('Dockerfile 内容:');
  console.log(result.dockerfile);

  console.log('附加文件:');
  for (const [filename, content] of result.files) {
    console.log(`--- ${filename} ---
`);
    console.log(content);
  }
}

// 使用预配置的 PromptIO（无需交互）
async function generateDockerfileNonInteractive() {
  const dockerpacks = new Dockerpacks();

  const builder = await dockerpacks.detectWithGroup(
    'node.npm',  // 指定构建器组
    '/path/to/node/project',
    new HardCodedPromptIO({
      environments: ['NODE_ENV=production', 'PORT=3000'],
      generalEntrypoint: 'npm start',
      expose: '3000'
    })
  );

  if (builder) {
    const result = await builder.build();
    // 写入文件
    require('fs').writeFileSync('Dockerfile', result.dockerfile);
    for (const [filename, content] of result.files) {
      require('fs').writeFileSync(filename, content);
    }
  }
}

generateDockerfile();

```

--------------------------------

### Configure Cloud Hosting Service

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Update the configuration of an existing cloud hosting service. This includes adjusting CPU, memory, instance counts, and scheduling policies. Use the 'update' action to modify settings.

```bash
wxcloud service:config
```

```bash
wxcloud service:config update --cpuThreshold=60 --memThreshold=60
```

--------------------------------

### 安装微信云托管 CLI 工具 (pnpm)

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/guide.md

使用 pnpm 安装最新版微信云托管 CLI 工具。请确保您的 Node.js 版本不低于 v16。

```bash
pnpm i -g @wxcloud/cli
```

--------------------------------

### wxcloud run:deploy

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/run.md

Deploys Weixin Cloud services. Supports various options for environment, service name, container port, and deployment strategy.

```APIDOC
## POST /api/run/deploy

### Description
Deploys cloud services using the `wxcloud run:deploy` command. This command allows for detailed configuration of the deployment process, including specifying environment, service name, container port, and deployment type.

### Method
POST

### Endpoint
/api/run/deploy

### Parameters
#### Query Parameters
- **envId** (string) - Required - The environment ID for the deployment.
- **serviceName** (string) - Required - The name of the service to deploy.
- **PATH** (string) - Optional - The path to the deployment source.
- **envId** (string) - Optional - Environment ID.
- **serviceName** (string) - Optional - Service name.
- **containerPort** (integer) - Optional - The port the container listens on.
- **detach** (boolean) - Optional - If true, returns directly without displaying deployment logs.
- **dockerfile** (string) - Optional - The name of the Dockerfile.
- **envParams** (string) - Optional - Service environment variables in `key=value&key2=value2` format.
- **envParamsJson** (string) - Optional - Service environment variables in JSON format `{"key":"value"}`.
- **libraryImage** (string) - Optional - The tag of the online image repository.
- **noConfirm** (boolean) - Optional - Skips the confirmation prompt before deployment if true.
- **override** (boolean) - Optional - Uses previous configuration for default parameters if true.
- **releaseType** (string) - Optional - Deployment type: FULL (full deployment) or GRAY (gray deployment).
- **remark** (string) - Optional - Version remark.
- **targetDir** (string) - Optional - The target directory for deployment.

### Request Example
```json
{
  "envId": "wxrun-id",
  "serviceName": "demo",
  "libraryImage": "demo-001-20220425111535",
  "containerPort": 80,
  "releaseType": "FULL",
  "remark": "测试备注",
  "noConfirm": true,
  "detach": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the deployment.

#### Response Example
```json
{
  "message": "Deployment initiated successfully."
}
```
```

--------------------------------

### Configure Service

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

Update the configuration of an existing Weixin Cloud service, including resource allocation and scheduling policies.

```APIDOC
## PUT /api/service/config

### Description
Updates the configuration of an existing service. This can include resource settings like CPU and memory, scaling parameters, and environment variables.

### Method
PUT

### Endpoint
/api/service/config

### Query Parameters
- **envId** (string) - Required - The ID of the environment containing the service.
- **serviceName** (string) - Required - The name of the service to configure.
- **cpu** (string) - Optional - The CPU allocation for the service (e.g., '1000m').
- **mem** (string) - Optional - The memory allocation for the service (e.g., '512Mi').
- **minNum** (integer) - Optional - The minimum number of instances for the service.
- **maxNum** (integer) - Optional - The maximum number of instances for the service.
- **cpuThreshold** (integer) - Optional - The CPU utilization threshold for auto-scaling.
- **memThreshold** (integer) - Optional - The memory utilization threshold for auto-scaling.
- **envParams** (string) - Optional - Environment variables in key-value format (e.g., 'VAR1=value1&VAR2=value2').
- **customLogs** (string) - Optional - Path for custom log collection.
- **region** (string) - Optional - The region of the service (e.g., 'ap-shanghai'). Defaults to 'ap-shanghai'.
- **noConfirm** (boolean) - Optional - Skips the confirmation prompt when updating configuration.
- **json** (boolean) - Optional - If true, the output will be in JSON format.

### Request Example
Update scaling policies for a service:
```bash
wxcloud service:config update --cpuThreshold=60 --memThreshold=60
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the configuration update was successful.

#### Response Example
```json
{
  "message": "Service configuration updated successfully."
}
```
```

--------------------------------

### Authenticate with CLI

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Log in to the WeChat Cloud Run environment using AppID and private key, or log out to clear local credentials.

```bash
# 交互式登录
wxcloud login

# 使用参数登录
wxcloud login --appId wx1234567890abcdef --privateKey "your-private-key"

# 登出
wxcloud logout
```

--------------------------------

### Configure cloud migration settings

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/migrate.md

Modify the wxcloud.config.js file to adjust migration modes such as switching to static hosting.

```js
/** @type {import('@wxcloud/core').CloudConfig} */
const cloudConfig = {
  server: '.',
  type: 'static', // 修改为纯静态模式
}

module.exports = cloudConfig
```

--------------------------------

### 执行项目部署命令

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/features/deployment.md

运行部署命令并根据提示选择环境与服务，CLI 将自动处理构建与上传流程。

```shell
$ wxcloud deploy

Wxcloud CLI 2.0.1-beta.15
? 请选择环境 test (test-environment)
? 请选择服务 test-service

<构建日志>

✔ 云托管产物上传
✔ 云托管版本创建
public       | ████████████████████████████████████████ | 2/2 Files
.next/static | ████████████████████████████████████████ | 12/12 Files
✔ 静态资源上传文件成功

部署开始于 2022-05-19 15:40:33

<部署日志>

✔ 部署完成
  服务 cloudkit 访问地址:
  > demo.ap-shanghai.run.tcloudbase.com
```

--------------------------------

### Upload a Cloud Function

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/function.md

Use this command to upload a cloud function directory to the cloud development environment.

```bash
wxcloud function:upload <云函数代码目录>
```

--------------------------------

### List Services

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/service.md

View a list of available Weixin Cloud services within a specified environment.

```APIDOC
## GET /api/service/list

### Description
Retrieves a list of services associated with the specified environment.

### Method
GET

### Endpoint
/api/service/list

### Query Parameters
- **envId** (string) - Optional - The ID of the environment to list services from.
- **serviceName** (string) - Optional - Filters the list by service name.
- **page** (integer) - Optional - Specifies the page number for paginated results.
- **json** (boolean) - Optional - If true, the output will be in JSON format.

### Response
#### Success Response (200)
- **services** (array) - A list of service objects.
  - **name** (string) - The name of the service.
  - **envId** (string) - The environment ID the service belongs to.
  - **status** (string) - The current status of the service.

#### Response Example
```json
{
  "services": [
    {
      "name": "my-service",
      "envId": "prod-env",
      "status": "running"
    }
  ]
}
```
```

--------------------------------

### Interacting with Cloud API

Source: https://context7.com/weixincloud/wxcloud/llms.txt

Core API methods for managing environments, services, releases, and logs via the @wxcloud/core package.

```typescript
import { CloudAPI } from '@wxcloud/core';

// 获取环境列表
const { envList } = await CloudAPI.tcbDescribeWxCloudBaseRunEnvs({ allRegions: true });

// 获取服务列表
const { cloudBaseRunServerSet } = await CloudAPI.tcbDescribeCloudBaseRunServers({
  envId: 'prod-xxxxxx',
  limit: 100,
  offset: 0
});

// 获取服务配置
const { serviceBaseConfig } = await CloudAPI.tcbDescribeServiceBaseConfig({
  envId: 'prod-xxxxxx',
  serverName: 'my-api'
});

// 提交发布
await CloudAPI.tcbSubmitServerRelease({
  envId: 'prod-xxxxxx',
  serverName: 'my-api',
  deployType: 'package',
  hasDockerfile: true,
  releaseType: 'FULL',
  wxAppId: 'wx1234567890',
  packageName: 'package-name',
  packageVersion: 'package-version',
  port: 3000,
  dockerfile: 'Dockerfile'
});

// 获取服务域名
const { defaultPublicDomain, defaultInternalDomain } =
  await CloudAPI.tcbDescribeCloudBaseRunServiceDomain({
    envId: 'prod-xxxxxx',
    serviceName: 'my-api'
  });

// 获取构建日志
const { log } = await CloudAPI.tcbDescribeCloudBaseRunBuildLog({
  envId: 'prod-xxxxxx',
  serviceVersion: 'my-api-001',
  buildId: 12345
});
```

--------------------------------

### Authentication Commands

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/cli/README.md

Commands for logging in and out of the WeChat Cloud environment.

```bash
wxcloud login --appId <微信AppId> --privateKey <秘钥>
```

```bash
wxcloud logout
```

--------------------------------

### Cloud Storage Upload

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/cli/README.md

Upload files to cloud storage with configurable concurrency and modes.

```bash
wxcloud storage:upload <文件目录>
```

```bash
OPTIONS
  -c, --concurrency=concurrency       并发上传数量
  -e, --envId=envId                   环境ID
  -h, --help                          查看帮助信息
  -m, --mode=(staticstorage|storage)  上传模式
  -r, --remotePath=remotePath         目标目录
```

--------------------------------

### wxcloud storage:list

Source: https://github.com/weixincloud/wxcloud/blob/main/packages/docs/docs/commands/storage.md

Lists files in Cloudbase storage. Supports filtering by path prefix and outputting in JSON format.

```APIDOC
## GET /api/storage/list

### Description
Lists files in Cloudbase storage. Supports filtering by path prefix and outputting in JSON format.

### Method
GET

### Endpoint
/api/storage/list

### Parameters
#### Query Parameters
- **pathPrefix** (string) - Optional - A prefix to filter the listed files.
- **concurrency** (number) - Optional - Number of concurrent operations.
- **envId** (string) - Optional - The environment ID.
- **mode** (string) - Optional - Storage mode. Can be 'staticstorage' or 'storage'.
- **delimiter** (string) - Optional - A delimiter for grouping object keys.
- **maxKeys** (number) - Optional - Maximum number of items to return per request. Defaults to 1000, max is 1000.
- **marker** (string) - Optional - Marker to start listing from.
- **json** (boolean) - Optional - If true, outputs a JSON object with full metadata; otherwise, outputs a list of file keys.

### Response
#### Success Response (200)
- **files** (array) - A list of file objects or file keys.

#### Response Example
```json
{
  "files": [
    {
      "key": "file1.txt",
      "size": 1024,
      "lastModified": "2023-10-27T10:00:00Z"
    },
    {
      "key": "folder/file2.txt",
      "size": 2048,
      "lastModified": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```
Tokens:
Raw