BLKC

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/cli

Create a Block

npx @blkc-code/cli new block hero

This creates a working manifest, an example, and a test that passes.

Check

npx @blkc-code/cli check

Each error prints a BLKC-E* code, the field, the fix, and a link to /docs/errors/<code>.

Preview

npx @blkc-code/cli dev

Try 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

On this page