Skip to main content
Version: v1.10

Installation

Interested in trying Formance Ledger out? The simplest way is to create yourself a Cloud Sandbox using the Formance CLI.

tip

Formance Ledger can also be used and installed locally or deployed as a standalone component without bringing the whole Formance Platform to the party. You can find more details about installing it this way the ledger reference.

Homebrew​

If you have Homebrew installed on your computer, you can install the CLI by running:

brew install formancehq/tap/fctl

To upgrade an existing installation of the Formance CLI, run:

brew upgrade fctl

Binary​

Binaries for fctl are available for Linux, macOS, and Windows. You can download the latest release from the GitHub releases page.

# You can use either amd64 for x86_64 or arm64 for ARM
ARCH="amd64"; curl -L -o fctl.tar.gz "https://github.com/formancehq/stack/releases/download/v2.0.0-rc.25/fctl_linux-$ARCH.tar.gz" \
&& tar -xvf fctl.tar.gz \
&& sudo mv fctl /usr/local/bin \
&& chmod +x /usr/local/bin/fctl \
&& rm fctl.tar.gz

Debian/Ubuntu​

First, you'll need to add the Formance's package repository to your /etc/apt/sources.list:

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

Then, you can run this command to install Formance CLI:

apt update && apt install fctl

Installation check​

You can check that Formance CLI was installed correctly by trying the following command:

fctl version

You should see something like

Version | 0.10.1
Date    | 2023-05-11T10:21:28Z
Commit  | f5f577ce

If you don't, then recheck the steps above, or reach out to us to ask for help.

Logging In​

Finally, you'll need to either log into or create your Formance Cloud account. You can do that from the CLI:

fctl login

This will take you to a page for creating an account or logging in to your existing account.

Creating your first stack​

Once you're logged in, you are able to create one stack for free, with as many ledgers as you want. You can do that with the following command:

fctl stack create helloworld

This will create a new stack called helloworld and set it as the default stack for your account. You can check that it was created successfully by running:

fctl stack list