Goal: Authenticate with the devkit, validate a local plugin folder, and submit it for Marketplace review. Prerequisite: Plugin repo with validDocumentation Index
Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt
Use this file to discover all available pages before exploring further.
package.json name, GitHub origin remote (HTTPS form preferred), and metadata aligned with Manifest and submit. Optional: orderly-devkit skills install — see below.
Using agent skills for this tutorial
The orderly-plugin-submit skill is for publishing to the Marketplace. It aligns withorderly-devkit the same way as the sections below:
| CLI step below | Skill behavior |
|---|---|
login, whoami | Requires real login before submit; skill should not pretend auth succeeded. |
submit --dry-run | Validate manifest / package.json / repoUrl / tags / usagePrompt length — run before any real submit. |
submit | Typical flags: --path, --tags, --storybook-url. Skill should obtain explicit user confirmation before calling the Marketplace API (no unattended submit). |
usagePrompt / README | Skill guides drafting usagePrompt (install → register snippet → pitfalls); README edits only with user consent. |
list, update, view | Same CLI as §4–§5 — view requires login. |
usagePrompt for @scope/plugin matching submit constraints.” Always confirm submit in the UI or chat before the agent runs the real command.
1. Log in
~/.orderly/auth.json.
2. Dry run (validate only)
From the plugin root:repoUrl, pluginId, tags, usagePrompt length). See Manifest and submit.
3. Submit
under_review). See status table in Manifest and submit.
4. List and update listings
pluginId in .orderly-manifest.json):
5. View a plugin by id
orderly-devkit login in the current CLI implementation.
Next steps
- Write or refine
usagePromptfor integrators and AI assistants: Usage prompt and README. - Short checklist: Marketplace submit recipe.