Install the Velora CLI

Install @velora-dex/cli and run your first swap quote from the terminal in under a minute.

The Velora CLI is published as @velora-dex/cli and installs a velora binary. It needs Node 22 or newer.

Run it without installing

Use npx (or your package manager’s equivalent) to run the latest version on demand:

npx @velora-dex/cli quote --src-token DAI --dest-token USDC --amount 1000

This is the fastest way to try the CLI or use it in a one-off script.

Install globally

For repeated use, install it once and call velora directly:

pnpm

pnpm add -g @velora-dex/cli

Then:

velora quote --src-token DAI --dest-token USDC --amount 1000

Your first quote

Price 1,000 DAI to USDC on Ethereum and print a summary:

velora quote --src-token DAI --dest-token USDC --amount 1000

By default the CLI requests --mode ALL, so the API returns a Delta intent when one is available and falls back to a Market route otherwise. The summary’s path: line tells you which one came back.

To get the full response for scripting, add --json:

velora quote --src-token DAI --dest-token USDC --amount 1000 --json | jq

Set a partner identifier

Every quote carries a partner string for attribution. The CLI defaults to velora-cli; pass your own app or project name with --partner:

velora quote --src-token DAI --dest-token USDC --amount 1000 --partner my-app-name

Replace my-app-name with your own identifier. partner is a free, no-signup attribution string, not a secret API key.

Add an API key

For higher rate limits, pass a Pro API key with --api-key, or set the VELORA_API_KEY environment variable and the CLI picks it up automatically:

export VELORA_API_KEY="<your-api-key>"
velora quote --src-token DAI --dest-token USDC --amount 1000

Next steps

Get Quote

Every flag, the --payload file, and crosschain quotes.

SDK

Build and submit orders programmatically with @velora-dex/sdk.