Skip to content

armgit / orca

Public Imported from GitHub
0

Orca is the place for working with a fleet of agents (e.g. Grok Bot, Claude Code). Run any coding agent with your own subscription. Available on desktop, mobile and remote runtime.

docs(plugins): add plugin listing policy (#36275)

Neilf78b5979ca2f
diff --git a/docs/reference/plugin-authoring.md b/docs/reference/plugin-authoring.md
index 6a70d7ca69f..a4d9ba3b07e 100644
--- a/docs/reference/plugin-authoring.md
+++ b/docs/reference/plugin-authoring.md
@@ -3,7 +3,8 @@
From an empty folder to a plugin anyone can install from a catalog. The field-by-field rules
live in the generated references: [manifest](plugin-manifest.md), [catalog](plugin-catalog.md),
[host API](plugin-host-api.md), [themes](plugin-themes.md) and [theme tokens](plugin-theme-tokens.md),
-[syntaxes](plugin-syntax.md).
+[syntaxes](plugin-syntax.md). Listed plugins must follow the
+[plugin listing policy](plugin-listing-policy.md).
## 1. Write
@@ -146,7 +147,9 @@ owner of the `origin` remote. Run it in CI for the plugin and catalog repositori
A catalog is a Git repository with `orca-catalog.json` at its root that lists plugins and pins
each release to an exact commit and file hash, so Orca refuses bytes the catalog did not vouch
-for.
+for. Plugins in Orca's official and community catalogs must follow the
+[plugin listing policy](plugin-listing-policy.md): free to use, no donation links, and no URLs in
+the description.
1. Commit the plugin and run `pnpm validate:plugin` on its directory. It prints the
release entry for `HEAD`: version, full commit SHA, `contentHash`, execution profile, minimum
diff --git a/docs/reference/plugin-listing-policy.md b/docs/reference/plugin-listing-policy.md
new file mode 100644
index 00000000000..f75566ccc1d
--- /dev/null
+++ b/docs/reference/plugin-listing-policy.md
@@ -0,0 +1,46 @@
+# Plugin listing policy
+
+These rules apply to every plugin listed in Orca's official and community catalogs and on the
+[plugin directory](https://onorca.dev/plugins). For how to write and publish a plugin, see
+[Writing an Orca plugin](plugin-authoring.md).
+
+## Free to install and use
+
+Orca doesn't support paid plugins yet. A listed plugin must be free to install and use:
+
+- No paywalls, license keys, trials, or features locked behind a purchase or subscription.
+- A plugin may connect to a paid service the user already has, such as their own API account.
+
+## No donation or sponsor links
+
+Don't add donation, sponsor or funding links to the manifest, the description or the plugin's
+UI. Don't put URLs in the description at all: Orca shows descriptions as plain text.
+
+## Publisher is the repository owner
+
+`publisher` must be the GitHub or GitLab user or organization that owns the plugin's repository, the same
+way Go module paths name their owner: `acme` for `github.com/acme/gleam-syntax`. See
+[Publisher names and trust](plugin-catalog.md#publisher-names-and-trust).
+
+## No impersonation
+
+Don't use another person's, company's or product's name, logo or brand in a way that suggests
+they made or endorse your plugin.
+
+## Safe code
+
+- No malware, and nothing that harms the user's machine, files or accounts.
+- No obfuscated or minified-to-hide code. Bundled output is fine if the source is in the
+ repository.
+- No tracking, analytics or data collection about the user.
+
+## No explicit content
+
+Names, descriptions, icons, covers and screenshots must not contain sexual, violent or otherwise
+explicit content.
+
+## Reports and removal
+
+Anyone can use **Report this plugin** on a plugin's directory page. A plugin that is reported and
+breaks these rules is removed from the listings. If it is harmful, Orca's kill list also disables
+copies that are already installed.