Building a NaaP plugin

Create, develop, and publish NaaP plugins using the @naap/plugin-sdk CLI. Scaffold, hot-reload, access shell services, and publish to the registry.

Building a plugin

NaaP has full tooling for plugin development and publishing. If you are building a network tool - a monitoring dashboard, a governance interface, an AI pipeline manager - shipping it as a NaaP plugin gives you shared auth, navigation, and database infrastructure with zero setup.

Install the CLI and scaffold a plugin:

npm install -g @naap/plugin-sdk
naap-plugin create my-plugin
naap-plugin dev

The dev server hot-reloads your plugin inside the shell at http://localhost:3000. The start.sh script manages the full platform locally:

git clone https://github.com/livepeer/naap.git && cd naap && ./bin/start.sh

First run handles everything: dependency installation, PostgreSQL via Docker, schema creation, .env generation, plugin bundle builds, and platform start. Subsequent starts take 6-8 seconds.

Every plugin declares a plugin.json manifest:

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "0.1.0",
  "category": "developer",
  "permissions": ["network:read"]
}

Plugins access shell services through the SDK hooks:

import { useShell, useAuth, useEventBus } from '@naap/plugin-sdk';

export function MyPlugin() {
  const { navigate, notifications } = useShell();
  const { user } = useAuth();
  const eventBus = useEventBus();
  // ...
}

All plugin API calls go through /api/v1/my-plugin/* using the standard response envelope:

// Success: { success: true, data: T, meta?: { page, limit, total } }
// Error:   { success: false, error: { code, message } }

NaaP also ships AI prompt templates for building plugins without writing boilerplate. The Prompts section in the NaaP docs covers 8 templates covering frontend plugins, full-stack apps, UI design, testing, and publishing - paste them into any AI assistant.

Full development guides are at operator.livepeer.org/docs/guides/your-first-plugin. The SDK hooks reference is at operator.livepeer.org/docs/api-reference/sdk-hooks.

The NaaP architecture page covers the ShellContext interface and micro-frontend design in depth. The NaaP tutorial walks through a complete plugin from scratch.