The Blnk CLI is a developer tool that helps you to build, test, and manage your Blnk installation directly from the command line. With the CLI, you can easily test your deployment, search your financial data, sync your server to the cloud, connect to local and remote instances, and so much more.

Let’s get started ✨

  1. Installing the Blnk CLI
  2. Connecting instances

​
1. Installing the Blnk CLI

To use the Blnk CLI, you need to first have Node.js and npm downloaded on your machine.

Next, install the Blnk CLI via your terminal into the same location as your ledger:

Shell
npm i @blnkfinance/blnk-cli

Next, confirm your installation by checking for the version you’ve downloaded:

Shell
blnk --version
Output
1.0.9

​
2. Connecting instances

To connect to an instance with the CLI, ensure that Blnk has been installed on your server (local or cloud). If you have Blnk running locally on your computer, your default connection url is https://localhost:5001/.

To connect to a different instance url:

Shell
blnk connect <url>

You can also choose to connect to a secure installation of the Blnk Ledger. To do this:

Shell
blnk connect <url> <token>

Next, confirm that you have successfully connected to an instance:

Shell
blnk info
Output
Current Server Connection:
Instance URL: http://localhost:5001
API Token: Not set

​
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 join our Discord community.

Was this page helpful?

Ledgers