Additional commands

Help guide

Get help for Blnk CLI commands from the terminal.

Pass -h or --help on any command to see usage, options, and examples (for example blnk ledgers list --help). Run blnk --help for top-level commands.

`help`

Look up usage, options, and examples without leaving the terminal.

blnk --help
blnk [command] --help

Usage

Root help

Run with no command, or pass --help at the root, to see top-level commands and global options:

blnk --help

The official command-line tool to interact with your Blnk Core.

Usage:
  blnk [command] [options]

Connection commands:
  connect, c            Connect to a Blnk Core instance
  info, i               Show current connection settings

Resource commands:
  ledgers               Make requests (create, list, etc.) on ledgers
  balances              Make requests (create, list, etc.) on balances
  transactions          Make requests (create, list, etc.) on transactions
  identities            Make requests (create, list, etc.) on identities
  reconciliations       Make requests (create, list, etc.) on reconciliations

Other commands:
  community             Chat with the Blnk team & other developers in our Discord
  docs                  Open Blnk developer documentation
  reindex               Manage Typesense reindex jobs

Options:
  -h, --help            Show help information
  -v, --version         Show CLI version

Tip: Use "blnk [command] --help" for more information about a command.

Help for a resource

See commands under a resource (for example ledgers):

blnk ledgers --help

Description:
  Make requests (create, list, etc.) on ledgers.

Usage:
  blnk ledgers [command] [options]

Commands:
  list, l              View all ledgers
  create, c            Create a new ledger

Options:
  -h, --help           Show help information

Help for a subcommand

See options and examples for a specific subcommand:

blnk ledgers list --help

Description:
  View a list of your ledgers.

Usage:
  blnk ledgers list [options]

Options:
Single list:
      --id <ledger-id>            Get a ledger by ID
      --json                      Print full JSON output for single fetch

Group list:
      --<field> <value>           Filter by any field (quote comma-separated values, e.g. --currency "USD,EUR")
  -p, --page <number>             Page number (default: 1, e.g. 2)
      --per-page <number>         Results per page (default: 10, e.g. 25)
  -h, --help                      Show help information

Examples:
  $ blnk ledgers list
  $ blnk ledgers l --page 2 --per-page 20
  $ blnk ledgers l --ledger-id ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc