Fluid ForgeFluid Forge
Home
Get Started
  • Local (DuckDB)
  • GCP (BigQuery)
  • Snowflake Team Collaboration
  • Declarative Airflow
  • Orchestration Export
  • Jenkins CI/CD
  • Universal Pipeline
CLI Reference
  • Overview
  • Architecture
  • GCP (BigQuery)
  • AWS (S3 + Athena)
  • Snowflake
  • Local (DuckDB)
  • Custom Providers
  • Roadmap
GitHub
GitHub
Home
Get Started
  • Local (DuckDB)
  • GCP (BigQuery)
  • Snowflake Team Collaboration
  • Declarative Airflow
  • Orchestration Export
  • Jenkins CI/CD
  • Universal Pipeline
CLI Reference
  • Overview
  • Architecture
  • GCP (BigQuery)
  • AWS (S3 + Athena)
  • Snowflake
  • Local (DuckDB)
  • Custom Providers
  • Roadmap
GitHub
GitHub
  • Introduction

    • /
    • Getting Started
    • Snowflake Quickstart
    • Vision & Roadmap
  • Walkthroughs

    • Walkthrough: Local Development
    • 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
  • CLI Reference

    • CLI Reference
    • fluid init
    • fluid forge
    • fluid status
    • fluid validate
    • fluid plan
    • fluid apply
    • fluid generate
    • fluid publish
    • fluid market
    • fluid import
    • fluid policy-check
    • fluid diff
    • fluid test
    • fluid verify
    • fluid config
    • fluid split
    • fluid bundle
    • fluid auth
    • fluid doctor
    • fluid providers
    • fluid version
  • Providers

    • Providers
    • Provider Architecture
    • GCP Provider
    • AWS Provider
    • Snowflake Provider
    • Local Provider
    • Creating Custom Providers
    • Provider Roadmap
  • Advanced

    • Blueprints
    • Governance & Compliance
    • Airflow Integration
    • Built-in And Custom Forge Guidance
    • FLUID Forge Contract GPT Packet
    • Forge Discovery Guide
    • Forge Memory Guide
  • Project

    • Contributing to Fluid Forge
    • Fluid Forge Docs Baseline: CLI 0.7.9
    • Fluid Forge v0.7.1 - Multi-Provider Export Release

fluid plan

Generate an execution plan without applying changes.

Syntax

fluid plan CONTRACT

Key options

OptionDescription
--envApply an environment overlay
--out, --outputWrite the plan JSON, default runtime/plan.json
--verbose, -vShow detailed action information
--validate-actionsValidate generated provider actions
--estimate-costAsk the provider to estimate cost
--check-sovereigntyAsk the provider to validate sovereignty constraints
--providerOverride the provider from the contract
--htmlGenerate an HTML visualization

Examples

fluid plan contract.fluid.yaml
fluid plan contract.fluid.yaml --verbose
fluid plan contract.fluid.yaml --env prod --out runtime/prod-plan.json
fluid plan contract.fluid.yaml --html

Notes

  • plan is the safest place to preview a provider override or environment overlay before you run apply.
  • The generated plan can be passed to fluid apply.

Visualizing the plan — fluid viz-graph

fluid plan --html emits a quick HTML summary alongside runtime/plan.json. For richer visualization — themed lineage and build-DAG diagrams — use fluid viz-graph:

fluid viz-graph CONTRACT [options]

Key options

Input / output

OptionDescription
CONTRACTPath to contract.fluid.yaml (positional, required)
--env ENVApply an environment overlay
--plan PATHOverlay a saved runtime/plan.json so build actions are shown on the graph
--out PATH, --output PATHOutput file path (default: runtime/graph/contract.svg)

Format & appearance

OptionDescription
--format {dot,svg,png,html}Output format (default: svg)
--theme NAMEColor theme (default: dark)
--custom-theme PATHPath to a custom theme JSON/YAML file
--rankdir {LR,TB,RL,BT}Graph layout direction (default: LR)
--title TEXTCustom title for the graph

Content

OptionDescription
--show-legendAdd a legend explaining node types
--collapse-consumes / --collapse-exposesCollapse consumed sources or exposed artifacts into one node each
--show-descriptionsInclude descriptions in node labels
--hide-metadataHide domain / layer metadata tags
--max-label-length NMax label length before truncation (default: 50)

Behavior

OptionDescription
--openOpen the output file in the default viewer when done
--forceOverwrite an existing output file without prompting
--quietSuppress non-error output
--graphviz-args ...Extra args passed through to Graphviz dot
--debugEnable debug output and keep intermediate files

Examples

fluid viz-graph contract.fluid.yaml
fluid viz-graph contract.fluid.yaml --format html --theme dark --open
fluid viz-graph contract.fluid.yaml --plan runtime/plan.json --show-legend
fluid viz-graph contract.fluid.yaml --out docs/graph.svg --title "Customer Churn Pipeline"

Requires Graphviz (dot) on PATH for svg, png, and the enhanced html output (brew install graphviz on macOS; apt install graphviz on Debian/Ubuntu). If the enhanced renderer is unavailable, a lightweight fluid graph fallback emits plain DOT. A compatibility entry point fluid viz-plan still exists for rendering a saved plan as HTML, but new work should prefer fluid viz-graph --plan runtime/plan.json.

Edit this page on GitHub
Last Updated: 4/16/26, 9:16 AM
Contributors: Jeff Watson, jeffwatson-ai
Prev
fluid validate
Next
fluid apply