Skip to Content
CLI Referencebridge create

bridge create

terminal
$pnpm orderly bridge create

Scaffold a new bridge package with manifest, tasks, and project config.

Usage

$ pnpm orderly bridge create [options]

Options

--name <name>Bridge name (kebab-case)
--category <cat>Bridge category (ecommerce, shipping, marketplace, erp)
--display-name <name>Human-readable display name

Examples

$ pnpm orderly bridge create

Interactive mode — prompts for all options

$ pnpm orderly bridge create --name my-platform --category ecommerce

Non-interactive with options

What Gets Created

The command generates a full bridge package at hub/packages/bridges/<name>/:

packages/bridges/my-platform/ ├── package.json # Package config with @orderly/shared dependency ├── tsconfig.json # TypeScript config ├── src/ │ ├── index.ts # BridgeImplementation export │ ├── manifest.ts # BridgeManifest declaration │ └── tasks/ # Task implementations (one per required task) └── tests/ └── index.test.ts # Test scaffold

The manifest includes all required tasks for the selected category, pre-filled with placeholder implementations.