Skip to main content

Installation

Formance CLI is available as pre-compiled binaries for Linux, macOS and Windows. You can install it using the installers below, or download a release binary from the releases page.

# check your installation
numary version

# start the instance
numary server start

Homebrewโ€‹

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

Dockerโ€‹

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

Docker Composeโ€‹

curl -L https://raw.githubusercontent.com/numary/ledger/main/docker-compose.yml -o docker-compose.yml

docker-compose up -d

Open Formance UI : http://127.0.0.1:3078

Install on APT Basedโ€‹

Add Formance's package repository to /etc/apt/sources.list:

/etc/apt/sources.list
deb [trusted=yes] https://apt.fury.io/numary/ /

Then run this command to install Formance Ledger:

apt update && apt install numary

Install on RPM basedโ€‹

Add Formance's package repository by creating a file called /etc/yum.repos.d/formance.repo:

/etc/yum.repos.d/numary.repo
[numary]
name=Formance Private Repo
baseurl=https://yum.fury.io/numary/
enabled=1
gpgcheck=0

Then run this command for install Formance Ledger:

yum update && yum install numary

Formance Cloudโ€‹

If you want to try Formance without installing it, you can sign-up for a Formance Cloud account.

We're currently running an early-adopter program that will give you enough room to explore Formance for free and access to discounted credits should you want to target production usage. Please request your seat here.