Alice — an open-source AI trading bot covering equities, crypto, commodities, forex, and macro

master
md 75 lines 2.55 KB
Rendered Raw
1 # open-alice
2
3 > Alice — an open-source AI trading bot covering equities, crypto, commodities, forex, and macro.
4
5 ## Features
6
7 - **Multi-asset support** — equities, crypto, commodities, forex
8 - **Strategy engine** — pluggable strategies with backtesting
9 - **Risk management** — position sizing, stop-loss, take-profit
10 - **Paper trading** — test without real money
11 - **Live trading** — connect to MetaTrader 5 for execution
12 - **Web dashboard** — account, charts, positions and order ticket in your browser
13 - **Signal integration** — receive signals from TradingView and other platforms via webhooks
14 - **CLI interface** — simple command-line controls
15
16 ## Quick Start
17
18 ```bash
19 # Install
20 pip install -e .
21
22 # For webhook server functionality
23 pip install -e ".[web]"
24
25 # Run paper trading
26 alice paper --strategy sma_crossover --symbol AAPL
27
28 # Backtest
29 alice backtest --strategy sma_crossover --symbol AAPL --period 1y
30
31 # Live trading (requires MetaTrader 5 terminal running)
32 alice live --symbol EURUSD --strategy sma_crossover --login 12345678 --password your_password --server your_server
33
34 # Start webhook server for signals (e.g., from TradingView)
35 alice serve --host 0.0.0.0 --port 5000
36
37 # Start the web dashboard (needs Flask: pip install -e ".[web]")
38 alice dashboard
39 # then open http://127.0.0.1:8080
40 ```
41
42 ## Project Structure
43
44 ```
45 open-alice/
46 ├── src/
47 │ └── open_alice/
48 │ ├── __init__.py
49 │ ├── __main__.py
50 │ ├── broker/ # Broker integrations
51 │ │ ├── __init__.py
52 │ │ └── mt5.py # MetaTrader 5 integration
53 │ ├── cli.py # CLI entry point
54 │ ├── dashboard/ # Web dashboard (Flask + Chart.js)
55 │ │ ├── __init__.py
56 │ │ ├── app.py # Routes + page (account, chart, orders API)
57 │ │ └── charts.py # Strategy output -> chart JSON
58 │ ├── data.py # Market data fetching
59 │ ├── engine/ # Backtesting & execution engine
60 │ ├── signals/ # Signal reception
61 │ │ ├── __init__.py
62 │ │ └── webhook.py # Webhook signal receiver
63 │ ├── strategies/ # Trading strategies
64 │ └── risk/ # Risk management
65 ├── tests/
66 ├── .github/
67 │ └── workflows/
68 │ └── ci.yml # GitHub Actions CI
69 ├── Dockerfile # Container build instructions
70 └── docker-compose.yml # Easy deployment configuration
71 ```
72
73 ## License
74
75 AGPL-3.0