CLI

The StreamWright CLI provides commands to execute pipelines (streamwright run), statically validate definitions (streamwright validate), manage connectors (streamwright connectors), and launch the Model Context Protocol server (streamwright mcp).

Shorthand Alias: sw

All commands can be invoked using either streamwright or the convenient sw alias (e.g. sw run, sw validate, sw connectors, sw mcp).

streamwright run

streamwright run SOURCE [options]

Inputs

Option	Meaning
--config FILE	A client's settings (YAML/JSON): config values and the streams/exports to run
--set NAME=VALUE	One spec.config value (repeatable; lists as a,b,c); overrides --config
--secrets FILE	Values for spec.secrets; overrides STREAMWRIGHT_SECRET_<NAME> env vars
--state FILE	State from a previous run (JSON or a Singer STATE message)
--timezone TZ	The client's IANA time zone for today and incremental windows

What runs

Option	Meaning
--stream NAME	Run only this stream (repeatable); its partition sources run too
--allow-connector NAME	Allow only these connectors (repeatable)

Where records go

Option	Meaning
--output	singer (default) or a target: jsonl:DIR, parquet:DIR, duckdb:PATH, dlt:DEST, …
--file-name TEMPLATE	Each export's file path for file outputs (templated)
--summary FILE	Also write the run summary as JSON

Logging

--log-level, --log NAME=LEVEL, --log-format text|json, --log-config FILE, --log-max-chars N.

Exit status

Status	Meaning
0	Success
1	The run failed
2	Invalid source, inputs, stream names, options, or a missing/disallowed connector (nothing fetched)
130	Interrupted

streamwright validate

streamwright validate SOURCE [--strict] [--format text|json|github] [--export-schema DIR]

Checks the source, inputs, stream names and options — without fetching. Use --format github for GitHub Actions annotations, or --export-schema to emit JSON Schemas for editors and CI.

streamwright connectors

streamwright connectors                                   # the installed connectors (and their SDK loggers)
streamwright connectors list                              # browse catalog with install status (shorthands: -ls, ls)
streamwright connectors search WORDS                      # search connectors by keyword (shorthands: -s, -f, find, or WORDS)
streamwright connectors install KEY [KEY ...] [--yes]     # install one or more connectors (shorthands: -i, i)

install checks every key first (an unknown key installs nothing), then installs them all with one pip install, so their dependencies are resolved together. Connectors that aren't official need a confirmation (or --yes).

Option	Meaning
-ls, ls, list	List catalog and installed status
-i, i, install KEY ...	Install specified connector(s)
-s, -f, find, search WORDS	Search connectors matching words (or pass words directly)
--yes	Skip the confirmation for non-official connectors
--hub-url URL	The catalog to read: default $STREAMWRIGHT_HUB_URL, else the live StreamWright hub. bundled uses the catalog bundled with this release, with no network

The catalog comes from the live StreamWright hub. When it is unreachable, the CLI prints a warning and uses the last copy it fetched, else the one bundled with the release.

streamwright mcp

streamwright mcp [--transport stdio|sse] [--port PORT]

Launches the StreamWright Model Context Protocol (MCP) server, allowing AI coding assistants (Google Antigravity, GitHub Copilot, Claude Desktop, Cursor) to discover installed connectors, inspect live contracts, and validate declarative pipelines directly.

Requires pip install streamwright-mcp. See the MCP Guide for full setup instructions.