Omarchy / Marketplace / Publish
Browse
Publishing

Publish your plugin

5 min readStable

Bring a useful Omarchy extension to the community. You keep the code in your GitHub repository; the marketplace reads its manifest.json.

The marketplace never hosts your plugin.

Your repository remains the source of truth for code, releases, documentation, and licensing.

01

Prepare the repository #

Your plugin should work on a current Omarchy installation and provide enough context to evaluate it.

  • ✓
    Public GitHub repositoryReachable over HTTPS without authentication.
  • ✓
    Manifest in the repository rootA valid manifest describes the plugin.
  • ✓
    README and licenseDocument purpose, usage, and licensing.
  • +
    Optional repository previewAdd a preview.png to the repository root and the marketplace will display it automatically.
  • ✓
    Safe install and removalDo not overwrite user configuration without consent.
02

Add a manifest #

Keep the manifest in sync with every release.

Start with omarchy plugin clone, validate with omarchy plugin validate, and consult 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"
  }
}
FieldPurposeRequired
schemaVersionOmarchy manifest contract versionYes
idUnique namespaced plugin identifierYes
nameHuman-readable nameYes
versionCurrent semantic versionYes
authorPlugin author shown in the marketplaceYes
descriptionShort marketplace summaryYes
kindsPlugin capabilities exposed to OmarchyYes
entryPointsQML entry file for each plugin kindYes
03

Open a submission #

Submit the repository URL, category, and useful tags through the GitHub issue form.

Submit your plugin

04

Review and publication #

A maintainer reviews function, documentation, safety, and marketplace fit. Approval adds one registry entry; GitHub then rebuilds the catalog automatically.

  1. 1
    ValidateManifest, URL, license, unique ID
  2. 2
    ReviewPurpose, quality, safety
  3. 3
    PublishRegistry merge and deployment
Copied