create-velocms-plugin

create-velocms-plugin

Scaffolding CLI for VeloCMS plugin developers. Generates a ready-to-develop plugin template with all necessary boilerplate.

Usage

npx create-velocms-plugin@latest my-plugin

This interactive CLI will ask you for:

• Plugin name
• Plugin slug (kebab-case identifier)
• Plugin type (block, integration, or widget)
• Plugin category (e.g., seo, commerce, writing, analytics)
• Author name
• Plugin description

Output

The CLI generates a directory with:

my-plugin/
├── src/
│   ├── index.ts         # Main plugin hook handler(s) + manifest
│   └── admin.tsx        # Optional admin UI component
├── tests/
│   └── example.test.ts  # Example test case (node:test + @velocms/plugin-sdk/test-helpers)
├── manifest.json         # Generated plugin manifest (auto-populated)
├── package.json          # npm config with @velocms/plugin-sdk dependency
├── tsconfig.json         # TypeScript configuration
├── tsconfig.build.json   # Build-time tsconfig (excludes tests/)
├── README.md             # Getting started guide
├── .gitignore            # Standard ignores
├── .npmignore            # What NOT to publish alongside dist/
└── .eslintrc.json        # ESLint config (VeloCMS standards)

Next steps

After scaffolding:

cd my-plugin
npm install
npm run build
npm run dev

For full plugin development guide, see https://velocms.org/developers/sdk.

License

MIT