# @eggjs/cluster 中文文档

规范地址：https://npmcn.com/package/%40eggjs/cluster/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:18:40.282Z
中文译文更新时间：2026-11-13T09:43:43.017Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/cluster
原文对照：https://npmcn.com/package/%40eggjs/cluster/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/packages/cluster
源码仓库：https://github.com/eggjs/egg

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：80.9 kB，44 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：11 个
- 首次发布：2024-12-17T03:25:38.930Z
- 最新版本发布：2026-10-07T08:18:39.920Z
- 近 30 天下载量：5159（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：72（近 12 个月 33 个）

## 中文简介

彩蛋组管理器

## 安装

```sh
npm install @eggjs/cluster
```

也可以使用：`pnpm add @eggjs/cluster`、`yarn add @eggjs/cluster`、`bun add @eggjs/cluster`

## README

# @eggjs/ 分组

[![NPM version](https://img.shields.io/npm/v/@eggjs/cluster.svg?style=flat-square)](https://npmjs.org/package/@eggjs/cluster) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/cluster/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/cluster) [![npm download](https://img.shields.io/npm/dm/@eggjs/cluster.svg?style=flat-square)](https://npmjs.org/package/@eggjs/cluster) [![Node.js Version](https://img.shields.io/node/v/@eggjs/cluster.svg?style=flat)](https://nodejs.org/en/download/)

EggJS 组管理器

## 安装

```bash
npm i @eggjs/cluster
```

## 使用量

常见JS

```js
const { startCluster } = require('@eggjs/cluster');

startCluster({
  baseDir: '/path/to/app',
  framework: '/path/to/framework',
});
```

您可以指定应用程序启动时将引用的回调 . 然而,主进程在遇到错误时会退出.

```js
startCluster(options).then(() => {
  console.log('started');
});
```

无害环境管理和类型脚本

```ts
import { startCluster } from '@eggjs/cluster';

startCluster({
  baseDir: '/path/to/app',
  framework: '/path/to/framework',
});
```

## 选项

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 碱性 | `String` | 应用目录 |
| 框架 | `String` | 指定可以是绝对路径或 npm 包的框架 |
| 插件 | `Object` | 单位测试插件 |
| 劳动者 | `Number` | 应用工人人数 |
| 粘着 | `Boolean` | 粘贴模式服务器 |
| 端口 | `Number` | 端口 |
| 调试端口 | `Number` | 调试端口只听 http 协议 |
| 网页 | `Object` | 启动 https 服务器, 注意 : `key` 编号 : `cert` 编号 : `ca` 文件的完整路径 |
| 需求 | `Array|String` | 将注入工人/代理工序 |
| pidfile 文件夹 | `String` | 将保存主 pid 到此文件 |
| 启动模式 | `String` | 默认为“ process” , 使用“ worker threads ” 启动 app & 代理工人 |
| 端口 | `Array` | 每个应用程序工人的启动端口, 如: \[7001, 7002, 7003\], 只有在启动模式是“ 工人 线程” 时才会有效果 |
| 环境 | `String` | 自定义env, 默认是进程. env. EGG SERVER ENV |

## 信封

`EGG_APP_CLOSE_TIMEOUT`: 应用工靴超时值

`EGG_AGENT_CLOSE_TIMEOUT`: 代理工靴超时值

## 许可证

[麻省理工学院](https://npmcn.com/package/%40eggjs/cluster/LICENSE)

## 贡献者

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 常见问题

### @eggjs/cluster 是什么？

彩蛋组管理器

### 如何安装 @eggjs/cluster？

在项目目录运行 npm install @eggjs/cluster，或使用 pnpm add / yarn add / bun add。

### @eggjs/cluster 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @eggjs/cluster 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @eggjs/cluster 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.18\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eggjs/cluster 可以商用吗？

@eggjs/cluster 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @eggjs/cluster 的下载量有多少？

根据 npm 官方下载统计，@eggjs/cluster 在 2026/10/13 – 2026/11/11 这 30 天内被下载 5,159 次，日均约 172 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eggjs/cluster 还在维护吗？

最新版本 4\.1\.0 发布于 2026/10/07（1 个月前）；至今共发布 72 个版本，其中过去 12 个月发布了 33 个；首次发布于 2024/12/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。