Manual / Reference

Commands

Every command takes --env, and most take --usecase; without it, a command acts on every use case in the repository. pipewright <command> --help lists the options. status, model list, monitor status, retrain list, retrain show, lineage and decisions pending take --json for scripts and reports.

Configure

CommandWhat it does
new-usecaseStarts a use case from an example: --from churn (default), minimal, ray, bqml, or --from-bq <table> --label <column> to draft the data contract from BigQuery
validateSchemas, references, files, table schemas and cross-checks, offline
resolvePrints the effective configuration for an environment
explainWhat a key means: description, type, allowed values, default, whether it may vary; --list for every key
schemasAdds editor schema hints to YAML files and refreshes them after an upgrade
doctorRead-only checks against the live environment; each failure says who to ask
testRuns the use case’s tests (tests.command)

Release

CommandWhat it does
tables syncCreates the use case’s tables; later changes are additive only
releaseBuilds and pins images and templates by digest, writes the contract, verifies, goes live
statusWhat is live, and the latest runs
rollbackMoves the live pointer back to the previous release, rebuilding nothing
promoteCarries the release live in one environment, and its approved model, to the next
schedules syncCreates the use case’s schedules: Cloud Scheduler jobs or Kubernetes CronJobs
alerts syncTurns monitoring.alerts into Cloud Monitoring alert policies
ci initWrites GitHub Actions workflows: pull requests, releases or promotion, operations and decisions

Operate

CommandWhat it does
runStarts a pipeline through the launcher: --pipeline, --source-uri, --schedule, --replay <run>
model listVersions with their metrics, gate results, approval and which is the default
model checkA version against today’s gates, slices and fairness; read only
model approveMakes a version the default, the champion
deploy-modelServes the default version; --canary, --promote, --undeploy-canary, --undeploy
model endpointHow to call the endpoint: ID, URL, the permission needed, a sample request
model predictSends instances to the endpoint (Agent Platform or KServe)
monitor statusDrift, performance and open retrain cases
lineageA version back to its run, release, rows, evaluation and decisions
images pruneDeletes images no release needs; a dry run unless --apply
data eraseRemoves an entity by key across the team’s tables
synthetic generate, synthetic gatesRows from the contract alone; the gates a synthetic release must pass
pipelines-uiA read-only Kubeflow Pipelines UI on private GKE

Decide

CommandWhat it does
retrain list, retrain showOpen cases, and one case’s decision pack
retrain approve, decline, snoozeA decision, under your own identity, with --reason
retrain retryRetries an approved case whose training failed
loop start, advance, show, rollbackThe closed retrain loop: train in test, promote back with approval
decisions pendingEvery decision waiting for a person, with the GitHub environment that gates it

Extend

CommandWhat it does
pluginsCommands added by installed packages through the pipewright.commands entry point, such as Enterprise’s evidence and fleet

Credentials

Pipewright uses Application Default Credentials, or GCLOUD_CONFIG=<gcloud configuration> for refreshable gcloud user credentials. Behind a TLS-inspecting proxy, set REQUESTS_CA_BUNDLE, GRPC_DEFAULT_SSL_ROOTS_FILE_PATH and PIPEWRIGHT_BUILD_CA_BUNDLE.