Deploying a Bridge

Once your bridge is built and tested, deploy it to make it available in the portal.

Using the CLI

From the hub/ directory:

pnpm orderly bridge deploy -n my-platform

This command:

1. Validates the bridge manifest
2. Builds the bridge package
3. Registers the bridge type in the bridge_types table
4. Makes it available for users to configure in the portal

Deploy Options

pnpm orderly bridge deploy [options]

What Happens During Deploy

1. Validation — The CLI reads your bridge’s manifest and validates all required fields, task names, and config field types
2. Build — The bridge package is compiled with tsup
3. Registration — A row is inserted/updated in bridge_types with the manifest data
4. Availability — Users can now see and configure this bridge in Bridges > Add Bridge

Listing Deployed Bridges

pnpm orderly bridge list

This shows all registered bridge types grouped by category.

Updating a Bridge

To deploy a new version, increment the version field in your manifest and run deploy again:

pnpm orderly bridge deploy -n my-platform

Existing bridge instances will continue using their current configuration. New instances will use the updated manifest.

Validating Without Deploying

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

This checks for:

• Valid manifest structure
• All required tasks for the category are present
• Config fields have correct types
• Auth methods are properly declared