@dtdyq/restbase 1.0.1 → 2.1.0

package/README.md

@@ -21,17 +21,27 @@
 bun install -g @dtdyq/restbase
 ```
 
-安装后直接在任意目录使用 `restbase` 命令：
+安装后在任意目录使用 `restbase` 命令。所有配置通过 `.env` 文件读取：
 
 ```bash
-# 默认 SQLite 内存模式启动
-restbase
+# 交互式配置 .env（已存在则用当前值作为默认）
+restbase env
 
-# 指定数据库和端口
-DB_URL=sqlite://./data.db SVR_PORT=8080 restbase
+# 前台启动（读取当前目录 .env）
+restbase run
 
-# 连接 MySQL
-DB_URL=mysql://user:pass@localhost/mydb restbase
+# 后台启动（daemon 模式）
+restbase start
+
+# 查看运行中的实例（含健康状态）
+restbase status
+
+# 查看某个实例的实时日志（支持 PID 或 SVR_NAME）
+restbase log <pid|name>
+
+# 停止（支持 PID、SVR_NAME 或 all）
+restbase stop <pid|name>   # 停止指定实例
+restbase stop all          # 停止所有实例
 ```
 
 更新到最新版：
@@ -44,14 +54,15 @@ bun install -g @dtdyq/restbase@latest
 
 ```bash
 bun install
-bun run server.ts
+bun run src/server.ts
 ```
 
 ### 验证
 
 ```bash
-# 健康检查
+# 健康检查（返回实例状态 + 资源占用 + cwd + logFile）
 curl http://localhost:3333/api/health
+# → { "code": "OK", "data": { "status": "healthy", "port": 3333, "pid": 12345, "cwd": "/path/to/dir", "uptime": 60, "memory": {...}, "cpu": {...} } }
 
 # Basic Auth 查询
 curl -u admin:admin http://localhost:3333/api/data/products
@@ -71,6 +82,10 @@ import RestBase, { gt } from "@dtdyq/restbase-client";
 const rb = new RestBase();  // 同源部署不传参
 await rb.auth.login("admin", "admin");
 const data = await rb.table("products").query().where(gt("price", 100)).data();
+
+// 多节点负载均衡（所有节点连同一 DB）
+const rb2 = new RestBase(["http://node1:3333", "http://node2:3333"]);
+await rb2.auth.login("admin", "admin"); // 一次登录，token 共享
 ```
 
 详见 [client/README.md](client/README.md)。
@@ -78,12 +93,7 @@ const data = await rb.table("products").query().where(gt("price", 100)).data();
 ## 构建与部署
 
 ```bash
-bun run build              # 当前平台
-bun run build:linux        # Linux x64
-bun run build:linux-arm    # Linux ARM64
-bun run build:mac          # macOS x64
-bun run build:mac-arm      # macOS ARM64
-bun run build:windows      # Windows x64
+bun run build              # 编译为当前平台独立二进制
 
 # 运行二进制（无需 Bun 运行时）
 ./restbase
@@ -93,6 +103,7 @@ bun run build:windows      # Windows x64
 
 | 变量                        | 说明                         | 默认值                 |
 |:--------------------------|:---------------------------|:--------------------|
+| `SVR_NAME`                | 实例名称（`status` 中显示）         | 空                   |
 | `SVR_PORT`                | 服务端口                       | `3333`              |
 | `SVR_STATIC`              | 静态文件目录（前端托管）               | 空                   |
 | `SVR_API_LIMIT`           | API 限流（每秒每接口请求数）           | `100`               |
@@ -112,7 +123,7 @@ bun run build:windows      # Windows x64
 ## 测试
 
 ```bash
-bun test rest.test.ts    # 137+ 用例
+bun test src/rest.test.ts    # 137+ 用例
 ```
 
 ## 文档
@@ -124,30 +135,52 @@ bun test rest.test.ts    # 137+ 用例
 | [documents/db_design.md](documents/db_design.md) | 数据库设计指南 — 表结构规范、约束、索引、设计模式与检查清单                   |
 | [documents/design.md](documents/design.md)       | 需求与设计文档 — 架构设计、技术规格、完整接口定义                        |
 
+## CLI 命令
+
+```
+restbase <command> [arguments]
+
+Commands:
+  run              前台启动服务（读取当前目录 .env）
+  start            后台启动（daemon 模式）
+  stop <pid|name|all>  停止后台实例（支持 PID、SVR_NAME 或 all）
+  status               查看运行中的实例（含健康检查）
+  log <pid|name>       实时查看实例日志（支持 PID 或 SVR_NAME）
+  env              交互式 .env 配置（创建或重新配置）
+  version          显示版本号
+  help             显示帮助
+```
+
+所有配置通过 `.env` 文件管理，可在 `.env` 中设置 `SVR_NAME` 为实例命名。
+
+实例管理完全无状态：通过 `ps` 自动发现运行中的实例，通过 `/api/health` 获取实例详情。
+daemon 模式默认日志存放在 `~/.restbase/logs/`。
+
 ## 文件结构
 
 ```
 restbase/
 ├── bin/
-│   └── restbase.ts      # 全局命令入口（bun install -g）
-├── server.ts            # 服务入口
-├── types.ts             # 配置 + 类型 + Zod Schema
-├── db.ts                # 数据库
-├── auth.ts              # 鉴权
-├── crud.ts              # CRUD 路由
-├── query.ts             # SQL 生成
-├── logger.ts            # 日志
+│   └── restbase.ts         # CLI 入口（run/start/stop/status）
+├── src/
+│   ├── server.ts           # 服务启动
+│   ├── types.ts            # 配置 + 类型 + Zod Schema
+│   ├── db.ts               # 数据库
+│   ├── auth.ts             # 鉴权
+│   ├── crud.ts             # CRUD 路由
+│   ├── query.ts            # SQL 生成
+│   ├── logger.ts           # 日志
+│   └── rest.test.ts        # 集成测试
 ├── client/
-│   ├── restbase-client.ts   # 前端客户端（独立 npm 包 @dtdyq/restbase-client）
-│   ├── README.md            # 客户端文档
+│   ├── restbase-client.ts  # 前端客户端（独立 npm 包 @dtdyq/restbase-client）
+│   ├── README.md           # 客户端文档
 │   └── package.json
 ├── documents/
-│   ├── design.md        # 需求设计文档
-│   ├── server.md        # 服务端文档
-│   └── db_design.md     # 数据库设计指南
-├── init.sql             # 初始化 SQL
-├── rest.test.ts         # 集成测试
-├── .env / .env.test     # 环境配置
+│   ├── design.md           # 需求设计文档
+│   ├── server.md           # 服务端文档
+│   └── db_design.md        # 数据库设计指南
+├── init.sql                # 初始化 SQL
+├── .env / .env.test        # 环境配置
 └── package.json
 ```