@backtest-kit/cli 11.6.0 → 11.8.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/build/index.cjs CHANGED
@@ -3360,10 +3360,10 @@ init();
3360
3360
 
3361
3361
  const MODES = ["backtest", "walker", "paper", "live", "pine", "editor", "dump", "pnldebug", "brokerdebug", "flush", "init", "docker", "help", "version"];
3362
3362
  const ENTRY_PATH$1 = "./node_modules/@backtest-kit/cli/build/index.mjs";
3363
- const HELP_TEXT$1 = `
3364
- Example:
3365
-
3366
- node ${ENTRY_PATH$1} --help
3363
+ const HELP_TEXT$1 = `
3364
+ Example:
3365
+
3366
+ node ${ENTRY_PATH$1} --help
3367
3367
  `.trimStart();
3368
3368
  const main$g = async () => {
3369
3369
  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)))) {
@@ -3373,7 +3373,7 @@ const main$g = async () => {
3373
3373
  if (MODES.some((mode) => values[mode])) {
3374
3374
  return;
3375
3375
  }
3376
- process.stdout.write(`@backtest-kit/cli ${"11.6.0"}\n`);
3376
+ process.stdout.write(`@backtest-kit/cli ${"11.8.0"}\n`);
3377
3377
  process.stdout.write("\n");
3378
3378
  process.stdout.write(`Run with --help to see available commands.\n`);
3379
3379
  process.stdout.write("\n");
@@ -4324,183 +4324,183 @@ const main$2 = async () => {
4324
4324
  main$2();
4325
4325
 
4326
4326
  const ENTRY_PATH = "./node_modules/@backtest-kit/cli/build/index.mjs";
4327
- const HELP_TEXT = `
4328
- Usage:
4329
- node index.mjs --<mode> [flags] [entry-point]
4330
-
4331
- Modes:
4332
-
4333
- --backtest <entry> Run strategy against historical candle data
4334
- --walker <entry...> Run Walker A/B strategy comparison across multiple strategies
4335
- --paper <entry> Paper trading (live prices, no real orders)
4336
- --live <entry> Live trading with real orders
4337
- --pine <entry> Execute a local .pine indicator file
4338
- --editor Open the Pine Script visual editor in the browser
4339
- --dump Fetch and save raw OHLCV candles
4340
- --pnldebug Simulate PnL per minute for a given entry price and direction
4341
- --brokerdebug Fire a single broker commit against the live broker adapter
4342
- --flush <entry...> Delete report/log/markdown/agent folders from strategy dump dir
4343
- --init Scaffold a new project in the current directory
4344
- --docker Scaffold a Docker workspace for running strategies in a container
4345
- --help Print this help message
4346
-
4347
- Backtest flags:
4348
-
4349
- --symbol <string> Trading pair (default: BTCUSDT)
4350
- --strategy <string> Strategy name from addStrategySchema (default: first registered)
4351
- --exchange <string> Exchange name from addExchangeSchema (default: first registered)
4352
- --frame <string> Frame name from addFrameSchema (default: first registered)
4353
- --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
4354
- --noCache Skip candle cache warming before the run
4355
- --noFlush Skip removing report/log/markdown/agent folders before backtest run
4356
- --verbose Log every candle fetch to stdout
4357
- --ui Start web dashboard at http://localhost:60050
4358
- --telegram Send trade notifications to Telegram
4359
-
4360
- Walker flags (--walker):
4361
-
4362
- --symbol <string> Trading pair (default: BTCUSDT)
4363
- --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
4364
- --noCache Skip candle cache warming before the run
4365
- --noFlush Skip removing report/log/markdown/agent folders before walker run
4366
- --verbose Log every candle fetch to stdout
4367
- --output <string> Output file base name (default: walker_{SYMBOL}_{TIMESTAMP})
4368
- --json Save results as JSON to ./dump/<output>.json
4369
- --markdown Save report as Markdown to ./dump/<output>.md
4370
-
4371
- Each positional argument is a strategy entry point. All strategy files are loaded without
4372
- changing process.cwd() — .env is read from the working directory only.
4373
- addWalkerSchema is called automatically using the registered exchange and frame.
4374
- After comparison completes the report is printed to stdout (or saved if --json/--markdown).
4375
-
4376
- Module file ./modules/walker.module is loaded automatically if it exists.
4377
-
4378
- Paper / Live flags:
4379
-
4380
- --symbol <string> Trading pair (default: BTCUSDT)
4381
- --strategy <string> Strategy name (default: first registered)
4382
- --exchange <string> Exchange name (default: first registered)
4383
- --verbose Log every candle fetch to stdout
4384
- --ui Start web dashboard
4385
- --telegram Send Telegram notifications
4386
-
4387
- PineScript flags (--pine):
4388
-
4389
- --symbol <string> Trading pair (default: BTCUSDT)
4390
- --timeframe <string> Candle interval (default: 15m)
4391
- --limit <string> Number of candles to fetch (default: 250)
4392
- --when <string> End date — ISO 8601 or Unix ms (default: now)
4393
- --exchange <string> Exchange name (default: first registered)
4394
- --output <string> Output file base name without extension
4395
- --json Save output as JSON array to <pine-dir>/dump/<output>.json
4396
- --jsonl Save output as JSONL to <pine-dir>/dump/<output>.jsonl
4397
- --markdown Save output as Markdown table to <pine-dir>/dump/<output>.md
4398
-
4399
- Only plot() calls with display=display.data_window produce output columns.
4400
- Module file ./modules/pine.module is loaded automatically if it exists.
4401
-
4402
- Candle dump flags (--dump):
4403
-
4404
- --symbol <string> Trading pair (default: BTCUSDT)
4405
- --timeframe <string> Candle interval (default: 15m)
4406
- --limit <string> Number of candles (default: 250)
4407
- --when <string> End date — ISO 8601 or Unix ms (default: now)
4408
- --exchange <string> Exchange name (default: first registered)
4409
- --output <string> Output file base name (default: {SYMBOL}_{LIMIT}_{TIMEFRAME}_{TIMESTAMP})
4410
- --json Save as JSON array to ./dump/<output>.json
4411
- --jsonl Save as JSONL to ./dump/<output>.jsonl
4412
-
4413
- Module file ./modules/dump.module is loaded automatically if it exists.
4414
-
4415
- PnL debug flags (--pnldebug):
4416
-
4417
- --symbol <string> Trading pair (default: BTCUSDT)
4418
- --priceopen <number> Entry price (required)
4419
- --direction <string> Position direction: long or short (default: long)
4420
- --when <string> Start timestamp — ISO 8601 or Unix ms (default: now)
4421
- --minutes <string> Number of 1m candles to simulate (default: 60)
4422
- --exchange <string> Exchange name (default: first registered)
4423
- --output <string> Output file base name (default: {SYMBOL}_{DIRECTION}_{PRICEOPEN}_{TIMESTAMP})
4424
- --json Save as JSON array to ./dump/<output>.json
4425
- --jsonl Save as JSONL to ./dump/<output>.jsonl
4426
- --markdown Save as Markdown table to ./dump/<output>.md
4427
-
4428
- Module file ./modules/pnldebug.module is loaded automatically if it exists.
4429
-
4430
- Broker debug flags (--brokerdebug):
4431
-
4432
- --symbol <string> Trading pair (default: BTCUSDT)
4433
- --exchange <string> Exchange name (default: first registered)
4434
- --commit <string> Commit type to fire: signal-open, signal-close, partial-profit,
4435
- partial-loss, average-buy, trailing-stop, trailing-take, breakeven
4436
- (default: signal-open)
4437
-
4438
- Loads ./live.module, fetches the last candle for --symbol/--timeframe, and calls
4439
- the selected broker commit with synthetic payload values derived from current price.
4440
-
4441
- Flush flags (--flush):
4442
-
4443
- One or more positional entry points. For each entry point the following
4444
- subdirectories are removed from <entry-dir>/dump/:
4445
-
4446
- report log markdown agent
4447
-
4448
- Init flags (--init):
4449
-
4450
- --output <string> Target directory name (default: backtest-kit-project)
4451
-
4452
- Scaffolds a project and runs scripts/fetch_docs.mjs to download library docs.
4453
-
4454
- Docker flags (--docker):
4455
-
4456
- --output <string> Target directory name (default: backtest-kit-docker)
4457
-
4458
- Scaffolds a Docker workspace: docker-compose.yaml, .env.example, package.json,
4459
- tsconfig.json, and a sample strategy under content/. Run npm install then
4460
- docker compose up to start the container.
4461
-
4462
- Module hooks (loaded automatically by each mode):
4463
-
4464
- modules/backtest.module --backtest Broker adapter for backtest
4465
- modules/walker.module --walker Broker adapter for walker comparison
4466
- modules/paper.module --paper Broker adapter for paper trading
4467
- modules/live.module --live Broker adapter for live trading
4468
- modules/pine.module --pine Exchange schema for PineScript runs
4469
- modules/editor.module --editor Exchange schema for the visual Pine editor
4470
- modules/dump.module --dump Exchange schema for candle dumps
4471
- modules/pnldebug.module --pnldebug Exchange schema for PnL debug runs
4472
- modules/brokerdebug.module --brokerdebug Broker adapter used for broker commit testing
4473
-
4474
- --flush has no associated module. It only removes dump subdirectories.
4475
-
4476
- Extensions .ts, .mjs, .cjs are tried automatically. Missing module = soft warning.
4477
-
4478
- Environment variables:
4479
-
4480
- CC_TELEGRAM_TOKEN Telegram bot token (required for --telegram)
4481
- CC_TELEGRAM_CHANNEL Telegram channel or chat ID (required for --telegram)
4482
- CC_WWWROOT_HOST UI server bind address (default: 0.0.0.0)
4483
- CC_WWWROOT_PORT UI server port (default: 60050)
4484
-
4485
- Examples:
4486
-
4487
- node ${ENTRY_PATH} --backtest ./content/feb_2026.strategy.ts
4488
- node ${ENTRY_PATH} --backtest --symbol BTCUSDT --noCache --noFlush --ui ./content/feb_2026.strategy.ts
4489
- node ${ENTRY_PATH} --walker ./content/feb_2026_v1.strategy.ts ./content/feb_2026_v2.strategy.ts ./content/feb_2026_v3.strategy.ts
4490
- node ${ENTRY_PATH} --walker --symbol BTCUSDT --noCache --noFlush --markdown ./content/feb_2026_v1.ts ./content/feb_2026_v2.ts
4491
- node ${ENTRY_PATH} --paper --symbol ETHUSDT ./content/feb_2026.strategy.ts
4492
- node ${ENTRY_PATH} --live --ui --telegram ./content/feb_2026.strategy.ts
4493
- node ${ENTRY_PATH} --pine ./math/feb_2026.pine --timeframe 15m --limit 500 --jsonl
4494
- node ${ENTRY_PATH} --editor
4495
- node ${ENTRY_PATH} --dump --symbol BTCUSDT --timeframe 15m --limit 500 --jsonl
4496
- node ${ENTRY_PATH} --pnldebug --symbol BTCUSDT --priceopen 64069.50 --direction short --when "2025-02-25" --minutes 120
4497
- node ${ENTRY_PATH} --pnldebug --priceopen 67956.73 --direction long --when 1772064000000 --minutes 60 --markdown
4498
- node ${ENTRY_PATH} --brokerdebug --commit signal-open --symbol BTCUSDT
4499
- node ${ENTRY_PATH} --brokerdebug --commit partial-profit --symbol ETHUSDT
4500
- node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts
4501
- node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts ./content/feb_2026.strategy/feb_2026.test.ts
4502
- node ${ENTRY_PATH} --init --output my-trading-bot
4503
- node ${ENTRY_PATH} --docker --output my-docker-workspace
4327
+ const HELP_TEXT = `
4328
+ Usage:
4329
+ node index.mjs --<mode> [flags] [entry-point]
4330
+
4331
+ Modes:
4332
+
4333
+ --backtest <entry> Run strategy against historical candle data
4334
+ --walker <entry...> Run Walker A/B strategy comparison across multiple strategies
4335
+ --paper <entry> Paper trading (live prices, no real orders)
4336
+ --live <entry> Live trading with real orders
4337
+ --pine <entry> Execute a local .pine indicator file
4338
+ --editor Open the Pine Script visual editor in the browser
4339
+ --dump Fetch and save raw OHLCV candles
4340
+ --pnldebug Simulate PnL per minute for a given entry price and direction
4341
+ --brokerdebug Fire a single broker commit against the live broker adapter
4342
+ --flush <entry...> Delete report/log/markdown/agent folders from strategy dump dir
4343
+ --init Scaffold a new project in the current directory
4344
+ --docker Scaffold a Docker workspace for running strategies in a container
4345
+ --help Print this help message
4346
+
4347
+ Backtest flags:
4348
+
4349
+ --symbol <string> Trading pair (default: BTCUSDT)
4350
+ --strategy <string> Strategy name from addStrategySchema (default: first registered)
4351
+ --exchange <string> Exchange name from addExchangeSchema (default: first registered)
4352
+ --frame <string> Frame name from addFrameSchema (default: first registered)
4353
+ --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
4354
+ --noCache Skip candle cache warming before the run
4355
+ --noFlush Skip removing report/log/markdown/agent folders before backtest run
4356
+ --verbose Log every candle fetch to stdout
4357
+ --ui Start web dashboard at http://localhost:60050
4358
+ --telegram Send trade notifications to Telegram
4359
+
4360
+ Walker flags (--walker):
4361
+
4362
+ --symbol <string> Trading pair (default: BTCUSDT)
4363
+ --cacheInterval <string> Comma-separated intervals to pre-cache (default: "1m, 15m, 30m, 4h")
4364
+ --noCache Skip candle cache warming before the run
4365
+ --noFlush Skip removing report/log/markdown/agent folders before walker run
4366
+ --verbose Log every candle fetch to stdout
4367
+ --output <string> Output file base name (default: walker_{SYMBOL}_{TIMESTAMP})
4368
+ --json Save results as JSON to ./dump/<output>.json
4369
+ --markdown Save report as Markdown to ./dump/<output>.md
4370
+
4371
+ Each positional argument is a strategy entry point. All strategy files are loaded without
4372
+ changing process.cwd() — .env is read from the working directory only.
4373
+ addWalkerSchema is called automatically using the registered exchange and frame.
4374
+ After comparison completes the report is printed to stdout (or saved if --json/--markdown).
4375
+
4376
+ Module file ./modules/walker.module is loaded automatically if it exists.
4377
+
4378
+ Paper / Live flags:
4379
+
4380
+ --symbol <string> Trading pair (default: BTCUSDT)
4381
+ --strategy <string> Strategy name (default: first registered)
4382
+ --exchange <string> Exchange name (default: first registered)
4383
+ --verbose Log every candle fetch to stdout
4384
+ --ui Start web dashboard
4385
+ --telegram Send Telegram notifications
4386
+
4387
+ PineScript flags (--pine):
4388
+
4389
+ --symbol <string> Trading pair (default: BTCUSDT)
4390
+ --timeframe <string> Candle interval (default: 15m)
4391
+ --limit <string> Number of candles to fetch (default: 250)
4392
+ --when <string> End date — ISO 8601 or Unix ms (default: now)
4393
+ --exchange <string> Exchange name (default: first registered)
4394
+ --output <string> Output file base name without extension
4395
+ --json Save output as JSON array to <pine-dir>/dump/<output>.json
4396
+ --jsonl Save output as JSONL to <pine-dir>/dump/<output>.jsonl
4397
+ --markdown Save output as Markdown table to <pine-dir>/dump/<output>.md
4398
+
4399
+ Only plot() calls with display=display.data_window produce output columns.
4400
+ Module file ./modules/pine.module is loaded automatically if it exists.
4401
+
4402
+ Candle dump flags (--dump):
4403
+
4404
+ --symbol <string> Trading pair (default: BTCUSDT)
4405
+ --timeframe <string> Candle interval (default: 15m)
4406
+ --limit <string> Number of candles (default: 250)
4407
+ --when <string> End date — ISO 8601 or Unix ms (default: now)
4408
+ --exchange <string> Exchange name (default: first registered)
4409
+ --output <string> Output file base name (default: {SYMBOL}_{LIMIT}_{TIMEFRAME}_{TIMESTAMP})
4410
+ --json Save as JSON array to ./dump/<output>.json
4411
+ --jsonl Save as JSONL to ./dump/<output>.jsonl
4412
+
4413
+ Module file ./modules/dump.module is loaded automatically if it exists.
4414
+
4415
+ PnL debug flags (--pnldebug):
4416
+
4417
+ --symbol <string> Trading pair (default: BTCUSDT)
4418
+ --priceopen <number> Entry price (required)
4419
+ --direction <string> Position direction: long or short (default: long)
4420
+ --when <string> Start timestamp — ISO 8601 or Unix ms (default: now)
4421
+ --minutes <string> Number of 1m candles to simulate (default: 60)
4422
+ --exchange <string> Exchange name (default: first registered)
4423
+ --output <string> Output file base name (default: {SYMBOL}_{DIRECTION}_{PRICEOPEN}_{TIMESTAMP})
4424
+ --json Save as JSON array to ./dump/<output>.json
4425
+ --jsonl Save as JSONL to ./dump/<output>.jsonl
4426
+ --markdown Save as Markdown table to ./dump/<output>.md
4427
+
4428
+ Module file ./modules/pnldebug.module is loaded automatically if it exists.
4429
+
4430
+ Broker debug flags (--brokerdebug):
4431
+
4432
+ --symbol <string> Trading pair (default: BTCUSDT)
4433
+ --exchange <string> Exchange name (default: first registered)
4434
+ --commit <string> Commit type to fire: signal-open, signal-close, partial-profit,
4435
+ partial-loss, average-buy, trailing-stop, trailing-take, breakeven
4436
+ (default: signal-open)
4437
+
4438
+ Loads ./live.module, fetches the last candle for --symbol/--timeframe, and calls
4439
+ the selected broker commit with synthetic payload values derived from current price.
4440
+
4441
+ Flush flags (--flush):
4442
+
4443
+ One or more positional entry points. For each entry point the following
4444
+ subdirectories are removed from <entry-dir>/dump/:
4445
+
4446
+ report log markdown agent
4447
+
4448
+ Init flags (--init):
4449
+
4450
+ --output <string> Target directory name (default: backtest-kit-project)
4451
+
4452
+ Scaffolds a project and runs scripts/fetch_docs.mjs to download library docs.
4453
+
4454
+ Docker flags (--docker):
4455
+
4456
+ --output <string> Target directory name (default: backtest-kit-docker)
4457
+
4458
+ Scaffolds a Docker workspace: docker-compose.yaml, .env.example, package.json,
4459
+ tsconfig.json, and a sample strategy under content/. Run npm install then
4460
+ docker compose up to start the container.
4461
+
4462
+ Module hooks (loaded automatically by each mode):
4463
+
4464
+ modules/backtest.module --backtest Broker adapter for backtest
4465
+ modules/walker.module --walker Broker adapter for walker comparison
4466
+ modules/paper.module --paper Broker adapter for paper trading
4467
+ modules/live.module --live Broker adapter for live trading
4468
+ modules/pine.module --pine Exchange schema for PineScript runs
4469
+ modules/editor.module --editor Exchange schema for the visual Pine editor
4470
+ modules/dump.module --dump Exchange schema for candle dumps
4471
+ modules/pnldebug.module --pnldebug Exchange schema for PnL debug runs
4472
+ modules/brokerdebug.module --brokerdebug Broker adapter used for broker commit testing
4473
+
4474
+ --flush has no associated module. It only removes dump subdirectories.
4475
+
4476
+ Extensions .ts, .mjs, .cjs are tried automatically. Missing module = soft warning.
4477
+
4478
+ Environment variables:
4479
+
4480
+ CC_TELEGRAM_TOKEN Telegram bot token (required for --telegram)
4481
+ CC_TELEGRAM_CHANNEL Telegram channel or chat ID (required for --telegram)
4482
+ CC_WWWROOT_HOST UI server bind address (default: 0.0.0.0)
4483
+ CC_WWWROOT_PORT UI server port (default: 60050)
4484
+
4485
+ Examples:
4486
+
4487
+ node ${ENTRY_PATH} --backtest ./content/feb_2026.strategy.ts
4488
+ node ${ENTRY_PATH} --backtest --symbol BTCUSDT --noCache --noFlush --ui ./content/feb_2026.strategy.ts
4489
+ node ${ENTRY_PATH} --walker ./content/feb_2026_v1.strategy.ts ./content/feb_2026_v2.strategy.ts ./content/feb_2026_v3.strategy.ts
4490
+ node ${ENTRY_PATH} --walker --symbol BTCUSDT --noCache --noFlush --markdown ./content/feb_2026_v1.ts ./content/feb_2026_v2.ts
4491
+ node ${ENTRY_PATH} --paper --symbol ETHUSDT ./content/feb_2026.strategy.ts
4492
+ node ${ENTRY_PATH} --live --ui --telegram ./content/feb_2026.strategy.ts
4493
+ node ${ENTRY_PATH} --pine ./math/feb_2026.pine --timeframe 15m --limit 500 --jsonl
4494
+ node ${ENTRY_PATH} --editor
4495
+ node ${ENTRY_PATH} --dump --symbol BTCUSDT --timeframe 15m --limit 500 --jsonl
4496
+ node ${ENTRY_PATH} --pnldebug --symbol BTCUSDT --priceopen 64069.50 --direction short --when "2025-02-25" --minutes 120
4497
+ node ${ENTRY_PATH} --pnldebug --priceopen 67956.73 --direction long --when 1772064000000 --minutes 60 --markdown
4498
+ node ${ENTRY_PATH} --brokerdebug --commit signal-open --symbol BTCUSDT
4499
+ node ${ENTRY_PATH} --brokerdebug --commit partial-profit --symbol ETHUSDT
4500
+ node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts
4501
+ node ${ENTRY_PATH} --flush ./content/feb_2026.strategy/feb_2026.strategy.ts ./content/feb_2026.strategy/feb_2026.test.ts
4502
+ node ${ENTRY_PATH} --init --output my-trading-bot
4503
+ node ${ENTRY_PATH} --docker --output my-docker-workspace
4504
4504
  `.trimStart();
4505
4505
  const main$1 = async () => {
4506
4506
  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)))) {
@@ -4510,7 +4510,7 @@ const main$1 = async () => {
4510
4510
  if (!values.help) {
4511
4511
  return;
4512
4512
  }
4513
- process.stdout.write(`@backtest-kit/cli ${"11.6.0"}\n\n`);
4513
+ process.stdout.write(`@backtest-kit/cli ${"11.8.0"}\n\n`);
4514
4514
  process.stdout.write(HELP_TEXT);
4515
4515
  process.exit(0);
4516
4516
  };
@@ -4524,7 +4524,7 @@ const main = async () => {
4524
4524
  if (!values.version) {
4525
4525
  return;
4526
4526
  }
4527
- process.stdout.write(`@backtest-kit/cli ${"11.6.0"}\n`);
4527
+ process.stdout.write(`@backtest-kit/cli ${"11.8.0"}\n`);
4528
4528
  process.exit(0);
4529
4529
  };
4530
4530
  main();