Skip to content

README.md

Latest commit

 

History

History
98 lines (73 loc) · 2.53 KB

README.md

File metadata and controls

98 lines (73 loc) · 2.53 KB

OpenACP Plugin Registry

The official plugin registry for OpenACP. This repository contains metadata for all community plugins discoverable via openacp plugin search.

Plugins

Plugin Description Category Version
👋 Hello World Plugin Example plugin — greets users on session start utility 0.0.1 ✓ verified

Total: 1 plugin · Submit yours →

Install a plugin

openacp plugin search <query>
openacp plugin install <plugin-name>

For Plugin Authors

Want to list your plugin? See CONTRIBUTING.md for submission instructions.

How It Works

  1. Plugin authors submit a JSON file via Pull Request to plugins/
  2. CI validates the submission (schema, npm existence, uniqueness)
  3. PR auto-merges if validation passes
  4. registry.json is automatically rebuilt
  5. OpenACP CLI fetches registry.json to power plugin search and discovery
  6. A daily CI job updates version numbers from npm

Registry Structure

plugins/
  example--openacp-hello.json    # One JSON file per plugin
registry.json                     # Auto-generated aggregate (do not edit)

Development

npm install

# Validate plugin files
npm run validate

# Check that npm packages exist
npm run check-npm

# Build registry.json + update README plugin list
npm run build

# Update versions from npm
npm run update-versions

# Run tests
npm test

Plugin JSON Schema

{
  "name": "plugin-name",
  "displayName": "Plugin Name",
  "description": "What the plugin does",
  "npm": "@scope/package-name",
  "repository": "https://github.com/org/repo",
  "author": { "name": "Author", "github": "username" },
  "version": "1.0.0",
  "minCliVersion": "2026.0326.0",
  "category": "adapter|utility|integration|ai|security|media",
  "tags": ["tag1", "tag2"],
  "icon": "🌐",
  "license": "MIT",
  "verified": false,
  "featured": false
}

Categories

Icon Category Description
🔌 Adapters Messaging platform adapters (WhatsApp, Line, etc.)
🔧 Utilities Utility plugins (translation, formatting, etc.)
🔗 Integrations Third-party integrations (Jira, Linear, etc.)
🤖 AI & Models AI model providers
🔒 Security Security & access control
🎵 Media Voice, image, video processing

License

MIT