filament

filament [--context NAME] [--config PATH] [-i] [COMMAND]

filament is the command-line client for Filament, a Go data-replication engine. It copies data from sources to sinks using full loads, incremental replication, or change data capture. Batches are verified at the sink handoff; resumable runs pick up from the last durable checkpoint instead of starting over.The same binary talks to a local runtime (file-backed SQLite and an in-process event bus; no Postgres or NATS required) or a remote Filament server selected by a context. Most management commands work against both.A connection stores connector settings (Postgres, MySQL, S3, ClickHouse, Iceberg, stdout, and several SaaS sources). A pipeline routes a source to a sink and names the resources, sync mode, and write mode. filament run executes that route and streams progress until it finishes.`filament up` keeps the embedded API and web UI available on a stable address. Ordinary local commands start the runtime for one operation and stop it.Filament is pre-1.0: public APIs, including connector interfaces, may still change.

-i, --interactive

Open the terminal menu (or a wizard when combined with a command such as source create).

Run this invocation against context NAME instead of the current one.

Local YAML document to apply (local contexts only).

Table drawing style. Also read from FILAMENT_LAYOUT.

Manage sources. ls is an alias of list. Connector fields become `--source-*` flags.

Manage sinks. Connector fields become `--sink-*` flags.

Manage saved pipelines. create needs --source and --sink naming saved connections.

Run a saved pipeline, or an inline transfer with --source-connector and --sink-connector. run list [PIPELINE] shows history.

Serve the local runtime, API, and web UI (default `127.0.0.1:8080`). -d, --detach backgrounds it.

Stop the detached process started by up --detach.

Show the selected context and whether its runtime is reachable.

Manage local vs remote targets. ctx is an alias.

Service-account login for a remote Filament server.

Inspect, check, or open the local YAML document in `$VISUAL`/`$EDITOR`.

The built-in local context reads `~/.config/filament/filament.yaml` (or `$XDGCONFIGHOME/filament/filament.yaml`). filament config path prints the active file. The YAML is declarative input applied when it changes; it is not an inventory. Removing an entry from YAML does not delete the object from local SQLite state.

$ version: 1

sources:
  production:
    type: postgres
    config:
      connection_method: url
      dsn: env:POSTGRES_DSN

sinks:
  warehouse:
    type: stdout

pipelines:
  users-copy:
    source:
      ref: production
    sink:
      ref: warehouse
    resources:
      - users
    sync_mode: full
    write_mode: replace

The command name filament is also used by unrelated projects (Google's Filament rendering engine and Laravel Filament). This page documents the Galaxy filament replication CLI (`galaxy-io/filament`).Inline filament run --source-connector ... transfers are full reads only. They do not keep run history or checkpoints. Remote contexts run saved pipelines without those inline overrides.filament up only accepts a local context.Do not put secrets on the process command line; they can appear in shell history and process listings. Prefer `*-env` flags or quoted environment references.

Filament is an Apache-2.0 Go project from galaxy-io, first published on GitHub in June 2026. It ships as a standalone CLI, an embeddable Go module, and container images (server, control plane, worker, standalone) for larger deployments.

rsync(1), pg_dump(1), mysqldump(1), debezium(1)

Source code · Homepage · Documentation