@vibek/cli 0.1.6 → 0.1.7

package/README.md

@@ -1,7 +1,6 @@
 # Vibek
 
-Vibek 是一个个人自用的 CTP 量化交易项目，提供后台行情与交易服务、策略管理、离线回测，
-以及浏览器中的 AI 策略工作台。npm 包安装后注册全局命令 `vibek`。
+面向个人使用的 CTP 量化交易 CLI 与 AI 策略工作台。
 
 ## 项目状态
 
@@ -12,232 +11,77 @@ Vibek 是一个个人自用的 CTP 量化交易项目，提供后台行情与交
 Vibek 可能连接真实期货账户，但不构成投资建议，也不对交易损失负责。使用者应自行评估并承担风险；
 首次使用应先在 CTP 测试环境、Paper 模式和离线回测中完成充分验证；Live 策略必须显式加载并启动。
 
-## 运行环境
-
-- [Bun](https://bun.sh/) 1.4.0 或更高版本
-- Windows x64，或 Ubuntu 24.04 x86_64
-- 可用的 CTP 账号、行情/交易前置地址和 App ID
-- 使用 Web 工作台时需要本机浏览器
-
-原生 CTP gateway 不包含在 npm 包中。Vibek 会通过 `vibek gateway` 下载并校验与当前应用兼容的版本。
-
 ## 安装
 
+需要 [Bun](https://bun.sh/) 1.4.0 或更高版本：
+
 ```bash
 bun install -g @vibek/cli
 vibek --version
 ```
 
-如果终端找不到 `vibek`，请确认 Bun 的全局 bin 目录 `~/.bun/bin` 已加入 `PATH`。
-
-## 快速开始
-
-### 1. 生成配置
-
-Windows PowerShell：
-
-```powershell
-New-Item -ItemType Directory -Force "$env:APPDATA\vibek" | Out-Null
-vibek --default-config | Set-Content -Encoding UTF8 "$env:APPDATA\vibek\config.toml"
-notepad "$env:APPDATA\vibek\config.toml"
-```
-
-Linux：
-
-```bash
-mkdir -p ~/.config/vibek
-vibek --default-config > ~/.config/vibek/config.toml
-${EDITOR:-vi} ~/.config/vibek/config.toml
-```
-
-账号名由 `broker_id-user` 自动生成。配置只支持一个账号：
-
-```toml
-[account]
-broker_id = "9999"
-user = "account"
-
-[account.ctp]
-market_front = "tcp://行情前置地址:端口"
-trader_front = "tcp://交易前置地址:端口"
-app_id = "你的-app-id"
-production_mode = true
-
-[account.market]
-record_instruments = ["IC2609.CFFEX"]
-tick_time_mode = "realtime"
-
-[account.trading]
-max_order_volume = 1
-max_position = 2
-max_active_open_orders = 2
-
-[account.trading.daily_limits]
-total_order_limit = 20000
-total_cancel_limit = 10000
-total_trade_limit = 10000
-instrument_order_limit = 2000
-instrument_cancel_limit = 1000
-instrument_trade_limit = 1000
-
-[account.trading.duplicate_orders]
-duplicate_order_limit = 10
-```
-
-`production_mode` 选择 CTP API 的生产/评测模式；它不决定策略使用 Paper 还是 Live。
-SimNow 7x24 等回放行情前置需将 `tick_time_mode` 设为 `"replay"`；券商实时行情保持默认
-`"realtime"`，以继续拒绝陈旧或明显超前的 tick。
-换号时修改 `[account]`，然后执行 `vibek daemon restart`。
-
-### 2. 校验配置
-
-```bash
-vibek config
-vibek status
-```
-
-配置有未知字段、类型错误、账号引用错误或风控值越界时，`vibek config` 会直接指出问题。
-
-### 3. 安装 CTP gateway
-
-```bash
-vibek gateway
-```
-
-该命令会安装或校验当前应用兼容的最新稳定 gateway。也可以安装明确版本或本地归档：
-
-```bash
-vibek gateway 0.1.0
-vibek gateway ./gateway.tar.gz
-```
-
-### 4. 启动后台服务
-
-```bash
-vibek daemon start
-vibek status
-```
-
-`daemon start` 会在终端中询问交易密码和 CTP 授权码。这些凭证只传给本次后台进程，
-不会写入 `config.toml`。查看运行状态和日志：
-
-```bash
-vibek daemon status
-vibek daemon logs --follow
-vibek daemon stop
-```
-
-### 5. 打开 Web 工作台
+## 开始使用
 
 ```bash
 vibek
 ```
 
-无参数运行等价于 `vibek web`。命令会启动本机 Web 工作台并打印浏览器地址；默认端口为 `3211`：
-
-```bash
-vibek web --port 3211
-```
-
-Web 工作台本身不会自动启动交易 daemon。需要行情、账户或策略运行能力时，请先执行
-`vibek daemon start`。
-
-## 常用命令
-
-| 命令 | 用途 |
-| --- | --- |
-| `vibek status` | 汇总账号、daemon、行情、交易连接和策略状态 |
-| `vibek risk` | 查询 Paper/Live 每日风险计数和单合约使用量 |
-| `vibek account` | 查询当前柜台资金 |
-| `vibek positions` | 查询实时持仓 |
-| `vibek orders` | 查询当前交易日委托 |
-| `vibek trades` | 查询当前交易日成交 |
-| `vibek contract <合约>` | 查询合约规格和当前账户手续费率 |
-| `vibek front test` | 测试候选 CTP 前置并按稳定性、延迟排名 |
-| `vibek front check` | 检查当前行情和交易前置 |
-| `vibek daemon restart` | 重新输入凭证并重启后台服务 |
-
-查询命令默认输出终端表格。需要脚本消费时可添加全局 `--json`：
-
-```bash
-vibek positions --json
-vibek --json status
-vibek risk --mode live --instrument RB2610.SHFE
-vibek --json risk --mode live
-```
-
-`vibek risk` 默认显示 Live、Paper 汇总以及所有计数非零的合约；`--mode paper|live` 和
-`--instrument CODE.EXCHANGE` 可缩小范围。统计来自运行中 daemon，daemon 未运行或尚未重启到
-支持风险快照的版本时命令返回失败，不会用静态配置或离线状态冒充实时数据。
-
-## 策略与回测
-
-先在 Paper 模式加载策略：
-
-```bash
-vibek strategy load ./my-strategy.ts --mode paper
-vibek strategy list
-vibek strategy start <策略实例ID>
-```
-
-停止或卸载策略：
-
-```bash
-vibek strategy stop <策略实例ID>
-vibek strategy unload <策略实例ID>
-```
-
-离线回测接受 mock 或 CSV 数据，并要求明确提供合约乘数、保证金和手续费参数：
-
-```bash
-vibek backtest ./my-strategy.ts --help
-```
-
-Live 模式必须显式使用 `--mode live`、显式启动，并通过委托限制和持仓核对。
-不要用尚未在 Paper 和回测中验证的策略直接连接实盘。
-
-## 配置和数据位置
-
-| 内容 | Windows | Linux |
-| --- | --- | --- |
-| 配置文件 | `%APPDATA%\vibek\config.toml` | `~/.config/vibek/config.toml` |
-| 默认数据根 | `%USERPROFILE%\.vibek` | `~/.vibek` |
-| 账号数据 | `<数据根>\accounts\<账号>` | `<数据根>/accounts/<账号>` |
-
-可在配置的 `[storage]` 中修改 `data_root`。数据库、日志、策略产物和 gateway 都位于数据根目录，
-不会写入 npm 包安装目录。
-
-## 升级与回退
-
-`vibek update` 将官方 npm 应用更新到 `latest` 指向的稳定版本。它不会更新 gateway，也不会停止或
-重启正在运行的 daemon；请在维护时段显式完成后续步骤：
-
-```bash
-vibek update
-vibek --version
-vibek gateway
-vibek daemon restart
-```
-
-实盘机器需要固定或回退版本时，不要使用 `vibek update`，而是安装明确版本，再用
-`vibek gateway <version>` 激活对应 gateway，最后重启 daemon：
-
-```bash
-bun install -g @vibek/cli@0.1.0
-```
-
-## 排查问题
-
-```bash
-vibek config                # 检查配置文件和当前账号
-vibek gateway               # 校验 gateway 安装
-vibek front check           # 检查 CTP 网络连通性
-vibek daemon status         # 检查后台进程
-vibek daemon logs --follow  # 查看运行日志
-vibek --help                # 查看全部命令
-vibek help <command>        # 查看某个命令的帮助
+WebUI 默认打开“快速开始”，其中包含安装、配置、gateway、daemon、策略、风控和排障说明。
+
+![Vibek WebUI 快速开始](https://unpkg.com/@vibek/cli@latest/webui-quick-start.png)
+
+## 全部指令
+
+```text
+vibek — 面向个人的 CTP 量化交易与 AI 策略工作台
+
+用法：
+  vibek [options]
+  vibek config
+  vibek web [options]
+  vibek status
+  vibek risk [options]
+  vibek update
+  vibek gateway [source]
+  vibek positions
+  vibek backtest <file> [options]
+  vibek account
+  vibek daemon [command]
+  vibek strategy [command]
+  vibek front [command]
+  vibek contract <vt-symbol>
+  vibek orders [options]
+  vibek trades [options]
+
+命令：
+  vibek                            默认启动 Web 工作台
+  vibek config                     显示并校验 config.toml
+  vibek web [options]              启动 AI 策略 Web 工作台
+  vibek status                     显示账号和系统运行概况
+  vibek risk [options]             显示每日风险统计
+  vibek update                     更新 Vibek 应用到最新稳定版
+  vibek gateway [source]           安装或更新 CTP gateway
+  vibek positions                  查询实时持仓
+  vibek backtest <file> [options]  离线回测策略
+  vibek account                    查询柜台资金
+  vibek daemon [command]           管理后台 daemon
+  vibek strategy [command]         部署和控制策略实例
+  vibek front [command]            检测和切换 CTP 前置
+  vibek contract <vt-symbol>       查询合约规格和当前账户手续费率
+  vibek orders [options]           查询当前交易日委托
+  vibek trades [options]           查询当前交易日成交
+
+选项：
+  --json            输出稳定 JSON
+  --default-config  输出完整默认配置模板
+  -V, --version     显示版本
+  -h, --help        显示帮助
+
+配置：vibek config
+数据：storage.data_root（默认 ~/.vibek）
+帮助：vibek help <command>
 ```
 
 ## License
 
-[MIT License](https://github.com/gamebody/vibek/blob/main/LICENSE), Copyright (c) 2026 Vibek contributors.
+MIT License, Copyright (c) 2026 Vibek contributors.

package/config.example.toml

@@ -19,26 +19,11 @@ tick_time_mode = "realtime"
 max_future_tick_ms = 5000
 
 [account.trading]
-# 单次策略发单请求允许的最大手数，开仓和平仓都受此限制（整数 1..10000）。
-# 超过上限时整笔拒绝，不会自动拆成多笔；应结合合约流动性、盘口深度、
-# 账户资金和策略正常单笔手数设置，用来拦截参数异常造成的大单。
 max_order_volume = 10
-
-# 单个策略、单个方向允许的最大预计持仓手数（整数 1..100000）。
-# 预计持仓 = 该方向今仓 + 昨仓 + 活动开仓委托剩余量 + 本次开仓量；多空分别计算。
-# 该值不是账户级总仓位，也不按合约乘数或保证金折算；应按每个合约的实际敞口
-# 选择可承受的手数。平仓不受此上限限制。
 max_position = 20
-
-# 单个策略允许同时存在的活动开仓物理委托笔数（整数 1..1000）。
-# 提交中、未成交、部分成交均占一笔，与每笔手数无关；全部成交、撤单或拒单后释放。
-# 达到上限后只拒绝新开仓，合法平仓仍然允许；应按策略正常并发挂单数设置，
-# 给撤单确认延迟留出余量，同时避免故障策略在盘口堆积大量开仓单。
 max_active_open_orders = 5
 
 [account.trading.daily_limits]
-# 当前 CTP TradingDay 内的计数上限。所有策略合并统计，但 Paper 与 Live 相互隔离。
-# 达到任一上限后只拒绝新的开仓请求；合法平仓和撤单始终允许并继续计数。
 total_order_limit = 20000
 total_cancel_limit = 10000
 total_trade_limit = 10000
@@ -47,8 +32,6 @@ instrument_cancel_limit = 1000
 instrument_trade_limit = 1000
 
 [account.trading.duplicate_orders]
-# 相同合约、方向、开平、取整后价格和手数的开仓请求按 TradingDay 累计。
-# 前 9 次允许，第 10 次及之后拒绝；策略 ID 不参与区分。
 duplicate_order_limit = 10
 
 [account.schedule]