Configuration and commands
Configuration and commands for sigstar. Collect market, on-chain, news and macro data, and explain, forecast and alert on crypto price moves from every angle.
sigstar init writes a commented sigstar.yml; every key is optional and the defaults are
the ones in that file. The main parts:
warehouse: the DuckDB file (defaultwarehouse.duckdb).history:daily_days(90) andhourly_days(7) for the first collection.assets: per asset, each venue's own market name (coinbase: BTC-USD,kraken: XBTUSD,binance: BTCUSDT,binance_futures: BTCUSDT,okx_swap: BTC-USDT-SWAP), its GDELT query, its headline keywords and its chainstar chains. Leave a venue out to skip it. Listingassets:replaces the defaults.topics: market-wide news topics (defaultssecandstablecoin), each with a GDELT query and keywords; each becomesnews_<topic>_volume_zand_tone_zfeatures.sources:enabled: true/falseper source; GDELT headline settings; RSS feeds; FRED series.chainstar:warehouse(orSIGSTAR_CHAINSTAR_WAREHOUSE), and the stablecoins to count, by chain and contract address.analysis: z-score window (30 days), anomaly threshold (3), driver threshold (2), forecast horizon (7 days), backtest origins (20).alerts: rules file and log file.report: output folder.
Environment variables: SIGSTAR_FRED_API_KEY, SIGSTAR_ALERT_WEBHOOK_URL,
SIGSTAR_CHAINSTAR_WAREHOUSE.
Commands
| Command | What it does |
|---|---|
sigstar init |
Writes sigstar.yml and an example sigstar-rules.yml (never overwrites without --force). |
sigstar collect [--source NAME ...] |
Fetches what is new from every enabled source, or only the named ones (coinbase, kraken, binance, binance_futures, okx, fear_greed, gdelt, rss, fred). |
sigstar build |
Builds the dbt staging views and marts and runs the data tests. |
sigstar explain ASSET [--date D] [--top N --start D --end D] [--json] |
The move and what coincided with it, ranked, with evidence. |
sigstar relationships [--benchmark BTC] |
Correlations, betas, lead/lag, Granger tests, volatility regimes. |
sigstar anomalies [--days 7] [--threshold 3] |
Features far from their own recent history. |
sigstar forecast [ASSET ...] [--target price|volatility|volume] |
Forecasts with their backtest error against naive. |
sigstar alerts [--date D] [--no-webhook] |
Evaluates your rules, logs and sends new alerts. |
sigstar report [--window 90] |
Writes the daily brief (Markdown + HTML). |
sigstar run [--skip-collect] |
collect, build, alerts, report: the one to schedule. |
sigstar doctor |
Config, keys (set or not), each source's reachability and robots.txt, terms notes, chainstar, dbt. |
Global options go before the command: --config PATH, --debug.