okx-trade-cli 1.0.4 → 1.0.7

package/README.md

@@ -1,104 +1,58 @@
 # okx-trade-cli
 
-## English
+> `@okx_retail/okx-trade-cli` 的无 scope alias 包。
 
-Command line tool for OKX. Supports market data, account queries, spot and swap
-trading, and configuration management.
-
-### Install
+## 安装
 
 ```bash
-npm install -g okx-trade-cli
-```
-
-### Configure credentials
-
-Create `~/.okx/config.toml`:
-
-```toml
-default_profile = "demo"
-
-[profiles.live]
-api_key = "your-live-api-key"
-secret_key = "your-live-secret-key"
-passphrase = "your-live-passphrase"
+# 无 scope（更简洁）
+npm install okx-trade-cli
 
-[profiles.demo]
-api_key = "your-demo-api-key"
-secret_key = "your-demo-secret-key"
-passphrase = "your-demo-passphrase"
-demo = true
+# 带 scope（官方标准写法）
+npm install @okx_retail/okx-trade-cli
 ```
 
-### Quick usage
+两种方式完全等价，安装后暴露相同的可执行命令。
 
-```bash
-okx market ticker BTC-USDT
-okx market orderbook BTC-USDT --sz 5
-okx account balance
-okx spot orders
-okx swap positions
-```
-
-### Examples
+## 提供的命令
 
-```bash
-okx market candles BTC-USDT --bar 1H --limit 10
-okx account balance BTC,ETH
-okx spot place --instId BTC-USDT --side buy --ordType market --sz 100
-okx swap leverage --instId BTC-USDT-SWAP --lever 10 --mgnMode cross
-```
+| 命令 | 对应原包 | 用途 |
+|------|---------|------|
+| `okx` | `@okx_retail/okx-trade-cli` | OKX CLI 工具 |
 
-For more details, see the repository README.
-
----
-
-## 中文
-
-OKX 命令行工具，支持行情、账户查询、现货与合约交易，以及配置管理。
-
-### 安装
+## 使用示例
 
 ```bash
-npm install -g okx-trade-cli
+npx okx market ticker BTC-USDT
+npx okx account balance
+npx okx swap positions
+npx okx --help
 ```
 
-### 配置凭证
+所有功能、参数、行为均来自主包，本包不含任何独立逻辑。
 
-创建 `~/.okx/config.toml`：
+---
 
-```toml
-default_profile = "demo"
+## 版本同步策略
 
-[profiles.live]
-api_key = "your-live-api-key"
-secret_key = "your-live-secret-key"
-passphrase = "your-live-passphrase"
+| 事件 | 操作 |
+|------|------|
+| 主包发布新 patch/minor | 更新本包 `package.json` 中的依赖版本，打 tag 自动发布 |
+| 主包发布新 major | 同上，同时更新本包 major 版本号保持一致 |
 
-[profiles.demo]
-api_key = "your-demo-api-key"
-secret_key = "your-demo-secret-key"
-passphrase = "your-demo-passphrase"
-demo = true
-```
+---
 
-### 快速使用
+## 发布流程
 
 ```bash
-okx market ticker BTC-USDT
-okx market orderbook BTC-USDT --sz 5
-okx account balance
-okx spot orders
-okx swap positions
-```
+# 1. 更新依赖版本号
+#    "dependencies": { "@okx_retail/okx-trade-cli": "^x.x.x" }
 
-### 示例
+# 2. 同步本包版本号
+npm version patch   # 或 minor / major
 
-```bash
-okx market candles BTC-USDT --bar 1H --limit 10
-okx account balance BTC,ETH
-okx spot place --instId BTC-USDT --side buy --ordType market --sz 100
-okx swap leverage --instId BTC-USDT-SWAP --lever 10 --mgnMode cross
+# 3. 打 tag，CI 自动发布
+git push --follow-tags
 ```
 
-更多说明请参考仓库根目录 README。
+> 需要在 GitHub repo Settings → Secrets 中配置 `NPM_TOKEN`。

package/bin/okx.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '@okx_retail/okx-trade-cli';

package/package.json

@@ -1,40 +1,18 @@
 {
   "name": "okx-trade-cli",
-  "version": "1.0.4",
-  "description": "OKX CLI - Command line tool for OKX exchange",
-  "type": "module",
-  "license": "MIT",
-  "main": "dist/index.js",
+  "version": "1.0.7",
+  "description": "Alias package for @okx_retail/okx-trade-cli — supports both install methods",
   "bin": {
-    "okx": "dist/index.js"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "publishConfig": {
-    "access": "public"
+    "okx": "bin/okx.mjs"
   },
-  "engines": {
-    "node": ">=18"
+  "files": ["bin"],
+  "scripts": {
+    "prepublishOnly": "node -e \"require('fs').chmodSync('bin/okx.mjs',0o755)\""
   },
-  "keywords": [
-    "okx",
-    "cli",
-    "trading"
-  ],
+  "engines": { "node": ">=18" },
+  "keywords": ["okx", "cli", "trading", "alias"],
+  "license": "MIT",
   "dependencies": {
-    "smol-toml": "^1.3.4"
-  },
-  "devDependencies": {
-    "@types/node": "^25.2.2",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3",
-    "@okx-hub/core": "1.0.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist"
+    "@okx_retail/okx-trade-cli": "^1.0.7"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 okx-hub
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.