fctl is Formant’s command-line interface. It may be used to query live and historical telemetry data, manage agent configuration or ingest offline data.

Install fctl

Convenience Script:

bash <(curl -s https://app.formant.io/install-fctl.sh)

This will intstall fctl on your system and prompt you for admin credentials. This will also configure your `~/.ssh/config` for ssh over Formant's peer-to-peer connection.

Linux:

First make sure you have setup the Formant debian repository on your machine and the Formant public key (replace <distro> with your Linux distribution):

DISTRO_CODENAME=`lsb_release -cs`
echo "deb https://repo.formant.io/formant/debian ${DISTRO_CODENAME} main" | sudo tee /etc/apt/sources.list.d/formant.list
sudo apt-key adv --fetch-keys https://keys.formant.io/formant.pub.gpg

Next, update and install the fctl debian package:

sudo apt update
sudo apt install fctl

Mac:

Setup the Formant tap and install via homebrew:

brew tap formantio/formant
brew install formantio/formant/fctl

Docker:

First you'll need to initialize the fctl container with a volume mount on your local machine to store tokens (make sure to include a '  ' before the command so it doesn't save to your history):

docker run -it -v <permanent_storage>:/root/.formant -e FORMANT_EMAIL=<admin_email> -e FORMANT_PASSWORD=<admin_password> formant/fctl init

Replace  <permanent_storage> with a mount path on your localhost system, and fill in your admin credentials.

Verify Installation (Mac/Linux):

Check that fctl is available by running:

$ fctl -h
fctl supports command-line interaction with the Formant Cloud APIs


Usage:
  fctl [command]


Available Commands:
  apply        Apply configuration to devices
  completion   Generate completion scripts
  create       Create a resource
  describe     Describe a resource
  help         Help about any command
  init         Reinitialize fctl credentials
  list         List a resource
  port-forward Port forward to your device, used for SSH, SCP, and network tunneling.
  provision    Provision a resource
  query        Query ingested datapoints
  version      Get fctl version


Flags:
  -h, --help   display detailed help for fctl


Use "fctl [command] --help" for more information about a command.

fctl requires admin level privileges on your Formant account. We never store your email/password on disk so you initialize by running:

fctl init