Skip to main content

Documentation Index

Fetch the complete documentation index at: https://fireblocks-43c4b3ee-chore-add-cli.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Fireblocks CLI (@fireblocks/fireblocks-cli) is an agent-first command-line tool that exposes every Fireblocks API operation as a typed command. Commands are organized by API namespace (e.g. vaults, transactions, embedded-wallets) and use JWT-signed requests identical to the Fireblocks SDKs. The CLI is built for:
  • Scripting and automation — run API calls from shell scripts, CI pipelines, or cron jobs
  • Exploration — inspect vault balances, transaction status, or workspace state without writing code
  • AI agent integration — the help-index command returns a compact JSON index of all commands that fits in an LLM context window

​
Features

  • Every Fireblocks API endpoint as a typed command
  • JWT-signed requests using the same signing approach as the TypeScript SDK
  • Credential management — store profiles in ~/.config/fireblocks/config.json
  • --dry-run — preview any request before executing it
  • --debug — log request and response details to stderr
  • Write-operation confirmation prompts (skippable with --no-confirm)
  • Structured JSON errors on stderr with distinct exit codes
  • Shell autocomplete for Bash and Zsh

​
Installation

The CLI is available as an npm package and requires Node.js 18 or later.
  • npm package: https://www.npmjs.com/package/@fireblocks/fireblocks-cli
  • GitHub repo: https://github.com/fireblocks/fireblocks-cli
  • GitHub release (latest): https://github.com/fireblocks/fireblocks-cli/releases/latest
npm install -g @fireblocks/fireblocks-cli

​
Standalone installers (macOS, Windows, Linux)

Standalone installers for each OS are available in the GitHub Releases assets.

​
Tarballs

Tarballs are also available in the GitHub Releases assets.

​
Homebrew (macOS)

brew tap fireblocks/fireblocks-cli
brew install fireblocks-cli

​
Other package managers

# yarn
yarn global add @fireblocks/fireblocks-cli

# pnpm
pnpm add -g @fireblocks/fireblocks-cli
The fireblocks command will be available immediately after installation.

​
Verify Installation

fireblocks --version

​
Quick Start

# 1. Set up credentials interactively
fireblocks configure

# 2. Verify credentials
fireblocks whoami

# 3. List vault accounts
fireblocks vaults get-paged-vault-accounts

# 4. Discover all available commands
fireblocks help-index

​
Next Steps

  • Authentication — configure credentials, environment variables, and profiles
  • Usage Guide — commands, flags, examples, and exit codes