Skip to main content

The Overcast CLI

@overcast/cli packages the entire SDK into one binary: overcast. It covers the full protocol surface — vault management, offer/option discovery, the interactive RFQ flow, the option lifecycle, and a built-in RFQ quoter — and anything it doesn't ask for on the command line it prompts for interactively.

$ overcast --help
$ overcast deposit --mint <mint> --amount <n>
$ overcast quote --spread 0.02

Install

The CLI is not published to npm yet; build it from the monorepo:

pnpm install
pnpm -r run build
node packages/overcast-cli/dist/bin.js --help

Or produce a single-file executable:

cd packages/overcast-cli
pnpm bundle
./dist-bundle/overcast.js --help

Configuration

There are no config files. Every setting resolves flag → environment variable → localhost default:

SettingFlagEnv varDefault
Wallet-k, --keypairOVERCAST_KEYPAIRrequired for signing
Solana RPC--rpcSOLANA_RPC_URLhttp://127.0.0.1:8899
Backend--backendOVERCAST_BACKEND_URLhttp://127.0.0.1:3000
Transport--transportwebsocket

These four are global options — they work on every subcommand.

The keypair value may be a path to a Solana id.json, a raw JSON byte array, or a base58 secret key:

export OVERCAST_KEYPAIR=~/.config/solana/id.json
export SOLANA_RPC_URL=http://127.0.0.1:8899
export OVERCAST_BACKEND_URL=http://127.0.0.1:3000

Read-only commands (balance --user, assets, offer list/show, option list/show) work without a wallet.

A five-minute tour

# 1. What can I trade?
overcast assets

# 2. Fund my escrow vault (premiums and collateral are paid from the vault).
overcast deposit --mint <cash-mint> --amount 1000000000
overcast balance --mint <cash-mint>

# 3. Request quotes for an option, interactively — pick strategy, strike,
# expiry; watch quotes stream in; accept one; the option mints on-chain.
overcast rfq create

# 4. ...or be the one quoting: run an RFQ quoter until Ctrl-C.
overcast quote

# 5. Later: exercise (taker) or redeem (maker), then withdraw.
overcast exercise -c <collateral-offer-id> -s <settlement-offer-id>
overcast redeem -c <collateral-offer-id> -s <settlement-offer-id>
overcast withdraw --mint <cash-mint> --amount 500000000

Any flag you omit — a mint, an amount, an offer ID — the CLI asks for with an interactive prompt, so overcast deposit with no flags at all is valid.

Continue with the command reference or the RFQ quoting guide.

⚠️ Pre-release. The CLI is under heavy development: the inline-keypair signer is temporary and RFQ offer signatures are currently stubbed placeholders. Expect breaking changes; overcast <command> --help is always the authoritative reference.