@backtest-kit/cli 8.0.0 → 8.2.0

package/build/index.cjs

@@ -586,6 +586,14 @@ const getArgs = functoolsKit.singleshot(() => {
                 type: "string",
                 default: "",
             },
+            brokerdebug: {
+                type: "boolean",
+                default: false,
+            },
+            commit: {
+                type: "string",
+                default: "",
+            },
             init: {
                 type: "boolean",
                 default: false,
@@ -2999,12 +3007,12 @@ const cli = {
 };
 init();
 
-const MODES = ["backtest", "walker", "paper", "live", "pine", "editor", "dump", "pnldebug", "flush", "init", "help", "version"];
+const MODES = ["backtest", "walker", "paper", "live", "pine", "editor", "dump", "pnldebug", "brokerdebug", "flush", "init", "help", "version"];
 const ENTRY_PATH$1 = "./node_modules/@backtest-kit/cli/build/index.mjs";
-const HELP_TEXT$1 = `
-Example:
-
-  node ${ENTRY_PATH$1} --help
+const HELP_TEXT$1 = `
+Example:
+
+  node ${ENTRY_PATH$1} --help
 `.trimStart();
 const main$e = async () => {
     if (!getEntry((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))) {
@@ -3014,7 +3022,7 @@ const main$e = async () => {
     if (MODES.some((mode) => values[mode])) {
         return;
     }
-    process.stdout.write(`@backtest-kit/cli ${"8.0.0"}\n`);
+    process.stdout.write(`@backtest-kit/cli ${"8.2.0"}\n`);
     process.stdout.write("\n");
     process.stdout.write(`Run with --help to see available commands.\n`);
     process.stdout.write("\n");
@@ -3632,158 +3640,173 @@ const main$2 = async () => {
 main$2();
 
 const ENTRY_PATH = "./node_modules/@backtest-kit/cli/build/index.mjs";
-const HELP_TEXT = `
-Usage:
-  node index.mjs --<mode> [flags] [entry-point]
-
-Modes:
-
-  --backtest <entry>          Run strategy against historical candle data
-  --walker   <entry...>       Run Walker A/B strategy comparison across multiple strategies
-  --paper    <entry>          Paper trading (live prices, no real orders)
-  --live     <entry>          Live trading with real orders
-  --pine     <entry>    Execute a local .pine indicator file
-  --editor              Open the Pine Script visual editor in the browser
-  --dump                Fetch and save raw OHLCV candles
-  --pnldebug            Simulate PnL per minute for a given entry price and direction
-  --flush  <entry...>   Delete report/log/markdown/agent folders from strategy dump dir
-  --init                Scaffold a new project in the current directory
-  --help                Print this help message
-
-Backtest flags:
-
-  --symbol      <string>   Trading pair (default: BTCUSDT)
-  --strategy    <string>   Strategy name from addStrategySchema (default: first registered)
-  --exchange    <string>   Exchange name from addExchangeSchema (default: first registered)
-  --frame       <string>   Frame name from addFrameSchema (default: first registered)
-  --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
-  --noCache                Skip candle cache warming before the run
-  --noFlush                Skip removing report/log/markdown/agent folders before backtest run
-  --verbose                Log every candle fetch to stdout
-  --ui                     Start web dashboard at http://localhost:60050
-  --telegram               Send trade notifications to Telegram
-
-Walker flags (--walker):
-
-  --symbol        <string>   Trading pair (default: BTCUSDT)
-  --cacheInterval <string>   Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
-  --noCache                  Skip candle cache warming before the run
-  --noFlush                  Skip removing report/log/markdown/agent folders before walker run
-  --verbose                  Log every candle fetch to stdout
-  --output        <string>   Output file base name (default: walker_{SYMBOL}_{TIMESTAMP})
-  --json                     Save results as JSON to ./dump/<output>.json
-  --markdown                 Save report as Markdown to ./dump/<output>.md
-
-  Each positional argument is a strategy entry point. All strategy files are loaded without
-  changing process.cwd() — .env is read from the working directory only.
-  addWalkerSchema is called automatically using the registered exchange and frame.
-  After comparison completes the report is printed to stdout (or saved if --json/--markdown).
-
-  Module file ./modules/walker.module is loaded automatically if it exists.
-
-Paper / Live flags:
-
-  --symbol    <string>   Trading pair (default: BTCUSDT)
-  --strategy  <string>   Strategy name (default: first registered)
-  --exchange  <string>   Exchange name (default: first registered)
-  --verbose              Log every candle fetch to stdout
-  --ui                   Start web dashboard
-  --telegram             Send Telegram notifications
-
-PineScript flags (--pine):
-
-  --symbol      <string>   Trading pair (default: BTCUSDT)
-  --timeframe   <string>   Candle interval (default: 15m)
-  --limit       <string>   Number of candles to fetch (default: 250)
-  --when        <string>   End date — ISO 8601 or Unix ms (default: now)
-  --exchange    <string>   Exchange name (default: first registered)
-  --output      <string>   Output file base name without extension
-  --json                   Save output as JSON array to <pine-dir>/dump/<output>.json
-  --jsonl                  Save output as JSONL to <pine-dir>/dump/<output>.jsonl
-  --markdown               Save output as Markdown table to <pine-dir>/dump/<output>.md
-
-  Only plot() calls with display=display.data_window produce output columns.
-  Module file ./modules/pine.module is loaded automatically if it exists.
-
-Candle dump flags (--dump):
-
-  --symbol      <string>   Trading pair (default: BTCUSDT)
-  --timeframe   <string>   Candle interval (default: 15m)
-  --limit       <string>   Number of candles (default: 250)
-  --when        <string>   End date — ISO 8601 or Unix ms (default: now)
-  --exchange    <string>   Exchange name (default: first registered)
-  --output      <string>   Output file base name (default: {SYMBOL}_{LIMIT}_{TIMEFRAME}_{TIMESTAMP})
-  --json                   Save as JSON array to ./dump/<output>.json
-  --jsonl                  Save as JSONL to ./dump/<output>.jsonl
-
-  Module file ./modules/dump.module is loaded automatically if it exists.
-
-PnL debug flags (--pnldebug):
-
-  --symbol      <string>   Trading pair (default: BTCUSDT)
-  --priceopen   <number>   Entry price (required)
-  --direction   <string>   Position direction: long or short (default: long)
-  --when        <string>   Start timestamp — ISO 8601 or Unix ms (default: now)
-  --minutes     <string>   Number of 1m candles to simulate (default: 60)
-  --exchange    <string>   Exchange name (default: first registered)
-  --output      <string>   Output file base name (default: {SYMBOL}_{DIRECTION}_{PRICEOPEN}_{TIMESTAMP})
-  --json                   Save as JSON array to ./dump/<output>.json
-  --jsonl                  Save as JSONL to ./dump/<output>.jsonl
-  --markdown               Save as Markdown table to ./dump/<output>.md
-
-  Module file ./modules/pnldebug.module is loaded automatically if it exists.
-
-Flush flags (--flush):
-
-  One or more positional entry points. For each entry point the following
-  subdirectories are removed from <entry-dir>/dump/:
-
-    report   log   markdown   agent
-
-Init flags (--init):
-
-  --output <string>   Target directory name (default: backtest-kit-project)
-
-  Scaffolds a project and runs scripts/fetch_docs.mjs to download library docs.
-
-Module hooks (loaded automatically by each mode):
-
-  modules/backtest.module   --backtest   Broker adapter for backtest
-  modules/walker.module     --walker     Broker adapter for walker comparison
-  modules/paper.module      --paper      Broker adapter for paper trading
-  modules/live.module       --live       Broker adapter for live trading
-  modules/pine.module       --pine       Exchange schema for PineScript runs
-  modules/editor.module     --editor     Exchange schema for the visual Pine editor
-  modules/dump.module       --dump       Exchange schema for candle dumps
-  modules/pnldebug.module   --pnldebug   Exchange schema for PnL debug runs
-
-  --flush has no associated module. It only removes dump subdirectories.
-
-  Extensions .ts, .mjs, .cjs are tried automatically. Missing module = soft warning.
-
-Environment variables:
-
-  CC_TELEGRAM_TOKEN    Telegram bot token (required for --telegram)
-  CC_TELEGRAM_CHANNEL  Telegram channel or chat ID (required for --telegram)
-  CC_WWWROOT_HOST      UI server bind address (default: 0.0.0.0)
-  CC_WWWROOT_PORT      UI server port (default: 60050)
-
-Examples:
-
-  node ${ENTRY_PATH} --backtest ./content/feb_2026.strategy.ts
-  node ${ENTRY_PATH} --backtest --symbol BTCUSDT --noCache --noFlush --ui ./content/feb_2026.strategy.ts
-  node ${ENTRY_PATH} --walker ./content/feb_2026_v1.strategy.ts ./content/feb_2026_v2.strategy.ts ./content/feb_2026_v3.strategy.ts
-  node ${ENTRY_PATH} --walker --symbol BTCUSDT --noCache --noFlush --markdown ./content/feb_2026_v1.ts ./content/feb_2026_v2.ts
-  node ${ENTRY_PATH} --paper --symbol ETHUSDT ./content/feb_2026.strategy.ts
-  node ${ENTRY_PATH} --live --ui --telegram ./content/feb_2026.strategy.ts
-  node ${ENTRY_PATH} --pine ./math/feb_2026.pine --timeframe 15m --limit 500 --jsonl
-  node ${ENTRY_PATH} --editor
-  node ${ENTRY_PATH} --dump --symbol BTCUSDT --timeframe 15m --limit 500 --jsonl
-  node ${ENTRY_PATH} --pnldebug --symbol BTCUSDT --priceopen 64069.50 --direction short --when "2025-02-25" --minutes 120
-  node ${ENTRY_PATH} --pnldebug --priceopen 67956.73 --direction long --when 1772064000000 --minutes 60 --markdown
-  node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts
-  node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts ./content/feb_2026.strategy/feb_2026.test.ts
-  node ${ENTRY_PATH} --init --output my-trading-bot
+const HELP_TEXT = `
+Usage:
+  node index.mjs --<mode> [flags] [entry-point]
+
+Modes:
+
+  --backtest <entry>          Run strategy against historical candle data
+  --walker   <entry...>       Run Walker A/B strategy comparison across multiple strategies
+  --paper    <entry>          Paper trading (live prices, no real orders)
+  --live     <entry>          Live trading with real orders
+  --pine     <entry>    Execute a local .pine indicator file
+  --editor              Open the Pine Script visual editor in the browser
+  --dump                Fetch and save raw OHLCV candles
+  --pnldebug            Simulate PnL per minute for a given entry price and direction
+  --brokerdebug         Fire a single broker commit against the live broker adapter
+  --flush  <entry...>   Delete report/log/markdown/agent folders from strategy dump dir
+  --init                Scaffold a new project in the current directory
+  --help                Print this help message
+
+Backtest flags:
+
+  --symbol      <string>   Trading pair (default: BTCUSDT)
+  --strategy    <string>   Strategy name from addStrategySchema (default: first registered)
+  --exchange    <string>   Exchange name from addExchangeSchema (default: first registered)
+  --frame       <string>   Frame name from addFrameSchema (default: first registered)
+  --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
+  --noCache                Skip candle cache warming before the run
+  --noFlush                Skip removing report/log/markdown/agent folders before backtest run
+  --verbose                Log every candle fetch to stdout
+  --ui                     Start web dashboard at http://localhost:60050
+  --telegram               Send trade notifications to Telegram
+
+Walker flags (--walker):
+
+  --symbol        <string>   Trading pair (default: BTCUSDT)
+  --cacheInterval <string>   Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
+  --noCache                  Skip candle cache warming before the run
+  --noFlush                  Skip removing report/log/markdown/agent folders before walker run
+  --verbose                  Log every candle fetch to stdout
+  --output        <string>   Output file base name (default: walker_{SYMBOL}_{TIMESTAMP})
+  --json                     Save results as JSON to ./dump/<output>.json
+  --markdown                 Save report as Markdown to ./dump/<output>.md
+
+  Each positional argument is a strategy entry point. All strategy files are loaded without
+  changing process.cwd() — .env is read from the working directory only.
+  addWalkerSchema is called automatically using the registered exchange and frame.
+  After comparison completes the report is printed to stdout (or saved if --json/--markdown).
+
+  Module file ./modules/walker.module is loaded automatically if it exists.
+
+Paper / Live flags:
+
+  --symbol    <string>   Trading pair (default: BTCUSDT)
+  --strategy  <string>   Strategy name (default: first registered)
+  --exchange  <string>   Exchange name (default: first registered)
+  --verbose              Log every candle fetch to stdout
+  --ui                   Start web dashboard
+  --telegram             Send Telegram notifications
+
+PineScript flags (--pine):
+
+  --symbol      <string>   Trading pair (default: BTCUSDT)
+  --timeframe   <string>   Candle interval (default: 15m)
+  --limit       <string>   Number of candles to fetch (default: 250)
+  --when        <string>   End date — ISO 8601 or Unix ms (default: now)
+  --exchange    <string>   Exchange name (default: first registered)
+  --output      <string>   Output file base name without extension
+  --json                   Save output as JSON array to <pine-dir>/dump/<output>.json
+  --jsonl                  Save output as JSONL to <pine-dir>/dump/<output>.jsonl
+  --markdown               Save output as Markdown table to <pine-dir>/dump/<output>.md
+
+  Only plot() calls with display=display.data_window produce output columns.
+  Module file ./modules/pine.module is loaded automatically if it exists.
+
+Candle dump flags (--dump):
+
+  --symbol      <string>   Trading pair (default: BTCUSDT)
+  --timeframe   <string>   Candle interval (default: 15m)
+  --limit       <string>   Number of candles (default: 250)
+  --when        <string>   End date — ISO 8601 or Unix ms (default: now)
+  --exchange    <string>   Exchange name (default: first registered)
+  --output      <string>   Output file base name (default: {SYMBOL}_{LIMIT}_{TIMEFRAME}_{TIMESTAMP})
+  --json                   Save as JSON array to ./dump/<output>.json
+  --jsonl                  Save as JSONL to ./dump/<output>.jsonl
+
+  Module file ./modules/dump.module is loaded automatically if it exists.
+
+PnL debug flags (--pnldebug):
+
+  --symbol      <string>   Trading pair (default: BTCUSDT)
+  --priceopen   <number>   Entry price (required)
+  --direction   <string>   Position direction: long or short (default: long)
+  --when        <string>   Start timestamp — ISO 8601 or Unix ms (default: now)
+  --minutes     <string>   Number of 1m candles to simulate (default: 60)
+  --exchange    <string>   Exchange name (default: first registered)
+  --output      <string>   Output file base name (default: {SYMBOL}_{DIRECTION}_{PRICEOPEN}_{TIMESTAMP})
+  --json                   Save as JSON array to ./dump/<output>.json
+  --jsonl                  Save as JSONL to ./dump/<output>.jsonl
+  --markdown               Save as Markdown table to ./dump/<output>.md
+
+  Module file ./modules/pnldebug.module is loaded automatically if it exists.
+
+Broker debug flags (--brokerdebug):
+
+  --symbol      <string>   Trading pair (default: BTCUSDT)
+  --exchange    <string>   Exchange name (default: first registered)
+  --commit      <string>   Commit type to fire: signal-open, signal-close, partial-profit,
+                           partial-loss, average-buy, trailing-stop, trailing-take, breakeven
+                           (default: signal-open)
+
+  Loads ./live.module, fetches the last candle for --symbol/--timeframe, and calls
+  the selected broker commit with synthetic payload values derived from current price.
+
+Flush flags (--flush):
+
+  One or more positional entry points. For each entry point the following
+  subdirectories are removed from <entry-dir>/dump/:
+
+    report   log   markdown   agent
+
+Init flags (--init):
+
+  --output <string>   Target directory name (default: backtest-kit-project)
+
+  Scaffolds a project and runs scripts/fetch_docs.mjs to download library docs.
+
+Module hooks (loaded automatically by each mode):
+
+  modules/backtest.module   --backtest   Broker adapter for backtest
+  modules/walker.module     --walker     Broker adapter for walker comparison
+  modules/paper.module      --paper      Broker adapter for paper trading
+  modules/live.module       --live       Broker adapter for live trading
+  modules/pine.module       --pine       Exchange schema for PineScript runs
+  modules/editor.module     --editor     Exchange schema for the visual Pine editor
+  modules/dump.module       --dump       Exchange schema for candle dumps
+  modules/pnldebug.module   --pnldebug      Exchange schema for PnL debug runs
+  modules/brokerdebug.module  --brokerdebug   Broker adapter used for broker commit testing
+
+  --flush has no associated module. It only removes dump subdirectories.
+
+  Extensions .ts, .mjs, .cjs are tried automatically. Missing module = soft warning.
+
+Environment variables:
+
+  CC_TELEGRAM_TOKEN    Telegram bot token (required for --telegram)
+  CC_TELEGRAM_CHANNEL  Telegram channel or chat ID (required for --telegram)
+  CC_WWWROOT_HOST      UI server bind address (default: 0.0.0.0)
+  CC_WWWROOT_PORT      UI server port (default: 60050)
+
+Examples:
+
+  node ${ENTRY_PATH} --backtest ./content/feb_2026.strategy.ts
+  node ${ENTRY_PATH} --backtest --symbol BTCUSDT --noCache --noFlush --ui ./content/feb_2026.strategy.ts
+  node ${ENTRY_PATH} --walker ./content/feb_2026_v1.strategy.ts ./content/feb_2026_v2.strategy.ts ./content/feb_2026_v3.strategy.ts
+  node ${ENTRY_PATH} --walker --symbol BTCUSDT --noCache --noFlush --markdown ./content/feb_2026_v1.ts ./content/feb_2026_v2.ts
+  node ${ENTRY_PATH} --paper --symbol ETHUSDT ./content/feb_2026.strategy.ts
+  node ${ENTRY_PATH} --live --ui --telegram ./content/feb_2026.strategy.ts
+  node ${ENTRY_PATH} --pine ./math/feb_2026.pine --timeframe 15m --limit 500 --jsonl
+  node ${ENTRY_PATH} --editor
+  node ${ENTRY_PATH} --dump --symbol BTCUSDT --timeframe 15m --limit 500 --jsonl
+  node ${ENTRY_PATH} --pnldebug --symbol BTCUSDT --priceopen 64069.50 --direction short --when "2025-02-25" --minutes 120
+  node ${ENTRY_PATH} --pnldebug --priceopen 67956.73 --direction long --when 1772064000000 --minutes 60 --markdown
+  node ${ENTRY_PATH} --brokerdebug --commit signal-open --symbol BTCUSDT
+  node ${ENTRY_PATH} --brokerdebug --commit partial-profit --symbol ETHUSDT
+  node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts
+  node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts ./content/feb_2026.strategy/feb_2026.test.ts
+  node ${ENTRY_PATH} --init --output my-trading-bot
 `.trimStart();
 const main$1 = async () => {
     if (!getEntry((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))) {
@@ -3793,7 +3816,7 @@ const main$1 = async () => {
     if (!values.help) {
         return;
     }
-    process.stdout.write(`@backtest-kit/cli ${"8.0.0"}\n\n`);
+    process.stdout.write(`@backtest-kit/cli ${"8.2.0"}\n\n`);
     process.stdout.write(HELP_TEXT);
     process.exit(0);
 };
@@ -3807,7 +3830,7 @@ const main = async () => {
     if (!values.version) {
         return;
     }
-    process.stdout.write(`@backtest-kit/cli ${"8.0.0"}\n`);
+    process.stdout.write(`@backtest-kit/cli ${"8.2.0"}\n`);
     process.exit(0);
 };
 main();