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.

Follow this path once per machine or project. Estimated time: 15–20 minutes. For why we recommend installing skills + MCP alongside the CLI—and how the four Orderly plugin skills fit the SDK workflow—read Skills-first workflow first.

​
Requirements

  • Node.js v20.19.0 or newer.

​
1. Install the devkit CLI

Global install (recommended): 
pnpm add -g @orderly.network/devkit
One-off without global install: 
pnpm dlx @orderly.network/devkit --help
The executable name is orderly-devkit (not orderly). Verify: 
orderly-devkit --help
These skills ship from OrderlyNetwork/orderly-skills and teach your agent orderly-plugin-create, orderly-plugin-write, orderly-plugin-add, and orderly-plugin-submit—aligned with orderly-devkit and this handbook’s tutorials. 
orderly-devkit skills install
orderly-devkit skills install --list    # list only
orderly-devkit skills install --dry-run # preview
Use --agent cursor (or your client) when you need skills installed for a specific agent—see CLI reference: skills. Without an AI agent, this step is optional; you can rely on the CLI and docs alone. With an agent, treat this as part of the default stack together with the MCP below. Enables AI assistants to search SDK docs, resolve component and type metadata, and fetch workflows. Use either: 
orderly-devkit mcp install
or the sdk-docs binary directly: 
pnpm dlx @orderly.network/sdk-docs orderly-sdk-docs-mcp install --client all --scope user
See Orderly SDK Docs MCP for tools and the install subcommand. After orderly-devkit create plugin or a successful submit, the devkit may print hints if the MCP server is not detected (see the published @orderly.network/devkit sources for MCP detection behavior).

​
4. Create a plugin from the template

Interactive (prompts for name, plugin id, interceptor target, output directory): 
orderly-devkit create plugin
Non-interactive example (all required options for --no-interactive): 
orderly-devkit create plugin --no-interactive \
  --name MyPlugin \
  --id my-plugin \
  --interceptor Trading.OrderEntry.SubmitSection \
  --target ./MyPlugin \
  --skip-install
Details: CLI reference: create plugin. The template repository is OrderlyNetwork/orderly-plugin-template. A .orderly-manifest.json may be generated in the output folder.

​
5. Build and run locally

cd ./YourPluginName
# Per template; often:
pnpm install   # or npm install
pnpm run dev   # or npm run dev
Wire the plugin into a host app using OrderlyAppProvider plugins.

​
Next steps

GoalDocument
Skills + MCP mental modelSkills-first workflow
First visible UI changeTutorial: First plugin
Add plugin to a DEX appTutorial: Integrate into host
Marketplace login and submitTutorial: Marketplace
When to use widget vs page vs layoutHow-to: Plugin types