@eggjs/ 标语

为鸡蛋项目部署工具.

注意: Windows 部分支持,参见 22号

安装

npm i @eggjs/scripts --save

使用量

添加 eggctl 改为 package.json 脚本 :

{
  "scripts": {
    "start": "eggctl start --daemon",
    "stop": "eggctl stop"
  }
}

然后运行为:

• npm start
• npm stop

说明: egg-scripts 不建议安装全局,您应当安装并用作 npm 脚本.

命令

开始

开始彩蛋模式.

$ eggctl start [options] [baseDir]

# Usage
# eggctl start --port=7001
# eggctl start ./server

• 参数
  • baseDir - 应用程序目录,默认为 process.cwd()。 。 。 .
• 选项
  • port - 听端口,默认为 process.env.PORT,如果未设定,则蛋将使用 7001 作为默认.
  • title - 处理标题描述,用于 kill grep, 默认为 egg-server-${APP_NAME}。 。 。 .
  • workers - 应用工人人数,默认为: process.env.EGG_WORKERS,如果未设定,则蛋将使用 os.cpus().length 作为默认.
  • daemon - 无论是在背景守护进程模式下运行,如果在嵌入模式下运行,不要使用它.
  • framework - 指定可以是绝对路径或npm包的框架,默认为自动检测.
  • env - 服务器环境,默认为 process.env.EGG_SERVER_ENV,建议保持空出,然后使用 framwork 默认环境.
  • stdout - 自定义 stdout 文件, 默认为 $HOME/logs/master-stdout.log。 。 。 .
  • stderr - 自定义 stderr 文件,默认为 $HOME/logs/master-stderr.log。 。 。 .
  • timeout - 应用程序启动时最大超时, 默认为300秒 .
  • ignore-stderr - 应用程序启动时是否忽略了 stderr .
  • sourcemap 编号 : typescript 编号 : ts - 为堆栈跟踪提供源地图支持.
  • node - 自定义节点命令路径, 默认将从 $PATH 中找到节点

停下来

别吃鸡蛋了.

说明: 如果执行没有 --title它会杀死所有的鸡蛋过程.

$ eggctl stop [options]

# Usage
# eggctl stop --title=example

• 选项
  • title - 处理标题描述,用于 kill grep.
  • timeout - 应用程序停止时的最大超时,默认为5s.

选项在 package.json

除命令行规格外,还可以在 package.json然而,命令行指定优先.

{
  "eggScriptsConfig": {
    "port": 1234,
    "ignore-stderr": true,
    // will pass as `node --max-http-header-size=20000`
    "node-options--max-http-header-size": "20000",
    // will pass as `node --allow-wasi`
    "node-options--allow-wasi": true
  }
}

问题和建议

请打开一个问题 这里。 。 。 .

许可证

麻省理工学院

贡献者

制造的 贡献者-img。 。 。 .