Skip to content

Cookbook.md

Latest commit

 

History

History
130 lines (95 loc) · 3.31 KB

Cookbook.md

File metadata and controls

130 lines (95 loc) · 3.31 KB
Raw

Cookbook

Short, task-focused recipes. Every recipe drives the same Terminal handle; see the runnable examples for full programs per language.

Run the TUI over a live feed

cargo run -p wickra-terminal -- --source live:binance:BTC/USDT

Keys: s add a source · a subscribe a symbol · d unsubscribe · x remove a source · ←/→ cycle the focused symbol · q quit.

Run the TUI over a deterministic synthetic feed (no network)

cargo run -p wickra-terminal -- --source synth:1

Drive the core from a config file

# terminal.toml
timeframe = "1m"

[[sources]]
[sources.Synth]
seed = 1

[[indicators]]
kind = "Sma"
params = [20]

[[indicators]]
kind = "Rsi"
params = [14]

[[layout.panels]]
kind = "Chart"
[layout.panels.rect]
x = 0
y = 0
w = 100
h = 100
cargo run -p wickra-terminal -- --config terminal.toml

Drive the core from any language

import json
from wickra_terminal import Terminal

term = Terminal(json.dumps({
    "sources": [{"Synth": {"seed": 1}}],
    "layout": {"panels": [{"kind": "Chart", "rect": {"x": 0, "y": 0, "w": 100, "h": 100}}]},
}))
term.command(json.dumps({"type": "Subscribe", "source": 0, "symbol": "BTC/USDT"}))
frame = json.loads(term.command(json.dumps({"type": "Tick"})))
print(frame["panels"][0])

The same protocol works from Node.js, Go, C#, Java, R, C/C++ and the browser — see RENDERERS.md.

Add a source and a symbol at runtime

{"type":"AddSource","spec":{"Synth":{"seed":2}}}
{"type":"Subscribe","source":1,"symbol":"ETH/USDT"}

Multiple sources coexist and hot-swap while the terminal runs.

Rewind a recorded feed (the time-machine)

A Replay source records the whole feed, so Seek can rewind it and re-fold state; playback then resumes forward:

{"type":"Subscribe","source":0,"symbol":"BTC/USDT"}
{"type":"Tick"}
{"type":"Seek","source":0,"index":50}

Seek re-folds deterministically from the recorded feed (a market's streaming indicators are not cloneable, so there is no state snapshot to restore). Seeking a live or synthetic source is an error.

Drive a source from your own feed (Manual + Feed)

Add a host-fed Manual source and push events into it; each is folded on the next Tick:

{"type":"AddSource","spec":"Manual"}
{"type":"Subscribe","source":1,"symbol":"BTC/USDT"}
{"type":"Feed","source":1,"event":{"type":"trade","symbol":{"base":"BTC","quote":"USDT"},"price":"64000","quantity":"0.1","aggressor":"Buy","timestamp":1}}
{"type":"Tick"}

This is how any embedder drives the terminal from a feed it already has — the same commands in every language.

Run a live feed in the browser

The WASM core cannot open sockets, so the browser opens the exchange WebSocket itself and bridges it into a Manual source through Feed. The web renderer ships a Binance bridge; type into the "add source" box:

live:binance:BTC/USDT

Public market data only — no API keys. See web/src/binance.ts and SOURCES.md.

Build the browser renderer

( cd bindings/wasm && wasm-pack build --target web )
( cd web && npm install && npm run dev )   # http://localhost:5173

See also: INDICATORS.md · PANELS.md · SOURCES.md · STREAMING.md.