Omarchy / Marketplace / Publish
Browse
Publishing

Publish your plugin

3 min readStable

List your plugin in three steps. Keep the code in a public GitHub repository and add a valid manifest.json.

Still building? Start with the custom plugin development guide →.

The marketplace validates listings, not plugin security.

Plugins run unsandboxed. You remain responsible for your code, assets, documentation, and license.

01

Prepare the repository

Prepare these files before you submit:

  • Public GitHub repository
  • Valid manifest.json in the repository root
  • README and license
  • Safe install and removal
  • Optional preview, optimized automatically
02

Add a manifest

Create and validate the manifest before you submit.

Run omarchy plugin clone, then omarchy plugin validate. See the official Omarchy Quattro plugin reference ↗.

JSON   manifest.json
{
  "schemaVersion": 1,
  "id": "yourname.plugin",
  "name": "Plugin name",
  "version": "1.0.0",
  "author": "Your name",
  "description": "What the plugin does.",
  "kinds": ["overlay"],
  "entryPoints": {
    "overlay": "Plugin.qml"
  }
}
Manifest field reference
FieldPurposeRequired
schemaVersionOmarchy manifest contract versionYes
idUnique namespaced plugin identifierYes
nameHuman-readable nameYes
versionCurrent version, up to 64 characters for marketplace displayYes
authorPlugin author shown in the marketplaceYes
descriptionShort marketplace summaryYes
kindsPlugin capabilities exposed to OmarchyYes
entryPointsQML entry file for each plugin kindYes
03

Submit your plugin

Open the issue form with your repository link, category, and tags. Automated validation checks the current commit before a maintainer approves the listing.

Submit your plugin

Copied