Update package.json and README files to include repository information and enhance CLI command mode documentation

- Added repository details to package.json for better project visibility.
- Revised README files in both English and Chinese to improve the clarity and accessibility of the `ritmex-bot` CLI command mode instructions.
- Included installation instructions for adding the project as a skill, enhancing user onboarding experience.
This commit is contained in:
discountry
2026-02-27 12:55:28 +08:00
parent 674a6fe0da
commit 74d0a0a98b
3 changed files with 34 additions and 18 deletions
+15 -9
View File
@@ -8,15 +8,6 @@ A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend en
基于 Bun 的多交易所永续合约量化终端,内置趋势跟随(SMA30)、Guardian 防守与做市策略,支持快速恢复、实时行情订阅、日志追踪与 CLI 仪表盘。
## CLI 命令模式(ritmex-bot
`ritmex-bot` 支持 Agent 友好的结构化命令调用,覆盖交易所能力查询、行情、账户、仓位、下单、撤单与策略启动。
- 保持现有环境变量体系,不新增也不改名,只读取当前执行环境中的变量。
- `--symbol` 原样透传,不对交易对做统一改写。
- 支持 `--dry-run` 模拟执行与 `--json` 结构化输出,便于自动化系统集成。
完整文档请见:[ritmex-bot CLI 使用手册(中文)](cli-guide.md)
如果您希望获取优惠并支持本项目,请考虑使用以下注册链接:
* [Lighter 手续费优惠注册链接](https://app.lighter.xyz/?referral=111909FA)
@@ -30,6 +21,21 @@ A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend en
* [Paradex 手续费优惠注册链接](https://paradex.io/ref/xingxingjun)
* [Apex 手续费优惠注册链接](https://join.omni.apex.exchange/SEA)
## CLI 命令模式(ritmex-bot
`ritmex-bot` 支持 Agent 友好的结构化命令调用,覆盖交易所能力查询、行情、账户、仓位、下单、撤单与策略启动。
- 保持现有环境变量体系,不新增也不改名,只读取当前执行环境中的变量。
- `--symbol` 原样透传,不对交易对做统一改写。
- 支持 `--dry-run` 模拟执行与 `--json` 结构化输出,便于自动化系统集成。
### 安装当前项目 Skillskills add
```bash
npx skills add https://github.com/discountry/ritmex-bot --skill use-ritmex-bot
```
如需指定分支,可追加 `--ref <branch-or-tag>`
完整文档请见:[ritmex-bot CLI 使用手册(中文)](cli-guide.md)
## 文档索引
- [ritmex-bot CLI 使用手册(中文)](cli-guide.md)
- [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
+15 -9
View File
@@ -4,15 +4,6 @@
A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend engine, a Guardian stop sentinel, and two market-making modes. It offers instant restarts, realtime market data, structured logging, and an Ink-based CLI dashboard.
## CLI Command Mode (`ritmex-bot`)
`ritmex-bot` provides an agent-friendly command interface for exchange capability checks, market data, account/position queries, order operations, and strategy execution.
- It keeps the current environment-variable system intact: no renaming and no new required keys.
- `--symbol` is passed through exactly as provided (no symbol normalization).
- It supports `--dry-run` simulation and `--json` structured output for automation.
Full guide: [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
If you'd like to support this project and get fee discounts, please consider using these referral links:
* [Lighter referral link](https://app.lighter.xyz/?referral=111909FA)
@@ -26,6 +17,21 @@ If you'd like to support this project and get fee discounts, please consider usi
* [Paradex referral link](https://paradex.io/ref/xingxingjun)
* [Apex referral link](https://join.omni.apex.exchange/SEA)
## CLI Command Mode (`ritmex-bot`)
`ritmex-bot` provides an agent-friendly command interface for exchange capability checks, market data, account/position queries, order operations, and strategy execution.
- It keeps the current environment-variable system intact: no renaming and no new required keys.
- `--symbol` is passed through exactly as provided (no symbol normalization).
- It supports `--dry-run` simulation and `--json` structured output for automation.
### Install This Project Skill (`skills add`)
```bash
npx skills add https://github.com/discountry/ritmex-bot --skill use-ritmex-bot
```
If you need a specific branch/tag, append `--ref <branch-or-tag>`.
Full guide: [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
## Documentation Map
- [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
- [ritmex-bot CLI 使用手册(中文)](cli-guide.md)
+4
View File
@@ -4,6 +4,10 @@
"module": "index.ts",
"type": "module",
"private": false,
"repository": {
"type": "git",
"url": "https://github.com/discountry/ritmex-bot.git"
},
"bin": {
"ritmex-bot": "./bin/ritmex-bot"
},