Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orderly.network/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the pattern that matches your repository layout.

​
Monorepo (pnpm workspace)

  1. Ensure the plugin package directory is included in pnpm-workspace.yaml (e.g. packages/*, or the plugin folder path).
  2. In the host package.json:
{
  "dependencies": {
    "@scope/my-plugin": "workspace:*"
  }
}
  1. Run pnpm install from the repo root.
Verification: pnpm why @scope/my-plugin resolves to the workspace package.

​
Local path (development)

When testing without publishing: 
"@scope/my-plugin": "file:../relative/path/to-plugin"
Run install from the host directory. Bumps to the plugin source are picked up on reinstall or via workspace protocols depending on your setup.

​
Published npm

After publishing: 
"@scope/my-plugin": "^1.0.0"
Align @orderly.network/plugin-core (and other peers) with the host to avoid duplicate React or incompatible SDK instances.

​
Runtime registration

Regardless of how the package is linked, the host must:
  1. Import the register function.
  2. Pass plugins={[registerFn(...)]} on OrderlyAppProvider (or equivalent app provider used by the host).
See Tutorial: Integrate into host.

​
Marketplace packages

orderly-devkit view <plugin-id> (authenticated) prints metadata including the npm package identifier and usagePrompt. Prefer following usagePrompt when present.