Skip to content

Plugin SDK

Author, validate, test, and publish CELLAS plugins.

Overview

Plugin authors extend CELLAS capabilities under a stable contract. This page summarizes the author guide; the monorepo remains canonical.

Canonical source: docs/developer/plugin-author-guide.md.

Concepts

CommandPurpose
cellas plugin initCreate the canonical Plugin package skeleton
cellas plugin validateValidate manifest, package layout, and integrity
cellas plugin testRun plugin, integration, compatibility, or all suites
cellas plugin packageBuild, test, and produce a signed distributable
cellas plugin verifyVerify a published package against registry metadata
cellas plugin publishPublish a verified package to the registry
cellas plugin doctorCheck toolchain, registry, and environment readiness

SDK behavior lives under packages/sdk/*. @cellas/plugin-sdk is a compatibility entrypoint—prefer specific SDK packages for your capability type.

Example: starter project

pnpm create cellas my-plugin --template plugin --yes
cd my-plugin
pnpm exec cellas verify
pnpm exec cellas certify

Example: monorepo author commands

Prerequisites: Node.js ^22.13.0 || >=24.0.0, pnpm run build:workspace.

pnpm exec cellas plugin init my-analyzer \
  --component-id my-analyzer \
  --capability-type analyzer \
  --capability-subtype seo

pnpm exec cellas plugin validate
pnpm exec cellas plugin test --suite plugin

CLI

pnpm exec cellas plugin --help

Reference plugins: plugins/reference-* in the repository.

Next steps

  1. Install
  2. Quick Start
  3. CLI