@zhengyizhao/deploy-helper 0.1.0

package/README.md

@@ -0,0 +1,120 @@
+# 🚀 deploy-helper
+
+> 把项目部署到服务器，就这么简单。
+
+不需要懂 Nginx、PM2、Certbot——回答几个问题，剩下的交给它。
+
+---
+
+## 为什么有这个工具？
+
+你写完了一个项目，想放到服务器上让别人访问。但你卡在了这些问题上：
+
+- 服务器买好了，然后呢？
+- Nginx 怎么配？
+- HTTPS 证书怎么申请？
+- 代码更新了怎么同步到服务器？
+- 服务挂了怎么知道？
+
+`deploy-helper` 就是来解决这些的。
+
+---
+
+## 快速开始
+
+```bash
+npx deploy-helper
+```
+
+第一次运行会引导你完成全套配置，大约 5 分钟搞定：
+
+```
+🚀 deploy-helper — 把项目部署到服务器，就这么简单
+
+[1/5] 服务器连接信息
+? 服务器 IP 地址：123.456.78.9
+? SSH 端口：22
+? 登录用户名：root
+? 登录方式：SSH 密钥（推荐）
+? SSH 密钥路径：~/.ssh/id_rsa
+  ✓ 服务器连接成功！
+
+[2/5] 项目信息
+  ℹ 自动检测到项目类型：Node.js 应用
+? 应用名称：my-app
+? 部署路径：/var/www/my-app
+? 启动命令：node index.js
+? 端口：3000
+
+[3/5] 域名 & HTTPS
+? 是否配置域名？是
+? 你的域名：example.com
+? 自动申请 HTTPS 证书？是
+
+[4/5] 安装服务器环境
+  ✓ 安装 Nginx
+  ✓ 安装 Node.js 20
+  ✓ 安装 PM2
+
+[5/5] 上传代码并启动服务
+  ✓ 项目文件上传完成
+  ✓ 安装依赖
+  ✓ 启动应用（PM2）
+  ✓ Nginx 配置完成
+  ✓ HTTPS 证书申请成功
+
+🎉 部署成功！
+
+  访问地址：https://example.com
+  更新代码 → deploy-helper update
+  查看状态 → deploy-helper status
+```
+
+---
+
+## 命令
+
+| 命令 | 说明 |
+|------|------|
+| `deploy-helper` 或 `deploy-helper init` | 首次部署，全程引导 |
+| `deploy-helper update` | 把最新代码推送到服务器并重启 |
+| `deploy-helper status` | 查看服务运行状态、内存、最近日志 |
+
+---
+
+## 支持的项目类型
+
+| 类型 | 进程管理 | 说明 |
+|------|---------|------|
+| Node.js | PM2 | Express、Koa、Next.js 等 |
+| Python | Supervisor | Flask、FastAPI、Django 等 |
+| Docker | docker compose | 任意容器化应用 |
+| 静态网站 | Nginx | 纯 HTML/CSS/JS |
+
+---
+
+## 前提条件
+
+- **本地**：Node.js 18+
+- **服务器**：Ubuntu 20.04 / 22.04 / 24.04（root 或 sudo 权限）
+
+---
+
+## 安装（全局）
+
+```bash
+npm install -g deploy-helper
+deploy-helper init
+```
+
+---
+
+## 配置文件
+
+首次部署后，项目根目录会生成 `.deploy-config.json`，记录所有配置。建议加入 `.gitignore`（其中包含服务器密码字段）。
+
+---
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@zhengyizhao/deploy-helper",
+  "version": "0.1.0",
+  "description": "Interactive CLI to deploy your project to any VPS server",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "fs-extra": "^11.3.5",
+    "inquirer": "^13.4.3",
+    "node-ssh": "^13.2.1",
+    "ora": "^9.4.0"
+  },
+  "type": "module",
+  "bin": {
+    "deploy-helper": "src/index.js"
+  }
+}

package/src/commands/backup.js

@@ -0,0 +1,313 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import inquirer from 'inquirer';
+import path from 'path';
+import fs from 'fs';
+import { connectSSH, runRemoteSilent } from '../utils/ssh.js';
+import { loadConfig, saveConfig } from '../utils/config.js';
+
+const BACKUP_BASE = '/var/deploy-helper/db-backups';
+
+/**
+ * 根据数据库类型生成备份命令
+ */
+function buildDumpCommand(dbConfig, outputFile) {
+  const { type, host, port, user, password, database } = dbConfig;
+  const h = host || '127.0.0.1';
+
+  if (type === 'mysql') {
+    const p = port || 3306;
+    return `MYSQL_PWD='${password}' mysqldump -h ${h} -P ${p} -u ${user} ${database} > ${outputFile}`;
+  }
+  if (type === 'postgresql') {
+    const p = port || 5432;
+    return `PGPASSWORD='${password}' pg_dump -h ${h} -p ${p} -U ${user} ${database} > ${outputFile}`;
+  }
+  if (type === 'mongodb') {
+    const p = port || 27017;
+    const auth = password ? `--username ${user} --password '${password}' --authenticationDatabase admin` : '';
+    return `mongodump --host ${h} --port ${p} ${auth} --db ${database} --archive=${outputFile} --gzip`;
+  }
+  return null;
+}
+
+/**
+ * 列出现有备份
+ */
+async function listBackups(ssh, appName) {
+  const result = await runRemoteSilent(
+    ssh,
+    `ls -lt ${BACKUP_BASE}/${appName}/ 2>/dev/null | grep -E "\\.(sql|gz|archive)" | head -20 || echo ""`
+  );
+  if (!result.stdout.trim()) return [];
+
+  return result.stdout.trim().split('\n').filter(Boolean).map(line => {
+    const parts = line.trim().split(/\s+/);
+    const filename = parts[parts.length - 1];
+    const size = parts[4];
+    return { filename, size, line };
+  });
+}
+
+export async function deployBackup() {
+  const config = loadConfig();
+  if (!config) {
+    console.log(chalk.red('\n没有找到部署配置，请先运行：') + chalk.cyan(' deploy-helper init\n'));
+    return;
+  }
+
+  const { action } = await inquirer.prompt([{
+    type: 'list',
+    name: 'action',
+    message: '数据库备份操作：',
+    choices: [
+      { name: '立即备份数据库', value: 'backup' },
+      { name: '查看历史备份列表', value: 'list' },
+      { name: '下载备份文件到本地', value: 'download' },
+      { name: '配置定时自动备份', value: 'schedule' },
+    ],
+  }]);
+
+  if (action === 'backup') await doBackup(config);
+  else if (action === 'list') await listBackupFiles(config);
+  else if (action === 'download') await downloadBackup(config);
+  else if (action === 'schedule') await scheduleBackup(config);
+}
+
+async function doBackup(config, silent = false) {
+  // 读取或询问数据库配置
+  let dbConfig = config.database;
+
+  if (!dbConfig) {
+    if (!silent) {
+      console.log(chalk.gray('\n首次使用，需要配置数据库连接信息。配置将保存到 .deploy-config.json\n'));
+    }
+    const answers = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'type',
+        message: '数据库类型：',
+        choices: [
+          { name: 'MySQL / MariaDB', value: 'mysql' },
+          { name: 'PostgreSQL', value: 'postgresql' },
+          { name: 'MongoDB', value: 'mongodb' },
+        ],
+      },
+      { type: 'input', name: 'host', message: '数据库地址：', default: '127.0.0.1' },
+      { type: 'input', name: 'port', message: '端口：', default: (a) => ({ mysql: '3306', postgresql: '5432', mongodb: '27017' }[a.type]) },
+      { type: 'input', name: 'user', message: '用户名：', default: 'root' },
+      { type: 'password', name: 'password', message: '密码：', mask: '*' },
+      { type: 'input', name: 'database', message: '数据库名：', validate: v => v.trim() ? true : '请输入数据库名' },
+    ]);
+    dbConfig = answers;
+
+    // 保存到 config
+    const updated = { ...config, database: dbConfig };
+    saveConfig(updated);
+  }
+
+  let ssh;
+  const connectSpinner = ora('连接服务器...').start();
+  try {
+    ssh = await connectSSH(config);
+    connectSpinner.succeed('连接成功');
+  } catch (err) {
+    connectSpinner.fail('连接失败：' + err.message);
+    return null;
+  }
+
+  try {
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
+    const ext = dbConfig.type === 'mongodb' ? '.archive.gz' : '.sql.gz';
+    const filename = `${dbConfig.database}_${timestamp}${ext}`;
+    const backupDir = `${BACKUP_BASE}/${config.appName}`;
+    const outputFile = `${backupDir}/${filename}`;
+    const rawFile = outputFile.replace('.gz', '');
+
+    await runRemoteSilent(ssh, `mkdir -p ${backupDir}`);
+
+    // 生成备份
+    const dumpSpinner = ora(`备份 ${dbConfig.type} 数据库 [${dbConfig.database}]...`).start();
+    const dumpCmd = buildDumpCommand(dbConfig, dbConfig.type === 'mongodb' ? outputFile : rawFile);
+    const dumpResult = await runRemoteSilent(ssh, dumpCmd);
+
+    if (dumpResult.code !== 0) {
+      dumpSpinner.fail('备份失败');
+      console.log(chalk.red(dumpResult.stdout));
+      ssh.dispose();
+      return null;
+    }
+
+    // MySQL/PostgreSQL 压缩
+    if (dbConfig.type !== 'mongodb') {
+      await runRemoteSilent(ssh, `gzip -f ${rawFile}`);
+    }
+
+    // 获取文件大小
+    const sizeResult = await runRemoteSilent(ssh, `du -sh ${outputFile} | cut -f1`);
+    dumpSpinner.succeed(`备份完成 → ${chalk.cyan(filename)} ${chalk.gray('(' + sizeResult.stdout + ')')}`);
+
+    // 只保留最近 10 个备份
+    await runRemoteSilent(
+      ssh,
+      `ls -t ${backupDir} | tail -n +11 | xargs -I{} rm -f ${backupDir}/{} 2>/dev/null || true`
+    );
+
+    ssh.dispose();
+    return { filename, outputFile };
+
+  } catch (err) {
+    console.log(chalk.red('\n备份失败：' + err.message));
+    ssh.dispose();
+    return null;
+  }
+}
+
+async function listBackupFiles(config) {
+  let ssh;
+  const spinner = ora('连接服务器...').start();
+  try {
+    ssh = await connectSSH(config);
+    spinner.succeed('连接成功');
+  } catch (err) {
+    spinner.fail('连接失败：' + err.message);
+    return;
+  }
+
+  const backups = await listBackups(ssh, config.appName);
+  ssh.dispose();
+
+  if (backups.length === 0) {
+    console.log(chalk.yellow('\n还没有任何备份记录。\n'));
+    return;
+  }
+
+  console.log(chalk.bold(`\n  历史备份（共 ${backups.length} 个）：\n`));
+  backups.forEach(({ filename, size }, i) => {
+    const prefix = i === 0 ? chalk.green('  ● ') : chalk.gray('  ○ ');
+    console.log(prefix + chalk.cyan(filename) + chalk.gray(`  ${size}`));
+  });
+  console.log('');
+}
+
+async function downloadBackup(config) {
+  let ssh;
+  const spinner = ora('连接服务器...').start();
+  try {
+    ssh = await connectSSH(config);
+    spinner.succeed('连接成功');
+  } catch (err) {
+    spinner.fail('连接失败：' + err.message);
+    return;
+  }
+
+  const backups = await listBackups(ssh, config.appName);
+
+  if (backups.length === 0) {
+    console.log(chalk.yellow('\n没有备份文件可下载。先运行备份。\n'));
+    ssh.dispose();
+    return;
+  }
+
+  const { selected } = await inquirer.prompt([{
+    type: 'list',
+    name: 'selected',
+    message: '选择要下载的备份：',
+    choices: backups.map(b => ({
+      name: `${b.filename}  ${chalk.gray(b.size)}`,
+      value: b.filename,
+    })),
+  }]);
+
+  const localPath = path.join(process.cwd(), selected);
+  const remotePath = `${BACKUP_BASE}/${config.appName}/${selected}`;
+
+  const dlSpinner = ora(`下载 ${selected}...`).start();
+  try {
+    await ssh.getFile(localPath, remotePath);
+    dlSpinner.succeed(`已下载到：${chalk.cyan(localPath)}`);
+  } catch (err) {
+    dlSpinner.fail('下载失败：' + err.message);
+  }
+
+  ssh.dispose();
+}
+
+async function scheduleBackup(config) {
+  const { frequency } = await inquirer.prompt([{
+    type: 'list',
+    name: 'frequency',
+    message: '备份频率：',
+    choices: [
+      { name: '每天凌晨 2 点', value: '0 2 * * *' },
+      { name: '每 6 小时', value: '0 */6 * * *' },
+      { name: '每周一凌晨 2 点', value: '0 2 * * 1' },
+      { name: '自定义 Cron 表达式', value: 'custom' },
+    ],
+  }]);
+
+  let cronExpr = frequency;
+  if (frequency === 'custom') {
+    const { custom } = await inquirer.prompt([{
+      type: 'input',
+      name: 'custom',
+      message: 'Cron 表达式（如 "0 3 * * *" 表示每天 3 点）：',
+      validate: v => v.trim().split(/\s+/).length === 5 ? true : '请输入正确的 5 段 Cron 表达式',
+    }]);
+    cronExpr = custom;
+  }
+
+  let ssh;
+  const spinner = ora('配置定时备份...').start();
+  try {
+    ssh = await connectSSH(config);
+  } catch (err) {
+    spinner.fail('连接失败：' + err.message);
+    return;
+  }
+
+  try {
+    const dbConfig = config.database;
+    if (!dbConfig) {
+      spinner.fail('未配置数据库信息，请先运行一次备份完成配置。');
+      ssh.dispose();
+      return;
+    }
+
+    const backupDir = `${BACKUP_BASE}/${config.appName}`;
+    const ext = dbConfig.type === 'mongodb' ? '.archive.gz' : '.sql.gz';
+
+    // 生成备份脚本
+    const scriptContent = `#!/bin/bash
+TIMESTAMP=$(date +%Y-%m-%dT%H-%M-%S)
+OUTFILE="${backupDir}/${dbConfig.database}_\${TIMESTAMP}${ext}"
+mkdir -p ${backupDir}
+${buildDumpCommand(dbConfig, dbConfig.type === 'mongodb' ? '$OUTFILE' : '${OUTFILE%.gz}')}
+${dbConfig.type !== 'mongodb' ? `gzip -f "\${OUTFILE%.gz}"` : ''}
+ls -t ${backupDir} | tail -n +11 | xargs -I{} rm -f ${backupDir}/{} 2>/dev/null
+echo "[$(date)] Backup completed: \$OUTFILE" >> /var/log/deploy-helper-backup.log
+`;
+
+    const scriptPath = `/usr/local/bin/deploy-helper-backup-${config.appName}.sh`;
+    await runRemoteSilent(ssh, `cat > ${scriptPath} << 'SCRIPT_EOF'\n${scriptContent}\nSCRIPT_EOF`);
+    await runRemoteSilent(ssh, `chmod +x ${scriptPath}`);
+
+    // 注入 crontab
+    await runRemoteSilent(
+      ssh,
+      `(crontab -l 2>/dev/null | grep -v "deploy-helper-backup-${config.appName}"; echo "${cronExpr} ${scriptPath}") | crontab -`
+    );
+
+    spinner.succeed('定时备份配置完成');
+    console.log(chalk.gray(`  Cron: ${cronExpr}`));
+    console.log(chalk.gray(`  日志: /var/log/deploy-helper-backup.log\n`));
+    ssh.dispose();
+
+  } catch (err) {
+    spinner.fail('配置失败：' + err.message);
+    ssh.dispose();
+  }
+}
+
+// 供 update.js 调用：部署前自动备份
+export { doBackup };