CLI Reference

This section tracks the command surface of forge-cli 0.18.1, the release pip install data-product-forge installs. fluid --help shows the promoted commands.

Read this first

• CLI release examples in this section use 0.18.1
• Contract examples use fluidVersion: 0.7.5, the stable schema, which fluid init --quickstart emits. 0.7.6 is a preview you opt into per contract
• fluid version and fluidVersion are different things
• The pinned CLI version is recorded in docs/.vuepress/cli-version.json and enforced by the cli-consistency workflow.
• Install: pip install data-product-forge installs 0.18.1; TestPyPI is only for release validation and intentional next-release candidates — see Getting Started for the full install matrix.

The 11-stage pipeline

0.8.0 promotes an eleven-stage production pipeline — each stage is a CI gate that exits non-zero on failure. Each command below maps to exactly one stage:

1. bundle → 2. validate → 3. generate-artifacts → 4. validate-artifacts
      → 5. diff (drift gate) → 6. plan → 7. apply → 8. policy-apply
      → 9. verify → 10. publish → 11. schedule-sync (Path A only)

See Walkthrough → 11-stage pipeline for the full end-to-end flow.

Core Workflow

The newcomer path is usually:

fluid init my-project --quickstart
cd my-project
fluid validate contract.fluid.yaml
fluid plan contract.fluid.yaml
fluid apply contract.fluid.yaml --yes

Pipeline Stages

These commands each map to one stage of the 11-stage production pipeline. Most users trigger them via a generated CI pipeline (fluid generate ci) rather than running them by hand; each can also be run on its own.

Safety & Supply Chain

These commands are for production-safety concerns that live alongside the pipeline rather than inside it.

Generate & Visualize

The promoted orchestration path is fluid generate schedule --scheduler airflow.

Standards & Interop

ODPS and ODCS are spec exporters, not cloud providers — they serialize a contract to an open standard and do not deploy infrastructure. List them with fluid exporters; for deployment targets see fluid providers.

Integrations

Quality & Governance

0.8.0 introduced the unified fluid policy {check,compile,apply} subcommand group. The hyphenated commands (policy-check, policy-compile, policy-apply) are still registered in 0.18.1.

Project & Workspace

CI & Scaffolding

Utilities

Command discovery

fluid --help
fluid <command> -h

If a page in the docs uses an older command spelling such as fluid compile ... or fluid publish --catalog ..., treat it as historical:

• fluid compile → use fluid bundle --format yaml (renamed in 0.7.3; bundle is now also the tgz+sign+attest command)
• fluid publish --catalog X,Y → use fluid publish --target X --target Y (renamed + made repeatable in 0.7.3)
• fluid policy-check / policy-compile / policy-apply → still work; new idiomatic form is fluid policy {check,compile,apply}

Need a hand with a specific command, or noticing something out of date? Start a discussion or open an issue — docs PRs welcome.