Getting Started with NetPad Plugins

This guide will walk you through creating, testing, and running your first NetPad plugin.

Prerequisites

• Node.js 18+
• Access to a NetPad workspace (with plugin support enabled)
• MongoDB Atlas connection (for plugin registry)

1. Install the NetPad Plugin CLI

The CLI tool helps you scaffold, test, and publish plugins.

npm install -g create-netpad-plugin

2. Create a New Plugin

Use the CLI to scaffold a new plugin project:

npx create-netpad-plugin my-plugin
cd my-plugin

This will generate a directory with:

• manifest.json — Plugin manifest
• runner.js — Plugin logic
• shape.js — Node shape (visual)
• icon.svg — Node icon
• README.md — Documentation

3. Run Tests

Each plugin template includes a test suite:

npm run test

4. Local Development

You can develop and hot-reload your plugin in NetPad:

npm run dev

• Make changes to runner.js or shape.js and see them live in your workspace.
• Use the NetPad UI to install your plugin locally for testing.

5. Next Steps

• Plugin Manifest Reference
• Development Workflow
• Publishing & Store

For more details, see the Plugin Sprint Plan.