Installation

Requirements

• Node.js 20 or later
• pnpm 9 or later (recommended) or npm

Install the CLI

npm install -g @kb-labs/cli
# or
pnpm add -g @kb-labs/cli

Verify the installation:

kb --version

Create a workspace

A workspace is a directory that contains your workflows, plugins, and configuration.

kb init my-workspace
cd my-workspace

This creates the following structure:

my-workspace/
├── .kb/
│   └── kb.config.json    # Platform configuration
├── workflows/
│   └── example.yaml      # Example workflow
├── plugins/
│   └── hello/            # Example plugin
└── package.json

Start the development server

kb dev

The dev server starts the workflow engine and watches for changes. You should see:

✓ Workflow engine started on :7778
✓ State broker ready
✓ Watching for changes…

Configure your environment

Copy the example environment file:

cp .env.example .env

Next steps

Now that you have the CLI installed, build your first workflow →