Tools
Trading Assistant
OpenClaw Trading Assistant - A fully functional trading decision support system that provides technical analysis, buy/sell signals, position management, and risk monitoring.
Install
npm install -g
README
# ๐ OpenClaw Trading Assistant
<div align="center">
**Version**: v1.3.1 (2026-03-25)
**Author**: OpenClaw Community
**License**: MIT
[๐ Docs Website](https://xuxuclassmate.github.io/trading-assistant/) โข [Features](#-features) โข [Installation](#-installation) โข [Usage](#-usage)
---
### ๐ Language / ่ฏญ่จ
**[Switch to Chinese โ](README_zh.md)**
---
</div>
---
## ๐ Introduction
**OpenClaw Trading Assistant** is a complete trading decision support system that provides technical analysis, trading signals, position management, and risk monitoring.
### โจ Key Features
- ๐ **Support & Resistance Levels** - Automatic calculation with multiple algorithms
- ๐ **Trading Signals** - Multi-indicator analysis (RSI, MACD, Moving Averages)
- ๐ฐ **Position Calculator** - Risk-based position sizing
- ๐ฏ **Stop Loss & Take Profit** - Price alerts and trigger detection
- โ ๏ธ **Risk Management** - Risk/Reward ratio, potential profit/loss
- ๐ **Notifications** - Feishu, DingTalk, Email (configurable)
### ๐ฏ Perfect For
- Stock/ETF investors
- Technical analysis enthusiasts
- Quantitative trading beginners
- OpenClaw users
---
## โจ Features
### 1. Support & Resistance Levels
- Automatic calculation of key price levels
- Multiple algorithms: Previous High/Low, Moving Averages, Fibonacci, Pivot Points
- Strength indicator (strong/medium/weak)
**Example Output**:
```
NVDA Current Price: $175.64
Resistance: $177.26 (+0.9%), $180.00 (+2.5%)
Support: $175.00 (-0.4%), $171.72 (-2.2%)
```
---
### 2. Trading Signals
- Multi-indicator analysis (RSI, MACD, Moving Averages)
- Combined signal scoring
- Recommendations: Strong Buy / Buy / Hold / Sell / Strong Sell
**Example Output**:
```
RSI: 52.34 [Neutral]
MACD: 0.1234 [Bullish]
Moving Averages: [Bullish]
Combined: Bullish (score: 3)
Recommendation: BUY (Confidence: Medium)
```
---
### 3. Position Calculator
- Risk-based position sizing
- Risk profiles: Conservative / Moderate / Aggressive
- Confidence adjustment
- Stop-loss calculation
- Portfolio allocation
**Example Output**:
```
Total Capital: $100,000
Entry Price: $175.64
Stop Loss: $165.00
Risk Profile: Moderate
Position: 562 shares ($98,710, 98.7%)
Risk: $5,964 (5.96%)
Risk/Reward: 1:2.0
```
---
## ๐ ๏ธ Installation
**๐ Complete guides**: https://xuxuclassmate.github.io/trading-assistant/guides/install-overview/
### Quick Comparison
| Method | Command | Time |
|--------|---------|------|
| **Docker** โญ | `docker run -it ghcr.io/xuxuclassmate/trading-assistant:latest` | 5 min |
| **pip** | `pip install openclaw-trading-assistant` | 10 min |
| **npm** | `npm install -g @xuxuclassmate/openclaw-trading-assistant` | 10 min |
| **Source** | `git clone + pip install -e .` | 15 min |
### Prerequisites
- Twelve Data API Key ([Get Free](https://twelvedata.com/pricing) - 800 calls/day)
- Alpha Vantage API Key ([Get Free](https://www.alphavantage.co/support/#api-key) - 25 calls/day)
### ๐ณ Docker Installation (Recommended)
**Pull from GitHub Container Registry**:
```bash
docker pull ghcr.io/xuxuclassmate/trading-assistant:latest
```
**Pull from Docker Hub**:
```bash
docker pull xuxuclassmate/trading-assistant:latest
```
**Quick Start**:
```bash
# Create config directory
mkdir -p trading-assistant-config
cd trading-assistant-config
# Download example config
curl -O https://raw.githubusercontent.com/XuXuClassMate/trading-assistant/main/.env.example
cp .env.example .env
# Edit .env with your API keys
nano .env # or use your favorite editor
# Run the container
docker run --rm -it \
-v $(pwd)/.env:/app/.env \
-v $(pwd)/watchlist.txt:/app/watchlist.txt \
ghcr.io/xuxuclassmate/trading-assistant:latest \
--help
```
**Available Images**:
- `ghcr.io/xuxuclassmate/trading-assistant:1.2.0` - Specific version
- `ghcr.io/xuxuclassmate/trading-assistant:latest` - Latest stable
- `xuxuclassmate/trading-assistant:1.2.0` - Docker Hub (versioned)
- `xuxuclassmate/trading-assistant:latest` - Docker Hub (latest)
**Supported Platforms**: linux/amd64, linux/arm64
---
## ๐ฅ๏ธ CLI Usage
### ๐ Quick Start
```bash
# Start interactive mode (short & sweet!)
ta
# Full name also works
openclaw-trading-assistant
```
### ๐ Available Commands
| Command | Example | Description |
|---------|---------|-------------|
| `ta` | `ta` | Start interactive mode / ไบคไบๆจกๅผ |
| `ta sr` | `ta sr` | Analyze support/resistance / ๅๆๆฏๆ้ปๅไฝ |
| `ta sig` | `ta sig --symbol NVDA` | Generate signals / ็ๆไฟกๅท |
| `ta pos` | `ta pos --symbol NVDA --price 175 --capital 10000` | Calculate position / ่ฎก็ฎไปไฝ |
| `ta alerts` | `ta alerts check` | Manage alerts / ็ฎก็ๆ้ |
| `ta all` | `ta all` | Run all analysis / ่ฟ่กๆๆๅๆ |
| `ta v` | `ta v` | Show version / ๆพ็คบ็ๆฌ |
| `ta h` | `ta h` | Show help / ๆพ็คบๅธฎๅฉ |
### ๐ก Examples
**Interactive Mode**:
```bash
$ ta
============================================================
OpenClaw Trading Assistant CLI
Version: 1.3.0
============================================================
ta> help
ta> sig
ta> pos --symbol NVDA --price 175.64 --capital 10000
ta> exit
```
**Direct Commands**:
```bash
ta sr # Support/Resistance
ta sig # Signals for watchlist
ta sig --symbol NVDA # Signals for specific stock
ta pos --symbol NVDA --price 175.64 --capital 10000
ta alerts check
ta all # Run everything
```
### ๐ณ Docker CLI Usage
```bash
# Interactive mode in Docker
docker run --rm -it \
-v $(pwd)/.env:/app/.env \
-v $(pwd)/watchlist.txt:/app/watchlist.txt \
ghcr.io/xuxuclassmate/trading-assistant:latest
# Direct command in Docker
docker run --rm -it \
-v $(pwd)/.env:/app/.env \
-v $(pwd)/watchlist.txt:/app/watchlist.txt \
ghcr.io/xuxuclassmate/trading-assistant:latest \
ta sig
```
---
## ๐ Internationalization
**Default Language**: English (`en`)
**Switch Language**:
```bash
# Method 1: Environment Variable
export TRADING_ASSISTANT_LANG=zh_CN
# Method 2: In Code
from i18n import set_language
set_language("zh_CN")
# Method 3: Config File
# Add to config.json: {"language": "zh_CN"}
```
**Supported Languages**:
- English (`en`) - Default
- Chinese Simplified (`zh_CN`)
๐ [See I18N Documentation](docs/I18N.md)
---
## โ๏ธ Configuration
### Required
1. **API Keys** - Twelve Data & Alpha Vantage
2. **Watchlist** - Your stock list
### Optional
1. **Notifications** - Feishu, DingTalk, Email (leave empty to disable)
2. **Risk Profile** - Conservative/Moderate/Aggressive
3. **Language** - English/Chinese
๐ [See Full Configuration Guide](docs/CONFIGURATION.md)
---
## ๐ Usage
### Basic Usage
```python
# Support & Resistance
from support_resistance import calculate_support_resistance
result = calculate_support_resistance("NVDA")
# Trading Signals
from trading_signals import generate_trading_signal
result = generate_trading_signal("AAPL")
# Position Calculation
from position_calculator import calculate_position_size
result = calculate_position_size(
total_capital=100000,
entry_price=175.64,
stop_loss_price=165.00,
risk_profile="moderate"
)
```
๐ [See Full Usage Guide](README_CLAWHUB.md)
---
## ๐ Project Structure
```
trading-assistant/
โโโ config.py # Configuration
โโโ i18n.py # Internationalization
โโโ support_resistance.py # Support/Resistance (Day 1)
โโโ trading_signals.py # Trading Signals (Day 1)
โโโ position_calculator.py # Position Calculator (Day 1)
โโโ stop_loss_alerts.py # Stop Loss & Take Profit (Day 2)
โโโ locales/
โ โโโ en.json # English translations
โ โโโ zh_CN.json # Chinese translations
โโโ data/
โ โโโ alerts/ # Alert persistence (JSON)
โโโ logs/ # Log files
โโโ docs/
โ โโโ I18N.md # i18n documentation
โ โโโ CONFIGURATION.md # Configuration guide
โ โโโ PUBLISHING.md # Package publishing guide
โ โโโ V1.1.0_SUCCESS.md # v1.1.0 release summary
โโโ .github/
โ โโโ workflows/
โ โโโ publish.yml # Auto-publish workflow
โ โโโ publish-gh.yml # GitHub Packages workflow
โโโ scripts/ # Utility scripts
โโโ requirements.txt # Dependencies
โโโ pyproject.toml # Python package config
โโโ .env.example # Environment template
โโโ watchlist.txt.example # Watchlist template
โโโ LICENSE # MIT License
โโโ README.md # This file (English)
โโโ README_zh.md # Chinese version
```
---
## ๐งช Testing
```bash
# Test all modules
python3 support_resistance.py
python3 trading_signals.py
python3 position_calculator.py
# Run unit tests
python3 -m pytest tests/
```
---
## ๐ Version History
### v1.1.0 (2026-03-24) - Stop Loss & Take Profit Alerts
**New Features**:
- โ
Stop Loss & Take Profit alert system
- โ
Automatic price trigger detection
- โ
Risk/Reward ratio calculation
- โ
Potential profit/loss estimation
- โ
JSON-based alert persistence
- โ
Detailed logging
**Files Added**:
- `stop_loss_alerts.py` - Alert management module
- `data/alerts/` - Alert data storage
- `logs/` - Log file directory
**Usage Example**:
```python
from stop_loss_alerts import StopLossAlert, calculate_stop_loss_levels
# Calculate levels
levels = calculate_stop_loss_levels(
entry_price=175.64,
stop_loss_percent=5.0,
take_profit_percent=10.0
)
# Create alert
alert = StopLossAlert("NVDA", 175.64)
alert.create_alert(
entry_price=175.64,
stop_loss_price=levels['stop_loss_price'],
take_profit_price=levels['take_profit_price'],
shares=100
)
```
---
### v1.0.0 (2026-03-24) - Initial Release
**Features**:
- โ
Support & Resistance calculation
- โ
Trading signal generation (RSI, MACD, MA)
- โ
Position size calculator
- โ
Multi-language support (EN/ZH)
- โ
Configurable notifications
- โ
Portfolio allocation
๐ [See Full Release Notes](CHANGELOG.md)
---
## โ ๏ธ Disclaimer
This s
... (truncated)
tools
Comments
Sign in to leave a comment