@quartal/create-plugin

The starter kit for Quartal Plugins. Scaffolds a new plugin project — an Astro app with the qrtlPlugin() integration serving MCP, OpenAPI/REST, widgets and Agent Skills.

Usage

pnpm create @quartal/plugin

npm create @quartal/plugin

Optionally pass the project name directly: pnpm create @quartal/plugin my-plugin.

Non-interactive (CI and coding agents)

Every question can be answered with a flag, and --yes accepts the defaults for the rest — so the command runs without a terminal:

pnpm create @quartal/plugin my-plugin --yes

npm create @quartal/plugin -- my-plugin --yes

Flags: --description <text>, --auth / --no-auth, --sample-tool / --no-sample-tool, --widgets none|vue|react|js, --yes, --help. With npm, flags go after --.

Interactive prompts

The starter kit asks for:

• Name — the npm package / directory name (required).
• Description — optional one-liner.
• Quartal Hub authentication — yes/no. Yes scaffolds OAuth2 with the default Quartal auth (auth: "quartal-hub"); no scaffolds an anonymous plugin (auth: "anon").
• Sample tool — yes/no (default yes): a HelloWorld class under src/tools/.
• Widgets — None / Vue (default) / React / Plain JavaScript: a sayHello widget page under src/pages/widgets/.

Then:

cd my-plugin
pnpm install
pnpm dev

See Getting started for what runs on http://localhost:4321 and how to make the plugin your own.

How it works

Static files are copied from templates/; the option-dependent files (package.json, qrtl.config.ts, astro.config.mjs, README.md, AGENTS.md, src/tools/mod.ts) are generated in src/scaffoldProject.ts. Dependency versions written into the scaffolded package.json are pinned in src/dependencyVersions.ts — bump them there when the workspace packages release.