Generated CLI help

Exact help emitted by the current onwardpg binary for every documented command surface.

This page is generated from the current binary. For workflow, semantics, and examples, read the CLI guide.

onwardpg

Usage: onwardpg <command> [options]

Everyday workflow:
  config check     validate configuration, DDL, databases, and history
  init             create a replayable history ground floor
  plan             create, revise, or restack one feature migration
  status           inspect the worktree-local active feature plan
  verify           clone-verify one exact bundle
  contract check   check live contract readiness read-only
  drift check      compare replayed history with a live catalog read-only

Diagnostics and compatibility:
  diff             diff two explicit schema sources
  history status   inspect the repository-local hash chain
  dev plan         diff the development catalog against desired DDL
  draft            explicit-history compatibility bundle command
  version          print the onwardpg build version

onwardpg generates and verifies plans; it never applies them to caller databases.

onwardpg config check

Usage of config check:
  -config string
        repository configuration path (default ".onwardpg.toml")

onwardpg init

Usage of init:
  -bundle string
        root history bundle identifier (default "baseline")
  -concurrent-indexes
        create standalone indexes concurrently
  -config string
        repository configuration path (default ".onwardpg.toml")
  -ignore value
        validated catalog selector to exclude
  -ignore-extension-version value
        extension name whose version changes should be ignored; repeat for multiple names
  -target string
        configured database target name

onwardpg plan

Usage: onwardpg plan [NAME] [options]
  -bundle string
        explicit existing feature bundle identifier
  -cascade-drops
        emit CASCADE for schema and table drops
  -concurrent-indexes
        create standalone indexes concurrently
  -config string
        repository configuration path (default ".onwardpg.toml")
  -dev-hint value
        development-workspace semantic JSON hint; repeat for multiple decisions
  -dev-hints-file string
        JSON array of development-workspace semantic hints
  -hint value
        semantic JSON hint; repeat for multiple decisions
  -hints-file string
        JSON array of semantic hints
  -if-exists
        emit IF EXISTS for schema and table drops
  -if-not-exists
        emit IF NOT EXISTS for schema and table creation
  -ignore value
        validated catalog selector to exclude
  -ignore-extension-version value
        extension name whose version changes should be ignored; repeat for multiple names
  -output string
        output format: sql, text, or json (default "json")
  -purpose string
        feature, repair, or contract (default "feature")
  -schema-qualifier value
        scope to one schema and render names using this qualifier
  -target string
        configured database target name

onwardpg status

Usage: onwardpg status [options]
  -config string
        repository configuration path (default ".onwardpg.toml")
  -target string
        configured database target name

onwardpg verify

Usage of verify:
  -bundle string
        bundle to verify
  -check
        read-only verification; reject unreceipted edits
  -config string
        repository configuration path (default ".onwardpg.toml")
  -target string
        configured database target name
  -through string
        last phase to execute: expand or contract (default "contract")

onwardpg contract check

Usage of contract check:
  -bundle string
        history-head bundle to check
  -config string
        repository configuration path (default ".onwardpg.toml")
  -database-env string
        environment variable containing a read-only PostgreSQL URL
  -environment string
        deployment environment identity
  -evidence string
        writer-drain evidence JSON
  -statement-timeout duration
        timeout for each read-only data gate (default 30s)
  -target string
        configured database target name

onwardpg drift check

Usage of drift check:
  -config string
        repository configuration path (default ".onwardpg.toml")
  -database string
        live PostgreSQL URL inspected read-only
  -ignore value
        validated catalog selector to exclude
  -target string
        configured database target name

onwardpg diff

Usage: onwardpg diff --from SOURCE --to SOURCE [options]
  -cascade-drops
        emit CASCADE for schema and table drops
  -concurrent-indexes
        create standalone indexes concurrently
  -dev-url string
        PostgreSQL admin URL for disposable materialization databases
  -from string
        current PostgreSQL URL or CREATE-statement SQL file
  -hint value
        semantic JSON hint; repeat for multiple decisions
  -hints-file string
        JSON array of semantic hints
  -if-exists
        emit IF EXISTS for schema and table drops
  -if-not-exists
        emit IF NOT EXISTS for schema and table creation
  -ignore value
        selector to exclude
  -ignore-extension-version value
        extension name whose version changes should be ignored; repeat for multiple names
  -output string
        output format: text or json (default "json")
  -schema-qualifier value
        scope to one schema and render names using this qualifier (empty means unqualified)
  -to string
        desired PostgreSQL URL or CREATE-statement SQL file

onwardpg history status

Usage of history status:
  -bundle string
        selected mutable bundle to exclude from its base
  -config string
        repository configuration path (default ".onwardpg.toml")
  -target string
        configured database target name

onwardpg dev plan

Usage of dev plan:
  -cascade-drops
        emit CASCADE for schema and table drops
  -concurrent-indexes
        create standalone indexes concurrently
  -config string
        repository configuration path (default ".onwardpg.toml")
  -hint value
        semantic JSON hint; repeat for multiple decisions
  -hints-file string
        JSON array of semantic hints
  -if-exists
        emit IF EXISTS for schema and table drops
  -if-not-exists
        emit IF NOT EXISTS for schema and table creation
  -ignore value
        validated catalog selector to exclude
  -ignore-extension-version value
        extension name whose version changes should be ignored; repeat for multiple names
  -output string
        output format: text or json (default "json")
  -schema-qualifier value
        scope to one schema and render names using this qualifier
  -target string
        configured database target name

onwardpg draft

Usage of draft:
  -after string
        exact accepted head_ref this feature bundle must follow
  -bundle string
        stable logical feature bundle identifier
  -cascade-drops
        emit CASCADE for schema and table drops
  -concurrent-indexes
        create standalone indexes concurrently
  -config string
        repository configuration path (default ".onwardpg.toml")
  -create
        assert this is the bundle's first invocation
  -hint value
        semantic JSON hint; repeat for multiple decisions
  -hints-file string
        JSON array of semantic hints
  -if-exists
        emit IF EXISTS for schema and table drops
  -if-not-exists
        emit IF NOT EXISTS for schema and table creation
  -ignore value
        validated catalog selector to exclude
  -ignore-extension-version value
        extension name whose version changes should be ignored; repeat for multiple names
  -output string
        output format: text or json (default "json")
  -purpose string
        feature, repair, or contract (default "feature")
  -schema-qualifier value
        scope to one schema and render names using this qualifier
  -target string
        configured database target name

onwardpg version

Usage: onwardpg version