# Filament

> Change data capture and replication, as a single binary or an embeddable Go library.

- [Introduction](https://filament.getgalaxy.io/pages/guides/get-started/introduction.md): What Filament is and how its pieces fit together
- [Quickstart](https://filament.getgalaxy.io/pages/guides/get-started/quickstart.md): Run Filament locally in three commands
- [Installation](https://filament.getgalaxy.io/pages/guides/get-started/installation.md): Install the CLI, add the Go module, or deploy Filament
- [Overview](https://filament.getgalaxy.io/pages/guides/concepts/overview.md): The few concepts you need to reason about data movement in Filament
- [Architecture](https://filament.getgalaxy.io/pages/guides/concepts/architecture.md): How data, progress, and control move through a Filament run
- [Replication modes](https://filament.getgalaxy.io/pages/guides/concepts/replication-modes.md): Choose how Filament reads a resource and how the destination changes
- [Streaming](https://filament.getgalaxy.io/pages/guides/concepts/streaming.md): How continuous runs commit progress, recover after interruptions, and stop safely
- [Integrity & checkpoints](https://filament.getgalaxy.io/pages/guides/concepts/integrity-and-checkpoints.md): What Filament verifies, when progress becomes durable, and where the guarantees end
- [Runs and recovery](https://filament.getgalaxy.io/pages/guides/concepts/runs-and-recovery.md): Run states, recovery boundaries, and lifecycle controls
- [Web](https://filament.getgalaxy.io/pages/guides/usage/web.md): The web app that ships inside the Filament server
- [CLI](https://filament.getgalaxy.io/pages/guides/usage/cli.md): Manage local and deployed Filament from the command line
- [Embedded](https://filament.getgalaxy.io/pages/guides/usage/embedded.md): Run Filament inside your own Go process
- [Python SDK](https://filament.getgalaxy.io/pages/guides/sdks/python.md): Create connections, discover resources, build pipelines, and run them from Python
- [TypeScript SDK](https://filament.getgalaxy.io/pages/guides/sdks/typescript.md): Create connections, discover resources, build pipelines, and run them from TypeScript or JavaScript
- [Overview](https://filament.getgalaxy.io/pages/connectors/overview/introduction.md): The sources and sinks that plug into Filament, and how mature each one is
- [PostgreSQL](https://filament.getgalaxy.io/pages/connectors/sources/postgres.md): Resumable full-snapshot, incremental, and CDC reads from PostgreSQL
- [MySQL](https://filament.getgalaxy.io/pages/connectors/sources/mysql.md): Keyset snapshot, incremental watermark, and binlog CDC reads from MySQL 8.0+
- [Kafka](https://filament.getgalaxy.io/pages/connectors/sources/kafka.md): Consume Kafka message envelopes with certified partition checkpoints
- [NATS JetStream](https://filament.getgalaxy.io/pages/connectors/sources/nats.md): Consume retained subject messages with certified epoch acknowledgements
- [Apollo](https://filament.getgalaxy.io/pages/connectors/sources/apollo.md): Read contacts, accounts, sequences, deals, and engagement data from Apollo
- [Attio](https://filament.getgalaxy.io/pages/connectors/sources/attio.md): Read CRM records, lists, notes, tasks, meetings, and call transcripts from Attio
- [FHIR](https://filament.getgalaxy.io/pages/connectors/sources/fhir.md): Read clinical resources from a FHIR R4 server
- [FXMacroData](https://filament.getgalaxy.io/pages/connectors/sources/fxmacrodata.md): Read macroeconomic announcements, forecasts, FX rates, and market context
- [GitHub](https://filament.getgalaxy.io/pages/connectors/sources/github.md): Read repository, community, and collaboration data from a GitHub organization
- [Gong](https://filament.getgalaxy.io/pages/connectors/sources/gong.md): Read calls, transcripts, users, and reference data from Gong
- [Granola](https://filament.getgalaxy.io/pages/connectors/sources/granola.md): Read meeting notes, AI summaries, transcripts, folders, and webhook configuration from Granola
- [HeyReach](https://filament.getgalaxy.io/pages/connectors/sources/heyreach.md): Read campaigns, leads, lists, conversations, and analytics from HeyReach
- [HubSpot](https://filament.getgalaxy.io/pages/connectors/sources/hubspot.md): Full and incremental reads of HubSpot CRM records and custom objects
- [Instantly](https://filament.getgalaxy.io/pages/connectors/sources/instantly.md): Read campaigns, leads, emails, accounts, and analytics from Instantly
- [Linear](https://filament.getgalaxy.io/pages/connectors/sources/linear.md): Read teams, users, projects, and issues from Linear's GraphQL API
- [Live Tennis API](https://filament.getgalaxy.io/pages/connectors/sources/livetennisapi.md): Read tennis matches, players, tournaments, historical results, and rankings
- [Mailchimp](https://filament.getgalaxy.io/pages/connectors/sources/mailchimp.md): Read audiences, members, campaigns, reports, and commerce data from Mailchimp
- [monday.com](https://filament.getgalaxy.io/pages/connectors/sources/monday.md): Read boards, items, updates, documents, and account data from monday.com
- [Notion](https://filament.getgalaxy.io/pages/connectors/sources/notion.md): Read databases, pages, users, and blocks from a Notion workspace
- [Novada](https://filament.getgalaxy.io/pages/connectors/sources/novada.md): Read proxy balances, scraping prices, usage reports, tasks, and request logs from Novada
- [Pipedrive](https://filament.getgalaxy.io/pages/connectors/sources/pipedrive.md): Read deals, leads, contacts, activities, and reference data from Pipedrive
- [PostHog](https://filament.getgalaxy.io/pages/connectors/sources/posthog.md): Read people, groups, cohorts, feature flags, experiments, and session replay metadata from a PostHog project
- [Resend](https://filament.getgalaxy.io/pages/connectors/sources/resend.md): Read sent and received email, broadcasts, contacts, segments, domains, templates, and webhook deliveries from Resend
- [ServiceTitan](https://filament.getgalaxy.io/pages/connectors/sources/servicetitan.md): Read ServiceTitan exports and supporting operational resources
- [Slack](https://filament.getgalaxy.io/pages/connectors/sources/slack.md): Read conversations, messages, thread replies, files, and workspace metadata from Slack
- [Stripe](https://filament.getgalaxy.io/pages/connectors/sources/stripe.md): Read charges, payment intents, invoices, subscriptions, and the balance ledger from a Stripe account
- [Zoho CRM](https://filament.getgalaxy.io/pages/connectors/sources/zoho.md): Read CRM and inventory records, custom modules, relationships, and administrative data from Zoho CRM
- [Sample](https://filament.getgalaxy.io/pages/connectors/sources/sample.md): Synthetic data for testing pipelines without a real upstream
- [PostgreSQL](https://filament.getgalaxy.io/pages/connectors/sinks/postgres.md): Write typed tables to PostgreSQL
- [MySQL](https://filament.getgalaxy.io/pages/connectors/sinks/mysql.md): Write typed tables to MySQL
- [NATS JetStream](https://filament.getgalaxy.io/pages/connectors/sinks/nats.md): Publish acknowledged JSON messages in bounded runs or continuous epochs
- [ClickHouse](https://filament.getgalaxy.io/pages/connectors/sinks/clickhouse.md): Write typed analytical tables to ClickHouse
- [MotherDuck](https://filament.getgalaxy.io/pages/connectors/sinks/motherduck.md): Write typed analytical tables to MotherDuck
- [Snowflake](https://filament.getgalaxy.io/pages/connectors/sinks/snowflake.md): Write typed analytical tables to Snowflake
- [Google BigQuery](https://filament.getgalaxy.io/pages/connectors/sinks/bigquery.md): Write typed analytical tables to Google BigQuery
- [Amazon Redshift](https://filament.getgalaxy.io/pages/connectors/sinks/redshift.md): Write typed analytical tables to Amazon Redshift
- [Meilisearch](https://filament.getgalaxy.io/pages/connectors/sinks/meilisearch.md): Write searchable documents to Meilisearch indexes
- [Iceberg](https://filament.getgalaxy.io/pages/connectors/sinks/iceberg.md): Write Parquet data files to Apache Iceberg tables
- [Google Cloud Storage](https://filament.getgalaxy.io/pages/connectors/sinks/gcs.md): Write NDJSON, JSON, or Parquet objects to Google Cloud Storage
- [AWS S3](https://filament.getgalaxy.io/pages/connectors/sinks/aws-s3.md): Write NDJSON, JSON, or Parquet objects to Amazon S3 or any S3-compatible endpoint
- [Standard output](https://filament.getgalaxy.io/pages/connectors/sinks/standard-output.md): Print records to stdout for local development and debugging
- [Overview](https://filament.getgalaxy.io/pages/connectors/building-a-connector/overview.md): How to add a connector, and which of the two paths to take
- [Writing a source](https://filament.getgalaxy.io/pages/connectors/building-a-connector/writing-a-source.md): Build a Go source that writes typed rows into Filament
- [Writing a sink](https://filament.getgalaxy.io/pages/connectors/building-a-connector/writing-a-sink.md): Build a Go sink that applies Arrow batches under a write policy
- [Optional interfaces](https://filament.getgalaxy.io/pages/connectors/building-a-connector/optional-interfaces.md): Add discovery, schemas, recovery, and CDC behavior to a connector
- [Streaming connectors](https://filament.getgalaxy.io/pages/connectors/building-a-connector/streaming.md): Implement reusable source sessions and sink epochs with explicit recovery boundaries
- [HTTP manifests](https://filament.getgalaxy.io/pages/connectors/building-a-connector/http-manifests.md): Declarative YAML manifests that drive the generic HTTP API source
- [Overview](https://filament.getgalaxy.io/pages/guides/deployment/overview.md): Choose how and where to run Filament
- [Configuration](https://filament.getgalaxy.io/pages/guides/deployment/configuration.md): Configure the server, control plane, and workers
- [Kubernetes](https://filament.getgalaxy.io/pages/guides/deployment/kubernetes.md): Deploy Filament with the Helm chart
- [Railway](https://filament.getgalaxy.io/pages/guides/deployment/railway.md): Deploy Filament from the Railway template
- [Render](https://filament.getgalaxy.io/pages/guides/deployment/render.md): Deploy Filament from the Render Blueprint
- [DigitalOcean](https://filament.getgalaxy.io/pages/guides/deployment/digitalocean.md): Deploy a single-process Filament instance to DigitalOcean App Platform
- [Overview](https://filament.getgalaxy.io/pages/api-reference/service/introduction.md): Use an SDK or call Filament's API directly, with authentication, tenancy, and pagination
- [Connectors](https://filament.getgalaxy.io/pages/api-reference/service/connectors.md): Discover the sources and sinks available in a Filament deployment
- [Connections](https://filament.getgalaxy.io/pages/api-reference/service/connections.md): Save connector settings once and reuse them across pipelines
- [Pipelines](https://filament.getgalaxy.io/pages/api-reference/service/pipelines.md): Define data routes, save versioned changes, and schedule runs
- [Runs](https://filament.getgalaxy.io/pages/api-reference/service/runs.md): Submit pipeline routes, inspect progress, stream events, and control execution
- [Metrics](https://filament.getgalaxy.io/pages/api-reference/service/metrics.md): Query run totals and time series for dashboards and reports
- [Benchmarking](https://filament.getgalaxy.io/pages/benchmarks/overview.md): How Filament's data-movement benchmarks are designed, measured, and reproduced
- [Local development](https://filament.getgalaxy.io/pages/guides/contributing/local-development.md): Set up the toolchain and run Filament from source
- [Style & testing](https://filament.getgalaxy.io/pages/guides/contributing/style-and-testing.md): Formatting, linting, and the three test layers


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