Fluid Forge
Why Forge
Concepts
Get Started
  • Consume a Data Product
  • See it run
  • Demos
  • Local (DuckDB)
  • Source-Aligned (Postgres → DuckDB)
  • AI Forge + Data Models
  • MCP Output Port — Serve to AI Agents
  • GCP (BigQuery)
  • Snowflake Team Collaboration
  • Declarative Airflow
  • Orchestration Export
  • Jenkins CI/CD
  • Universal Pipeline
  • 11-Stage Production Pipeline
  • Catalog Forge End-to-End
CLI Reference
  • Agent Policy (concept)
  • MCP Output Port — Serve to Agents
  • MCP deep-dive
  • AI-assisted authoring
  • LLM providers & backends
  • Overview
  • Quickstart
  • Examples
  • Your own CI
  • Your own scaffolding
  • Custom validator
  • Apply hook
  • Reference
  • Overview
  • Architecture
  • GCP (BigQuery)
  • AWS (S3 + Athena)
  • Snowflake
  • Local (DuckDB)
  • Custom Providers
  • Roadmap
GitHub
Why Forge
Concepts
Get Started
  • Consume a Data Product
  • See it run
  • Demos
  • Local (DuckDB)
  • Source-Aligned (Postgres → DuckDB)
  • AI Forge + Data Models
  • MCP Output Port — Serve to AI Agents
  • GCP (BigQuery)
  • Snowflake Team Collaboration
  • Declarative Airflow
  • Orchestration Export
  • Jenkins CI/CD
  • Universal Pipeline
  • 11-Stage Production Pipeline
  • Catalog Forge End-to-End
CLI Reference
  • Agent Policy (concept)
  • MCP Output Port — Serve to Agents
  • MCP deep-dive
  • AI-assisted authoring
  • LLM providers & backends
  • Overview
  • Quickstart
  • Examples
  • Your own CI
  • Your own scaffolding
  • Custom validator
  • Apply hook
  • Reference
  • Overview
  • Architecture
  • GCP (BigQuery)
  • AWS (S3 + Athena)
  • Snowflake
  • Local (DuckDB)
  • Custom Providers
  • Roadmap
GitHub
  • Introduction

    • Home
    • Why Fluid Forge
    • Getting Started
    • Snowflake Quickstart
    • See it run
    • Forge Data Model
    • Vision & Roadmap
    • Playground
    • FAQ
  • Concepts

    • Concepts
    • Builds, Exposes, Bindings
    • What is a contract?
    • Quality, SLAs & Lineage
    • Governance & Policy
    • Agent Policy (LLM/AI governance)
    • Providers vs Platforms
    • Fluid Forge vs alternatives
  • Data Products

    • Consume a Data Product
    • Product Types — SDP, ADP, CDP
  • Walkthroughs

    • Walkthrough: Local Development
    • Source-Aligned: Postgres → DuckDB → Parquet
    • AI Forge And Data-Model Journeys
    • Walkthrough: MCP Output Port
    • Walkthrough: Deploy to Google Cloud Platform
    • Walkthrough: Snowflake Team Collaboration
    • Declarative Airflow DAG Generation - The FLUID Way
    • Generating Orchestration Code from Contracts
    • Jenkins CI/CD for FLUID Data Products
    • Universal Pipeline
    • The 11-Stage Pipeline
    • End-to-End Walkthrough: Catalog → Contract → Transformation
  • CLI Reference

    • CLI Reference
    • Core workflow

      • fluid init
      • fluid demo
      • fluid forge
      • fluid validate
      • fluid plan
      • fluid apply
      • fluid diff
      • fluid status
    • Build & ship

      • fluid bundle
      • fluid generate
      • fluid generate artifacts
      • fluid validate-artifacts
      • fluid verify-signature
      • fluid generate iac
      • fluid generate-airflow
      • fluid generate-pipeline
      • fluid viz-graph
      • fluid publish
      • fluid ship
      • fluid rollback
      • fluid schedule-sync
    • AI & Agents

      • fluid ai
      • fluid agents
      • fluid mcp
      • fluid memory
      • fluid stats
      • fluid skills
    • Quality & governance

      • fluid test
      • fluid verify
      • fluid contract-tests
      • fluid contract-validation
      • fluid policy
      • fluid policy check
      • fluid policy compile
      • fluid policy apply
    • Standards & interoperability

      • fluid odps
      • fluid odps-bitol
      • fluid odcs
      • fluid export
      • fluid export-odps
      • fluid exporters
      • fluid import
      • fluid market
      • fluid datamesh-manager
    • Project & workspace

      • fluid product-new
      • fluid product-add
      • fluid workspace
      • fluid contract
      • fluid split
      • fluid config
      • fluid providers
      • fluid plugins
      • fluid provider-init
      • fluid auth
      • fluid secrets
      • fluid ide
      • fluid scaffold-ci
      • fluid scaffold-composer
      • fluid scaffold-ide
      • fluid docs
      • fluid runs
      • fluid retention
      • fluid describe
      • fluid doctor
      • fluid roadmap
      • fluid version
    • Catalog adapters

      • Source Catalog Integration (V1.5)
      • Publishing to a Catalog — Overview
      • BigQuery Catalog
      • Snowflake Horizon Catalog
      • Databricks Unity Catalog
      • Google Dataplex Catalog
      • AWS Glue Data Catalog
      • DataHub Catalog
      • Data Mesh Manager Catalog
      • OpenMetadata Catalog
    • CLI by task

      • CLI by task
      • Add quality rules
      • Add agent governance
      • Debug a failed pipeline run
      • Switch clouds with one line
  • Recipes

    • Recipes
    • Recipe — add a quality rule
    • Recipe — switch clouds with one line
    • Recipe — tag PII in your schema
    • Write a contract that consumes another contract
    • Generate per-environment overlays
  • SDK & Plugins

    • SDK & Plugins
    • Quickstart — your first plugin
    • Examples

      • Runnable examples
      • Example: hello-scaffold — the minimal viable plugin
      • Example: gitlab-ci-scaffold — generate a complete CI project
      • Example: steward-validator — a custom governance rule
      • Example: prod-key-guard — apply-time invariant check
    • Journeys

      • Journeys
      • Your own CI/CD

        • You have your own CI/CD setup, no problem
        • GitLab CI — the bundle template
        • GitHub Actions — the bundle template
        • Jenkins — the bundle template
        • CircleCI — the bundle template
      • You have a strict project layout, no problem
      • You have governance rules, no problem
      • You want a check at apply time, no problem
    • Reference

      • Reference
      • Roles reference
      • Entry points reference
      • Trust model
      • Packaging
      • Companion packages
  • Providers

    • Providers
    • Provider Architecture
    • GCP Provider
    • AWS Provider
    • Snowflake Provider
    • Local Provider
    • Creating Custom Providers
    • Provider Roadmap
  • AI & Agents

    • MCP Server
    • Built-in And Custom Forge Guidance
    • Forge Discovery Guide
    • Forge Memory Guide
    • Authoring Forge Tools
    • Guided fluid forge UX
    • LLM Providers
    • LiteLLM Backend
    • Capability Warnings
    • Cost Tracking
    • FLUID Forge Contract GPT Packet
    • Agentic Primitives
  • Operate & Deploy

    • Airflow Integration
    • Blueprints
    • Source-Aligned Acquisition
  • Govern & Secure

    • Governance, Compliance & the Business Case
    • Governance & Compliance
    • Network Safety
    • Credential Resolver — Security Model
  • Configuration & Reference

    • Environment Variables
    • Typed Errors
    • Typed CLI Errors
    • API Stability — fluid_build.api
  • Architecture & Releases

    • V1.5 Catalog Integration — Architecture Deep-Dive
    • V1.5 + V2 Hardening — Release Notes
  • Project

    • Contributing to Fluid Forge
    • Fluid Forge Docs Baseline: CLI 0.9.0
    • Fluid Forge Docs Baseline: CLI 0.8.11
    • Fluid Forge Docs Baseline: CLI 0.8.10
    • Fluid Forge Docs Baseline: CLI 0.8.9
    • Fluid Forge Docs Baseline: CLI 0.8.8
    • Fluid Forge Docs Baseline: CLI 0.8.7
    • Fluid Forge Docs Baseline: CLI 0.8.6
    • Fluid Forge Docs Baseline: CLI 0.8.5
    • Fluid Forge Docs Baseline: CLI 0.8.4
    • Fluid Forge Docs Baseline: CLI 0.8.3
    • Fluid Forge Docs Baseline: CLI 0.8.0
    • Fluid Forge Docs Baseline: CLI 0.7.11
    • Fluid Forge Docs Baseline: CLI 0.7.9
    • Fluid Forge v0.7.1 - Multi-Provider Export Release

fluid generate

Unified artifact generation from FLUID contracts.

Syntax

fluid generate <transformation|speed-transformation|dbt|dbt-tests|schedule|ci|standard|artifacts>

Subcommands

fluid generate artifacts

Stage 3 of the 11-stage pipeline. Fanout that produces all catalog + execution artifacts for a contract in one call:

  • ODCS (v3.1.0) contract files under odcs/
  • ODPS-Bitol (v1.0.0) product files under odps-bitol/
  • Schedule DAGs under schedule/ (Airflow / Dagster / Prefect — depending on orchestration.engine)
  • Policy bindings under policy/bindings.json (IAM / GRANT)
  • A unified MANIFEST.json (SHA-256 per file + merkle root) for downstream stage-4 verification

Reference-only contracts (builds[].pattern: hybrid-reference / reference / external-reference) auto-skip the schedule and policies emitters — those execution artifacts are owned by the team's own dbt/Airflow repo. Catalog artifacts (odcs/, odps-bitol/) are still emitted.

Key options:

  • CONTRACT — path to contract.fluid.yaml (or a tgz bundle from fluid bundle --format tgz)
  • --out PATH — output directory (default dist/artifacts/)
  • --emit {odcs,odps-bitol,schedule,policies}[,...] — explicit emit set; default emits all of these
  • --env ENV — environment overlay
  • --no-generate-artifacts — CI helper: auto-skip this stage when the contract is reference-only (pattern: hybrid-reference etc.)
fluid generate artifacts contract.fluid.yaml --out dist/artifacts/
fluid generate artifacts runtime/bundle.tgz --out dist/artifacts/        # tgz input
fluid generate artifacts contract.fluid.yaml --emit odcs,odps-bitol      # catalog only

Verify the emitted tree with fluid validate-artifacts (stage 4).

fluid generate transformation

Generate transformation artifacts such as dbt projects or SQL output.

Key options:

  • contract
  • --output, -o
  • --build-index
  • --overwrite
  • --env
  • --dbt-validate
  • --list
  • --verbose

When the contract was produced by fluid forge data-model, the generator auto-loads the logical sidecar named by labels.modelSidecar and emits deterministic SQL from the forged logical model. For dbt output, zero generated models/**/*.sql files is a hard failure rather than a quiet success.

A normal dbt output directory includes:

  • dbt_project.yml
  • profiles.yml
  • models/sources.yml when source hints are available
  • non-empty SQL models under models/

fluid generate speed-transformation and fluid generate dbt remain aliases for this path.

fluid generate dbt-tests

Read the contract's exposes[].contract.dq.rules[] and emit a dbt schema.yml so your data-quality rules run as native dbt tests.

fluid generate dbt-tests
fluid generate dbt-tests contract.fluid.yaml -o dbt/models/schema.yml
fluid generate dbt-tests --env prod

Key options:

OptionDescription
contractContract path. Defaults to contract.fluid.yaml in the current directory.
--out, -oOutput path for the dbt schema.yml (default ./schema.yml). Drop it into your dbt project's models/<schema>/ directory.
--envEnvironment overlay (dev / test / prod).
  • Column-level rules map to dbt's built-in tests — not_null, unique, accepted_values — with dbt-utils placeholders emitted for rules that have no native dbt equivalent.
  • Model-level rules map to dbt-utils: anomaly_detection / drift_detection rules become dbt-utils expressions, and a freshness rule becomes dbt_utils.recency.
  • The generated dbt-utils-based tests require the dbt-utils package to be installed in your dbt project.
  • A managed-by sentinel marks the generated file, so re-running the command never clobbers a schema.yml you have hand-edited.

After generating, run dbt test in your dbt project to execute the rules.

fluid generate schedule

Generate orchestration artifacts such as Airflow DAGs, Dagster pipelines, or Prefect flows.

Key options:

  • contract
  • --output, -o
  • --scheduler
  • --overwrite
  • --env
  • --list
  • --verbose

This is the promoted path for orchestration generation.

fluid generate ci

Generate CI/CD pipeline configuration for Jenkins, GitHub Actions, GitLab CI, Azure DevOps, Bitbucket, CircleCI, or Tekton.

Key options:

OptionDescription
contractContract path. Defaults to contract.fluid.yaml when omitted.
--systemTarget CI system: jenkins, github, gitlab, azure, bitbucket, circle, or tekton.
--out PATHOverride the primary output path. Multi-file systems still write their supporting files to canonical locations.
--no-generate-artifactsSkip transformation/schedule artifact stages for reference-only contracts. Reference-only builds are also auto-detected from builds[].pattern.
--install-mode {pypi,dev-source}Jenkins only. pypi installs data-product-forge; dev-source installs from a /forge-cli-src bind mount for contributor labs.
--default-publish-target TARGETJenkins only. Emits a Stage 10 shell fallback of ${PUBLISH_TARGETS:-TARGET} so the first Pipeline-from-SCM build can publish to the intended catalog before Jenkins exports parameter defaults.
--[no-]verify-strict-defaultJenkins only. Controls the generated VERIFY_STRICT parameter default. Default is true.
--[no-]publish-stage-defaultJenkins only. Controls the generated RUN_STAGE_10_PUBLISH parameter default. Default is false.
--[no-]publish-include-envJenkins only. Controls whether Stage 10 appends --env "${FLUID_ENV:-dev}" to fluid publish. Use --no-publish-include-env for catalog publish paths that should not receive an environment flag.

Jenkins example for an Entropy Data / Data Mesh Manager first run:

fluid generate ci contract.fluid.yaml \
  --system jenkins \
  --install-mode pypi \
  --default-publish-target datamesh-manager \
  --no-verify-strict-default \
  --publish-stage-default \
  --no-publish-include-env \
  --out Jenkinsfile

fluid generate standard

Export to data product standards.

Key options:

  • contract
  • --format, -f
  • --out, -o
  • --env
  • --list

Supported formats:

--formatWhat it isUse it when
odps (default)Bitol ODPS v1.0.0 — Open Data Product Standard (center-stage)Publishing to Entropy Data / Data Mesh Manager. Rich product metadata, lineage, SLA, governance. Preserves FLUID-specific fields under an x-fluid namespace.
odcsOpen Data Contract Standard (ODCS) v3.1.0 — the Bitol.io standardPublishing contract-level specs (schema, quality, SLA) to Bitol-aligned tooling. Where ODPS describes a whole data product, ODCS focuses on the consumer-facing contract.
odps-v4.1LF/ODPI ODPS v4.1 — Open Data Product Specification (opt-in)ODPI-aligned catalogs that consume the Linux Foundation / Open Data Product Initiative spec.
odps-bitolStandards-compliant Bitol ODPS payload, stricter than odpsStrict conformance — fields that are not explicitly declared on a consumes[] entry are omitted (no synthetic contractId, no default required: True).

Examples of each format

fluid generate standard contract.fluid.yaml --format odps        # FLUID -> Bitol ODPS v1.0.0 (default, center-stage)
fluid generate standard contract.fluid.yaml --format odcs        # FLUID -> ODCS v3.1.0
fluid generate standard contract.fluid.yaml --format odps-v4.1  # FLUID -> LF/ODPI ODPS v4.1 (opt-in)
fluid generate standard contract.fluid.yaml --format odps-bitol  # FLUID -> ODPS (strict Bitol conformance)

ODPS environment tuning

The ODPS exporter reads a few environment variables for output shape:

Env varDefaultPurpose
ODPS_INCLUDE_BUILD_INFOtrueInclude build information (engine, pattern)
ODPS_INCLUDE_EXECUTION_DETAILSfalseInclude execution details (triggers, runtime)
ODPS_TARGET_PLATFORMgenericPlatform-specific tuning (collibra, etc.)
ODPS_VALIDATE_OUTPUTtrueValidate the emitted JSON

All formats are deterministic — identical input yields byte-identical output, so the result is safe to check into version control.

Shortcut — fluid export-odps

For a one-shot file write of the ODPS format:

fluid export-odps CONTRACT [--env ENV] [--out PATH]
OptionDescription
CONTRACTPath to contract.fluid.yaml (positional, required)
--env ENVApply an environment overlay
--out PATHOutput file path (default: runtime/exports/product.odps.json)

Produces the same output as fluid generate standard --format odps.

Examples

fluid generate transformation
fluid generate transformation contract.fluid.yaml -o ./dbt_project
fluid generate transformation contract.fluid.yaml -o ./dbt_project --dbt-validate
fluid generate schedule contract.fluid.yaml --scheduler airflow -o dags
fluid generate ci --system github
fluid generate standard contract.fluid.yaml --format odps
fluid generate standard contract.fluid.yaml --format odps-v4.1

Compatibility note

fluid generate-airflow still works for Airflow generation, but current docs lead with fluid generate schedule --scheduler airflow.

Edit this page on GitHub
Last Updated: 5/29/26, 4:51 PM
Contributors: Jeff Watson, jeffwatson-ai, fas89, Claude Opus 4.7, Claude Opus 4.7 (1M context)
Prev
fluid bundle
Next
fluid generate artifacts