@backtest-kit/cli 0.0.1 → 0.0.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backtest-kit/cli",
-  "version": "0.0.1",
-  "description": "The CLI for launching backtests without a boilerplate",
+  "version": "0.0.3",
+  "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",
     "email": "tripolskypetr@gmail.com",
@@ -13,7 +13,23 @@
   },
   "license": "MIT",
   "homepage": "https://backtest-kit.github.io/documents/example_02_first_backtest.html",
-  "keywords": [],
+  "keywords": [
+    "backtest",
+    "backtesting",
+    "trading",
+    "cli",
+    "cryptocurrency",
+    "crypto",
+    "live-trading",
+    "paper-trading",
+    "telegram",
+    "binance",
+    "ccxt",
+    "candle-cache",
+    "strategy",
+    "typescript",
+    "monorepo"
+  ],
   "files": [
     "build",
     "types.d.ts",

package/types.d.ts

@@ -1,6 +1,6 @@
 import * as functools_kit from 'functools-kit';
+import { CandleInterval, TrailingTakeCommit, TrailingStopCommit, BreakevenCommit, PartialProfitCommit, PartialLossCommit, IStrategyTickResultScheduled, IStrategyTickResultCancelled, IStrategyTickResultOpened, IStrategyTickResultClosed, RiskContract } from 'backtest-kit';
 import { Input } from 'telegraf';
-import { TrailingTakeCommit, TrailingStopCommit, BreakevenCommit, PartialProfitCommit, PartialLossCommit, IStrategyTickResultScheduled, IStrategyTickResultCancelled, IStrategyTickResultOpened, IStrategyTickResultClosed, RiskContract } from 'backtest-kit';
 
 interface ILogger {
     log(topic: string, ...args: any[]): void;
@@ -20,41 +20,68 @@ declare class LoggerService implements ILogger {
 
 declare class PaperMainService {
     private loggerService;
-    private exchangeSchemaService;
     private resolveService;
+    private exchangeSchemaService;
+    private symbolSchemaService;
     private frontendProviderService;
     private telegramProviderService;
-    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    run: ((payload: {
+        entryPoint: string;
+        symbol: string;
+        strategy: string;
+        exchange: string;
+        verbose: boolean;
+    }) => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class LiveMainService {
     private loggerService;
-    private exchangeSchemaService;
     private resolveService;
+    private exchangeSchemaService;
+    private symbolSchemaService;
     private frontendProviderService;
     private telegramProviderService;
-    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    private liveProviderService;
+    run: ((payload: {
+        entryPoint: string;
+        symbol: string;
+        strategy: string;
+        exchange: string;
+        verbose: boolean;
+    }) => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class BacktestMainService {
     private loggerService;
+    private resolveService;
     private exchangeSchemaService;
     private frameSchemaService;
+    private symbolSchemaService;
     private cacheLogicService;
-    private resolveService;
     private frontendProviderService;
     private telegramProviderService;
-    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    run: ((payload: {
+        entryPoint: string;
+        symbol: string;
+        strategy: string;
+        exchange: string;
+        frame: string;
+        cacheList: string[];
+        verbose: boolean;
+    }) => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class ExchangeSchemaService {
     readonly loggerService: LoggerService;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    addSchema: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class FrameSchemaService {
     readonly loggerService: LoggerService;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    addSchema: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class ResolveService {
@@ -68,19 +95,19 @@ declare class ResolveService {
 declare class ErrorService {
     handleGlobalError: (error: Error) => Promise<void>;
     private _listenForError;
-    protected init: () => void;
+    protected init: (() => void) & functools_kit.ISingleshotClearable;
 }
 
 declare class SymbolSchemaService {
     readonly loggerService: LoggerService;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    addSchema: (() => Promise<void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class FrontendProviderService {
     private readonly loggerService;
     enable: (() => () => void) & functools_kit.ISingleshotClearable;
     disable: () => void;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<() => void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class TelegramProviderService {
@@ -88,12 +115,12 @@ declare class TelegramProviderService {
     private readonly telegramLogicService;
     enable: (() => () => void) & functools_kit.ISingleshotClearable;
     disable: () => void;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<() => void>) & functools_kit.ISingleshotClearable;
 }
 
 declare class CacheLogicService {
     private readonly loggerService;
-    execute: (dto: {
+    execute: (intervalList: CandleInterval[], dto: {
         symbol: string;
         frameName: string;
         exchangeName: string;
@@ -190,7 +217,7 @@ declare class LiveProviderService {
     private handleRisk;
     enable: (() => (...args: any[]) => any) & functools_kit.ISingleshotClearable;
     disable: () => void;
-    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+    connect: (() => Promise<() => void>) & functools_kit.ISingleshotClearable;
 }
 
 declare const cli: {
@@ -225,4 +252,11 @@ declare enum FrameName {
 
 declare function setLogger(logger: ILogger): void;
 
-export { type BaseModule, ExchangeName, FrameName, type ILiveModule, type ILogger, type LiveModule, type TBaseModuleCtor, cli, setLogger };
+type PayloadBacktest = Parameters<typeof cli.backtestMainService.run>[0];
+type PayloadPaper = Parameters<typeof cli.paperMainService.run>[0];
+type PayloadLive = Parameters<typeof cli.liveMainService.run>[0];
+type Mode = "backtest" | "live" | "paper";
+type Args = Partial<PayloadBacktest> | Partial<PayloadPaper> | Partial<PayloadLive>;
+declare function run(mode: Mode, args: Args): Promise<void>;
+
+export { type BaseModule, ExchangeName, FrameName, type ILiveModule, type ILogger, type LiveModule, type TBaseModuleCtor, cli, run, setLogger };