Documentation Index
Fetch the complete documentation index at: https://docs.simplefunctions.dev/llms.txt
Use this file to discover all available pages before exploring further.
A
Account context — User-scoped data exposed viasf me (theses, intents, keys, portfolio summary). Always redacts secrets.
Agent harness — A non-TUI runner that drives sf agent --headless, NDJSON in/out.
adjIY (adjusted IY) — Implied yield adjusted for spread + slippage at typical liquidity.
Alert rule — Server object that fires when a condition on a watched object trips. Conditions: price_above, price_below, econ_release, gov_action, semantic_match.
B
BYOK — Bring-your-own-key. The cloud portfolio manager encrypts your Kalshi private key with AES-256-GCM client-side and uploads the ciphertext.C
CRI (Cliff Risk Index) — How “cliff-shaped” a market’s resolution payoff is. Cross-venue pair — Kalshi ↔ Polymarket counterpart pair with matching event semantics. CVR (Cross-Venue Ratio) —cross_venue_gap_cents / price_cents.
D
Dedupe key — Stable hash on(rule_id, channel, endpoint_id, window) preventing duplicate alert deliveries.
Drawdown halt — Auto-flip of execution_mode to halted when max_drawdown_cents >= max_drawdown_halt_cents.
E
EE (Event Overround) — Sum of YES asks across all event outcomes. > 100 = book maker margin. Edge — Cents of expected value on a position direction (buy_yes, buy_no, sell_yes, sell_no). Execution mode — Per-user trading mode:dry-run (default), live, halted.
F
Family markets — Markets in the same event group on the same venue (e.g., all “Who wins 2028” candidates). Forum — Lightweight discussion surface with channels, posts, DMs.G
Gate (risk gate) — Pre-trade check that blocks orders violating size, exposure, or loss caps. Ground truth — The authoritative source for a fact. For SF: code in this repo, schema, and the live API.H
Heartbeat — Per-thesis or system-wide self-monitoring loop. Headless —sf agent --headless mode: NDJSON tool I/O on stdin/stdout.
I
IY (Implied Yield) — Annualized return-to-resolution at current price. Idea — Daily LLM-generated trade suggestion with quantSignals and provenance. Indicator — One numeric column onmarket_indicators (IY, CRI, OR, EE, LAS, τ, RV, CVR).
Intent — Server-side trade intent — “buy this when conditions met” — distinct from a placed order.
L
LAS (Liquidity-Adjusted Spread) — Composite of bid/ask spread + top-of-book depth.M
MCP — Model Context Protocol. SF exposes 57 tools at/api/mcp/{transport}.
O
Observability — One regime signal field summarizing how readable the market is. OR (Overround) —Σ ask_yes_cents − 100.
P
Portfolio tick — One run of the autopilot agent loop. Ticks happen on cron (default0 7,19 * * *).
Provenance — Audit trail: trace_id, cron_run_log, health_alerts.
R
Regime — Categorical label summarizing a market’s microstructure state. Risk gate — See Gate. RV (Realized Volatility) — Annualized stdev of recent price changes.S
SF Index — Composite of top liquid markets across themes. Skill — Reusable agent capability: instructions + tools + params, versioned. Slug — URL-safe identifier ([a-z0-9-]+, max 60 chars).
Snapshot — Compact world-state object designed for agent context windows.
Strategy — User-owned long-running instruction for portfolio autopilot.
T
τ (tau / tauDays) — Days remaining until market closes. Theme — Thematic keyword group (fed_monetary, iran_crisis, etc.) used for cross-event correlation.
Thesis — Living causal tree. Lifecycle: create → context → signal → evaluate → augment → publish.
Trade ideas — See Idea.
trace_id — UUID tagged on every async write for audit reconstruction.
V
View (PM view) — User’s own conviction-tagged opinion on a market or theme. Feeds the autopilot prompt. Venue —kalshi or polymarket.
W
Watched object — Server object representing what you’re tracking (ticker / query / URL / text). Watchlist — Collection of watched objects. What-if — Counterfactual analysis on a thesis (sf whatif).