Getting Started
First steps for plugin/theme development and monorepo development on cockpitOS.
Two Paths
| Goal | Approach |
|---|---|
| Plugin/Theme without entire Monorepo | @cockpitos/sdk — CLI create-block, create-theme |
| Platform with Dashboard, API, Website | Clone this repository — see Root README |
cockpitOS SDK (external / Monorepo)
The SDK located at packages/sdk generates scaffold projects for block and theme plugins.
Monorepo (recommended for SMG developers)
pnpm install
pnpm --filter @cockpitos/sdk build
pnpm --filter @cockpitos/sdk exec cockpitos create-block my-hero-block
cd my-hero-block && npm install && npm run dev
Global (external authors)
npm install -g @cockpitos/sdk
cockpitos create-block my-hero-block
cd my-hero-block && npm install && npm run dev
Note: cockpitos dev in the SDK is currently a stub. Development in the generated project is done via npm run dev. There is no create-service / create-plugin in the CLI.
Details: packages/sdk/README.md
Monorepo Quick Start
Node.js ≥ 22.13, pnpm 10.x
pnpm install
pnpm db:generate
pnpm db:push # or pnpm db:migrate
pnpm --filter @mall-os/dashboard dev # http://localhost:3000
Additional apps: Center Manager 3001, Signage 3002, Center Website 3004 — see Root README.
Public API & v0
External websites (v0, Vercel) access live data without dashboard login:
Additional Documentation
- Plugin Development
- WordPress Themes
- AI Website Build & Cockpit Sync
- MCP:
packages/mcp-cockpit-os— Claude & Cockpit
Requirements
- Node.js: ≥ 22.13 (Monorepo)
- TypeScript: ≥ 5.0
- React / Next.js: as specified in the respective app's
package.json
Older sections on Storybook/Playground and create-service have been removed — they were not in line with the SDK in the repository.
Nutzungsstatistik: Seitenaufrufe werden anonymisiert erfasst. Im Umami-Dashboard nach diesem Pfad filtern: /en/developer-guide/getting-started