open-index/open-npm huggingface dataset:
npm package: @kiploks/engine-adapters
Description: **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)
Latest version: 0.1.0

# @kiploks/engine-adapters

**Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)

CSV adapters for **[Kiploks](https://kiploks.com)** Open Core: map UTF-8 CSV (header row, comma or semicolon) into engine `Trade[]` via `csvToTrades` and `csvToTradesFromStream`.

**Keywords** CSV backtest import, streaming trades parse, algorithmic trading integration, TypeScript adapters.

Freqtrade- or OctoBot-shaped JSON is **not** parsed here; convert to `Trade[]` or CSV in your integration.

## Install

```bash
npm install @kiploks/engine-adapters @kiploks/engine-contracts
```

## Exports (overview)

- `csvToTrades(csvString, mapping)`
- `csvToTradesFromStream(stream, mapping, options)` - row cap for CLI-scale files

Use with `@kiploks/engine-core` for analysis. Product [kiploks.com](https://kiploks.com).

## License

Apache-2.0 (`LICENSE` in this package).

## Trademarks

See [TRADEMARK.md](https://github.com/kiploks/engine/blob/main/TRADEMARK.md) in the repository root.
npm package: @kiploks/engine-cli
Description: **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)
Latest version: 0.1.0

# @kiploks/engine-cli

**Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)

Command-line entry for the **[Kiploks](https://kiploks.com)** Open Core engine: run `analyze` on JSON, optional **cloud upload** for parity checks, and drive the full **engine validation** suite from a git checkout of this repository.

**Keywords** trading CLI, backtest JSON analyze, integration API upload, walk-forward engine tests, npm binary `kiploks`.

## Commands

### `kiploks test-conformance`

Runs the full engine validation pipeline when invoked from a **repository checkout** that contains the engine workspace (resolves config via `vitest.config.ts` and `engine:validate`):

- Vitest suite for the engine workspace
- Engine boundary import check
- Open Core npm bundle safety check

Equivalent to `npm run engine:validate` at the **engine** repository root.

```bash
npm run engine:test-conformance
# or, from repo root with the CLI on PATH:
kiploks test-conformance
```

### `kiploks analyze`

Run the deterministic `analyze()` pipeline on a JSON file matching `AnalyzeInput`.

```bash
kiploks analyze ./input.json --json
```

### `kiploks upload --cloud`

POST integration result payload(s) to the Kiploks API (`POST /api/integration/results`), the same path used by external integration scripts toward **[Kiploks](https://kiploks.com)**.

**Environment**

- `KIPLOKS_API_BASE` - API origin (no trailing slash), e.g. `https://kiploks.com` for production, or `http://127.0.0.1:3001` for a local API.
- `KIPLOKS_API_KEY` - Bearer token (Integration API key from the product).

**Options**

- `--dry-run` - Print what would be sent without POST.
- `--local-analyze <file>` - Attach `kiploksLocalEngine.metadata` from a prior `kiploks analyze --json` output so the server can report **engine parity** (local vs server `analyze()` on `oos_trades`).
- `--skip-status` - Skip GET `/api/integration/analyze-status` preflight (quota and storage hints).

**Example**

```bash
export KIPLOKS_API_BASE=https://kiploks.com
export KIPLOKS_API_KEY=your_key
kiploks analyze ./minimal-input.json --json > local-analyze.json
kiploks upload ./standalone-result.json --cloud --local-analyze ./local-analyze.json
```

The upload response includes `parity` (per result) and `funnel` (free tier, monthly remaining, `upgradeUrl`).

## License

Apache-2.0 - see repository `LICENSE`.

## Trademarks

See [TRADEMARK.md](https://github.com/kiploks/engine/blob/main/TRADEMARK.md) in the repository root.
npm package: @kiploks/engine-contracts
Description: **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)
Latest version: 0.1.0

# @kiploks/engine-contracts

**Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)

Versioned **TypeScript contracts** for **[Kiploks](https://kiploks.com)** Open Core: analyze I/O, test result shapes, engine and formula version constants. Use as the **stable boundary** between integrators, CLI, and `@kiploks/engine-core`.

**Keywords** trading API types, WFA contracts, analyze input schema, backtest result types, engine versioning.

## Install

```bash
npm install @kiploks/engine-contracts
```

## What is included

- `AnalyzeInput`, `AnalyzeConfig`, `AnalyzeOutput`
- `TestResultData` and related contract types
- Engine and formula version constants

Pair with `@kiploks/engine-core` for runtime behavior.

## License

Apache-2.0 (`LICENSE` in this package).

## Trademarks

See [TRADEMARK.md](https://github.com/kiploks/engine/blob/main/TRADEMARK.md) in the repository root.
npm package: @kiploks/engine-core
Description: **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)
Latest version: 0.1.0

# @kiploks/engine-core

**Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)

Deterministic **trading analytics engine** for **[Kiploks](https://kiploks.com)** Open Core: `analyze()`, walk-forward and professional-grade paths, benchmark and turnover logic, and types aligned with hosted Kiploks reports and integrations.

**Use cases** algorithmic trading research, **walk-forward analysis (WFA)**, backtest validation, risk and benchmark metrics in **TypeScript**, reproducible local pipelines.

## Install

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

## Quick example

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

const out = analyze(
  { strategyId: "demo", trades: [{ profit: 1.25 }, { profit: -0.4 }] },
  { seed: 42, decimals: 8 },
);

console.log(out.summary, out.metadata);
```

## Philosophy

Results are **deterministic** for a given input, config, and published version. The hosted product at [kiploks.com](https://kiploks.com) builds full reports and workflows on the same methodological stack; this package is the **embeddable core** for integrators and researchers.

## API policy

- **Stable (semver)** import from `@kiploks/engine-core` (root). The published package exposes this entry only.
- The repository includes a secondary `./internal` barrel (re-exports used by full-report assembly). It is **not** part of the npm tarball (`prepack` strips it). Prefer the root import unless you maintain a host that mirrors that assembly graph.

## License

Apache-2.0 (`LICENSE` in this package).

## Trademarks

The **Kiploks** name is a product trademark. Using this package does not grant rights to use the brand in a misleading way. See the repository root [`TRADEMARK.md`](https://github.com/kiploks/engine/blob/main/TRADEMARK.md).
npm package: @kiploks/engine-test-vectors
Description: **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)
Latest version: 0.1.0

# @kiploks/engine-test-vectors

**Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)

Golden **JSON fixtures** for **[Kiploks](https://kiploks.com)** Open Core: **conformance** and **regression** tests for `analyze()` and core pure functions (risk, benchmark, turnover). Consumers of `@kiploks/engine-core` normally do not need this package unless you replicate our test suite.

**Keywords** trading engine golden tests, backtest fixture data, deterministic regression vectors, WFA test data.

## Install

```bash
npm install @kiploks/engine-test-vectors
```

## Package contents

- `v1/*` - Analyze pipeline vectors with locked input/config hashes
- `v2/*` - Extended goldens (risk, benchmark, turnover blocks)
- `CONFORMANCE.md` - Policy and when to refresh metadata

## License

Apache-2.0 (`LICENSE` in this package).

## Trademarks

See [TRADEMARK.md](https://github.com/kiploks/engine/blob/main/TRADEMARK.md) in the repository root.