Install the plugin tools.

Create a local project, install its dependencies, and connect it to Editful.

Start with the generated command. No UI framework required.

Create the project

The CLI creates a typed, React-ready project and installs its dependencies.

Terminal

npx @editful/cli plugin new hello-editful
cd hello-editful

hello-editful/
├── assets/icon.svg
├── editful.plugin.ts
├── src/index.tsx
└── package.json

The generated plugin runs without a UI framework. Build a validated artifact:

Terminal

pnpm build

Start the watcher and choose the parent folder when Editful asks for a plugin directory.

Terminal

pnpm dev --root /absolute/path/to/editful-plugins

Editful loads plugin artifacts from direct subfolders of that root.

Your local plugin is ready. Start with the simplest useful extension: add a Card tool that creates a canvas object with a click or drag.