Skip to main content

What the CLI does

The CLI is the fastest way to:
  • inspect active instruments
  • get quotes
  • place paper-trading orders
  • review balances and positions
  • stream market activity in the terminal

Setup

pnpm install
pnpm -r build
cd packages/cli && pnpm link --global && cd ../..
joyride setup
The setup wizard stores config in ~/.joyride/config.toml.

Common commands

joyride chain SOL
joyride quote SOL_USDC-27FEB26-85-C
joyride order place --instrument SOL_USDC-27FEB26-85-C --side sell --size 1 --price 5
joyride balance
joyride order list

Config precedence

Values resolve in this order:
  1. CLI flags
  2. Environment variables
  3. ~/.joyride/config.toml
  4. Built-in defaults

Output modes

  • table for human-readable terminal output
  • json for scripts and agents
joyride balance --output json

Transport model

  • Chain, quote, and streaming commands use WebSocket
  • Account and history workflows may call the HTTP API
  • The CLI uses the same normalized core client types as the rest of the SDK