Skip to Content
CLI Referencebridge deploy

bridge deploy

terminal
$pnpm orderly bridge deploy

Build, validate, and register a bridge with the platform.

Usage

$ pnpm orderly bridge deploy -n <name> [options]

Options

-n, --name <name>Bridge package name (required)
--dry-runValidate without deploying
--forceOverwrite existing bridge type

Examples

$ pnpm orderly bridge deploy -n shopify

Deploy the Shopify bridge

$ pnpm orderly bridge deploy -n my-platform --dry-run

Validate only

$ pnpm orderly bridge deploy -n shopify --force

Force overwrite

Deploy Steps

  1. Validate — Runs bridge validate checks
  2. Build — Compiles the package with tsup
  3. Register — Inserts/updates the bridge_types table
  4. Available — Users can now configure this bridge in the portal

See Deploying a Bridge for more context.

bridge validateSettings