backtest-kit 8.2.0 → 8.4.0
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 +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
Build reliable trading systems: backtest on historical data, deploy live bots with recovery, and optimize strategies using LLMs like Ollama.
|
|
15
15
|
|
|
16
|
-
📚 **[API Reference](https://backtest-kit.github.io/documents/example_02_first_backtest.html)** | 🌟 **[Quick Start](https://github.com/tripolskypetr/backtest-kit/tree/master/
|
|
16
|
+
📚 **[API Reference](https://backtest-kit.github.io/documents/example_02_first_backtest.html)** | 🌟 **[Quick Start](https://github.com/tripolskypetr/backtest-kit/tree/master/example)** | **📰 [Article](https://backtest-kit.github.io/documents/article_07_ai_news_trading_signals.html)**
|
|
17
17
|
|
|
18
18
|
## 🚀 Quick Start
|
|
19
19
|
|
|
@@ -44,6 +44,19 @@ npm start
|
|
|
44
44
|
|
|
45
45
|
Sidekick generates a project where the exchange adapter, frame definitions, risk rules, strategy logic, and runner script all live as editable source files inside the project. Use it when you need full visibility and control over every part of the setup.
|
|
46
46
|
|
|
47
|
+
### 🐳 Running in Docker
|
|
48
|
+
|
|
49
|
+
> **Automatic restarts — Zero-downtime trading:**
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
npx @backtest-kit/cli --docker
|
|
53
|
+
cd backtest-kit-docker
|
|
54
|
+
MODE=live SYMBOL=TRXUSDT UI=1 docker-compose up -d
|
|
55
|
+
docker-compose logs -f
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
CLI can create a ready-to-use Docker workspace: self-contained directory with `docker-compose.yaml` and a strategy entry point.
|
|
59
|
+
|
|
47
60
|
### 📦 Manual Installation
|
|
48
61
|
|
|
49
62
|
> **Want to see the code?** 👉 [Demo app](https://github.com/tripolskypetr/backtest-kit/tree/master/example) 👈
|
|
@@ -52,6 +65,8 @@ Sidekick generates a project where the exchange adapter, frame definitions, risk
|
|
|
52
65
|
npm install backtest-kit ccxt ollama uuid
|
|
53
66
|
```
|
|
54
67
|
|
|
68
|
+
Install the core library and peer dependencies manually. Use this approach when integrating backtest-kit into an existing project or when you need full control over your package setup.
|
|
69
|
+
|
|
55
70
|
## ✨ Why Choose Backtest Kit?
|
|
56
71
|
|
|
57
72
|
- 🚀 **Production-Ready**: Seamless switch between backtest/live modes; identical code across environments.
|