Enum Command 

pub enum Command {
    Run(RunArgs),
    Backfill(BackfillArgs),
    Replicate(ReplicateArgs),
    Discover(DiscoverArgs),
    Validate(ValidateArgs),
    Schema(SchemaArgs),
    List(ListArgs),
    Search(SearchArgs),
    Conformance(ConformanceArgs),
    Install(InstallArgs),
    Preview(PreviewArgs),
    Plan(PlanArgs),
    Dev(DevArgs),
    Init(InitArgs),
    New(NewArgs),
    Doctor(DoctorArgs),
    Test(TestArgs),
    Dlq(DlqArgs),
    Contract(ContractArgs),
    Masking(MaskingArgs),
    Schedule(ScheduleArgs),
    Serve(ServeArgs),
    Mcp(McpArgs),
    Notify(NotifyArgs),
    Catalog(CatalogArgs),
    Template(TemplateArgs),
    Completions(CompletionsArgs),
    Migrate(MigrateArgs),
    Fmt(FmtArgs),
    Explain(ExplainArgs),
    History(HistoryArgs),
}

Top-level subcommands.

Variants

Run(RunArgs)

Execute a pipeline config end-to-end.

Backfill(BackfillArgs)

Replay a bounded historical window of a pipeline: chunk –from/–to into window units, run them with bounded parallelism, and record durable, resumable progress. Exits non-zero if any unit fails.

Replicate(ReplicateArgs)

Bulk-snapshot a database table, then stream CDC from a position captured before the snapshot (a true mirror with write_mode: upsert). Long-running when replication.continuous is true (Ctrl-C / SIGTERM to stop).

Discover(DiscoverArgs)

Connect to a config’s source, enumerate the datasets behind it (tables / collections / indices / prefixes), and emit a ready-to-run config with one matrix row per dataset.

Validate(ValidateArgs)

Parse + validate a pipeline config without running it.

Schema(SchemaArgs)

Print the JSON Schema for a specific connector.

List(ListArgs)

List every compiled-in source, sink, and transform with a one-line description (--available lists the whole connector registry instead).

Search(SearchArgs)

Search the connector registry index for connectors by name / keyword.

Conformance(ConformanceArgs)

Score each connector’s conformance to the faucet SDK contract and print its maturity tier (Stable / Experimental / Beta / Draft) + capabilities.

Install(InstallArgs)

Show how to install or enable a connector from the registry index (prints the recipe; never executes anything).

Preview(PreviewArgs)

Run only the source side and print records to stdout (uses the stdout sink).

Plan(PlanArgs)

Read-only preview of what a config would do: resolved pipeline, inferred output schema, sink schema delta, lineage, and target sinks — zero writes.

Dev(DevArgs)

Available on crate feature cli-dev only.

Watch a config and re-run a sample offline on every save, printing a live diff of the output. Requires the cli-dev build feature.

Init(InitArgs)

Scaffold a starter pipeline.yaml to disk.

New(NewArgs)

Scaffold a new artifact — currently a third-party connector crate.

Doctor(DoctorArgs)

Probe every connector in a config (auth / network / permissions) and print a green/red checklist. Exits non-zero if any probe fails.

Test(TestArgs)

Run fixture-based offline pipeline tests from one or more spec files. No real source or sink is touched. Exits non-zero if any case fails.

Dlq(DlqArgs)

Inspect, replay, or discard dead-letter-queue envelopes written by a pipeline’s dlq: sink.

Contract(ContractArgs)

Available on crate feature contract only.

Validate a config’s contract: block and print a summary, or export it in a machine-readable format (--export).

Masking(MaskingArgs)

Available on crate feature masking only.

Validate a config’s masking: block and print which rules apply to each destination sink.

Schedule(ScheduleArgs)

Available on crate feature schedule only.

Run a pipeline on a cron schedule (long-running; Ctrl-C / SIGTERM to stop).

Serve(ServeArgs)

Available on crate feature serve only.

Run a long-running HTTP control plane (submit / poll / cancel pipeline runs).

Mcp(McpArgs)

Available on crate feature mcp only.

Run an MCP (Model Context Protocol) server over stdio, exposing faucet’s introspection surfaces as agent tool calls (for Claude Desktop / Code).

Notify(NotifyArgs)

Available on crate feature notify only.

Send a synthetic notification through a config’s notifications: rules to validate channel setup end-to-end (no pipeline runs).

Catalog(CatalogArgs)

Available on crate feature catalog only.

Browse the Data Movement Catalog accumulated by a config’s catalog: store — datasets, schema timelines, volume/freshness, lineage.

Template(TemplateArgs)

Available on crate feature templates only.

Register a parameterized config once, then trigger runs by id + params. The registry is shared with faucet serve — point both at the same store URL and templates registered here are triggerable over HTTP.

Completions(CompletionsArgs)

Generate a shell tab-completion script (bash / zsh / fish / powershell / elvish). For registry- and config-aware dynamic completion, enable the COMPLETE hook instead, e.g. source <(COMPLETE=zsh faucet).

Migrate(MigrateArgs)

Upgrade a config written against an older faucet grammar to the current shape (e.g. pre-pipeline: top-level source/sink, legacy inline auth). Idempotent; rewrites in place unless --check / --stdout.

Fmt(FmtArgs)

Canonicalize a config: stable key order, normalized style. Idempotent; rewrites in place unless --check / --stdout. Comments are not preserved (the config is parsed and re-serialized).

Explain(ExplainArgs)

Explain, in plain English, what a pipeline config does — source → transforms → sink, matrix expansion, replication, delivery guarantee, and state store. Read-only and fully offline (no source is touched).

History(HistoryArgs)

Available on crate feature catalog only.

Show recent run history recorded in a config’s catalog: store — status, duration, throughput, and bookmark. Read-only; requires the catalog build feature.

Trait Implementations

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Command

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Command

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand