Readme_zh.md

AiyoPerps

English

AiyoPerps 是一套同時支援 CEX (中心化) 與 DEX (去中心化) 的永續合約桌面交易終端，提供完整桌面 UI、給 AI Agent 使用的 MCP Server，以及本機 REST API。
你可以基於 AiyoPerps 實現 手動、與 AI 協作，或 完全由 AI 操作 加密貨幣永續合約交易。

支持我們

如果你覺得這個專案不錯，請我們喝杯咖啡吧!
贊助我們的同時，你也會獲得參加台灣發票樂透的機會!
因為宸泗工作室是誠實納稅的團隊，我們的每一筆收入都會開立發票，發票號碼每兩個月可以兌獎一次。
即使你不是台灣的居民，如果你中獎了，請通知我們。我們會幫你兌獎之後(扣除必要的手續費)匯款給你。

近期更新

• 新增 Dashboard 介面，現在在同一個介面就可以管理所有交易所的所有持倉及掛單。

• 新增固定時間主動喚醒 AI Agent 功能，支援 Codex CLI、Claude Code CLI、Gemini CLI。

0. 支援的交易平台

• CEX: BitMEX
• DEX: Hyperliquid、Aster、Grvt、dYdX

1. 環境需求

• Windows、Linux、MacOS (透過 docker)。
• .NET 10 Runtime (發佈版本已內建)。
• 永續合約交易平台帳號，目前支援 Hyperliquid、BitMEX、Aster。

2. 執行桌面版

使用發佈版本

1. 到 GitHub Releases 下載最新版本。
2. 解壓縮。
3. 執行：
   • Windows：AiyoPerps.exe
   • Linux：./AiyoPerps

從原始碼編譯執行

1. Clone 此 repo 或下載完整原始碼。
   git clone https://github.com/phidiassj/AiyoPerps.git
2. 使用 Visual Studio 2026 編譯。

3. 啟用本機 MCP Server 及 API

1. 啟動桌面程式。
2. 在上方工具列設定 HTTP API 埠號（預設 5078）。
3. 將 API 開關切到 ON。
4. 可直接開啟：
   • OpenAPI 介面：http://127.0.0.1:5078/scalar
   • MCP 端點：http://127.0.0.1:5078/mcp

4. 無介面模式

只需要 REST 或 MCP 時可使用。

本機 headless

使用 -- headless --port 5078 啟動軟體

Windows:
AiyoPerps.exe -- headless --port 5078

Linux:
./AiyoPerps -- headless --port 5078

Docker

MacOS 目前僅能透過 Docker 使用。

docker run --rm --name aiyoperps -p 5078:5078 phidiassj/aiyoperps:latest

容器會自動以 headless 模式啟動，並自動開啟 HTTP API。

5. 連接 AI Agent

建議：使用 installer 自動安裝到支援的 AI Agent

npx -y @phidiassj/aiyoperps-mcp-installer

這會把 AiyoPerps 註冊到 Codex、Claude Desktop、Claude Code CLI、OpenClaw 等支援的 AI Agent。

手動使用 stdio bridge

npx -y @phidiassj/aiyoperps-mcp-bridge --quiet --url http://127.0.0.1:5078/mcp

如果自動安裝 Installer 不支援你的 AI Agent，你可以嘗試使用這個方式。

6. UI 快速流程

1. 開啟 Account Manager 新增帳號。
2. 建立或選取一個分頁。
3. 選擇帳號後按 Enable。
4. 設定 Symbol 與 Interval。
5. 右側可切換 下單、持倉、訂單、餘額 分頁。

7. 進一步說明

• 完整 API 與 MCP 文件：API_zh.md
• English API guide: API.md