nodebbs 0.2.0 → 0.3.0-beta.0

package/README.md

@@ -7,11 +7,13 @@
 
 ## 📖 简介
 
-NodeBBS CLI 是一个专为全栈开发者设计的命令行工具，用于简化 NodeBBS 项目的开发、部署和管理流程。它提供了直观的命令接口，让你可以轻松管理 Docker 容器、查看日志、操作数据库等。
+NodeBBS CLI 是一个专为全栈开发者设计的命令行工具，用于简化 NodeBBS 项目的开发、部署和管理流程。它能够自动识别 **源码项目** 和 **纯净镜像部署** 两种场景，并提供开箱即用的 Docker 容器管理能力。
 
 ### 特性
 
-- �️ **交互式菜单** - 支持键盘导航的可视化命令选择
+- ️ **交互式菜单** - 支持键盘导航的可视化命令选择
+- 🧠 **智能识别** - 自动检测源码模式或镜像模式
+- 🔄 **平滑升级** - 一个命令完成更新（自动选择重建或拉取镜像）
 - 🎯 **全栈友好** - 命令设计贴近开发者思维
 - 📊 **实时日志** - 方便查看各服务日志
 - 💾 **数据库管理** - 内置数据库迁移和管理工具
@@ -45,206 +47,63 @@ npx nodebbs [command]
 ```bash
 npx nodebbs
 ```
-- **start**： 开始部署（首次使用推荐选择此项）
-- **rebuild**： 重新构建并启动（跳过检查，通常在代码更新后选择此项）
-
-## 📚 命令参考
-
-#### `nodebbs start`
-开始部署
-
-```bash
-# 交互式启动
-npx nodebbs start
-
-# 指定环境启动
-npx nodebbs start -e production
-
-# 重新构建并启动（跳过检查）
-npx nodebbs start --build
-```
-
-**参数**：
-- `-e, --env` - 部署环境（production, lowmem, basic）
-- `-b, --build` - 重新构建镜像并启动（跳过健康检查和初始化）
 
-启动流程包含：
-- Docker 环境检查
-- 环境变量验证
-- 镜像构建
-- 服务启动
-- 健康检查（默认开启，使用 `--build` 跳过）
-- 数据库初始化（默认开启，使用 `--build` 跳过）
-
-#### `nodebbs restart`
-重启所有服务（不更新镜像，支持环境选择）
-
-```bash
-npx nodebbs restart
-npx nodebbs restart -e production
-```
-
-#### `nodebbs stop`
-停止服务（支持环境选择）
-
-```bash
-npx nodebbs stop
-npx nodebbs stop -e production
-
-# 停止服务并删除数据卷（危险！）
-npx nodebbs stop --volumes
-npx nodebbs stop -v
-```
-
-**参数**：
-- `-v, --volumes` - 同时删除数据卷
-
-#### `nodebbs status`
-查看服务状态
-
-```bash
-npx nodebbs status
-# 查看指定环境状态
-npx nodebbs status -e production
-```
-
-### 日志管理
-
-#### `nodebbs logs`
-查看服务日志
-
-```bash
-# 查看所有日志
-npx nodebbs logs
-# 查看指定环境日志
-npx nodebbs logs -e production
-```
-
-#### `nodebbs logs:api`
-查看 API 服务日志
-
-```bash
-npx nodebbs logs:api
-```
-
-#### `nodebbs logs:web`
-查看 Web 服务日志
-
-```bash
-npx nodebbs logs:web
-```
-
-#### `nodebbs logs:db`
-查看数据库日志
-
-```bash
-npx nodebbs logs:db
-```
-
-#### `nodebbs logs:redis`
-查看 Redis 日志
-
-```bash
-npx nodebbs logs:redis
-```
-
-### 离线部署
-
-#### `nodebbs pack`
-生成离线部署包（包含镜像、配置文件和安装脚本）
-
-```bash
-npx nodebbs pack
-npx nodebbs pack -o my-deployment.tar.gz
-```
-
-**参数**：
-- `-o, --output` - 输出文件名 (默认: nodebbs-offline.tar.gz)
-
-
-### Shell 访问
-
-#### `nodebbs shell`
-进入容器 Shell (支持 api, web, db, redis)
-
-```bash
-# 进入 API 容器
-npx nodebbs shell:api
-# 进入生产环境 API 容器
-npx nodebbs shell:api -e production
-```
-
-#### `nodebbs shell:web`
-进入 Web 容器
-
-```bash
-npx nodebbs shell:web
-```
-
-#### `nodebbs shell:db`
-进入数据库（自动启动 psql）
-
-```bash
-npx nodebbs shell:db
-```
-
-#### `nodebbs shell:redis`
-进入 Redis（自动启动 redis-cli）
-
-```bash
-npx nodebbs shell:redis
-```
-
-### 数据库管理
-
-#### `nodebbs db:push`
-推送数据库 schema
-
-```bash
-npx nodebbs db:push
-```
-
-#### `nodebbs db:seed`
-初始化数据库数据
-
-```bash
-npx nodebbs db:seed
-```
-
-#### `nodebbs db:reset`
-重置并重新初始化数据（危险！）
-
-```bash
-npx nodebbs db:reset
-```
-
-#### `nodebbs db:backup`
-备份数据库
-
-```bash
-npx nodebbs db:backup
-npx nodebbs db:backup -o backup.sql
-```
-
-#### `nodebbs clean`
-清理 Docker 缓存和残留资源
-
-```bash
-# 交互式选择清理项目
-npx nodebbs clean
-
-# 自动清理所有（构建缓存、无用镜像、网络）
-npx nodebbs clean -a
-
-# 仅清理构建缓存
-npx nodebbs clean --cache
-```
-
-## 🎯 使用场景
+- **start**： 开始部署（首次使用推荐选择此项）
+- **upgrade**： 升级并重启（自动检测更新策略）
+
+## 📚 部署模式
+
+CLI 会自动根据当前目录内容判断部署模式：
+
+1.  **源码模式 (Source Mode)**
+    - 检测到 `package.json`。
+    - 行为：使用本地源码执行 `docker build` 构建镜像。
+    - 适用：开发环境、二次开发。
+
+2.  **镜像模式 (Image Mode)**
+    - 未检测到源码。
+    - 行为：直接从远程仓库拉取预构建镜像。
+    - 适用：生产环境部署、快速体验。
+    - **配置**：首次启动时会提示输入镜像版本（默认为 `latest`），并自动写入 `.env`。
+
+## 🛠️ 常用命令
+
+```bash
+$ nodebbs
+? 选择命令:
+❯ start         启动服务
+  stop          停止服务
+  restart       重启服务
+  upgrade       升级服务
+  status        查看服务状态
+  logs          查看服务日志  [+]
+  shell         进入容器终端  [+]
+  db            数据库操作 (备份, 迁移, 种子数据等)  [+]
+  pack          生成离线部署包
+  clean         清理 Docker 缓存和残留资源
+  help          显示帮助信息
+  ❌ 退出
+```
+
+#### 命令说明
+
+| 命令 | 说明 |
+|------|---------|
+| **start** | 启动服务（根据当前配置环境）|
+| **stop** | 停止所有服务 |
+| **restart** | 重启服务（相当于 `docker compose up --force-recreate`）|
+| **upgrade** | 升级服务（拉取最新 Docker 镜像或重新构建本地镜像）|
+| **status** | 查看所有容器的运行状态和健康检查结果 |
+| **logs** | 查看服务日志（支持选择特定服务 API/Web/DB/Redis）|
+| **shell** | 进入容器终端进行调试（支持选择特定服务）|
+| **db** | 数据库高级操作：<br>• 备份 (backup)<br>• 恢复 (import)<br>• 迁移 (migrate)<br>• 种子数据 (seed) |
+| **pack** | 生成离线部署包（**仅限源码模式**），方便在无网环境部署 |
+| **clean** | 清理工具（删除未使用镜像、容器、卷，释放磁盘空间）|
 
 ### 离线服务器部署
 
 1. **在开发机打包**：
+   > 注意：此命令需要在 **源码模式** 下运行（项目根目录包含 package.json）。
 ```bash
 # 生成离线包
 npx nodebbs pack
@@ -266,131 +125,29 @@ vi .env
 ./install.sh
 ```
 
-
-
 ## ⚙️ 环境配置
 
 ### 支持的环境
 
-- **basic** - 基础环境（仅用于测试）
-- **lowmem** - 低配环境（1C1G/1C2G）
-- **production** - 生产环境（2C4G+，推荐）
+- **production** - 生产环境（推荐，启用资源限制与安全配置）
+- **lowmem** - 低配环境（适用于 1C2G 服务器）
+- **basic** - 基础环境（测试用，无资源限制）
 
 ### 环境变量
 
-在 `.env` 文件中配置：
+CLI 首次运行时会引导生成 `.env` 文件。
+在 **镜像模式** 下，会额外生成：
 
 ```env
-# 数据库配置
-POSTGRES_PASSWORD=your_secure_password
-POSTGRES_DB=nodebbs
-
-# Redis 配置
-REDIS_PASSWORD=your_redis_password
-
-# JWT 配置
-JWT_SECRET=your_jwt_secret
-
-# 应用配置
-APP_URL=http://localhost:3100
-API_URL=http://localhost:7100
-
-# CORS 配置
-CORS_ORIGIN=*
-```
-
-> **提示**：可以使用 `openssl rand -hex 32` 命令生成安全的随机密钥。
-
-### 环境持久化
-
-CLI 会自动记住您上次启动的环境：
-
-1. 当您运行 `nodebbs start` 并选择环境（如 `production`）后，CLI 会在当前目录创建 `.nodebbs-env` 文件记录该选择。
-2. 后续运行 `nodebbs logs`, `nodebbs status` 等命令时，会自动使用该环境，无需再次指定 `-e production`。
-3. 运行 `nodebbs stop` 成功停止服务后，会自动删除 `.nodebbs-env` 文件。
-
-**注意**：如果您需要临时操作其他环境，仍然可以使用 `-e` 参数强制指定，例如 `nodebbs logs -e basic`。
-
-## 🛠️ 高级用法
-
-### 内置模板
-
-NodeBBS CLI 内置了 Docker Compose 配置文件，即使项目中没有这些文件，也可以直接使用：
-
-```bash
-# 在任何目录运行
-npx nodebbs start
-```
-
-CLI 会自动：
-1. 检查当前目录是否有 `docker-compose.yml`
-2. 如果没有，使用内置模板
-3. 使用当前目录作为项目目录
-
-### 自定义配置
-
-如果需要自定义配置，在项目根目录创建：
-- `docker-compose.yml` - 基础配置
-- `docker-compose.prod.yml` - 生产环境配置
-- `docker-compose.lowmem.yml` - 低配环境配置
-
-CLI 会优先使用本地配置文件。
-
-## 🐛 故障排除
-
-### 服务启动失败
-
-```bash
-# 查看日志
-npx nodebbs logs
-
-# 查看特定服务日志
-npx nodebbs logs:api
-
-# 检查服务状态
-npx nodebbs status
-```
-
-### 数据库连接问题
-
-```bash
-# 进入数据库检查
-npx nodebbs shell:db
-
-# 重置数据库
-npx nodebbs db:reset
-```
-
-### 端口冲突
-
-检查以下端口是否被占用：
-- 3100 - Web 前端
-- 7100 - API 服务
-- 5432 - PostgreSQL
-- 6379 - Redis
-
-### 清理环境
-
-```bash
-# 停止所有服务
-npx nodebbs stop
-
-# 停止并删除所有数据（危险！）
-npx nodebbs stop --volumes
+API_IMAGE=ghcr.io/aiprojecthub/nodebbs-api:latest
+WEB_IMAGE=ghcr.io/aiprojecthub/nodebbs-web:latest
 ```
 
+如需升级至特定版本，修改 `.env` 中的版本号后运行 `nodebbs upgrade` 即可。
 ## 🔗 相关链接
 
 - [NodeBBS 项目](https://github.com/aiprojecthub/nodebbs)
 - [问题反馈](https://github.com/aiprojecthub/nodebbs/issues)
-
-## 💡 提示
-
-- 使用 `npx nodebbs --help` 查看所有可用命令
-- 使用 `npx nodebbs [command] --help` 查看特定命令的帮助
-- 所有命令都支持 `--help` 参数
-- 建议在生产环境使用前先在测试环境验证
-
 ---
 
 Made with ❤️ by NodeBBS Team

package/dist/commands/db/import.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class DbImport extends Command {
+    static description: string;
+    static flags: {
+        env: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        input: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/db/import.js

@@ -0,0 +1,115 @@
+import { Command, Flags } from '@oclif/core';
+import { getComposeFiles } from '../../utils/docker.js';
+import { logger } from '../../utils/logger.js';
+import { execa } from 'execa';
+import fs from 'node:fs';
+import path from 'node:path';
+import dotenv from 'dotenv';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
+import { confirm, select, input } from '@inquirer/prompts';
+export default class DbImport extends Command {
+    static description = '导入数据库 (从 SQL 文件恢复)';
+    static flags = {
+        env: EnvFlag,
+        input: Flags.string({
+            char: 'i',
+            description: '输入文件路径',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbImport);
+        // 1. 选择环境
+        const env = await selectEnvironment(flags.env);
+        // 2. 确定输入文件
+        let inputFile = flags.input;
+        if (!inputFile) {
+            // 尝试自动查找当前目录下的 .sql 文件
+            const files = fs.readdirSync(process.cwd())
+                .filter(f => f.endsWith('.sql'))
+                .sort((a, b) => {
+                // 尝试按时间倒序 (虽然文件名可能有时间戳，但用文件修改时间更准)
+                const statA = fs.statSync(a);
+                const statB = fs.statSync(b);
+                return statB.mtime.getTime() - statA.mtime.getTime();
+            });
+            if (files.length > 0) {
+                const choices = files.map(f => ({
+                    name: `${f} (${(fs.statSync(f).size / 1024 / 1024).toFixed(2)} MB)`,
+                    value: f
+                }));
+                choices.push({ name: '手动输入路径', value: '__MANUAL__' });
+                const selection = await select({
+                    message: '请选择导入文件:',
+                    choices: choices,
+                });
+                if (selection === '__MANUAL__') {
+                    inputFile = await input({ message: '请输入文件路径:' });
+                }
+                else {
+                    inputFile = selection;
+                }
+            }
+            else {
+                inputFile = await input({ message: '未找到 SQL 文件，请输入路径:' });
+            }
+        }
+        // 确保绝对路径并检查是否存在
+        const inputPath = path.resolve(process.cwd(), inputFile);
+        if (!fs.existsSync(inputPath)) {
+            logger.error(`文件未找到: ${inputPath}`);
+            this.exit(1);
+        }
+        // 3. 危险操作确认
+        logger.warning('警告: 此操作将清空当前数据库的所有数据并从备份恢复！');
+        logger.warning(`目标文件: ${inputPath}`);
+        const isConfirmed = await confirm({
+            message: '确认继续？(数据丢失不可撤销)',
+            default: false
+        });
+        if (!isConfirmed) {
+            logger.info('操作已取消');
+            this.exit(0);
+        }
+        // 4. 获取 Compose 文件
+        const { files, isBuiltIn } = await getComposeFiles(env);
+        const composeArgs = files.flatMap(f => ['-f', f]);
+        if (isBuiltIn) {
+            composeArgs.push('--project-directory', process.cwd());
+        }
+        // 加载环境配置获取数据库信息 (用于可能的连接参数，虽然 docker exec 默认用 postgres 用户通常足够)
+        const envConfig = dotenv.config().parsed || {};
+        const dbUser = envConfig.POSTGRES_USER || 'postgres';
+        const dbName = envConfig.POSTGRES_DB || 'nodebbs';
+        const dbPassword = envConfig.POSTGRES_PASSWORD;
+        // 5. 执行恢复
+        logger.info('正在准备恢复数据库...');
+        try {
+            // 步骤 A: 重置 Schema (Drop & Create public)
+            // 这样做比单纯导入更干净，因为 pg_dump 默认可能不包含 DROP TABLE
+            logger.info('正在重置数据库 Schema...');
+            const resetCmd = [...composeArgs, 'exec', '-T', 'postgres', 'psql', '-U', dbUser, '-d', dbName, '-c', 'DROP SCHEMA public CASCADE; CREATE SCHEMA public;'];
+            // 如果有密码
+            const envs = process.env;
+            if (dbPassword)
+                envs.PGPASSWORD = dbPassword;
+            await execa('docker', ['compose', ...resetCmd], { env: envs });
+            logger.success('数据库 Schema 已重置');
+            // 步骤 B: 导入数据
+            logger.info(`正在导入数据 from ${path.basename(inputPath)}...`);
+            const importCmd = [...composeArgs, 'exec', '-T', 'postgres', 'psql', '-U', dbUser, '-d', dbName];
+            const subprocess = execa('docker', ['compose', ...importCmd], {
+                env: envs,
+                input: fs.createReadStream(inputPath)
+            });
+            await subprocess;
+            logger.success('数据库导入成功！');
+        }
+        catch (error) {
+            logger.error('数据库导入失败');
+            if (error instanceof Error) {
+                logger.error(error.message);
+            }
+            this.exit(1);
+        }
+    }
+}