Hello World

Official exampleSample plugin from the Paperclip repo, for learning to build your own.

Use this reference example to build a minimal plugin with one dashboard widget. The example is in the Paperclip repository.

PaperclipIn the Paperclip repoDevelopment example

InstallSource on GitHub (opens in a new tab)

What it does

  • A dashboard widget UI slot
  • Reads host context such as the company ID
  • Worker lifecycle hooks for basic health checks

Install

This example lives in the Paperclip repo. It may not be included in regular Paperclip installs.

pnpm --filter @paperclipai/plugin-hello-world-example build
npx paperclipai plugin install ./packages/plugins/examples/plugin-hello-world-example
  1. In a Paperclip source checkout, build the example from the repository root.
  2. Install it by local path.
  3. Review its manifest and capabilities before enabling it.