Quickstart
Install BLKC and create your first Block in minutes.
Quickstart
Prerequisites
- Node.js 22+ (or Bun)
- npm, pnpm, or Bun
Install
npm install @blkc-code/cliCreate a Block
npx @blkc-code/cli new block heroThis creates a working manifest, an example, and a test that passes.
Check
npx @blkc-code/cli checkEach error prints a BLKC-E* code, the field, the fix, and a link to /docs/errors/<code>.
Preview
npx @blkc-code/cli devTry it
Edit the Block JSON and watch the preview update:
Live preview
Hello BLKC
Try editing me
Live preview powered by @blkc-code/render-web.
EOF