Super Agent CLI Plugins

Official plugin repository for Super Agent CLI.

Extend your Super Agent CLI with custom tools, integrations, and capabilities through a simple plugin system.

🚀 Quick Start

See QUICKSTART.md for a step-by-step guide to creating your first plugin.

📦 Available Examples

Explore fully-functional example plugins in the examples/ directory:

• weather - External API integration with weather data
• database - Database query tools with state management
• notify - System notifications and cross-platform integration

🎨 Templates

Get started quickly with our templates in the templates/ directory:

• basic - Minimal single-tool plugin
• advanced - Full-featured plugin with tests and CI

📖 Plugin API

All plugins must export a SuperAgentPlugin object:

export interface SuperAgentPlugin {
  name: string; // Unique plugin identifier
  version: string; // Semantic version
  description?: string; // Human-readable description
  tools?: SuperAgentTool[]; // Tools provided by this plugin
  onInit?: (context: PluginContext) => Promise<void>;
  onShutdown?: () => Promise<void>;
}

Tool Definition

export interface SuperAgentTool {
  type: "function";
  function: {
    name: string;
    description: string;
    parameters?: {
      type: "object";
      properties: Record<string, any>;
      required?: string[];
    };
    executor: (args: any, context: any) => Promise<string>;
  };
}

🔧 Installing Plugins

From this repository:

super-agent plugins install @plugins/examples/weather

From local file:

super-agent plugins install ./my-plugin.js
super-agent plugins install /path/to/plugin/dist/index.js

List installed plugins:

super-agent plugins list

Remove a plugin:

super-agent plugins uninstall weather

📝 Contributing

We welcome plugin contributions! Please see our Contributing Guidelines for details.

Plugin Submission Checklist

• Plugin follows the API specification
• Includes README with usage examples
• TypeScript types are properly defined
• Error handling is implemented
• Code is tested (for advanced plugins)

📄 License

MIT - See LICENSE for details.

🔗 Links

• Super Agent CLI Documentation
• Plugin Quickstart Guide
• Report Issues