CLI Commands Reference

CLI Commands Reference

Abstract

Machine-oriented reference for every command on the preferred pyne Click group (alias pynescript; src/pynescript/__main__.py). Install via hoox-pyne (pip install hoox-pyne). For workflows see the CLI guide. The language server is a separate console script (pyne-lsp; alias pynescript-lsp).

Version option: pyne --version / -V reports pynescript.__about__.__version__ (e.g. 0.3.14). Global --no-color honors NO_COLOR.

Command index

pyne --help
pyne --version
pyne <command> -h
# alias: pynescript …

---

pyne check

Validate that path(s) parse as Pine Script.

pyne check script.pine
pyne check scripts/ --ext .pyne
pyne check -q strategy.pine   # exit 0/1 only
cat x.pine | pyne check -

Exit: 0 all ok; 1 any parse failure.

---

pyne format (fmt)

Canonicalize Pine by parse → unparse (structural, not a full style formatter).

pyne format script.pine            # stdout
pyne fmt script.pine -w
pyne format script.pine --check    # CI drift gate

---

pyne convert

Rewrite older Pine toward v5 or v6. --to 6 converts any older version (missing //@version counts as v1): color / n / timeframe idents, ta.* / math.* / request.* namespaces, study( → indicator(, typed input.*(), iff / offset. Not a semantic v6 migrator (bool-as-int, na).

pyne convert old.pine --to 6
pyne convert strategy.pine --to 6 -w

---

pyne parse-and-dump (dump / ast)

pyne dump strategy.pine
pyne parse-and-dump strategy.pine --indent 4 -o tree.txt

---

pyne parse-and-unparse (unparse)

pyne unparse messy.pine -o clean.pine

---

pyne lint

pyne lint strategy.pine
pyne lint --json --fail-on never strategy.pine
pyne lint --fail-on warnings strategy.pine
cat strategy.pine | pyne lint -

---

pyne compile

Compile via pynescript.compiler.compile_script. Requires pip install "hoox-pyne[compile]" for full Numba path; --emit works without JIT.

pyne compile script.pine --emit
pyne compile script.pine --emit -o out.py
pyne compile script.pine            # warm load / compile-check

---

pyne prewarm

H2 warm-compile product path: pay cold JIT before first interactive run.

pyne prewarm                    # shared Numba kernels only
pyne prewarm strategy.pine lib/*.pine
pyne prewarm --json

---

pyne run

Compile and execute on deterministic synthetic OHLCV (same compile pipeline as Pro API mode=compile). No --mode. Does not call Runtime.run. Prefer package pynescript.runtime.Runtime / Pro API for real bars, libraries=, and timeout_seconds.

pyne run strategy.pine --bars 100
pyne run strategy.pine --json

---

pyne optimize

Search input.* values for a strategy() script. Loops interpret Runtime (not /backtest/quick). Requires --space JSON.

--validation walk-forward derives windows from --bars when the bar flags are omitted: train=max(8, bars*2//3), test=max(4, bars//6), step=max(1, test) (so default --bars 120 → 80/20/20). Explicit --train-bars / --test-bars / --step-bars override that. The CLI refuses walk-forward when --bars < train+test. All-errored studies exit 1 even if the study status is success.

pyne optimize strat.pine --trials 20 --sampler tpe \
  --space '{"params":[{"name":"Fast","kind":"int","min":3,"max":12}]}'
pyne optimize strat.pine --validation walk-forward --bars 120 --trials 20 \
  --space '{"params":[{"name":"Fast","kind":"int","min":3,"max":12}]}'
pyne optimize strat.pine --validation walk-forward --train-bars 80 --test-bars 20 \
  --space '{"params":[{"name":"Fast","kind":"int","min":3,"max":12}]}'

Library: pynescript.optimize.run_study. HTTP: POST /optimize.

---

pyne data

pyne data AAPL
pyne data AAPL --provider yahoo --period 6mo
pyne data BTC/USDT --provider ccxt --exchange binance --format csv

CCXT needs pip install "hoox-pyne[data]".

---

pyne runner

HTTP client for the optional Flask hosted runner (PYNE_RUNNER=1). Group options apply to every subcommand.

pyne runner deploy script.pine --id demo --symbol BTCUSDT --source mock
pyne runner tick --id demo --force
pyne runner list
pyne runner --url http://127.0.0.1:5002 jobs

Full HTTP contract: hosted runner.

---

pyne info (ls)

Prints package version, Python, platform, and whether numba / rich are available.

---

Related: pyne-lsp (not a subcommand)

pip install "hoox-pyne[lsp]"
pyne-lsp
# alias: pynescript-lsp
python -m pynescript.langserver

Internals

Invariants

• Aliases: dump/ast → parse-and-dump; unparse → parse-and-unparse; fmt → format; ls → info.
• Prefix match works when unique (pynescript ch → check).
• check walks directories; dump/format take a single file.
• Docker: pynescript-cli image ENTRYPOINT is pynescript (non-root).
• Standalone binaries: GitHub Release pynescript-cli-* (Nuitka).

Failure modes

See also

• CLI guide
• Runtime modes
• Installation
• Compiler overview
• Docker