Getting started

Install the packages, run a minimal analyze, then explore WFA and CLI when you need them.

Prerequisites

Node.js 20+ and npm (or pnpm/yarn). TypeScript recommended for integrations.

Install

npm install @kiploks/engine-core @kiploks/engine-contracts

Minimal analyze

Import analyze from @kiploks/engine-core, pass trades with profit as a fraction of capital, and an AnalyzeConfig with seed and decimals for reproducible hashes.

import { analyze } from "@kiploks/engine-core";

const out = analyze(
  { strategyId: "demo", trades: [{ profit: 0.02 }, { profit: -0.01 }] },
  { seed: 42, decimals: 8 },
);
console.log(out.summary, out.metadata);

Walk-forward and CSV

For trade-sliced WFA, use analyzeFromTrades with timestamps and window config. For CSV files, add @kiploks/engine-adapters. See [Entry points] for the decision map.

CLI

Install @kiploks/engine-cli and use the kiploks binary for analyze, validate, and optional upload helpers. Details: [CLI].

Source and versions

Clone or browse [Engine repository]. All publishable packages share one semver; align engineVersion in reports with the npm version you installed.