ReferenceLive V1

CLI reference

The omnious CLI grouped by intent, with auth requirements per command.

One binary, grouped by intent: bun cli/omnious.ts <command> (or just omnious once linked). Auth badges below: read needs nothing, pay signs an x402 payment from your wallet key or keystore, key reads your own data through OMNIOUS_API_KEY, and admin needs the operator token. keygen and the wallet keystore commands run entirely locally and never touch the network.

Get started

CommandAuthWhat it does
omniousreadbare on a TTY: the interactive market terminal
omnious welcomereadguided first run: connectivity, wallet, next steps
omnious keygenreadmint a wallet key for real-chain payments (local only)
omnious wallet importreadencrypted keystore: import, list, use, remove (local only)
omnious helpreadthe grouped command reference

Ask the market

CommandAuthWhat it does
ask "prompt"paypay-and-stream one completion; --priority, --model, --max-price
chatpayinteractive REPL on one session budget
image "prompt"paypaid image generation to PNG
run <script>paydeterministic sub-agent harness (spawn, parallel, pipeline)

Market data

CommandAuthWhat it does
models / book / statsreadlive classes, ask ladder, 24h clearing summary
candles / indexreadcleared-price OHLC, composite price index
leaderboard / healthreadtop customers by volume; router status (--watch redraws)

Receipts & economics

CommandAuthWhat it does
receipt <id>readthe signed usage record for a request
economics [id]readauction counterfactuals, per request or market-wide
session <id> [--close]readsession state and economics; --close signs with your wallet
bestexkeybest-execution report for your wallet (OMNIOUS_API_KEY)
points [wallet]readyour S1 score; points leaderboard, points --provider <id>

Advanced orders

CommandAuthWhat it does
lock-buy <cls> <tok> <ttl>paybuy a forward price lock; spend with ask --lock <id>
order-place "prompt"paypatient limit order (--limit <usd> --expires <s>)
lock <id> / order <id>readread a lock or order; order --cancel refunds escrow

Providers

CommandAuthWhat it does
providerreadrun the quoting loop (env-driven; signs with PROVIDER_KEY)
outcomes <id>readrecent auction outcomes and loss reasons
provider-report <id>readwin rate, loss breakdown, price gaps
verification [--follow]adminprovider trust roll-up (OMNIOUS_ADMIN_TOKEN)

The reconcile script

Not a CLI command but the same toolbox: bun scripts/reconcile.ts independently checks the money invariant, that every payment, refund, and payout nets to zero per epoch. Run it any time; it reads the same SQLite file the router writes.

The two-minute local demo

No chain, no GPU: mock settlement, two fake backends, two providers quoting different floors. Watch the cleared price land between their floors; that is second-score pricing working.

local demofrom README.md
cd router && bun install

# fake OpenAI-compatible backends + the router (mock settlement, fast epochs)
PORT=8001 bun examples/mock-backend.ts &
PORT=8002 bun examples/mock-backend.ts &
CHAIN=mock EPOCH_MS=15000 PROVIDERS_FILE=examples/providers.example.json bun src/server.ts &

# two providers competing at different price floors
PROVIDER_ID=minimax PROVIDER_KEY=0xe13ebb03ffe22f505ba6773aa0f2cff0a53ce7cfc41b2444902ec07a4d0c7e5d \
  MODEL_CLASS=qwen3-72b-instruct FLOOR_IN=210000 FLOOR_OUT=680000 bun examples/provider-quoter.ts &
PROVIDER_ID=zai PROVIDER_KEY=0xd82063457c0395ad7c79d01c152cd939301087f30b17740005bd5bceead6f149 \
  MODEL_CLASS=qwen3-72b-instruct FLOOR_IN=260000 FLOOR_OUT=750000 bun examples/provider-quoter.ts &

# guided first run, then pay for a completion through the 402 flow
bun cli/omnious.ts welcome
bun cli/omnious.ts ask "Why is truthful bidding dominant in an Omnious auction?" --priority cheapest
bun cli/omnious.ts receipt <request-id>   # the signed usage record
bun scripts/reconcile.ts                  # verify the books balance
environmentOMNIOUS_ROUTER_URL points the CLI at a router, OMNIOUS_WALLET_KEY overrides the keystore (mock chains need no key), OMNIOUS_WALLET_PASSWORD unlocks the keystore non-interactively, and NO_COLOR or --json gives plain output.