Documentation Index
Fetch the complete documentation index at: https://docs.formance.com/llms.txt
Use this file to discover all available pages before exploring further.
fctl (Formance CLI) is the command-line tool for managing the Formance Platform. Use it to create and manage stacks, interact with services, and configure your environment.
The Formance Platform embraces a CloudPrem architecture — enabling you to decide how much you want to run on your own infrastructure, and how much you want to run on Formance Cloud. More details can be found in the architecture section. Homebrew
If you have Homebrew installed on your computer, you can install the CLI by running:
brew install formancehq/tap/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
# 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_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/ /
apt update && apt install fctl
Installation check
You can check that Formance CLI was installed correctly by trying the following command:
You should see something like
Version | 0.10.1
Date | 2023-05-11T10:21:28Z
Commit | f5f577ce
Logging In
Finally, you’ll need to either log into or create your Formance Cloud account. You can do that from the CLI:
This will take you to a page for creating an account or logging in to your existing account.
