paseo.cafe

Community registry intake

Submit your plugin

Fill in the listing details here, then review and submit them on GitHub. The registry bot writes the file and opens the pull request for you.

01

Describe

Enter the registry details.

02

Confirm

Review the prefilled GitHub issue.

03

Automate

The bot opens the registry PR.

1. Before you submit

Required

  • Your repo is public on GitHub.
  • Its paseo-plugin.json id matches the registry filename.
  • Its package.json has a released semantic version, not 0.0.0, and you will increment it for each plugin update.
  • Its npm package is public on npmjs.org and contains the same plugin ID and version as the GitHub source.

Recommended — not required to get in, but makes your listing much better

  • A README with an Install, Installation, Setup, or Getting started section — we pull it into your listing verbatim.
  • A README with a Limitations, Caveats, or Known issues section if you have one — same deal, pulled in automatically.
  • If your plugin only runs on certain platforms, declare it here — don't rely on us guessing from your README.
  • A LICENSE file.
  • An images/ folder with one or more screenshots.
  • A demo video — a YouTube or Loom link, or a video dropped directly into the README — gets auto-embedded.
  • Theme plugins: keep addTheme palettes as literal hex-color objects in index.client.ts or index.client.tsx so the catalog can generate an exact preview.
  • npm test and npm run typecheck scripts in package.json.

2. Describe your plugin

These answers become the registry entry. Everything else is read from the plugin repository automatically.

Lowercase kebab-case. Becomes registry/my-plugin.json.

Public "owner/repo" hosting paseo-plugin.json. Do not paste a full URL.

Only needed when one repository hosts multiple plugins.

Paseo 0.9 installs this package; Paseo 0.8 uses the GitHub source.

Categories
CategoriesOptional
Platforms
PlatformsOptional restriction

Leave blank when the plugin is not platform-restricted.

One per line. Up to 6 single-sentence caveats, 140 characters each.

GitHub opens with these answers filled in. Tick the two required confirmation boxes, then submit the issue. You may be asked to sign in.

Need the manual pull request path?

Use this only when the issue form cannot express the registry change you need. New plugin submissions should use the form above.

git clone https://github.com/paseo-cafe/paseo-cafe.git
cd paseo-cafe
git checkout -b add-your-plugin-id
$EDITOR registry/your-plugin-id.json
git add registry/your-plugin-id.json
git commit -m "Add your-plugin-id"
git push -u origin add-your-plugin-id

3. What happens next

  1. Submit the issue: GitHub shows every prefilled answer for a final review and asks you to confirm the manifest id and released package version.
  2. The bot opens a PR: the issue is validated, converted into the registry JSON file, and referenced by the generated pull request.
  3. Registry admission: the normal checks confirm the repo/path exists, the manifest id matches, and the plugin passes the security scan.
  4. On merge: your full listing is generated from its published sources. Six-hour scans refresh npm downloads and publish dates or GitHub stars without another PR.

What you don't need to write

  • Name from the validated plugin ID; description, author, and license from package.json, paseo-plugin.json, and the README. package.json.version is the update identity used by the companion catalog.
  • The install commands: npmjs for Paseo 0.9 and GitHub for Paseo 0.8.
  • Screenshots, from an images/ folder in your repo.
  • Demo videos, detected in your README (YouTube, Loom, or an uploaded GitHub video).
  • A best-effort limitations/caveats excerpt, detected from your README if you didn't declare platforms/caveats yourself.
  • Star count, last-updated date, and license, from the GitHub API.
  • Health badges: manifest validity, README/license/tests presence, and recency.
Browse existing plugins Read the source