nodebbs 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,6 @@
 # NodeBBS CLI
 
-> 全栈友好的 NodeBBS 部署和管理命令行工具
+> NodeBBS 论坛系统专业运维工具
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/nodebbs.svg)](https://npmjs.org/package/nodebbs)
@@ -11,7 +11,8 @@ NodeBBS CLI 是一个专为全栈开发者设计的命令行工具，用于简
 
 ### 特性
 
-- 🚀 **快速启动** - 一键启动开发环境
+- �️ **交互式菜单** - 支持键盘导航的可视化命令选择（新增）
+- �🚀 **快速启动** - 一键启动开发环境
 - 🎯 **全栈友好** - 命令设计贴近开发者思维
 - 🔧 **服务级控制** - 可以单独管理每个服务
 - 📊 **实时日志** - 方便查看各服务日志
@@ -32,44 +33,36 @@ pnpm add -g nodebbs
 yarn global add nodebbs
 ```
 
-或者直接使用 npx（无需安装）：
+或者直接使用 npx（推荐）：
 
 ```bash
+# 进入交互式菜单（推荐）
+npx nodebbs
+
+# 运行特定命令
 npx nodebbs [command]
 ```
 
 ## 🚀 快速开始
 
-### 1. 初始化项目
-
-```bash
-# 首次使用，初始化项目环境
-npx nodebbs setup
-```
-
-这会创建 `.env` 文件，请编辑该文件并修改：
-- `POSTGRES_PASSWORD` - 数据库密码
-- `REDIS_PASSWORD` - Redis 密码
-- `JWT_SECRET` - JWT 密钥
-
-### 2. 启动开发环境
+### 1. 启动服务
 
 ```bash
-# 启动所有服务
-npx nodebbs dev
+# 启动所有服务（生产模式，包含完整检查）
+npx nodebbs start
 
-# 或者重新构建并启动
-npx nodebbs dev --rebuild
+# 重新构建并启动（跳过检查，用于更新）
+npx nodebbs start --build
 ```
 
-### 3. 查看服务状态
+### 2. 查看服务状态
 
 ```bash
 # 查看所有服务状态
 npx nodebbs status
 ```
 
-### 4. 访问应用
+### 3. 访问应用
 
 - **Web 前端**: http://localhost:3100
 - **API 文档**: http://localhost:7100/docs
@@ -77,61 +70,46 @@ npx nodebbs status
 
 ## 📚 命令参考
 
-### 核心命令
-
-#### `nodebbs setup`
-初始化项目（首次使用）
+#### `nodebbs start`
+开始部署
 
 ```bash
-npx nodebbs setup
-```
-
-#### `nodebbs dev`
-启动开发环境
-
-```bash
-# 启动所有服务
-npx nodebbs dev
-
-# 重新构建并启动
-npx nodebbs dev --rebuild
-npx nodebbs dev -r
+# 交互式启动
+npx nodebbs start
 
 # 指定环境启动
-npx nodebbs dev -e production
-npx nodebbs dev -e lowmem
-npx nodebbs dev -e basic
+npx nodebbs start -e production
+
+# 重新构建并启动（跳过检查）
+npx nodebbs start --build
 ```
 
 **参数**：
 - `-e, --env` - 部署环境（production, lowmem, basic）
-- `-r, --rebuild` - 重新构建镜像
-
-#### `nodebbs deploy`
-部署到生产环境
+- `-b, --build` - 重新构建镜像并启动（跳过健康检查和初始化）
 
-```bash
-# 完整部署流程
-npx nodebbs deploy
-
-# 指定环境部署
-npx nodebbs deploy -e production
-```
-
-包含：
+启动流程包含：
 - 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
@@ -141,27 +119,25 @@ npx nodebbs stop -v
 **参数**：
 - `-v, --volumes` - 同时删除数据卷
 
-#### `nodebbs restart`
-重启所有服务
-
-```bash
-npx nodebbs restart
-```
-
 #### `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`
@@ -194,11 +170,14 @@ npx nodebbs logs:redis
 
 ### Shell 访问
 
-#### `nodebbs shell:api`
-进入 API 容器
+#### `nodebbs shell`
+进入容器 Shell (支持 api, web, db, redis)
 
 ```bash
+# 进入 API 容器
 npx nodebbs shell:api
+# 进入生产环境 API 容器
+npx nodebbs shell:api -e production
 ```
 
 #### `nodebbs shell:web`
@@ -224,12 +203,7 @@ npx nodebbs shell:redis
 
 ### 数据库管理
 
-#### `nodebbs db`
-打开数据库管理界面（Drizzle Studio）
 
-```bash
-npx nodebbs db
-```
 
 #### `nodebbs db:generate`
 生成数据库迁移文件
@@ -266,30 +240,49 @@ npx nodebbs db:seed
 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
+```
+
 ## 🎯 使用场景
 
 ### 场景 1：新开发者加入项目
 
 ```bash
-# 1. 初始化项目
-npx nodebbs setup
-
-# 2. 启动开发环境
-npx nodebbs dev
+# 1. 启动服务
+npx nodebbs start
 
-# 3. 初始化数据库
+# 2. 初始化数据库
 npx nodebbs db:push
 npx nodebbs db:seed
 
-# 4. 查看服务状态
+# 3. 查看服务状态
 npx nodebbs status
 ```
 
 ### 场景 2：日常开发
 
 ```bash
-# 启动开发环境
-npx nodebbs dev
+# 启动服务
+npx nodebbs start
 
 # 查看 API 日志
 npx nodebbs logs:api
@@ -297,8 +290,7 @@ npx nodebbs logs:api
 # 进入 API 容器调试
 npx nodebbs shell:api
 
-# 打开数据库管理
-npx nodebbs db
+
 
 # 重置测试数据
 npx nodebbs db:reset
@@ -311,7 +303,7 @@ npx nodebbs db:reset
 npx nodebbs stop
 
 # 重新构建并启动
-npx nodebbs dev --rebuild
+npx nodebbs start --build
 
 # 查看日志确认启动成功
 npx nodebbs logs
@@ -321,7 +313,7 @@ npx nodebbs logs
 
 ```bash
 # 部署到生产环境
-npx nodebbs deploy -e production
+npx nodebbs start -e production
 
 # 查看服务状态
 npx nodebbs status
@@ -336,8 +328,7 @@ npx nodebbs db:migrate
 ### 场景 5：数据库操作
 
 ```bash
-# 打开数据库管理界面
-npx nodebbs db
+
 
 # 运行迁移
 npx nodebbs db:migrate
@@ -355,18 +346,16 @@ npx nodebbs shell:db
 
 | Makefile 命令 | NodeBBS CLI 命令 |
 |--------------|-----------------|
-| `make init` | `npx nodebbs setup` |
-| `make up` | `npx nodebbs dev` |
-| `make build` | `npx nodebbs dev --rebuild` |
-| `make rebuild` | `npx nodebbs dev --rebuild` |
-| `ENV=prod make rebuild` | `npx nodebbs deploy -e production` |
+| `make up` | `npx nodebbs start` |
+| `make build` | `npx nodebbs start --build` |
+| `make rebuild` | `npx nodebbs start --build` |
+| `ENV=prod make rebuild` | `npx nodebbs start -e production --build` |
 | `make down` | `npx nodebbs stop` |
-| `make restart` | `npx nodebbs restart` |
 | `make ps` | `npx nodebbs status` |
 | `make logs` | `npx nodebbs logs` |
 | `make logs-api` | `npx nodebbs logs:api` |
 | `make exec-api` | `npx nodebbs shell:api` |
-| `make db-studio` | `npx nodebbs db` |
+
 | `make clean-all` | `npx nodebbs stop --volumes` |
 
 ## ⚙️ 环境配置
@@ -400,6 +389,18 @@ API_URL=http://localhost:7100
 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`。
+
 ## 🛠️ 高级用法
 
 ### 内置模板
@@ -408,7 +409,7 @@ NodeBBS CLI 内置了 Docker Compose 配置文件，即使项目中没有这些
 
 ```bash
 # 在任何目录运行
-npx nodebbs dev
+npx nodebbs start
 ```
 
 CLI 会自动：
@@ -474,7 +475,7 @@ npx nodebbs stop --volumes
 
 ```bash
 # 克隆仓库
-git clone https://github.com/nodebbs/nodebbs.git
+git clone https://github.com/aiprojecthub/nodebbs.git
 cd nodebbs
 
 # 安装依赖
@@ -493,26 +494,17 @@ pnpm build
 # 查看帮助
 ./bin/run.js --help
 
-# 测试 dev 命令
-./bin/run.js dev --help
+# 测试 start 命令
+./bin/run.js start --help
 
 # 测试 logs 命令
 ./bin/run.js logs --help
 ```
 
-## 🤝 贡献
-
-欢迎贡献！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。
-
-## 📄 许可证
-
-MIT License - 详见 [LICENSE](LICENSE) 文件
-
 ## 🔗 相关链接
 
-- [NodeBBS 项目](https://github.com/nodebbs/nodebbs)
-- [问题反馈](https://github.com/nodebbs/nodebbs/issues)
-- [更新日志](CHANGELOG.md)
+- [NodeBBS 项目](https://github.com/aiprojecthub/nodebbs)
+- [问题反馈](https://github.com/aiprojecthub/nodebbs/issues)
 
 ## 💡 提示
 

package/bin/dev.js

@@ -2,4 +2,9 @@
 
 import {execute} from '@oclif/core'
 
-await execute({development: true, dir: import.meta.url})
+if (process.argv.length <= 2) {
+  const {runInteractive} = await import('../src/interactive.ts')
+  await runInteractive(import.meta.url)
+} else {
+  await execute({development: true, dir: import.meta.url})
+}

package/bin/run.js

@@ -2,4 +2,9 @@
 
 import {execute} from '@oclif/core'
 
-await execute({dir: import.meta.url})
+if (process.argv.length <= 2) {
+  const {runInteractive} = await import('../dist/interactive.js')
+  await runInteractive(import.meta.url)
+} else {
+  await execute({dir: import.meta.url})
+}

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

@@ -0,0 +1,11 @@
+import { Command } from '@oclif/core';
+export default class Clean extends Command {
+    static description: string;
+    static flags: {
+        all: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        cache: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        images: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/clean/index.js

@@ -0,0 +1,93 @@
+import { Command, Flags } from '@oclif/core';
+import { checkbox, confirm } from '@inquirer/prompts';
+import { logger } from '../../utils/logger.js';
+import { execa } from 'execa';
+export default class Clean extends Command {
+    static description = '清理 Docker 缓存和残留资源';
+    static flags = {
+        all: Flags.boolean({
+            char: 'a',
+            description: '清理所有 (构建缓存、无用镜像、网络)',
+            default: false,
+        }),
+        cache: Flags.boolean({
+            description: '清理构建缓存',
+            default: false,
+        }),
+        images: Flags.boolean({
+            description: '清理无用镜像 (dangling)',
+            default: false,
+        }),
+        force: Flags.boolean({
+            char: 'f',
+            description: '跳过确认提示',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Clean);
+        let targets = [];
+        // 根据标志确定清理目标
+        if (flags.all) {
+            targets = ['cache', 'images', 'networks'];
+        }
+        else {
+            if (flags.cache)
+                targets.push('cache');
+            if (flags.images)
+                targets.push('images');
+        }
+        // 如果未提供标志，进行交互式选择
+        if (targets.length === 0) {
+            targets = await checkbox({
+                message: '请选择要清理的项目：',
+                choices: [
+                    { name: '构建缓存 (Build Cache)', value: 'cache' },
+                    { name: '无用镜像 (Dangling Images)', value: 'images' },
+                    { name: '无用网络 (Unused Networks)', value: 'networks' },
+                ],
+            });
+        }
+        if (targets.length === 0) {
+            logger.info('未选择任何清理项目。');
+            return;
+        }
+        // 确认提示
+        if (!flags.force) {
+            logger.warning(`即将清理: ${targets.join(', ')}`);
+            const confirmed = await confirm({
+                message: '确认继续？',
+                default: false
+            });
+            if (!confirmed) {
+                logger.info('操作已取消。');
+                return;
+            }
+        }
+        // 执行清理
+        try {
+            if (targets.includes('cache')) {
+                logger.info('正在清理构建缓存...');
+                await execa('docker', ['builder', 'prune', '-f'], { stdio: 'inherit' });
+                logger.success('构建缓存已清理');
+            }
+            if (targets.includes('images')) {
+                logger.info('正在清理无用镜像...');
+                await execa('docker', ['image', 'prune', '-f'], { stdio: 'inherit' });
+                logger.success('无用镜像已清理');
+            }
+            if (targets.includes('networks')) {
+                logger.info('正在清理无用网络...');
+                await execa('docker', ['network', 'prune', '-f'], { stdio: 'inherit' });
+                logger.success('无用网络已清理');
+            }
+        }
+        catch (error) {
+            logger.error('清理过程中发生错误');
+            if (error instanceof Error) {
+                logger.error(error.message);
+            }
+            this.exit(1);
+        }
+    }
+}

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

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

package/dist/commands/db/backup.js

@@ -0,0 +1,78 @@
+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';
+export default class DbBackup extends Command {
+    static description = '备份数据库 (PostgreSQL)';
+    static flags = {
+        env: EnvFlag,
+        output: Flags.string({
+            char: 'o',
+            description: '输出文件路径',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbBackup);
+        // 1. 选择环境
+        const env = await selectEnvironment(flags.env);
+        // 2. 确定输出文件
+        let outputFile = flags.output;
+        if (!outputFile) {
+            const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
+            outputFile = `backup_${timestamp}.sql`;
+        }
+        // 确保绝对路径
+        const outputPath = path.resolve(process.cwd(), outputFile);
+        // 3. 获取 Compose 文件
+        const { files, isBuiltIn } = await getComposeFiles(env);
+        logger.info(`正在备份数据库到: ${outputPath}`);
+        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;
+        // 4. 构建 Compose 参数
+        const composeArgs = files.flatMap(f => ['-f', f]);
+        if (isBuiltIn) {
+            composeArgs.push('--project-directory', process.cwd());
+        }
+        // 5. 运行 pg_dump
+        const dumpArgs = [...composeArgs, 'exec', '-T'];
+        // 如果有密码则注入
+        if (dbPassword) {
+            dumpArgs.push('-e', `PGPASSWORD=${dbPassword}`);
+        }
+        dumpArgs.push('postgres', 'pg_dump', '-U', dbUser, dbName);
+        try {
+            const subprocess = execa('docker', ['compose', ...dumpArgs]);
+            if (subprocess.stdout) {
+                subprocess.stdout.pipe(fs.createWriteStream(outputPath));
+            }
+            await subprocess;
+            // 检查文件大小
+            const stats = fs.statSync(outputPath);
+            if (stats.size === 0) {
+                logger.error('备份文件为空，备份可能失败。');
+            }
+            else {
+                logger.success(`数据库备份成功！文件大小: ${(stats.size / 1024 / 1024).toFixed(2)} MB`);
+            }
+        }
+        catch (error) {
+            logger.error('数据库备份失败');
+            if (error instanceof Error) {
+                logger.error(error.message);
+            }
+            // 如果失败则清理空文件
+            if (fs.existsSync(outputPath) && fs.statSync(outputPath).size === 0) {
+                fs.unlinkSync(outputPath);
+            }
+            this.exit(1);
+        }
+    }
+}

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

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

package/dist/commands/db/generate.js

@@ -1,11 +1,17 @@
 import { Command } from '@oclif/core';
 import { execCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class DbGenerate extends Command {
-    static description = '生成数据库迁移文件';
+    static description = '生成 Prisma Client (db:generate)';
+    static flags = {
+        env: EnvFlag,
+    };
     async run() {
-        const { files, isBuiltIn } = await getComposeFiles('basic');
-        logger.info('正在生成数据库迁移...');
+        const { flags } = await this.parse(DbGenerate);
+        const env = await selectEnvironment(flags.env);
+        const { files, isBuiltIn } = await getComposeFiles(env);
+        logger.info('正在生成 Prisma Client...');
         await execCompose(files, 'api', ['npm', 'run', 'db:generate'], isBuiltIn);
         logger.success('数据库迁移文件生成完成');
     }

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

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

package/dist/commands/db/migrate.js

@@ -1,10 +1,16 @@
 import { Command } from '@oclif/core';
 import { execCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class DbMigrate extends Command {
-    static description = '执行数据库迁移';
+    static description = '执行数据库迁移 (db:migrate)';
+    static flags = {
+        env: EnvFlag,
+    };
     async run() {
-        const { files, isBuiltIn } = await getComposeFiles('basic');
+        const { flags } = await this.parse(DbMigrate);
+        const env = await selectEnvironment(flags.env);
+        const { files, isBuiltIn } = await getComposeFiles(env);
         logger.info('正在执行数据库迁移...');
         await execCompose(files, 'api', ['npm', 'run', 'db:migrate'], isBuiltIn);
         logger.success('数据库迁移完成');