Skip to main content
Install the CLI to use Filament locally or manage a deployed server. Use the Go module to embed Filament in an application. Shared deployments run from the published container images or Helm chart.

​
CLI

Install the CLI on Linux or macOS:
On macOS, you can also use Homebrew:
Prebuilt binaries are available from GitHub Releases. Confirm the installation with:
The local CLI uses file-backed SQLite and an in-process event bus. It does not require Postgres or NATS. Continue with the CLI guide.

​
Go module

Add Filament to a Go application:
Import app and the connectors the application needs. See Embedded for a minimal program and runtime options.

​
Deployments

Filament publishes these container images: Use the same release tag for the server, control plane, and worker. A split deployment also needs a datastore, an event bus, and a secret provider. Worker tags with a -libc suffix include the connectors that depend on native libraries. Kubernetes with Helm is the recommended production installation. Railway and Render are available when runs can execute inside the control plane. Choose a path in the deployment overview.

​
Build from source

See local development to build the binaries, images, and web application from this repository.