Skip to main content
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):
One-off without global install:
The executable name is orderly-devkit (not orderly). Verify:
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.
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:
or the sdk-docs binary directly:
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):
Non-interactive example (all required options for --no-interactive):
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

Wire the plugin into a host app using OrderlyAppProvider plugins.

​
Next steps