nodebbs 0.0.8 → 0.1.0

package/README.md

@@ -15,7 +15,7 @@ NodeBBS CLI 是一个专为全栈开发者设计的命令行工具，用于简
 - 🎯 **全栈友好** - 命令设计贴近开发者思维
 - 📊 **实时日志** - 方便查看各服务日志
 - 💾 **数据库管理** - 内置数据库迁移和管理工具
-- 🌐 **内置模板** - 无需本地配置文件即可使用
+- 🌐 **内置模板** - 无需本地配置文件即可通过远程镜像快速部署
 
 ## 📦 安装
 
@@ -46,7 +46,7 @@ npx nodebbs [command]
 npx nodebbs
 ```
 - **start**： 开始部署（首次使用推荐选择此项）
-- **rebuild**： 重新构建并启动（跳过检查，通常在代码更新后选择此项）
+- **rebuild**： 更新并重启（Pull & Restart，代码/镜像更新后使用）
 
 ## 📚 命令参考
 
@@ -60,21 +60,25 @@ npx nodebbs start
 # 指定环境启动
 npx nodebbs start -e production
 
-# 重新构建并启动（跳过检查）
-npx nodebbs start --build
-```
-
 **参数**：
-- `-e, --env` - 部署环境（production, lowmem, basic）
-- `-b, --build` - 重新构建镜像并启动（跳过健康检查和初始化）
+- `-e, --env` - 部署环境（production, lowmem）
+- `-t, --tag` - 镜像版本 tag (默认: latest)
 
 启动流程包含：
 - Docker 环境检查
 - 环境变量验证
-- 镜像构建
+- 拉取最新镜像
 - 服务启动
-- 健康检查（默认开启，使用 `--build` 跳过）
-- 数据库初始化（默认开启，使用 `--build` 跳过）
+- 健康检查（默认开启）
+- 数据库初始化（默认开启）
+
+#### `nodebbs rebuild`
+拉取最新镜像并重启服务 (Update & Restart)
+
+```bash
+npx nodebbs rebuild
+```
+> 此命令是 `start` 的别名，用于快速更新部署。
 
 #### `nodebbs restart`
 重启所有服务（不更新镜像，支持环境选择）
@@ -272,9 +276,8 @@ vi .env
 
 ### 支持的环境
 
-- **basic** - 基础环境（仅用于测试）
 - **lowmem** - 低配环境（1C1G/1C2G）
-- **production** - 生产环境（2C4G+，推荐）
+- **production** - 生产环境（标准配置，推荐）
 
 ### 环境变量
 
@@ -309,7 +312,7 @@ CLI 会自动记住您上次启动的环境：
 2. 后续运行 `nodebbs logs`, `nodebbs status` 等命令时，会自动使用该环境，无需再次指定 `-e production`。
 3. 运行 `nodebbs stop` 成功停止服务后，会自动删除 `.nodebbs-env` 文件。
 
-**注意**：如果您需要临时操作其他环境，仍然可以使用 `-e` 参数强制指定，例如 `nodebbs logs -e basic`。
+**注意**：如果您需要临时操作其他环境，仍然可以使用 `-e` 参数强制指定，例如 `nodebbs logs -e lowmem`。
 
 ## 🛠️ 高级用法
 
@@ -330,9 +333,8 @@ CLI 会自动：
 ### 自定义配置
 
 如果需要自定义配置，在项目根目录创建：
-- `docker-compose.yml` - 基础配置
-- `docker-compose.prod.yml` - 生产环境配置
-- `docker-compose.lowmem.yml` - 低配环境配置
+- `docker-compose.yml` - 基础/生产环境配置
+- `docker-compose.lowmem.yml` - 低配环境配置 (Override)
 
 CLI 会优先使用本地配置文件。
 

package/dist/commands/clean/index.d.ts

@@ -5,6 +5,7 @@ export default class Clean extends Command {
         all: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         cache: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         images: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;

package/dist/commands/clean/index.js

@@ -2,12 +2,13 @@ import { Command, Flags } from '@oclif/core';
 import { checkbox, confirm } from '@inquirer/prompts';
 import { logger } from '../../utils/logger.js';
 import { execa } from 'execa';
+import { clearStoredEnv } from '../../utils/selection.js';
 export default class Clean extends Command {
     static description = '清理 Docker 缓存和残留资源';
     static flags = {
         all: Flags.boolean({
             char: 'a',
-            description: '清理所有 (构建缓存、无用镜像、网络)',
+            description: '清理所有 (构建缓存、无用镜像、网络、环境锁定)',
             default: false,
         }),
         cache: Flags.boolean({
@@ -18,6 +19,10 @@ export default class Clean extends Command {
             description: '清理无用镜像 (dangling)',
             default: false,
         }),
+        env: Flags.boolean({
+            description: '清理环境锁定 (Environment Lock)',
+            default: false,
+        }),
         force: Flags.boolean({
             char: 'f',
             description: '跳过确认提示',
@@ -29,13 +34,15 @@ export default class Clean extends Command {
         let targets = [];
         // 根据标志确定清理目标
         if (flags.all) {
-            targets = ['cache', 'images', 'networks'];
+            targets = ['cache', 'images', 'networks', 'env'];
         }
         else {
             if (flags.cache)
                 targets.push('cache');
             if (flags.images)
                 targets.push('images');
+            if (flags.env)
+                targets.push('env');
         }
         // 如果未提供标志，进行交互式选择
         if (targets.length === 0) {
@@ -45,6 +52,7 @@ export default class Clean extends Command {
                     { name: '构建缓存 (Build Cache)', value: 'cache' },
                     { name: '无用镜像 (Dangling Images)', value: 'images' },
                     { name: '无用网络 (Unused Networks)', value: 'networks' },
+                    { name: '环境锁定 (Environment Lock)', value: 'env' },
                 ],
             });
         }
@@ -81,6 +89,11 @@ export default class Clean extends Command {
                 await execa('docker', ['network', 'prune', '-f'], { stdio: 'inherit' });
                 logger.success('无用网络已清理');
             }
+            if (targets.includes('env')) {
+                logger.info('正在清除环境锁定...');
+                await clearStoredEnv();
+                logger.success('环境锁定已移除');
+            }
         }
         catch (error) {
             logger.error('清理过程中发生错误');

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

@@ -0,0 +1,10 @@
+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>;
+        file: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/db/import.js

@@ -0,0 +1,87 @@
+import { Command, Flags } from '@oclif/core';
+import { confirm } from '@inquirer/prompts';
+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';
+export default class DbImport extends Command {
+    static description = '导入数据库 (PostgreSQL)';
+    static flags = {
+        env: EnvFlag,
+        file: Flags.string({
+            char: 'f',
+            description: 'SQL 备份文件路径',
+            required: true,
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: '跳过确认提示',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbImport);
+        // 1. 选择环境
+        const env = await selectEnvironment(flags.env);
+        // 2. 验证文件
+        const inputPath = path.resolve(process.cwd(), flags.file);
+        if (!fs.existsSync(inputPath)) {
+            logger.error(`找不到备份文件: ${inputPath}`);
+            this.exit(1);
+        }
+        // 3. 用户确认
+        if (!flags.yes) {
+            logger.warning('警告：此操作将覆盖当前数据库中的数据！');
+            const confirmImport = await confirm({
+                message: `确认从 ${flags.file} 恢复数据库？`,
+                default: false
+            });
+            if (!confirmImport) {
+                logger.info('操作已取消。');
+                this.exit(0);
+            }
+        }
+        // 4. 获取 Compose 文件
+        const { files, isBuiltIn } = await getComposeFiles(env);
+        logger.info(`正在从文件恢复数据库: ${inputPath}`);
+        logger.info('环境: ' + env);
+        // 加载环境配置
+        const envConfig = dotenv.config().parsed || {};
+        const dbUser = envConfig.POSTGRES_USER || 'postgres';
+        const dbName = envConfig.POSTGRES_DB || 'nodebbs';
+        const dbPassword = envConfig.POSTGRES_PASSWORD;
+        // 5. 构建 Compose 参数
+        const composeArgs = files.flatMap(f => ['-f', f]);
+        if (isBuiltIn) {
+            composeArgs.push('--project-directory', process.cwd());
+        }
+        // 6. 运行 psql
+        // const dumpArgs = [...composeArgs, 'exec', '-T'] // backup uses exec
+        // import should also use exec -T to accept stdin
+        const importArgs = [...composeArgs, 'exec', '-T'];
+        // 如果有密码则注入
+        if (dbPassword) {
+            importArgs.push('-e', `PGPASSWORD=${dbPassword}`);
+        }
+        importArgs.push('postgres', 'psql', '-U', dbUser, '-d', dbName);
+        try {
+            const subprocess = execa('docker', ['compose', ...importArgs], {
+                input: fs.createReadStream(inputPath)
+            });
+            // subprocess.stdout?.pipe(process.stdout)
+            // subprocess.stderr?.pipe(process.stderr)
+            await subprocess;
+            logger.success('数据库导入成功！');
+        }
+        catch (error) {
+            logger.error('数据库导入失败');
+            if (error instanceof Error) {
+                logger.error(error.message);
+            }
+            this.exit(1);
+        }
+    }
+}

package/dist/commands/pack/index.js

@@ -4,6 +4,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as os from 'os';
 import { getTemplatePath } from '../../utils/template.js';
+import { checkDocker } from '../../utils/docker.js';
 export default class Pack extends Command {
     static description = '生成离线部署包';
     static flags = {
@@ -13,12 +14,7 @@ export default class Pack extends Command {
         const { flags } = await this.parse(Pack);
         const outputPath = path.resolve(flags.output);
         // 检查 docker 是否可用
-        try {
-            await execa('docker', ['--version']);
-        }
-        catch {
-            this.error('无法执行 docker 命令，请确保 Docker 已安装并运行。');
-        }
+        await checkDocker();
         // 1. 准备临时目录
         const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'nodebbs-pack-'));
         this.log(`正在准备构建环境: ${tmpDir}`);
@@ -30,7 +26,6 @@ export default class Pack extends Command {
             // 但既然是打包，通常是想把当前开发好的代码打包。
             // 所以我们假设在项目根目录运行。
             if (!fs.existsSync('docker-compose.yml')) {
-                this.warn('当前目录未找到 docker-compose.yml，将使用内置模板。');
                 // TODO: 从 templates 复制 (简化起见，我们假设用户在项目根目录，或者我们强制要求)
                 // 如果没找到，我们实际上无法 build api/web，因为 build context 需要源码。
                 // 所以必须要求在项目根目录运行。
@@ -79,9 +74,6 @@ export default class Pack extends Command {
                 return line;
             });
             fs.writeFileSync(path.join(tmpDir, 'docker-compose.yml'), cleanedLines.join('\n'));
-            if (fs.existsSync('docker-compose.prod.yml')) {
-                fs.copyFileSync('docker-compose.prod.yml', path.join(tmpDir, 'docker-compose.prod.yml'));
-            }
             if (fs.existsSync('.env')) {
                 this.warn('检测到 .env 文件，出于安全考虑，不会默认打包 .env 文件。请在部署时手动配置环境变量。');
             }
@@ -122,7 +114,9 @@ services:
     image: nodebbs-web:latest
 EOF
 
-docker compose -f docker-compose.yml -f docker-compose.prod.yml -f docker-compose.override.yml up -d
+COMPOSE_FILES="-f docker-compose.yml -f docker-compose.override.yml"
+
+docker compose \$COMPOSE_FILES up -d
 
 echo "部署完成！"
 `;

package/dist/commands/rebuild/index.js

@@ -1,11 +1,11 @@
 import { Command } from '@oclif/core';
 import Start from '../start/index.js';
 export default class Rebuild extends Command {
-    static description = '重新构建并启动服务 (start --build)';
+    static description = '拉取最新镜像并重启服务 (Update & Restart)';
     // Allow passing flags like -e to the underlying start command
     static strict = false;
     async run() {
-        // Invoke Start command with --build flag and any other arguments
-        await Start.run(['--build', ...this.argv]);
+        // Invoke Start command to pull latest images and restart
+        await Start.run(this.argv);
     }
 }

package/dist/commands/restart/index.js

@@ -1,7 +1,7 @@
 import { Command } from '@oclif/core';
 import { runCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
-import { EnvFlag, selectEnvironment, setStoredEnv } from '../../utils/selection.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Restart extends Command {
     static description = '重启所有服务 (up --force-recreate)';
     static flags = {
@@ -11,7 +11,6 @@ export default class Restart extends Command {
         const { flags } = await this.parse(Restart);
         // 1. 选择环境
         const env = await selectEnvironment(flags.env);
-        await setStoredEnv(env);
         const { files, isBuiltIn } = await getComposeFiles(env);
         logger.info('正在重启服务 (使用现有镜像)...');
         logger.info('环境: ' + env);

package/dist/commands/start/index.d.ts

@@ -3,7 +3,7 @@ export default class Start extends Command {
     static description: string;
     static flags: {
         env: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        build: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        tag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/start/index.js

@@ -4,28 +4,22 @@ import { checkDocker, runCompose, waitForHealth, execCompose, getComposeFiles }
 import { initEnv, checkEnv } from '../../utils/env.js';
 import { logger } from '../../utils/logger.js';
 import dotenv from 'dotenv';
-import { EnvFlag, selectEnvironment, setStoredEnv } from '../../utils/selection.js';
+import { input } from '@inquirer/prompts';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Start extends Command {
     static description = '开始部署';
     static flags = {
         env: EnvFlag,
-        build: Flags.boolean({
-            char: 'b',
-            description: '重新构建并启动服务 (跳过健康检查和数据初始化)',
-            default: false,
+        tag: Flags.string({
+            char: 't',
+            description: 'Image version tag (e.g. latest, v0.1.0)',
         }),
     };
     async run() {
         const { flags } = await this.parse(Start);
-        if (flags.build) {
-            logger.header('NodeBBS 重新构建启动');
-        }
-        else {
-            logger.header('NodeBBS Docker 部署');
-        }
+        logger.header('NodeBBS Docker 部署');
         // 1. 选择环境
         const env = await selectEnvironment(flags.env);
-        await setStoredEnv(env);
         // 2. 获取 Compose 文件
         const { files: composeFiles, isBuiltIn } = await getComposeFiles(env);
         if (isBuiltIn) {
@@ -40,69 +34,83 @@ export default class Start extends Command {
         else if (env === 'lowmem') {
             logger.success('已选择：低配环境');
         }
-        else {
-            logger.success('已选择：基础环境');
-            if (!flags.build) {
-                logger.warning('注意：无资源限制，不推荐用于生产环境。');
-            }
-        }
         // 3. 检查 Docker 和环境变量
         await checkDocker();
         // initEnv 保证 .env 存在（或退出）
         await initEnv();
         await checkEnv(env);
-        if (!flags.build) {
-            const continueDeploy = await confirm({
-                message: '是否继续启动？',
-                default: true
+        // 如果不是本地构建，则询问镜像版本
+        // 先加载环境变量以获取当前的 IMAGE 配置（如果有）
+        const envConfig = dotenv.config().parsed || {};
+        let tag = flags.tag;
+        if (!tag) {
+            tag = await input({
+                message: '请选择要部署的镜像版本:',
+                default: 'latest'
             });
-            if (!continueDeploy) {
-                logger.info('操作已取消。');
-                this.exit(0);
-            }
         }
-        // 4. 构建并启动服务
-        if (flags.build) {
-            logger.info('正在重新构建并启动服务...');
-            await runCompose(composeFiles, ['up', '-d', '--build'], isBuiltIn);
-            logger.success('服务已重新构建并启动');
+        // 构造新的镜像名称
+        // 逻辑：如果 .env 里定义了 API_IMAGE，则解析出 registry/name 部分，然后拼接 tag
+        // 否则使用默认 registry
+        const defaultApiImage = 'ghcr.io/aiprojecthub/nodebbs-api';
+        const defaultWebImage = 'ghcr.io/aiprojecthub/nodebbs-web';
+        let currentApiImage = envConfig.API_IMAGE || defaultApiImage;
+        let currentWebImage = envConfig.WEB_IMAGE || defaultWebImage;
+        const replaceTag = (image, newTag) => {
+            const parts = image.split(':');
+            if (parts.length > 1 && !parts[parts.length - 1].includes('/')) {
+                // 最后一个部分不包含 '/'，认为是 tag
+                parts.pop();
+            }
+            return `${parts.join(':')}:${newTag}`;
+        };
+        process.env.API_IMAGE = replaceTag(currentApiImage, tag);
+        process.env.WEB_IMAGE = replaceTag(currentWebImage, tag);
+        logger.info(`将部署版本: ${tag}`);
+        logger.info(`API Image: ${process.env.API_IMAGE}`);
+        logger.info(`Web Image: ${process.env.WEB_IMAGE}`);
+        const continueDeploy = await confirm({
+            message: '是否继续启动？',
+            default: true
+        });
+        if (!continueDeploy) {
+            logger.info('操作已取消。');
+            this.exit(0);
         }
-        else {
-            logger.info('正在构建 Docker 镜像...');
-            await runCompose(composeFiles, ['build', '--no-cache'], isBuiltIn);
-            logger.success('镜像构建完成');
-            logger.info('正在启动服务...');
-            await runCompose(composeFiles, ['up', '-d'], isBuiltIn);
-            logger.success('服务启动指令已发送');
+        // 4. 拉取并启动服务
+        logger.info('正在拉取最新的 Docker 镜像...');
+        await runCompose(composeFiles, ['pull'], isBuiltIn);
+        logger.success('镜像拉取完成');
+        logger.info('正在启动服务...');
+        await runCompose(composeFiles, ['up', '-d'], isBuiltIn);
+        logger.success('服务启动指令已发送');
+        // 5. 启动后操作
+        await waitForHealth(composeFiles, isBuiltIn);
+        const pushDb = await confirm({
+            message: '是否推送数据库 schema？',
+            default: false
+        });
+        if (pushDb) {
+            logger.info('正在推送数据库 schema...');
+            await execCompose(composeFiles, 'api', ['npm', 'run', 'db:push'], isBuiltIn);
+            logger.success('数据库 schema 推送完成');
         }
-        // 5. 启动后操作 (仅完整部署)
-        if (!flags.build) {
-            await waitForHealth(composeFiles, isBuiltIn);
-            const pushDb = await confirm({
-                message: '是否推送数据库 schema？',
-                default: false
-            });
-            if (pushDb) {
-                logger.info('正在推送数据库 schema...');
-                await execCompose(composeFiles, 'api', ['npm', 'run', 'db:push'], isBuiltIn);
-                logger.success('数据库 schema 推送完成');
-            }
-            const seedDb = await confirm({
-                message: '是否初始化种子数据？',
-                default: false
-            });
-            if (seedDb) {
-                logger.info('正在初始化数据...');
-                await execCompose(composeFiles, 'api', ['npm', 'run', 'seed'], isBuiltIn);
-                logger.success('数据初始化完成');
-            }
+        const seedDb = await confirm({
+            message: '是否初始化种子数据？',
+            default: false
+        });
+        if (seedDb) {
+            logger.info('正在初始化数据...');
+            await execCompose(composeFiles, 'api', ['npm', 'run', 'seed'], isBuiltIn);
+            logger.success('数据初始化完成');
         }
-        logger.header(flags.build ? '启动成功！' : 'NodeBBS 启动成功！');
+        logger.header('NodeBBS 启动成功！');
         // 6. 显示信息
         logger.info(`环境: ${env}`);
-        const envConfig = dotenv.config().parsed || {};
-        const webPort = envConfig.WEB_PORT || '3100';
-        const apiPort = envConfig.API_PORT || '7100';
+        // 复用之前的 envConfig 或重新读取 (这里直接复用即可，或者为了保险重新读取但不要 redeclare)
+        const finalEnvConfig = dotenv.config().parsed || {};
+        const webPort = finalEnvConfig.WEB_PORT || '3100';
+        const apiPort = finalEnvConfig.API_PORT || '7100';
         console.log(`  Web 前端: http://localhost:${webPort}`);
         console.log(`  API 服务: http://localhost:${apiPort}`);
         console.log(`  API 文档: http://localhost:${apiPort}/docs`);

package/dist/commands/stop/index.js

@@ -2,7 +2,7 @@ import { Command, Flags } from '@oclif/core';
 import { runCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
 import { confirm } from '@inquirer/prompts';
-import { EnvFlag, selectEnvironment, clearStoredEnv } from '../../utils/selection.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Stop extends Command {
     static description = '停止服务';
     static flags = {
@@ -32,13 +32,11 @@ export default class Stop extends Command {
             }
             logger.info('正在停止服务并删除数据卷...');
             await runCompose(files, ['down', '-v'], isBuiltIn);
-            await clearStoredEnv();
             logger.success('服务已停止，数据卷已删除');
         }
         else {
             logger.info('正在停止服务...');
             await runCompose(files, ['down'], isBuiltIn);
-            await clearStoredEnv();
             logger.success('服务已停止');
         }
     }

package/dist/interactive.js

@@ -147,7 +147,7 @@ async function navigate(node, breadcrumbs, config) {
                         console.log('\n操作已取消。');
                         continue;
                     }
-                    console.error(error);
+                    console.error(error.message);
                 }
                 console.log('\n命令执行完成。');
                 // 动态导入 input 以保持轻量
@@ -178,7 +178,7 @@ async function navigate(node, breadcrumbs, config) {
                         console.log('\n操作已取消。');
                         continue;
                     }
-                    console.error(error);
+                    console.error(error.message);
                 }
                 console.log('\n命令执行完成。');
                 // 动态导入 input 以保持轻量