> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Blnk CLI

> Use the Blnk CLI to manage your Core from your terminal.

The Blnk CLI is the official command-line tool to interact with your Blnk Core. Use the commands below to connect to an instance, manage ledgers, balances, transactions, identities, and reconciliations.

<Note>
  Ensure your Blnk server is running and that you have connected the CLI to an instance before using resource commands. Run `blnk connect [url]` then `blnk info` to verify.
</Note>

***

## install/update

<Info>Current version: 1.8.0</Info>

To use the Blnk CLI, you need [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/package/blnk-cli) on your machine.

Install and update the Blnk CLI globally:

```bash theme={"system"}
npm i -g @blnkfinance/blnk-cli
```

Confirm your installation:

<CodeGroup>
  ```bash bash theme={"system"}
  blnk --version
  ```

  ```bash latest version theme={"system"}
  Blnk CLI:
    1.8.0
  ```
</CodeGroup>

***

## connect

Use the `connect` command to connect to a Blnk Core instance and verify that the instance is reachable.

```bash theme={"system"}
blnk connect [url]
```

You can also use the alias `c`, e.g. `blnk c https://api.example.com`

```bash Options theme={"system"}
Description:
  This command connects to a Blnk Core instance and verifies that
  the instance is reachable.

Usage:
  blnk connect [url]

Options:
  -h, --help            Show help information

Examples:
  $ blnk connect
  $ blnk c https://api.example.com
```

***

## info

Use the `info` command to show the current server URL and whether the CLI is connected.

```bash theme={"system"}
blnk info
```

Alias: `blnk i`

```bash Options theme={"system"}
Description:
  Shows the current server URL and whether it is connected.

Usage:
  blnk info

Options:
  -h, --help            Show help information
```

***

## ledgers

Use the `ledgers` command to make requests (create, list, etc.) on ledgers.

```bash theme={"system"}
blnk ledgers [command] [options]
```

| Command | Alias | Description         |
| ------- | ----- | ------------------- |
| list    | l     | View all ledgers    |
| create  | c     | Create a new ledger |

### View ledgers

View a list of your ledgers.

```bash theme={"system"}
blnk ledgers list [options]
```

```bash Options theme={"system"}
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_abc123
```

### Create a ledger

Create a new ledger interactively.

```bash theme={"system"}
blnk ledgers create
```

```bash Options theme={"system"}
Description:
  This command creates a new ledger interactively.

Usage:
  blnk ledgers create

Options:
      --json            Print full JSON output
  -h, --help            Show help information

Examples:
  $ blnk ledgers create
  $ blnk ledgers c
  $ blnk ledgers create --json
```

***

## balances

Use the `balances` command to make requests (create, list, update) on balances.

```bash theme={"system"}
blnk balances [command] [options]
```

| Command | Alias | Description                   |
| ------- | ----- | ----------------------------- |
| list    | l     | View all balances             |
| create  | c     | Create a new balance          |
| update  | u     | Link a balance to an identity |

### View balances

View a list of your balances.

```bash theme={"system"}
blnk balances list [options]
```

```bash Options theme={"system"}
Description:
  View a list of your balances.

Usage:
  blnk balances list [options]

Options:
Single list:
      --id <balance-id>           Get a balance 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 balances list
  $ blnk balances l --page 2 --per-page 15
  $ blnk balances l --currency "USD,EUR" --indicator World
```

### Create a balance

Create a new balance interactively.

```bash theme={"system"}
blnk balances create
```

```bash Options theme={"system"}
Description:
  This command creates a new balance interactively.

Usage:
  blnk balances create

Options:
      --json            Print full JSON output
  -h, --help            Show help information

Examples:
  $ blnk balances create
  $ blnk balances c
  $ blnk balances create --json
```

### Link a balance to an identity

Link a balance to an identity.

```bash theme={"system"}
blnk balances update <balance-id>
```

```bash Options theme={"system"}
Description:
  Link a balance to an identity.

Usage:
  blnk balances update <balance-id>

Options:
  -h, --help            Show help information

Examples:
  $ blnk balances update bln_abc123
  $ blnk balances u bln_abc123
```

***

## transactions

Use the `transactions` command to make requests (create, list, update) on transactions.

```bash theme={"system"}
blnk transactions [command] [options]
```

| Command | Alias | Description                           |
| ------- | ----- | ------------------------------------- |
| list    | l     | View all transactions                 |
| create  | c     | Create a new transaction              |
| update  | u     | Commit, void, or refund a transaction |

### View transactions

View a list of your transactions.

```bash theme={"system"}
blnk transactions list [options]
```

```bash Options theme={"system"}
Description:
  View a list of your transactions.

Usage:
  blnk transactions list [options]

Options:
Single list:
      --id <transaction-id>       Get a transaction 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 transactions list
  $ blnk transactions l --page 3 --per-page 25
  $ blnk transactions l --status APPLIED --currency "USD,EUR"
  $ blnk transactions l --balance-id bln_abc123 --status APPLIED
```

### Create a transaction

Create a new transaction interactively.

```bash theme={"system"}
blnk transactions create
```

<Tip>
  For creating more complex transactions, use the API. See the [API documentation](https://docs.blnkfinance.com).
</Tip>

```bash Options theme={"system"}
Description:
  This command creates a new transaction interactively.

Usage:
  blnk transactions create

Options:
      --json            Print full JSON output
  -h, --help            Show help information

Examples:
  $ blnk transactions create
  $ blnk transactions c
  $ blnk transactions create --json

Note:
  For creating more complex transactions, please use the API. Refer to the API documentation at https://docs.blnkfinance.com
```

### Commit, void, or refund a transaction

Commit, void, or refund a transaction.

```bash theme={"system"}
blnk transactions update [options] <transaction-id>
```

```bash Options theme={"system"}
Description:
  Commit, void, or refund a transaction.

Usage:
  blnk transactions update [options] <transaction-id>

Options:
      --commit         Fully commit an inflight transaction
      --void           Void an inflight transaction
      --refund         Refund a transaction
  -h, --help           Show help information

Examples:
  $ blnk transactions update --commit txn_abc123
  $ blnk transactions u --void txn_abc123
  $ blnk transactions u --refund txn_abc123
```

***

## identities

Use the `identities` command to make requests (create, list) on identities.

```bash theme={"system"}
blnk identities [command] [options]
```

| Command | Alias | Description           |
| ------- | ----- | --------------------- |
| list    | l     | View all identities   |
| create  | c     | Create a new identity |

### View identities

View a list of your identities.

```bash theme={"system"}
blnk identities list [options]
```

```bash Options theme={"system"}
Description:
  View a list of your identities.

Usage:
  blnk identities list [options]

Options:
Single list:
      --id <identity-id>           Get an identity 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 identities list
  $ blnk identities l --page 2 --per-page 20
  $ blnk identities l --email-address jane@example.com
  $ blnk identities l --first-name Jane --last-name Doe
```

### Create an identity

Create a new identity interactively.

```bash theme={"system"}
blnk identities create
```

```bash Options theme={"system"}
Description:
  This command creates a new identity interactively.

Usage:
  blnk identities create

Options:
      --json            Print full JSON output
  -h, --help            Show help information

Examples:
  $ blnk identities create
  $ blnk identities c
  $ blnk identities create --json
```

***

## reconciliations

Use the `reconciliations` command to view reconciliations.

```bash theme={"system"}
blnk reconciliations [command] [options]
```

| Command | Alias | Description              |
| ------- | ----- | ------------------------ |
| list    | l     | View all reconciliations |

### View reconciliations

View a list of your reconciliations.

```bash theme={"system"}
blnk reconciliations list [options]
```

```bash Options theme={"system"}
Description:
  View a list of your reconciliations.

Usage:
  blnk reconciliations list [options]

Options:
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 reconciliations list
  $ blnk reconciliations l -p 2 --per-page 20
  $ blnk reconciliations l --status COMPLETED --upload-id upl_abc123
```

***

## community

Use the `community` command to open community resources (Discord) in your browser.

```bash theme={"system"}
blnk community
```

```bash Options theme={"system"}
Description:
  Open community resources in your browser.

Usage:
  blnk community

Options:
  -h, --help            Show help information

Examples:
  $ blnk community
```

***

## docs

Use the `docs` command to open Blnk developer documentation in your browser.

```bash theme={"system"}
blnk docs
```

```bash Options theme={"system"}
Description:
  Open Blnk documentation in your browser.

Usage:
  blnk docs

Options:
  -h, --help            Show help information

Examples:
  $ blnk docs
```

***

## Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.

To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).

***

<Tip>
  **Tip:** Connect to Blnk Cloud to see your Core data.

  You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard.

  [Check out Blnk Cloud →](https://www.blnkfinance.com/products/cloud)
</Tip>