Interested in trying Formance Ledger out? You can install it on your local machine first.
Formance Ledger is, as you'd expect, available for Linux, macOS, and Windows.
We also provide Docker images for production environments. You can learn more about all the different ways of installing Formance Ledger in the reference documentation.
If you have Homebrew installed on your computer, you can install the CLI by running:
brew install numary/tap/numary
To upgrade an existing installation of the Formance CLI, run:
brew upgrade numary
Formance Ledger is available for APT (Debian) and RPM (RedHat) based distributions.
Install with APT (Debian, Ubuntu)
Add Formance's package repository to
deb [trusted=yes] https://apt.fury.io/numary/ /
Then run this command to install Formance Ledger:
apt update && apt install numary
Install with RPM (RedHat, Fedora, SUSE)
Add Formance's package repository by creating a file called
name=Formance Private Repo
Then run this command for install Formance Ledger:
yum update && yum install numary
Download the pre-compiled binary
numary_x.y.z_Windows-64bit.zip from GitHub (where
x.y.z is the version number). Unzip the file, and place
numary.exe somewhere convenient such as
Consider renaming the executable
numary (without the
.exe suffix) to make it easier to type, and so the example commands in the rest of the tutorial will work without having to edit them.
We provide the Formance CLI as ready-to-use Docker container images. You can install the latest version of the CLI using the latest tag or a specific version passing the appropriate tag.
docker run -p 3068:3068 -v $HOME/numary:/root/.numary --env NUMARY_SERVER_HTTP_BIND_ADDRESS="0.0.0.0:3068" ghcr.io/numary/ledger:latest
Open Formance API : http://127.0.0.1:3068/_info
You can check that Formance CLI was installed correctly by trying the following command:
You should see something like
If you don't, then recheck the steps above, or reach out to us to ask for help.