่ทณ่ฝฌ่‡ณ

๐Ÿ“š 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?