> ## Documentation Index
> Fetch the complete documentation index at: https://filament.getgalaxy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the CLI, add the Go module, or deploy Filament

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:

```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
curl -fsSL https://getgalaxy.io/filament/install | sh
```

On macOS, you can also use Homebrew:

```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
brew install galaxy-io/tap/filament
```

Prebuilt binaries are available from
[GitHub Releases](https://github.com/galaxy-io/filament/releases). Confirm the
installation with:

```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
filament version
```

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](/pages/guides/usage/cli).

## Go module

Add Filament to a Go application:

```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
go get github.com/galaxy-io/filament@latest
```

Import `app` and the connectors the application needs. See
[Embedded](/pages/guides/usage/embedded) for a minimal program and runtime
options.

## Deployments

Filament publishes these container images:

| Image | Purpose |
| - | - |
| `ghcr.io/galaxy-io/filament/server` | API and web application |
| `ghcr.io/galaxy-io/filament/control-plane` | Scheduling and run coordination |
| `ghcr.io/galaxy-io/filament/worker` | Connector host and run executor |
| `ghcr.io/galaxy-io/filament/standalone` | Single-process evaluation image |

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](/pages/guides/deployment/overview).

## Build from source

See [local development](/pages/guides/contributing/local-development) to build
the binaries, images, and web application from this repository.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.