Skip to content

📚 Installation Overview

Choose your installation method / 选择安装方式

🎯 Quick Comparison

Method Difficulty Time Best For
🐳 Docker ⭐ Easy 5 min Quick start, no setup
🐍 pip ⭐⭐ Medium 10 min Python developers
📦 npm ⭐⭐ Medium 10 min Node.js projects
🔧 Source ⭐⭐⭐ Advanced 15 min Developers, contributors

For Most Users → Docker

Why: No Python/Node.js setup, works everywhere

docker run --rm -it \
  -v $(pwd)/.env:/app/.env \
  ghcr.io/xuxuclassmate/trading-assistant:latest

→ Docker Guide

For Python Developers → pip

Why: Native Python integration, easy to extend

pip install openclaw-trading-assistant

→ pip Guide

For Node.js Developers → npm

Why: Use in JavaScript/TypeScript projects

npm install -g @xuxuclassmate/openclaw-trading-assistant

→ npm Guide

For Contributors → Source

Why: Full access to code, make modifications

git clone https://github.com/XuXuClassMate/trading-assistant.git
cd trading-assistant
pip install -e .

→ Source Guide

📋 Prerequisites

API Keys Required

All methods require these free API keys:

  1. Twelve Data - 800 calls/day free

  2. Get: https://twelvedata.com/pricing

  3. Alpha Vantage - 25 calls/day free

  4. Get: https://www.alphavantage.co/support/#api-key

→ API Setup Guide

🎯 Next Steps

After installation:

  1. Configure API Keys
  2. Setup Watchlist
  3. Learn CLI Commands
  4. First Analysis

❓ Need Help?