Formance CLI
The Formance Platform comes with a command line interface (CLI) that allows you to manage your Formance Platform instances. The CLI is called fctl and is available for Linux, macOS, and Windows.
As of today, fctl is only available for Formance Cloud and CloudPrem deployments. If you are self-hosting Formance Elements or a single component like Ledger, you will need to use their respective API directly.
Installing fctl
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.
- Linux
- macOS
- Windows
# 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/components%2Ffctl%2Fv0.14.0/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
# 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/components%2Ffctl%2Fv0.14.0/fctl_darwin-$ARCH.tar.gz" \
&& tar -xvf fctl.tar.gz \
&& sudo mv fctl /usr/local/bin \
&& chmod +x /usr/local/bin/fctl \
&& rm fctl.tar.gz
# You can download and unzip the latest fctl release from the GitHub releases page
# available at https://github.com/formancehq/stack/releases
#
# Place the binary somewhere convenient and in your PATH, such as C:\Program Files\fctl
# and make sure to drop the .exe for easier usage afterwards
Debian/Ubuntu
First, you'll need to add the Formance's package repository to your /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
Post-installation
You can check that Formance CLI was installed correctly by trying the following command:
fctl version
You should see something like
Version | 0.5.1
Date | 2022-11-14T11:09:43Z
Commit | 9fe16ac
If you don't, then recheck the steps above, or reach out to us to ask for help.
Now, 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.
Troubleshooting
Formance CLI stores its configuration in a file located at ~/.formance/fctl.config in your home directory. If you are having trouble with the fctl, you can delete this file, and it will be recreated the next time you run fctl login.