Publish and Distribute a Plugin

Prepare a plugin for release with stable IDs, clear metadata, and a clean install flow.

A release-ready plugin should be easy to install, easy to understand, and safe to disable.

Release checklist

Before publishing, confirm these items:

• plugin ID is stable and unique

• name and description are clear

• permissions match real behavior

• hook names are correct

• unload cleanup works

• the plugin runs on the intended app version

Packaging expectations

Your plugin should keep a simple folder structure.

At minimum, users need:

• the plugin directory

• plugin.json

• __init__.py

• any additional files the plugin imports at runtime

Metadata quality

Good plugin metadata helps users trust the plugin quickly.

Use:

• a clear name

• a real version number

• a short author field

• a description that says what changes in the app

Compatibility guidance

If your plugin targets API v2.2.0, test against that version before release.

Do not assume future compatibility without verification.

Distribution advice

Keep the installation flow obvious:

1. copy the plugin folder into plugins/

2. start the app

3. enable the plugin if required

4. verify the expected action appears

Support advice

When users report issues, ask for:

• the app version

• the plugin version

• the failing action

• whether the failure happens on load, use, or unload

The best plugin releases feel boring: clear metadata, predictable behavior, and clean uninstall paths.

Related guides

• Plugin Best Practices

• Testing and Debugging Plugins

• Plugin Creator Skill