create-kardalum-plugin

Scaffold a new plugin for Kardalum, the free CMS that never loses your data. It writes a typed project built against @kardalum/plugin-sdk, with a starter manifest and test for the plugin type you choose, and the kardalum command line set up to run a local sandbox, validate, pack and publish.

Install

Needs Node.js 22.12 or later.

npm create kardalum-plugin@latest

With no flags it asks for the name, the type and the id. The type is the plugin's marketplace listing label: datatype, section, template, theme, integration, utility or bundle. It picks the starter code, not what the plugin may do: any plugin may declare any contribution.

Every starter carries the same spine: a declared permission, an example admin route, a README.md written as the plugin's listing page, and a DEVELOPING.md of notes for you that the package build leaves out. The starters that show screens (datatype, section and utility) also ship locales/en.json.

To skip the prompts, pass every flag after --:

npm create kardalum-plugin@latest -- --name "My Plugin" --type datatype --id com.example.my-plugin

--author and --description are optional; --help lists every option. A name is at most 80 characters, an author 200 and a description 2000. Quotes, backticks, backslashes and newlines are refused in all three, and a name may not hold {{, {%, }}, %}, <, >, [ or ]. Then, inside the new project:

npm install
npm run sandbox           # a local Kardalum CMS running your plugin; the first run offers its install screen
npm run plugin:validate   # every check the marketplace runs on a submission that can run on your machine

Docs

The plugin guide, the manifest reference and the CLI reference are at dev.kardalum.com/docs.

Support

Kardalum's source is not public. Questions and bug reports: kardalum-devkit. Licensed Apache-2.0.