Skip to main content

Module commands

Module commands 

Source
Expand description

Subcommand implementations. Each module owns its run(...) entry point and stays free of clap so the integration tests can drive it directly.

Modules§

doctor
faucet doctor — preflight probes for every connector in a config (#126).
init
faucet init — scaffold a starter pipeline.yaml from each connector’s JSON Schema. Defaults to a restjsonl pipeline so faucet init with no flags continues to produce the same shape it did before this command grew schema-driven scaffolding.
list
faucet list — show every compiled-in source, sink, transform, and state-store backend so users can discover what their binary supports.
preview
faucet preview — run only the source side of the first root row and emit the first N records to stdout as JSON Lines.
replicate
faucet replicate — load a config with a replication: block, validate it, and run the two-phase snapshot→CDC orchestration.
run
faucet run — load a pipeline config, expand the matrix, execute every invocation under bounded concurrency.
scheduleschedule
faucet schedule — run a pipeline on a cron schedule in one long-running process. Reuses expand + executor::run_expanded per tick; keeps no state of its own (resumability rides the pipeline’s per-page bookmark). See docs/superpowers/specs/2026-05-30-faucet-schedule-design.md.
schema
faucet schema — print the JSON Schema for a connector’s config.
serveserve
faucet serve — thin command layer: parse args into a ServeConfig, load the startup .env, and hand off to serve::run_server.
validate
faucet validate — parse + expand a pipeline config without running.

Functions§

report
Render any CliError to a single line on stderr, scrubbing any resolved secret values that may have reached the error chain.