Official starter templates for building SperaxOS plugins.

# Default plugin (recommended starting point)
cp -r templates/default my-plugin

# OpenAPI plugin (if you have an OpenAPI spec)
cp -r templates/openapi my-plugin

# Markdown plugin (for formatted text output)
cp -r templates/markdown my-plugin

# Standalone plugin (interactive frontend-only)
cp -r templates/standalone my-plugin

# Settings plugin (API key authentication)
cp -r templates/settings my-plugin

# Basic plugin (full-featured template with all features)
cp -r templates/basic my-plugin

cd my-plugin
pnpm install

1. Edit public/manifest-dev.json with your plugin details
2. Update package.json name and description
3. Implement your API logic in api/ folder

pnpm dev

Server runs at http://localhost:3400

1. Open SperaxOS
2. Go to Plugin Settings
3. Add custom plugin: http://localhost:3400/manifest-dev.json
4. Start chatting!

Need AI to summarize results?
├── YES → Do you have an OpenAPI spec?
│         ├── YES → openapi template
│         ├── NO → Need API key authentication?
│         │        ├── YES → settings template
│         │        └── NO → default template
│
└── NO → Is output pre-formatted Markdown?
          ├── YES → markdown template
          └── NO → Need user interaction?
                    ├── YES → standalone template
                    └── NO → default template

• Complete example (clothes recommendation)
• Backend API with Edge Runtime
• Optional frontend UI in iframes
• Gateway for local development
• Production and dev manifests

• OpenAPI 3.0 spec file (openapi.json)
• Example endpoints (greet, calculate)
• Automatic parameter validation
• No separate API definitions needed

• Returns Markdown directly (no JSON)
• No AI summarization step
• Fast response times
• Example: time/date display

• React + Next.js + Ant Design
• Full SDK integration
• State management with hooks
• Programmatic AI triggers
• No backend required

• Settings schema in manifest
• API key authentication example
• Server-side settings retrieval
• Error handling for invalid settings

• Production-ready template
• ESLint + Prettier + Vitest
• Semantic release
• Complete documentation
• GitHub Actions workflows

Each template includes:

All templates are configured for Vercel deployment:

# Deploy to Vercel
vercel --prod

Then update public/manifest.json:

1. Remove the gateway field
2. Update all url fields to production URLs

• @sperax/plugin-sdk - Plugin SDK
• @sperax/chat-plugins-gateway - Gateway package
• CoinGecko Plugin - Real-world example
• Plugin Development Guide - Full documentation