Skip to content

Latest commit

 

History

History
109 lines (88 loc) · 5.65 KB

README.md

File metadata and controls

109 lines (88 loc) · 5.65 KB

pinerun command reference

pinerun is the CLI around the piner Pine Script v6 engine: run one script across many symbols, timeframes, or parameter combinations — in parallel, ranked, and deterministic. Install it with the curl | sh one-liner in the project README, then:

pinerun --help

Commands

Command One-liner
init Scaffold a commented starter strategy.
scan Screen one script across N symbols, ranked.
backtest Analyze one strategy on one symbol — a full tearsheet.
compare Two strategies (or one, two ways) on the same bars, side by side.
portfolio One strategy across N symbols against ONE shared pot of capital.
sweep Optimize one script's input grid over one or more symbols.
walkforward Validate a swept edge out of sample (anti-overfitting).
upgrade Update pinerun to the latest release, in place.

pinetop has the same upgrade verb for itself (pinetop upgrade [--check]).

Forward testing

pinelive consumes pinery MarketDataProvider closed bars, advances piner, and reconciles one resolved exact contract through PaperBroker or a broker adapter.

Opt-in install: releases ship a standalone pinelive binary, but the installer fetches it only with PINESTACK_BINS="pinerun pinetop pinelive". The built-in official Tiger adapter is intentionally blocked and ineligible for armed production execution because it cannot prove complete open-order inventory, authoritative exact order absence, or closure of the snapshot/account-stream gap. From a checkout, bun packages/pinelive/src/cli.ts run --config <path> works without any install. The pinelive package README contains the canonical "configVersion": 3 Paper/CSV example. See the production-safety runbook for the Tiger gate, status, and confirmed recovery procedures.

Pine alert() calls in a running strategy reach registered channels — see pinelive alerts for the frequency gate, webhook channel, ledger records, and delivery semantics.

Broker implementers should read the adapter contract. Operators should read the production-safety runbook for Tiger gate semantics, claim paths, read-only status, and explicit stale recovery. The forward-testing guide covers the broader runtime.

Shared flags

Data-source, credential, cache, execution, metrics, ranking, and input-grammar flags are shared across the analysis commands and documented once in common options. Each command page documents its own flags in full and links there for the rest.

Concepts

  • Bar Magnifier exact mode — strict tri-state overrides, automatic piner mapping, the shipped contract-capable engine's authoritative active/inactive reporting, provider support matrices, typed outcomes, and the 200k fold guard.
  • How the portfolio model works — capital models (isolated vs shared), the union clock, per-bar execution order, and the exact identities behind the portfolio numbers.
  • CSV data files — run any command on local CSV history (--provider csv --data-dir <dir>, or CSV: symbols in a mixed universe): file naming, row format, instrument-metadata sidecar, and the exact-mode evidence flags (--csv-alignment, --csv-week-anchor, --csv-calendar, --csv-complete-record) that enable Bar Magnifier over CSV files.

Typical flow

pinerun init strategy.pine                       # 1. scaffold
pinerun backtest strategy.pine --symbol BTCUSDT --tf 1h --limit 500   # 2. inspect on one symbol
pinerun sweep strategy.pine --symbol BTCUSDT --tf 1h --limit 500 \
  --input fast=5:20:5 --input slow=30:100:10 --top 10                 # 3. optimize
pinerun walkforward strategy.pine --symbol BTCUSDT --tf 1h --limit 2000 \
  --input fast=5:20:5 --input slow=30:100:10 --windows 5              # 4. validate OOS
pinerun scan strategy.pine --symbols BTCUSDT,ETHUSDT,SOLUSDT --tf 1h --limit 500   # 5. screen a universe

Running that flow interactively

Those five steps are one loop you walk repeatedly against the same script, and the CLI makes you retype the invocation each turn. pinetop is a terminal UI over these same commands — one page per command, the flags editable beside the report, w on a swept winner carrying the grid into walkforward:

pinetop

It adds no flags and no analytics of its own: every page composes a real invocation, spawns pinerun … --json, and renders that payload, so anything you see is reproducible with the command it prints at the bottom of the frame. It installs from the same curl | sh as the CLI and self-updates with pinetop upgrade. See packages/pinetop/README.md.

The full narrative guide — architecture, concepts, programmatic API — lives in packages/pinerun/README.md. These pages are the per-command flag reference.