Skip to content

Installation and upgrade

Installation

Supported platforms

Operating System Architecture
Linux arm64
Linux x86_64
MacOS x86_64
MacOS arm64

Install formae

Run the installation script:

/bin/bash -c "$(curl -fsSL https://hub.platform.engineering/setup/formae.sh)"

This installs formae to /opt/pel/formae/.

Configure Your PATH

For zsh users (macOS default):

echo 'export PATH=/opt/pel/formae/bin:$PATH' >> ~/.zshrc
source ~/.zshrc

For bash users:

echo 'export PATH=/opt/pel/formae/bin:$PATH' >> ~/.profile
source ~/.profile

Verify installation

formae --version

Next steps

After installation, start the agent and configure your environment. See the Configuration documentation for available options.


Upgrade

Latest version

formae upgrade

Specific version

List available versions:

formae upgrade list

Install a specific version:

formae upgrade --version 0.74.0

Agent Sizing

Recommended resources for the Formae agent based on the number of managed resources:

Resources Memory vCPU
Up to 1,000 512 MB 1
1,000-5,000 1 GB 2
5,000-10,000 1.5 GB 2-4
10,000-20,000 2 GB 4

These recommendations assume active discovery and synchronization. Memory usage scales primarily with the number of resources tracked, while CPU usage depends on the rate of changes and API operations.