omnitrade-mcp 0.9.5 → 0.9.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<br />
|
|
3
3
|
<picture>
|
|
4
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Connectry-io/omnitrade-mcp/main/.github/assets/logo-dark.svg">
|
|
5
|
-
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Connectry-io/omnitrade-mcp/main/.github/assets/logo-light.svg">
|
|
6
|
-
<img alt="OmniTrade" src="https://raw.githubusercontent.com/Connectry-io/omnitrade-mcp/main/.github/assets/logo-dark.svg" width="350">
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Connectry-io/connectrylab-omnitrade-mcp/main/.github/assets/logo-dark.svg">
|
|
5
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Connectry-io/connectrylab-omnitrade-mcp/main/.github/assets/logo-light.svg">
|
|
6
|
+
<img alt="OmniTrade" src="https://raw.githubusercontent.com/Connectry-io/connectrylab-omnitrade-mcp/main/.github/assets/logo-dark.svg" width="350">
|
|
7
7
|
</picture>
|
|
8
8
|
<br />
|
|
9
9
|
</p>
|
|
@@ -20,13 +20,14 @@
|
|
|
20
20
|
<p align="center">
|
|
21
21
|
<a href="https://www.npmjs.com/package/omnitrade-mcp"><img src="https://img.shields.io/npm/v/omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="npm version"></a>
|
|
22
22
|
<a href="https://www.npmjs.com/package/omnitrade-mcp"><img src="https://img.shields.io/npm/dm/omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="npm downloads"></a>
|
|
23
|
-
<a href="https://github.com/Connectry-io/omnitrade-mcp"><img src="https://img.shields.io/github/stars/Connectry-io/omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="GitHub stars"></a>
|
|
24
|
-
<a href="https://github.com/Connectry-io/omnitrade-mcp/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Connectry-io/omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
|
|
23
|
+
<a href="https://github.com/Connectry-io/connectrylab-omnitrade-mcp"><img src="https://img.shields.io/github/stars/Connectry-io/connectrylab-omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="GitHub stars"></a>
|
|
24
|
+
<a href="https://github.com/Connectry-io/connectrylab-omnitrade-mcp/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Connectry-io/connectrylab-omnitrade-mcp?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
|
|
25
25
|
</p>
|
|
26
26
|
|
|
27
27
|
<p align="center">
|
|
28
28
|
<a href="#-quick-start">Quick Start</a> •
|
|
29
29
|
<a href="#-features">Features</a> •
|
|
30
|
+
<a href="#-desktop-app">Desktop App</a> •
|
|
30
31
|
<a href="#-examples">Examples</a> •
|
|
31
32
|
<a href="#-tui-dashboard">Dashboard</a> •
|
|
32
33
|
<a href="#-paper-trading">Paper Trading</a> •
|
|
@@ -36,7 +37,7 @@
|
|
|
36
37
|
|
|
37
38
|
---
|
|
38
39
|
|
|
39
|
-
> ⚠️ **Disclaimer:** OmniTrade is a developer tool and does not constitute financial advice. Cryptocurrency trading involves substantial risk. Connectry Labs is not a licensed financial advisor. Always do your own research and consult a qualified financial advisor before making investment decisions. [Use at your own risk.](https://github.com/Connectry-io/omnitrade-mcp/blob/main/LICENSE)
|
|
40
|
+
> ⚠️ **Disclaimer:** OmniTrade is a developer tool and does not constitute financial advice. Cryptocurrency trading involves substantial risk. Connectry Labs is not a licensed financial advisor. Always do your own research and consult a qualified financial advisor before making investment decisions. [Use at your own risk.](https://github.com/Connectry-io/connectrylab-omnitrade-mcp/blob/main/LICENSE)
|
|
40
41
|
|
|
41
42
|
## 💬 What is OmniTrade?
|
|
42
43
|
|
|
@@ -119,6 +120,26 @@ Practice risk-free with a virtual $10,000 USDT wallet. Buy and sell at live mark
|
|
|
119
120
|
|
|
120
121
|
<br />
|
|
121
122
|
|
|
123
|
+
## 🖥️ Desktop App
|
|
124
|
+
|
|
125
|
+
OmniTrade ships a native desktop GUI built with Tauri — Dashboard, Prices, Portfolio, Alerts, DCA, and Settings in a standalone app.
|
|
126
|
+
|
|
127
|
+
### Download
|
|
128
|
+
|
|
129
|
+
| Platform | File | Notes |
|
|
130
|
+
|----------|------|-------|
|
|
131
|
+
| macOS | `.dmg` | Built automatically on each release |
|
|
132
|
+
| Windows | `.msi` / `.exe` | Built automatically on each release |
|
|
133
|
+
| Linux (portable) | `.AppImage` | Run without installing |
|
|
134
|
+
| Linux (Debian/Ubuntu) | `.deb` | `dpkg -i OmniTrade_*.deb` |
|
|
135
|
+
| Linux (RedHat/Fedora) | `.rpm` | `rpm -i OmniTrade-*.rpm` |
|
|
136
|
+
|
|
137
|
+
👉 **[Download from GitHub Releases](https://github.com/Connectry-io/connectrylab-omnitrade-mcp/releases)**
|
|
138
|
+
|
|
139
|
+
The desktop app reads your existing `~/.omnitrade/config.json` — no extra setup needed after running `omnitrade setup`.
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
122
143
|
## 🚀 Quick Start
|
|
123
144
|
|
|
124
145
|
### 1. Install
|
|
@@ -499,13 +520,17 @@ The wizard walks you through:
|
|
|
499
520
|
| Channel | How to configure |
|
|
500
521
|
|---------|-----------------|
|
|
501
522
|
| **Native OS** | Zero setup — uses system notifications on macOS, Windows, and Linux |
|
|
502
|
-
| **Telegram** | Create a bot via [@BotFather](https://t.me/BotFather), get your
|
|
523
|
+
| **Telegram** | Create a bot via [@BotFather](https://t.me/BotFather) → get the **Bot Token** (long string like `7481234567:AAHdqTcvCH1v...`), then get your **Chat ID** (numeric, from the getUpdates URL) |
|
|
503
524
|
| **Discord** | Create a webhook in your server's channel settings, paste the URL |
|
|
504
525
|
|
|
526
|
+
> **API key input:** Keys and secrets are masked as you type — nothing shown in plaintext in the terminal.
|
|
527
|
+
|
|
505
528
|
4. **Claude integration** — auto-writes to Claude Desktop config and optionally `~/.claude/settings.json` for Claude Code
|
|
506
529
|
|
|
507
530
|
You can re-run `omnitrade setup` at any time to update credentials or add new notification channels.
|
|
508
531
|
|
|
532
|
+
> **Tip:** Re-running setup won't wipe your existing config. It detects your current keys and lets you keep, update, or skip each exchange individually.
|
|
533
|
+
|
|
509
534
|
### Dashboard — Full-Screen TUI *(v0.9.0)*
|
|
510
535
|
|
|
511
536
|
Launch the Bloomberg Terminal-style interface with live prices, charts, and portfolio panel.
|
|
@@ -677,7 +702,7 @@ OmniTrade provides **40 tools** organized by category:
|
|
|
677
702
|
- ✅ **API keys stay on your machine** — Never sent anywhere else
|
|
678
703
|
- ✅ **No cloud storage** — Everything local
|
|
679
704
|
- ✅ **No telemetry** — Zero data collection
|
|
680
|
-
- ✅ **Open source** — [Audit the code yourself](https://github.com/Connectry-io/omnitrade-mcp)
|
|
705
|
+
- ✅ **Open source** — [Audit the code yourself](https://github.com/Connectry-io/connectrylab-omnitrade-mcp)
|
|
681
706
|
|
|
682
707
|
### API Key Best Practices
|
|
683
708
|
|
|
@@ -741,7 +766,7 @@ We love contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
|
741
766
|
|
|
742
767
|
```bash
|
|
743
768
|
# Clone the repo
|
|
744
|
-
git clone https://github.com/Connectry-io/omnitrade-mcp.git
|
|
769
|
+
git clone https://github.com/Connectry-io/connectrylab-omnitrade-mcp.git
|
|
745
770
|
cd omnitrade-mcp
|
|
746
771
|
|
|
747
772
|
# Install dependencies
|
|
@@ -791,7 +816,7 @@ OmniTrade is a project by [Connectry Labs](https://connectry.io/labs) — the in
|
|
|
791
816
|
</p>
|
|
792
817
|
|
|
793
818
|
<p align="center">
|
|
794
|
-
<a href="https://github.com/Connectry-io/omnitrade-mcp">GitHub</a> •
|
|
819
|
+
<a href="https://github.com/Connectry-io/connectrylab-omnitrade-mcp">GitHub</a> •
|
|
795
820
|
<a href="https://www.npmjs.com/package/omnitrade-mcp">npm</a> •
|
|
796
821
|
<a href="https://connectry.io/labs/omnitrade">Website</a>
|
|
797
822
|
</p>
|