@vibek/cli 0.1.1 → 0.1.3

package/README.md

@@ -1,10 +1,16 @@
-# Vibek CLI 用户指南
+# Vibek
 
-Vibek 是一个面向个人的 CTP 量化交易工具，提供后台行情与交易服务、策略管理、离线回测，
+Vibek 是一个个人自用的 CTP 量化交易项目，提供后台行情与交易服务、策略管理、离线回测，
 以及浏览器中的 AI 策略工作台。npm 包安装后注册全局命令 `vibek`。
 
-> Vibek 会连接真实期货账户。首次使用请保持 `live_enabled = false`，先完成配置校验、
-> Paper 模式运行和风险参数检查，再考虑启用实盘。
+## 项目状态
+
+**本项目正在开发和测试中，尚未作为稳定产品发布。** 功能、命令、配置和数据格式可能继续调整，
+不承诺向后兼容性、持续可用性或交易数据的完整与正确。该 npm 包主要用于个人环境中的开发、研究和验证，
+不建议直接用于他人的生产或实盘交易环境。
+
+Vibek 可能连接真实期货账户，但不构成投资建议，也不对交易损失负责。使用者应自行评估并承担风险；
+首次使用应先在 CTP 测试环境、Paper 模式和离线回测中完成充分验证；Live 策略必须显式加载并启动。
 
 ## 运行环境
 
@@ -44,32 +50,29 @@ vibek --default-config > ~/.config/vibek/config.toml
 ${EDITOR:-vi} ~/.config/vibek/config.toml
 ```
 
-填写账号时，账号表名必须是 `<broker_id>-<user>`。下面是一份最小起步配置：
+账号名由 `broker_id-user` 自动生成，不需要手工重复填写。下面是一份单账号最小起步配置：
 
 ```toml
-version = 1
-active_account = "9999-account"
-
-[accounts."9999-account".identity]
+[[accounts]]
 broker_id = "9999"
 user = "account"
 
-[accounts."9999-account".ctp]
+[accounts.ctp]
 market_front = "tcp://行情前置地址:端口"
 trader_front = "tcp://交易前置地址:端口"
 app_id = "你的-app-id"
 production_mode = true
 
-[accounts."9999-account".trading]
-live_enabled = false
+[accounts.trading]
 max_order_volume = 1
 max_position = 2
 max_active_orders = 2
 allow_short = true
 ```
 
-`production_mode` 选择 CTP API 的生产/评测模式；它不等于允许实盘交易。
-`live_enabled` 是独立的实盘总闸，默认应保持关闭。
+`production_mode` 选择 CTP API 的生产/评测模式；它不决定策略使用 Paper 还是 Live。
+只有一个 `[[accounts]]` 时会自动选中；配置多个账号时才需要在文件顶部填写
+`active_account = "<broker_id>-<user>"`。
 
 ### 2. 校验配置
 
@@ -170,7 +173,7 @@ vibek strategy unload <策略实例ID>
 vibek backtest ./my-strategy.ts --help
 ```
 
-Live 模式必须显式使用 `--mode live`，并同时通过账号配置中的 `live_enabled`、委托限制和持仓核对。
+Live 模式必须显式使用 `--mode live`、显式启动，并通过委托限制和持仓核对。
 不要用尚未在 Paper 和回测中验证的策略直接连接实盘。
 
 ## 配置和数据位置
@@ -186,16 +189,22 @@ Live 模式必须显式使用 `--mode live`，并同时通过账号配置中的
 
 ## 升级与回退
 
-实盘机器建议安装明确版本，不要自动跟随 `latest`：
+`vibek update` 将官方 npm 应用更新到 `latest` 指向的稳定版本。它不会更新 gateway，也不会停止或
+重启正在运行的 daemon；请在维护时段显式完成后续步骤：
 
 ```bash
-bun install -g @vibek/cli@0.1.0
+vibek update
 vibek --version
 vibek gateway
 vibek daemon restart
 ```
 
-回退时安装旧的 npm 版本，再用 `vibek gateway <version>` 激活对应 gateway，最后重启 daemon。
+实盘机器需要固定或回退版本时，不要使用 `vibek update`，而是安装明确版本，再用
+`vibek gateway <version>` 激活对应 gateway，最后重启 daemon：
+
+```bash
+bun install -g @vibek/cli@0.1.0
+```
 
 ## 排查问题
 

package/config.example.toml

@@ -1,58 +1,91 @@
-# Vibek configuration
-# 复制到平台配置目录，或运行 `vibek --default-config` 输出同等模板。
-# 修改后运行 `vibek config` 校验；daemon 配置重启后生效。
-version = 1
+# Vibek 配置模板
+# 默认路径: Linux/macOS ~/.config/vibek/config.toml; Windows %APPDATA%\vibek\config.toml
+# 带 # 的字段当前未启用；保留注释即使用程序默认值。
+# 修改后运行 vibek config 校验；daemon 相关修改需重启后生效。
+# 交易密码和 CTP 授权码不要写入本文件；vibek daemon start/restart 会在终端询问。
 
+# 当前账号: 单账号自动选中；多账号时取消下一行注释，值为 broker_id-user。
 # active_account = "9999-account"
 
+# 本机数据根目录，保存 gateway、账号数据库、日志、策略状态和 AI 设置。
 [storage]
 # data_root = "~/.vibek"
 
+# 本机服务端口。两个端口必须不同，服务仅监听本机。
 [server]
+# daemon 控制 API 和行情 WebSocket 端口。
 # daemon_port = 3111
+# Web 工作台端口。
 # webui_port = 3211
 
+# 网络代理。目前只用于 Telegram 通知，不影响 CTP 行情和交易连接。
 [network]
 # telegram_proxy = "http://127.0.0.1:7890"
 
-# [accounts."9999-account".identity]
+# 账号身份与 CTP 连接。使用 daemon 时必须取消以下必填行的注释并填写。
+# broker_id 和 user 组合为账号名 broker_id-user；添加账号时复制整组账号及其子表。
+# [[accounts]]
+# 期货公司提供的 CTP BrokerID，不是期货公司中文名称。
 # broker_id = "9999"
+# CTP 用户号/投资者代码，通常是期货资金账号。
 # user = "account"
 
-# [accounts."9999-account".ctp]
+# [accounts.ctp]
+# 期货公司提供的行情和交易前置，格式必须是 tcp://主机:端口。
 # market_front = "tcp://host:port"
 # trader_front = "tcp://host:port"
+# 可选线路，格式为 描述@IP；供 vibek front test/use 测速和切换，端口沿用上方地址。
 # front_candidates = ["主线@1.2.3.4", "备用@1.2.3.5"]
+# 期货公司为该 CTP 客户端分配的 AppID，不能自行编造。
 # app_id = "client-id"
+# 可选，默认 true；按期货公司资料选择 CTP 生产/评测模式，不决定策略使用 Paper 还是 Live。
 # production_mode = true
 
-# [accounts."9999-account".logging]
-# level = "info" # trace | debug | info | warn | error
+# 可选日志级别: trace | debug | info | warn | error。
+# 未设置时，CTP 生产模式默认 info，评测模式默认 debug。
+# [accounts.logging]
+# level = "info"
 
-# [accounts."9999-account".market]
+# 可选行情存储与固定录制合约。
+# [accounts.market]
+# 留空使用账号默认数据库: <data-root>/accounts/<account>/vibek_bars.db。
 # db_path = ""
+# 合约格式必须是 CODE.EXCHANGE；这里的合约会由 daemon 持续订阅并记录 1 分钟 K 线。
 # record_instruments = ["NI2609.SHFE", "IF2609.CFFEX"]
+# 丢弃时间戳比本机时间超前超过该毫秒数的行情。
 # max_future_tick_ms = 5000
 
-# [accounts."9999-account".trading]
-# live_enabled = false
+# Live 策略硬风控。mode=live 且显式启动后，委托仍必须通过以下限制。
+# [accounts.trading]
+# 单笔委托最大手数。
 # max_order_volume = 10
+# 单个策略、单个方向的预计持仓上限，包含未成交开仓委托。
 # max_position = 20
+# 单个策略允许同时存在的活动委托数。
 # max_active_orders = 5
+# 是否允许开空仓；false 时仍允许平已有空仓。
 # allow_short = true
 
-# [accounts."9999-account".schedule]
+# 北京时间交易窗口调度。启用后，daemon 按窗口自动连接、启停策略、撤单和断开。
+# [accounts.schedule]
 # enabled = true
+# 日盘和夜盘窗口的启动/停止锚点，格式为 HH:MM。
 # day_start = "08:45"
 # day_stop = "15:15"
 # night_start = "20:45"
 # night_stop = "02:35"
+# 单个窗口最多启动尝试次数，以及首次重试等待毫秒数（后续指数退避）。
 # max_start_attempts = 4
 # retry_base_ms = 30000
+# 调度器检查窗口状态的间隔毫秒数。
 # tick_ms = 30000
 
-# [accounts."9999-account".notifications]
+# 可选通知。密钥会以明文保存在本文件中，不要提交到 Git 或放入共享目录。
+# [accounts.notifications]
+# 接收信号、调度和故障通知的 Bark key。
 # bark_key = ""
+# 仅额外接收交易信号的 Bark key 列表。
 # bark_signal_keys = []
+# Telegram 通知需同时填写 bot token 和 chat ID。
 # telegram_bot_token = ""
 # telegram_chat_id = ""