Submitting plugins
Once your plugin works (Building a plugin), you pack it with the CLI and submit it from your dashboard. A reviewer checks it against your source, and then it's live in the marketplace for anyone to install.
1. Build & pack
Build your project, then run the pack command from @revyme/plugin-tools:
npm run build # produces dist/
npx revyme-plugin pack # produces plugin.zip(The example project wires this up as "pack": "revyme-plugin pack" in package.json.) The CLI builds first (unless you pass --prebuilt), then zips it up:
plugin.zip
├── index.html ← your built entry, at the zip root
├── assets/… ← your built JS/CSS
└── source/ ← your src/ — ALWAYS included
Source is required. Every submission includes a
source/folder so a reviewer can read what the plugin actually does before approving it. The CLI will refuse to pack ifsrc/is missing.
Useful flags: -d/--dist-dir (default dist), -s/--source-dir (default src), -o/--output (default plugin.zip), --prebuilt (skip the build step).
2. Submit from the dashboard
Go to revyme.com/dashboard → Plugins → Submit Plugin, open the Upload tab, and drop your plugin.zip. Fill in:
- Name, description, byline (author).
- A thumbnail for the marketplace card.
- Tags to help people find it.
- Visibility — see below.
Save, and it goes into the review queue.
3. Review & go live
A reviewer reads your bundled source/ and approves it. Once approved, the plugin appears in the marketplace and shows up for everyone under ⌘K → Plugins. Ship a new version by packing and submitting again — installed cloud plugins pick it up automatically.
Open vs closed source
When you submit, you choose how your source is exposed:
- Open — people can Import locally (fork your source into their project) and read it. Good for examples and community templates.
- Closed — people can only Add to project (Cloud); they run it but can't fork or read the source. Your source is still reviewed privately — "closed" only controls public exposure, not the review.
How people install yours
From the marketplace (⌘K → Plugins), each user gets:
- Add to project (Cloud) — a pointer to your plugin that auto-updates.
- Import locally — a forked, editable copy (open plugins only).
See Using plugins for the installer's side.
Share a draft first
You don't have to publish to share. From a plugin you built in the editor, use Copy URL to get a draft link. Anyone can paste it into their command palette to try it instantly, and you can paste it into the Submit form to pre-fill the bundle, source, and metadata. Drafts don't go in the marketplace until you submit and they're approved.