backtest-kit 5.10.0 → 6.0.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 +18 -4
- package/build/index.cjs +558 -284
- package/build/index.mjs +555 -285
- package/package.json +1 -1
- package/types.d.ts +94 -3
package/README.md
CHANGED
|
@@ -17,17 +17,31 @@ Build reliable trading systems: backtest on historical data, deploy live bots wi
|
|
|
17
17
|
|
|
18
18
|
## 🚀 Quick Start
|
|
19
19
|
|
|
20
|
-
### 🎯 The Fastest Way:
|
|
20
|
+
### 🎯 The Fastest Way: CLI Init
|
|
21
21
|
|
|
22
|
-
> **
|
|
22
|
+
> **Minimal scaffold — all boilerplate stays inside `@backtest-kit/cli`:**
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx @backtest-kit/cli --init --output backtest-kit-project
|
|
26
|
+
cd backtest-kit-project
|
|
27
|
+
npm install
|
|
28
|
+
npm start
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The generated project contains only your strategy files. There is no bootstrap, exchange registration, or runner code to maintain — all of that lives inside `@backtest-kit/cli` and is invoked via `npm start`. Library documentation is fetched automatically into `docs/lib/` on init.
|
|
32
|
+
|
|
33
|
+
### 🏗️ Alternative: Sidekick CLI
|
|
34
|
+
|
|
35
|
+
> **Full-control scaffold — all wiring is in your project files:**
|
|
23
36
|
|
|
24
37
|
```bash
|
|
25
|
-
# Create project with npx (recommended)
|
|
26
38
|
npx -y @backtest-kit/sidekick my-trading-bot
|
|
27
39
|
cd my-trading-bot
|
|
28
40
|
npm start
|
|
29
41
|
```
|
|
30
42
|
|
|
43
|
+
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.
|
|
44
|
+
|
|
31
45
|
### 📦 Manual Installation
|
|
32
46
|
|
|
33
47
|
> **Want to see the code?** 👉 [Demo app](https://github.com/tripolskypetr/backtest-kit/tree/master/demo) 👈
|
|
@@ -1661,7 +1675,7 @@ npm install @backtest-kit/signals backtest-kit
|
|
|
1661
1675
|
|
|
1662
1676
|
> **[Explore on NPM](https://www.npmjs.com/package/@backtest-kit/sidekick)** 🚀
|
|
1663
1677
|
|
|
1664
|
-
The **@backtest-kit/sidekick** package is
|
|
1678
|
+
The **@backtest-kit/sidekick** package scaffolds a project where **all wiring is visible and editable** in your project files — exchange adapter, frame definitions, risk rules, strategy logic, and the runner script. Think of it as the **eject** of `@backtest-kit/cli --init`: instead of the boilerplate being hidden inside the CLI package, it lives directly in your project.
|
|
1665
1679
|
|
|
1666
1680
|
#### Key Features
|
|
1667
1681
|
- 🚀 **Zero Config**: Get started with one command - no setup required
|