What problem does it solve?
This guide removes uncertainty and manual boilerplate when creating, scaffolding, or documenting Paperclip plugins by providing a clear scaffold workflow, runtime assumptions, verification steps, and documentation expectations.
Core Features & Use Cases
- Scaffold Automation: Use the create-paperclip-plugin scaffold to generate a ready-to-edit plugin package with manifest, worker, UI, tests, and package metadata.
- External and In-Repo Support: Supports snapshotting an SDK for plugins developed outside the repo and recommends targets for example or production packages.
- Verification & Best Practices: Emphasizes capability declarations, route conventions, typechecking, testing, building, and documentation distinctions between current runtime and future specs.
- Use Case: Quickly create an example plugin for documentation or a local plugin package for development and verify it with typecheck, tests, and build steps.
Quick Start
Scaffold a new Paperclip plugin package named @acme/plugin-name into packages/plugins/examples and prepare it for local development.