@backtest-kit/cli 0.0.4 → 0.0.5

package/README.md

@@ -137,11 +137,12 @@ npm start -- --symbol BTCUSDT --ui
 | `--ui`                    | boolean | Start web UI dashboard (default: `false`)                          |
 | `--telegram`              | boolean | Enable Telegram notifications (default: `false`)                   |
 | `--verbose`               | boolean | Log each candle fetch (default: `false`)                           |
+| `--noCache`               | boolean | Skip candle cache warming before backtest (default: `false`)       |
 | `--symbol`                | string  | Trading pair (default: `"BTCUSDT"`)                                |
 | `--strategy`              | string  | Strategy name (default: first registered)                          |
 | `--exchange`              | string  | Exchange name (default: first registered)                          |
 | `--frame`                 | string  | Backtest frame name (default: first registered)                    |
-| `--cache`                 | string  | Intervals to pre-cache before backtest (default: `"1m, 15m, 30m, 4h"`) |
+| `--cacheInterval`         | string  | Intervals to pre-cache before backtest (default: `"1m, 15m, 30m, 4h"`) |
 
 **Positional argument (required):** path to your strategy entry point file (set once in `package.json` scripts).
 
@@ -162,7 +163,7 @@ Runs the strategy against historical candle data using a registered `FrameSchema
 ```json
 {
   "scripts": {
-    "backtest": "@backtest-kit/cli --backtest --symbol ETHUSDT --strategy my-strategy --exchange binance --frame feb-2024 --cache \"1m, 15m, 1h, 4h\" ./src/index.mjs"
+    "backtest": "@backtest-kit/cli --backtest --symbol ETHUSDT --strategy my-strategy --exchange binance --frame feb-2024 --cacheInterval \"1m, 15m, 1h, 4h\" ./src/index.mjs"
   }
 }
 ```
@@ -171,7 +172,7 @@ Runs the strategy against historical candle data using a registered `FrameSchema
 npm run backtest
 ```
 
-Before running, the CLI warms the candle cache for every interval in `--cache`. On the next run, cached data is used directly — no API calls needed.
+Before running, the CLI warms the candle cache for every interval in `--cacheInterval`. On the next run, cached data is used directly — no API calls needed. Pass `--noCache` to skip this step entirely.
 
 ### Paper Trading
 
@@ -389,7 +390,7 @@ When your strategy module does not register an exchange, frame, or strategy name
 | **Exchange** | CCXT Binance (`default_exchange`) | `Warning: The default exchange schema is set to CCXT Binance...`       |
 | **Frame**    | February 2024 (`default_frame`)   | `Warning: The default frame schema is set to February 2024...`         |
 | **Symbol**   | `BTCUSDT`                         | —                                                                      |
-| **Cache intervals** | `1m, 15m, 30m, 4h`         | Shown if `--cache` not provided                                        |
+| **Cache intervals** | `1m, 15m, 30m, 4h`         | Used if `--cacheInterval` not provided; skip entirely with `--noCache` |
 
 > **Note:** The default exchange schema **does not support order book fetching in backtest mode**. If your strategy calls `getOrderBook()` during backtest, you must register a custom exchange schema with your own snapshot storage.
 
@@ -424,7 +425,8 @@ await run(mode, args);
 | `strategy` | `string` | Strategy name (default: first registered) |
 | `exchange` | `string` | Exchange name (default: first registered) |
 | `frame` | `string` | Frame name (default: first registered) |
-| `cacheList` | `CandleInterval[]` | Intervals to pre-cache (default: `["1m","15m","30m","1h","4h"]`) |
+| `cacheInterval` | `CandleInterval[]` | Intervals to pre-cache (default: `["1m","15m","30m","1h","4h"]`) |
+| `noCache` | `boolean` | Skip candle cache warming (default: `false`) |
 | `verbose` | `boolean` | Log each candle fetch (default: `false`) |
 
 **Paper** and **Live** (`mode: "paper"` / `mode: "live"`):
@@ -448,7 +450,7 @@ await run('backtest', {
   entryPoint: './src/index.mjs',
   symbol: 'ETHUSDT',
   frame: 'feb-2024',
-  cacheList: ['1m', '15m', '1h'],
+  cacheInterval: ['1m', '15m', '1h'],
   verbose: true,
 });
 ```

package/build/index.cjs

@@ -6,6 +6,7 @@ var functoolsKit = require('functools-kit');
 var fs = require('fs');
 var stackTrace = require('stack-trace');
 var url = require('url');
+var module$1 = require('module');
 var path = require('path');
 var fs$1 = require('fs/promises');
 var dotenv = require('dotenv');
@@ -22,7 +23,6 @@ var MarkdownIt = require('markdown-it');
 var sanitizeHtml = require('sanitize-html');
 var jsdom = require('jsdom');
 var Mustache = require('mustache');
-var module$1 = require('module');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
@@ -84,7 +84,7 @@ var stackTrace__namespace = /*#__PURE__*/_interopNamespaceDefault(stackTrace);
 }
 {
     backtestKit.StorageLive.usePersist();
-    backtestKit.StorageBacktest.useDummy();
+    backtestKit.StorageBacktest.useMemory();
 }
 {
     backtestKit.NotificationLive.useDummy();
@@ -232,6 +232,24 @@ const entrySubject = new functoolsKit.BehaviorSubject();
 
 const __filename$1 = url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
 const __dirname$1 = path.dirname(__filename$1);
+const require$2 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+const REQUIRE_ENTRY_FACTORY = (filePath) => {
+    try {
+        require$2(filePath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+const IMPORT_ENTRY_FACTORY = async (filePath) => {
+    await import(url.pathToFileURL(filePath).href);
+};
+const LOAD_ENTRY_FN = async (filePath) => {
+    if (!REQUIRE_ENTRY_FACTORY(filePath)) {
+        await IMPORT_ENTRY_FACTORY(filePath);
+    }
+};
 let _is_launched = false;
 class ResolveService {
     constructor() {
@@ -250,9 +268,9 @@ class ResolveService {
             {
                 const cwd = process.cwd();
                 process.chdir(moduleRoot);
-                dotenv.config({ path: path.join(cwd, '.env') });
-                dotenv.config({ path: path.join(moduleRoot, '.env'), override: true });
-                await import(url.pathToFileURL(absolutePath).href);
+                dotenv.config({ path: path.join(cwd, '.env'), override: true, quiet: true });
+                dotenv.config({ path: path.join(moduleRoot, '.env'), override: true, quiet: true });
+                await LOAD_ENTRY_FN(absolutePath);
                 await entrySubject.next(absolutePath);
             }
             _is_launched = true;
@@ -395,7 +413,11 @@ const getArgs = functoolsKit.singleshot(() => {
                 type: "boolean",
                 default: false,
             },
-            cache: {
+            noCache: {
+                type: "boolean",
+                default: false,
+            },
+            cacheInterval: {
                 type: "string",
                 default: "1m, 15m, 30m, 4h",
             },
@@ -459,17 +481,64 @@ const notifyFinish = functoolsKit.singleshot(() => {
 });
 
 const getEntry = (metaUrl) => {
-    return process.argv[1] === new URL(metaUrl).pathname;
+    const metaPath = url.fileURLToPath(metaUrl);
+    return path.resolve(process.argv[1]) === path.resolve(metaPath);
 };
 
+const notifyVerbose = functoolsKit.singleshot(() => {
+    console.log("Using verbose logging...");
+    backtestKit.listenSignal((event) => {
+        if (event.action === "scheduled") {
+            console.log(`[POSITION SCHEDULED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Current Price: ${event.currentPrice}`);
+            console.log(`  Entry Price: ${event.signal.priceOpen}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Direction: ${event.signal.position}`);
+            console.log(`  Stop Loss: ${event.signal.priceStopLoss}`);
+            console.log(`  Take Profit: ${event.signal.priceTakeProfit}`);
+            return;
+        }
+        if (event.action === "opened") {
+            console.log(`[POSITION OPENED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Entry Price: ${event.currentPrice}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Direction: ${event.signal.position}`);
+            console.log(`  Stop Loss: ${event.signal.priceStopLoss}`);
+            console.log(`  Take Profit: ${event.signal.priceTakeProfit}`);
+            return;
+        }
+        if (event.action === "closed") {
+            console.log(`[POSITION CLOSED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Entry Price (adj): ${event.pnl.priceOpen}`);
+            console.log(`  Exit Price (adj): ${event.pnl.priceClose}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Close Reason: ${event.closeReason}`);
+            console.log(`  PnL: ${event.pnl.pnlPercentage.toFixed(2)}%`);
+            console.log(`  Win: ${event.pnl.pnlPercentage > 0 ? "YES" : "NO"}`);
+            return;
+        }
+        if (event.action === "cancelled") {
+            console.log(`[POSITION CANCELLED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Current Price: ${event.currentPrice}`);
+            console.log(`  Cancel Reason: ${event.reason}`);
+            console.log(`  Cancelled At: ${new Date(event.closeTimestamp).toISOString()}`);
+            return;
+        }
+    });
+});
+
 const DEFAULT_CACHE_LIST = ["1m", "15m", "30m", "1h", "4h"];
-const GET_CACHE_LIST_FN = () => {
+const GET_CACHE_INTERVAL_LIST_FN = () => {
     const { values } = getArgs();
-    if (!values.cache) {
-        console.warn(`Warning: No cache timeframes provided. Using default timeframes: ${DEFAULT_CACHE_LIST.join(", ")}`);
+    if (!values.cacheInterval) {
         return DEFAULT_CACHE_LIST;
     }
-    return String(values.cache)
+    return String(values.cacheInterval)
         .split(",")
         .map((timeframe) => timeframe.trim());
 };
@@ -513,8 +582,8 @@ class BacktestMainService {
             if (!frameName) {
                 throw new Error("Frame name is required");
             }
-            {
-                await this.cacheLogicService.execute(payload.cacheList, {
+            if (!payload.noCache) {
+                await this.cacheLogicService.execute(payload.cacheInterval, {
                     exchangeName,
                     frameName,
                     symbol,
@@ -529,6 +598,7 @@ class BacktestMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             backtestKit.Backtest.background(symbol, {
                 strategyName,
@@ -546,19 +616,20 @@ class BacktestMainService {
             if (!values.backtest) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }
-            const cacheList = GET_CACHE_LIST_FN();
+            const cacheInterval = GET_CACHE_INTERVAL_LIST_FN();
             return await this.run({
                 symbol: values.symbol,
                 entryPoint,
-                cacheList,
+                cacheInterval,
                 exchange: values.exchange,
                 frame: values.frame,
                 strategy: values.strategy,
                 verbose: values.verbose,
+                noCache: values.noCache,
             });
         });
     }
@@ -607,6 +678,7 @@ class LiveMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             backtestKit.Live.background(symbol, {
                 strategyName,
@@ -623,7 +695,7 @@ class LiveMainService {
             if (!values.live) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }
@@ -677,6 +749,7 @@ class PaperMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             backtestKit.Live.background(symbol, {
                 strategyName,
@@ -693,7 +766,7 @@ class PaperMainService {
             if (!values.paper) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }

package/build/index.mjs

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
-import { Storage, Notification, Markdown, Report, StorageLive, StorageBacktest, NotificationLive, NotificationBacktest, listExchangeSchema, addExchangeSchema, roundTicks, listFrameSchema, addFrameSchema, listenDoneLive, listenDoneBacktest, listStrategySchema, overrideExchangeSchema, Backtest, Live, getCandles, checkCandles, warmCandles, listenRisk, listenSignal, listenStrategyCommit } from 'backtest-kit';
+import { Storage, Notification, Markdown, Report, StorageLive, StorageBacktest, NotificationLive, NotificationBacktest, listExchangeSchema, addExchangeSchema, roundTicks, listFrameSchema, addFrameSchema, listenDoneLive, listenDoneBacktest, listenSignal, listStrategySchema, overrideExchangeSchema, Backtest, Live, getCandles, checkCandles, warmCandles, listenRisk, listenStrategyCommit } from 'backtest-kit';
 import { getErrorMessage, errorData, singleshot, str, BehaviorSubject, compose, execpool, queued, sleep, randomString, createAwaiter, TIMEOUT_SYMBOL, typo, retry, memoize, trycatch } from 'functools-kit';
 import fs, { constants } from 'fs';
 import * as stackTrace from 'stack-trace';
 import { fileURLToPath, pathToFileURL } from 'url';
+import { createRequire } from 'module';
 import path from 'path';
 import fs$1, { access } from 'fs/promises';
 import dotenv from 'dotenv';
@@ -20,7 +21,6 @@ import MarkdownIt from 'markdown-it';
 import sanitizeHtml from 'sanitize-html';
 import { JSDOM } from 'jsdom';
 import Mustache from 'mustache';
-import { createRequire } from 'module';
 
 /**
  * Fix for `Attempted to assign to readonly property (at redactToken)`
@@ -62,7 +62,7 @@ import { createRequire } from 'module';
 }
 {
     StorageLive.usePersist();
-    StorageBacktest.useDummy();
+    StorageBacktest.useMemory();
 }
 {
     NotificationLive.useDummy();
@@ -210,6 +210,24 @@ const entrySubject = new BehaviorSubject();
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
+const require$1 = createRequire(import.meta.url);
+const REQUIRE_ENTRY_FACTORY = (filePath) => {
+    try {
+        require$1(filePath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+const IMPORT_ENTRY_FACTORY = async (filePath) => {
+    await import(pathToFileURL(filePath).href);
+};
+const LOAD_ENTRY_FN = async (filePath) => {
+    if (!REQUIRE_ENTRY_FACTORY(filePath)) {
+        await IMPORT_ENTRY_FACTORY(filePath);
+    }
+};
 let _is_launched = false;
 class ResolveService {
     constructor() {
@@ -228,9 +246,9 @@ class ResolveService {
             {
                 const cwd = process.cwd();
                 process.chdir(moduleRoot);
-                dotenv.config({ path: path.join(cwd, '.env') });
-                dotenv.config({ path: path.join(moduleRoot, '.env'), override: true });
-                await import(pathToFileURL(absolutePath).href);
+                dotenv.config({ path: path.join(cwd, '.env'), override: true, quiet: true });
+                dotenv.config({ path: path.join(moduleRoot, '.env'), override: true, quiet: true });
+                await LOAD_ENTRY_FN(absolutePath);
                 await entrySubject.next(absolutePath);
             }
             _is_launched = true;
@@ -373,7 +391,11 @@ const getArgs = singleshot(() => {
                 type: "boolean",
                 default: false,
             },
-            cache: {
+            noCache: {
+                type: "boolean",
+                default: false,
+            },
+            cacheInterval: {
                 type: "string",
                 default: "1m, 15m, 30m, 4h",
             },
@@ -437,17 +459,64 @@ const notifyFinish = singleshot(() => {
 });
 
 const getEntry = (metaUrl) => {
-    return process.argv[1] === new URL(metaUrl).pathname;
+    const metaPath = fileURLToPath(metaUrl);
+    return path.resolve(process.argv[1]) === path.resolve(metaPath);
 };
 
+const notifyVerbose = singleshot(() => {
+    console.log("Using verbose logging...");
+    listenSignal((event) => {
+        if (event.action === "scheduled") {
+            console.log(`[POSITION SCHEDULED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Current Price: ${event.currentPrice}`);
+            console.log(`  Entry Price: ${event.signal.priceOpen}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Direction: ${event.signal.position}`);
+            console.log(`  Stop Loss: ${event.signal.priceStopLoss}`);
+            console.log(`  Take Profit: ${event.signal.priceTakeProfit}`);
+            return;
+        }
+        if (event.action === "opened") {
+            console.log(`[POSITION OPENED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Entry Price: ${event.currentPrice}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Direction: ${event.signal.position}`);
+            console.log(`  Stop Loss: ${event.signal.priceStopLoss}`);
+            console.log(`  Take Profit: ${event.signal.priceTakeProfit}`);
+            return;
+        }
+        if (event.action === "closed") {
+            console.log(`[POSITION CLOSED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Entry Price (adj): ${event.pnl.priceOpen}`);
+            console.log(`  Exit Price (adj): ${event.pnl.priceClose}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Close Reason: ${event.closeReason}`);
+            console.log(`  PnL: ${event.pnl.pnlPercentage.toFixed(2)}%`);
+            console.log(`  Win: ${event.pnl.pnlPercentage > 0 ? "YES" : "NO"}`);
+            return;
+        }
+        if (event.action === "cancelled") {
+            console.log(`[POSITION CANCELLED] ${event.symbol}`);
+            console.log(`  Strategy: ${event.strategyName}`);
+            console.log(`  Signal ID: ${event.signal.id}`);
+            console.log(`  Current Price: ${event.currentPrice}`);
+            console.log(`  Cancel Reason: ${event.reason}`);
+            console.log(`  Cancelled At: ${new Date(event.closeTimestamp).toISOString()}`);
+            return;
+        }
+    });
+});
+
 const DEFAULT_CACHE_LIST = ["1m", "15m", "30m", "1h", "4h"];
-const GET_CACHE_LIST_FN = () => {
+const GET_CACHE_INTERVAL_LIST_FN = () => {
     const { values } = getArgs();
-    if (!values.cache) {
-        console.warn(`Warning: No cache timeframes provided. Using default timeframes: ${DEFAULT_CACHE_LIST.join(", ")}`);
+    if (!values.cacheInterval) {
         return DEFAULT_CACHE_LIST;
     }
-    return String(values.cache)
+    return String(values.cacheInterval)
         .split(",")
         .map((timeframe) => timeframe.trim());
 };
@@ -491,8 +560,8 @@ class BacktestMainService {
             if (!frameName) {
                 throw new Error("Frame name is required");
             }
-            {
-                await this.cacheLogicService.execute(payload.cacheList, {
+            if (!payload.noCache) {
+                await this.cacheLogicService.execute(payload.cacheInterval, {
                     exchangeName,
                     frameName,
                     symbol,
@@ -507,6 +576,7 @@ class BacktestMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             Backtest.background(symbol, {
                 strategyName,
@@ -524,19 +594,20 @@ class BacktestMainService {
             if (!values.backtest) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }
-            const cacheList = GET_CACHE_LIST_FN();
+            const cacheInterval = GET_CACHE_INTERVAL_LIST_FN();
             return await this.run({
                 symbol: values.symbol,
                 entryPoint,
-                cacheList,
+                cacheInterval,
                 exchange: values.exchange,
                 frame: values.frame,
                 strategy: values.strategy,
                 verbose: values.verbose,
+                noCache: values.noCache,
             });
         });
     }
@@ -585,6 +656,7 @@ class LiveMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             Live.background(symbol, {
                 strategyName,
@@ -601,7 +673,7 @@ class LiveMainService {
             if (!values.live) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }
@@ -655,6 +727,7 @@ class PaperMainService {
                         },
                     },
                 });
+                notifyVerbose();
             }
             Live.background(symbol, {
                 strategyName,
@@ -671,7 +744,7 @@ class PaperMainService {
             if (!values.paper) {
                 return;
             }
-            const [entryPoint = null] = positionals;
+            const [entryPoint = null] = positionals.slice(-1);
             if (!entryPoint) {
                 throw new Error("Entry point is required");
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backtest-kit/cli",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Zero-boilerplate CLI runner for backtest-kit strategies. Run backtests, paper trading, and live bots with candle cache warming, web dashboard, and Telegram notifications — no setup code required.",
   "author": {
     "name": "Petr Tripolsky",
@@ -59,6 +59,7 @@
   },
   "devDependencies": {
     "@backtest-kit/ui": "3.1.0",
+    "markdown-it": "14.1.1",
     "@rollup/plugin-typescript": "11.1.6",
     "@types/image-size": "0.7.0",
     "@types/jsdom": "21.1.7",
@@ -77,7 +78,9 @@
     "worker-testbed": "1.0.12"
   },
   "peerDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "@backtest-kit/ui": "^3.1.0",
+    "markdown-it": "^14.1.1"
   },
   "dependencies": {
     "ccxt": "4.5.39",

package/types.d.ts

@@ -68,8 +68,9 @@ declare class BacktestMainService {
         strategy: string;
         exchange: string;
         frame: string;
-        cacheList: string[];
+        cacheInterval: string[];
         verbose: boolean;
+        noCache: boolean;
     }) => Promise<void>) & functools_kit.ISingleshotClearable;
     connect: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }