Skip to content

Marketplace

HarborClient maintains a curated plugin marketplace built from plugins/catalog.json in the main repository. In the app, open Settings → Plugins and click Marketplace to install listed plugins with one click. The app clones each listing from its public GitHub repository using the same git install flow as Install from Git….

Requirements

  1. Host on GitHub — Publish your plugin source in a public https://github.com/... repository. The repository root must contain a valid manifest.json and prebuilt entry files (HarborClient does not run a build step during install).
  2. Match manifest metadata — The catalog id must match your plugin manifest id. Keep name, version, and engines.harborclient accurate in the repository.
  3. Open a pull request — Add an entry to plugins/catalog.json in the HarborClient repository.

Catalog entry fields

FieldRequiredDescription
idYesPlugin manifest id (for example com.example.my-plugin).
nameYesDisplay name shown in the marketplace.
versionYesSemver version string (must match the tagged release in ref when set).
summaryYesShort one-line description for list views.
authorYesPublisher or author name.
categoriesYesOne or more category labels (for example themes, integrations).
repoUrlYesPublic GitHub repository URL (https://github.com/owner/repo).
refNoBranch or tag to clone (for example v1.0.0). Omit to use the repository default branch.
homepageNoProject website URL.
iconNoHTTPS URL to a square plugin icon.
screenshotNoHTTPS URL to a preview image shown in the marketplace list (PNG, JPEG, or WebP).
minAppVersionNoMinimum HarborClient semver required to install.

Example entry:

json
{
  "id": "com.example.my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "summary": "Adds a sidebar panel for API audit checks.",
  "author": "Example Inc.",
  "categories": ["integrations"],
  "repoUrl": "https://github.com/example/my-plugin",
  "ref": "v1.0.0",
  "homepage": "https://example.com/my-plugin",
  "screenshot": "https://raw.githubusercontent.com/example/my-plugin/v1.0.0/assets/screenshots/overview.png"
}

After your pull request merges, the docs site and in-app catalog update on the next HarborClient docs deploy. You do not need to host the catalog yourself — only your plugin repository on GitHub.