Files
everything-claude-code/docs/zh-CN/commands/pm2.md
2026-03-22 15:39:24 -07:00

6.6 KiB
Raw Blame History

PM2 初始化

自动分析项目并生成 PM2 服务命令。

命令: $ARGUMENTS


工作流程

  1. 检查 PM2如果缺失通过 npm install -g pm2 安装)
  2. 扫描项目以识别服务(前端/后端/数据库)
  3. 生成配置文件和各命令文件

服务检测

类型 检测方式 默认端口
Vite vite.config.* 5173
Next.js next.config.* 3000
Nuxt nuxt.config.* 3000
CRA package.json 中的 react-scripts 3000
Express/Node server/backend/api 目录 + package.json 3000
FastAPI/Flask requirements.txt / pyproject.toml 8000
Go go.mod / main.go 8080

端口检测优先级: 用户指定 > .env 文件 > 配置文件 > 脚本参数 > 默认端口


生成的文件

project/
├── ecosystem.config.cjs              # PM2 配置文件
├── {backend}/start.cjs               # Python 包装器(如适用)
└── .claude/
    ├── commands/
    │   ├── pm2-all.md                # 启动所有 + 监控
    │   ├── pm2-all-stop.md           # 停止所有
    │   ├── pm2-all-restart.md        # 重启所有
    │   ├── pm2-{port}.md             # 启动单个 + 日志
    │   ├── pm2-{port}-stop.md        # 停止单个
    │   ├── pm2-{port}-restart.md     # 重启单个
    │   ├── pm2-logs.md               # 查看所有日志
    │   └── pm2-status.md             # 查看状态
    └── scripts/
        ├── pm2-logs-{port}.ps1       # 单个服务日志
        └── pm2-monit.ps1             # PM2 监控器

Windows 配置(重要)

ecosystem.config.cjs

必须使用 .cjs 扩展名

module.exports = {
  apps: [
    // Node.js (Vite/Next/Nuxt)
    {
      name: 'project-3000',
      cwd: './packages/web',
      script: 'node_modules/vite/bin/vite.js',
      args: '--port 3000',
      interpreter: 'C:/Program Files/nodejs/node.exe',
      env: { NODE_ENV: 'development' }
    },
    // Python
    {
      name: 'project-8000',
      cwd: './backend',
      script: 'start.cjs',
      interpreter: 'C:/Program Files/nodejs/node.exe',
      env: { PYTHONUNBUFFERED: '1' }
    }
  ]
}

框架脚本路径:

框架 script args
Vite node_modules/vite/bin/vite.js --port {port}
Next.js node_modules/next/dist/bin/next dev -p {port}
Nuxt node_modules/nuxt/bin/nuxt.mjs dev --port {port}
Express src/index.jsserver.js -

Python 包装脚本 (start.cjs)

const { spawn } = require('child_process');
const proc = spawn('python', ['-m', 'uvicorn', 'app.main:app', '--host', '0.0.0.0', '--port', '8000', '--reload'], {
  cwd: __dirname, stdio: 'inherit', windowsHide: true
});
proc.on('close', (code) => process.exit(code));

命令文件模板(最简内容)

pm2-all.md (启动所有 + 监控)

启动所有服务并打开 PM2 监控器。
```bash
cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 monit"
```

pm2-all-stop.md

停止所有服务。
```bash
cd "{PROJECT_ROOT}" && pm2 stop all
```

pm2-all-restart.md

重启所有服务。
```bash
cd "{PROJECT_ROOT}" && pm2 restart all
```

pm2-{port}.md (启动单个 + 日志)

启动 {name} ({port}) 并打开日志。
```bash
cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs --only {name} && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 logs {name}"
```

pm2-{port}-stop.md

停止 {name} ({port})。
```bash
cd "{PROJECT_ROOT}" && pm2 stop {name}
```

pm2-{port}-restart.md

重启 {name} ({port})。
```bash
cd "{PROJECT_ROOT}" && pm2 restart {name}
```

pm2-logs.md

查看所有 PM2 日志。
```bash
cd "{PROJECT_ROOT}" && pm2 logs
```

pm2-status.md

查看 PM2 状态。
```bash
cd "{PROJECT_ROOT}" && pm2 status
```

PowerShell 脚本 (pm2-logs-{port}.ps1)

Set-Location "{PROJECT_ROOT}"
pm2 logs {name}

PowerShell 脚本 (pm2-monit.ps1)

Set-Location "{PROJECT_ROOT}"
pm2 monit

关键规则

  1. 配置文件: ecosystem.config.cjs (不是 .js)
  2. Node.js: 直接指定 bin 路径 + 解释器
  3. Python: Node.js 包装脚本 + windowsHide: true
  4. 打开新窗口: start wt.exe -d "{path}" pwsh -NoExit -c "command"
  5. 最简内容: 每个命令文件只有 1-2 行描述 + bash 代码块
  6. 直接执行: 无需 AI 解析,直接运行 bash 命令

执行

基于 $ARGUMENTS,执行初始化:

  1. 扫描项目服务
  2. 生成 ecosystem.config.cjs
  3. 为 Python 服务生成 {backend}/start.cjs(如果适用)
  4. .claude/commands/ 中生成命令文件
  5. .claude/scripts/ 中生成脚本文件
  6. 更新项目 CLAUDE.md,添加 PM2 信息(见下文)
  7. 显示完成摘要,包含终端命令

初始化后:更新 CLAUDE.md

生成文件后,将 PM2 部分追加到项目的 CLAUDE.md(如果不存在则创建):

## PM2 服务

| 端口 | 名称 | 类型 |
|------|------|------|
| {port} | {name} | {type} |

**终端命令:**
```bash
pm2 start ecosystem.config.cjs   # First time
pm2 start all                    # After first time
pm2 stop all / pm2 restart all
pm2 start {name} / pm2 stop {name}
pm2 logs / pm2 status / pm2 monit
pm2 save                         # Save process list
pm2 resurrect                    # Restore saved list
```

更新 CLAUDE.md 的规则:

  • 如果存在 PM2 部分,替换它
  • 如果不存在,追加到末尾
  • 保持内容精简且必要

初始化后:显示摘要

所有文件生成后,输出:

## PM2 初始化完成

**服务列表:**

| 端口 | 名称 | 类型 |
|------|------|------|
| {port} | {name} | {type} |

**Claude 指令:** /pm2-all, /pm2-all-stop, /pm2-{port}, /pm2-{port}-stop, /pm2-logs, /pm2-status

**终端命令:**
## 首次运行(使用配置文件)
pm2 start ecosystem.config.cjs && pm2 save

## 首次之后(简化命令)
pm2 start all          # 启动全部
pm2 stop all           # 停止全部
pm2 restart all        # 重启全部
pm2 start {name}       # 启动单个
pm2 stop {name}        # 停止单个
pm2 logs               # 查看日志
pm2 monit              # 监控面板
pm2 resurrect          # 恢复已保存进程

**提示:** 首次启动后运行 `pm2 save` 以启用简化命令。