Skip to content

CLI commands ​

Use the generated npm scripts inside an extension, or invoke the installed CLI with npx nectar. The CLI operates on the current directory, except init, which creates the supplied new directory.

CommandPurpose
nectar init <directory>Generate an extension; existing directories are not overwritten.
nectar devRun the loopback preview with fixtures and automatic rebuilds.
nectar buildBundle src/main.ts, copy public assets and generate HTML entries.
nectar validateCheck the manifest.
nectar validate --builtAlso check built files against the archive contract.
nectar doctorCheck Node.js, the manifest and the source entry.
nectar doctor --builtAlso check the built archive contract.
nectar packPackage built files into a .nectar archive.
nectar --versionDisplay the installed SDK version.
nectar --helpDisplay command usage.

Generate a project ​

bash
npx --package @hivedevelopment/[email protected] nectar init my-extension --id yourname.example --panel-version dev --sdk-source npm

--sdk-source npm pins a registry dependency; local uses a relative SDK checkout. Installed npm copies default to npm; source checkouts default to local.

Preview and compatibility ​

bash
npx nectar dev --port 5174
npx nectar validate --built --panel-version dev
npx nectar doctor --built --panel-version dev

Preview uses mocks rather than a live Panel or service. --panel-version checks an exact target, not a semver range. Read the quick start for fixtures and rebuild behaviour.

Package an extension ​

bash
npm run build
npm run validate
npm run doctor
npx nectar pack --out yourname.example-1.0.0.nectar

pack does not rebuild and will not overwrite an existing output archive. Remove an old archive or choose a different output path. The generated project's npm run pack uses the default extension ID/version filename.

A .nectar package is installed through Panel. npm pack and npm publish have a different purpose: they package and publish an npm library, including the SDK itself.

HivePanel is open source software. · [Privacy Policy](/privacy)