CLI

Drive everything the platform does without opening the web UI.

Overview

The CLI ships inside the Houston container. The easiest way to run it is via a host-side alias the installer wires into your shell profile:

alias auracle='docker compose -f ~/auracle/compose.yaml exec houston auracle'

That alias is what every command below assumes. The top-level surface:

$ auracle --help
Usage: auracle [OPTIONS] COMMAND [ARGS]...

  Self-hosted algorithmic trading platform.

Options:
  --version  Show version and exit.
  --help     Show this and exit.

Commands:
  backtest   Run a backtest against a strategy file.
  deploy     Deploy a strategy live.
  schedule   Manage scheduled jobs.
  forge     Auracle Forge subcommands.
  status     Health, version, and license info.
  strategy   List, validate, promote strategies.

Every subcommand accepts --format table|json where output is tabular.

auracle forge providers

List the bundled data and broker providers Auracle can auto-classify keys for.

$ auracle forge providers

NAME            KIND          AUTH      KEY PREFIX             CAPABILITIES
polygon.io      market_data   bearer    pk_*                   bars, quotes, options, fundamentals
yfinance        market_data   none      —                      bars, quotes, fundamentals
openbb          market_data   bearer    obb-*                  bars, options, macro
coingecko       market_data   api_key   CG-*                   market_chart, prices
coinalyze       market_data   api_key   ca_*                   funding_rates, oi, liquidations
defillama       market_data   none      —                      tvl, dex_volumes
sharadar        market_data   token     —                      fundamentals, tickers
alpaca          broker        basic     AKZ*                   bars, quotes, trade
ibkr            broker        socket    —                      bars, options, futures, trade
clearstreet     broker        oauth     —                      stocks, options, sblock
hyperliquid     broker        signed    —                      perps, spot, trade
anthropic       llm           bearer    sk-ant-*               messages, tool_use
openai          llm           bearer    sk-*                   chat, completions

Flags

auracle forge catalog

List dataset rows in the catalog, optionally filtered.

$ auracle forge catalog --verdict useful

  ID  PROVIDER       CAPABILITY               ASSET    HISTORY  SCORE  VERDICT
  12  polygon.io     bars.daily               equities 25.0y    87     useful
   7  polygon.io     options.chains           equities  4.5y    81     useful
  18  coinalyze      funding_rates            crypto    3.0y    78     useful
  21  coingecko      market_chart             crypto    8.0y    74     useful
   3  ibkr           bars.minute              equities  1.0y    72     useful

5 datasets (verdict=useful)

Flags

auracle forge dataset <id>

Detailed view of a single dataset with ASCII bars for each of the six dimensions.

$ auracle forge dataset 12

  polygon.io / bars.daily
  ────────────────────────────────────────────────────────────────
  ID                12
  Asset class       equities
  Universe          ~9,500 symbols
  History           25.0 years (1999-01-04 → 2026-05-13)
  Granularity       1d
  Storage           postgres://auracle.bars_daily_polygon (timescale)

  Quality
    coverage           ███████████████████░░  92
    freshness          ████████████████████░  95
    completeness       ███████████████░░░░░░  78
    uniqueness         ████████████████░░░░░  80
    stability          █████████████████░░░░  85
    trading_relevance  ████████████████████░  94

  Aggregate (geometric mean)  87.1   verdict: useful
  Last scored: 2026-05-13 09:42:18 UTC
  Cost to probe: $0.42 (2,310 input / 410 output tokens)

auracle forge ambient

Print the AmbientContext exactly as the AI assistant currently sees it. Useful for debugging "why is Jupyternaut suggesting X" or verifying that the kill switch took effect.

$ auracle forge ambient

  install_uuid:      00000000-0000-0000-0000-000000000000
  tier:              pro
  enabled:           true
  catalog_signature: 7a3f9e1b2c4d5e6f
  relevant_datasets: 5

  ─── injected into the assistant's system prompt ───
  The user has these RELEVANT datasets in their Auracle catalog:
    • polygon.io.bars.daily            equities       25.0y  useful
    • polygon.io.options.chains        equities       4.5y   useful
    • coinalyze.funding_rates          crypto         3.0y   useful
    • coingecko.market_chart           crypto         8.0y   useful
    • ibkr.bars.minute                 equities       1.0y   useful
  ─────────────────────────────────────────────────────

Flags

Core commands

Non-Forge CLI surface — the operations you run day-to-day.

auracle status

$ auracle status

  Version           2.1.0
  Tier              pro (license expires 2027-02-14)
  Install UUID      00000000-…
  Containers        houston (healthy) · jupyter (healthy) · db (healthy)
  Brokers           ibkr (connected, paper) · alpaca (not configured)
  Catalog           5 useful · 12 marginal · 3 poor · 1 irrelevant
  Pending plans     2
  Active deploys    1 (sma_breakout v3)

auracle walkforward / event-backtest

$ auracle walkforward strategies.sma_breakout.SMABreakout \
    --train 2y --test 6m
$ auracle event-backtest strategies.sma_breakout.SMABreakout \
    --start 2020-01-01 --end 2024-12-31

auracle strategy

$ auracle strategy list
$ auracle strategy scaffold MyMomentum --template momentum_vol_target

auracle schedule-* (hyphenated)

$ auracle schedule-list
$ auracle schedule-add sma_breakout \
    --strategy strategies.sma_breakout.SMABreakout \
    --cron "0 14 * * MON-FRI"
$ auracle schedule-run sma_breakout
$ auracle schedule-remove sma_breakout

auracle deploy

$ auracle deploy init my-deploy
$ auracle deploy validate my-deploy
$ auracle deploy up my-deploy
$ auracle deploy ps
$ auracle deploy status my-deploy
$ auracle deploy down my-deploy