Skip to content

Venum CLI

Use @venumdev/cli when you want to work with the Venum API from a terminal, shell script, CI job, or coding agent.

The CLI covers the core execution flow:

  • health checks
  • price lookups
  • token and pool discovery
  • swap quotes
  • unsigned swap builds
  • local signing and submission
  • transaction status
  • SSE streams

Install

With pnpm:

bash
pnpm add -g @venumdev/cli

With npm:

bash
npm install -g @venumdev/cli

Without installing:

bash
pnpm dlx @venumdev/cli health
npx @venumdev/cli health

Configure

Get an API key at venum.dev, then save it once:

bash
venum config set api-key <your-key>
venum config set api-url https://api.venum.dev

Saved config lives at:

bash
~/.config/venum/config.json

Environment variables override saved config:

bash
VENUM_API_KEY=<your-key>
VENUM_API_URL=https://api.venum.dev

Inspect config:

bash
venum config get
venum config path

Quick Start

Check health:

bash
venum health

Get prices:

bash
venum price SOL
venum prices SOL,ETH,JUP

Get a quote:

bash
venum quote SOL USDC 1000000000
venum quote SOL USDC 1000000000 --slippage 50 --json

Build an unsigned swap:

bash
venum swap build SOL USDC 1000000000 --wallet <pubkey>

Build, sign locally, and submit:

bash
venum swap sign-and-submit SOL USDC 1000000000 --keypair ~/.config/solana/id.json
venum swap sign-and-submit SOL USDC 1000000000 --keypair ~/.config/solana/id.json --wait

Check transaction status:

bash
venum tx <signature>

Streams

Stream prices:

bash
venum prices --time --change
venum stream prices SOL,ETH --time

Stream new pools:

bash
venum stream pools

JSON Output

Use --json for automation, agents, and scripts:

bash
venum quote SOL USDC 1000000000 --json
venum tx <signature> --json