Krellbot docs

Telemetry

Telemetry is off until the operator types y. The first time a command would send a payload, the CLI prints the payload shape and asks:

Send anonymous usage telemetry? [y/N]

Until the operator types y, no telemetry is sent. An exchange permission probe or a live trading action can still contact the selected venue. The choice is recorded in $KRELLBOT_HOME/telemetry.json.

krellbot telemetry enable
krellbot telemetry disable

enable and disable write the flag and print the new state. Neither command sends a payload by itself.

What the payload carries

A telemetry record carries only these keys:

KeyMeaning
install_idA random per-install UUID. Not a key, not a license.
pack_idThe slug of the armed pack.
pack_versionThe version recorded at arm time.
venueThe exchange the pack is armed on.
pairThe market the pack trades.
sidebuy or sell.
bar_tsThe candle close time the engine acted on.
modeled_pxThe price the pack's signal produced.
fill_pxThe fill price the simulator or venue reported.
qty_bucketThe floor of log2 of the USD notional. Not the raw quantity.
fee_bpsThe venue's fee in basis points.

What the payload does NOT carry

The record does not send:

The payload travels over HTTPS to https://krellbot.dev/api/telemetry. The operator can inspect the recorded shape any time with krellbot telemetry show.

← docs