60 seconds

Guide

Install the binary, scaffold a site, run the dev server.

Install

Get the binary

kazam is a single self-contained Rust binary. No runtime, no Node, no Python. Pick whichever install method is convenient — all three land the same binary on your PATH.

Easiest on macOS / Linux. Pulls from the tdiderich/tap tap.

brew install tdiderich/tap/kazam
kazam --version

Works on any system with a Rust toolchain. Installed to ~/.cargo/bin/kazam.

cargo install kazam
kazam --version

Bleeding edge: install straight from main to pick up unreleased fixes.

cargo install --git https://github.com/tdiderich/kazam

For development or if you want to pin to a specific branch or commit.

git clone https://github.com/tdiderich/kazam
cd kazam
cargo build --release
cp target/release/kazam /usr/local/bin/kazam
Scaffold

Live on localhost in 30 seconds

kazam init my-site       # scaffolds kazam.yaml + index.yaml + AGENTS.md
cd my-site
kazam dev .              # watch + serve at localhost:3000, live reload

Edit index.yaml — the browser reloads on save. Add new .yaml files for new pages. That's the whole dev loop.

Or skip the scaffold — let your agent write it

Drop a folder of real context (notes, transcripts, prior decks, PDFs) and run kazam wish deck. Your agent — Claude, Gemini, Codex, or OpenCode — reads everything with its own file tools and writes a populated deck. Or kazam wish deck --yolo "about me" to skip the folder entirely and let the agent invent the whole thing.

Ship

Build a static bundle

kazam build . --out dist --release    # one-shot build to ./dist

The output is plain HTML, CSS, and copied assets — no runtime, no framework bundle. Any static host works.

Next up

You've got a site running. The full tour walks through how pages are shaped — shells, components, and a full kazam.yaml — then deploy recipes cover the handful of hosts most people pick.