Installation

On this page

Requirements
Create a site
Start the dev server
Build and check

Requirements

Node.js 22.18 or later. Kilim loads kilim.config.ts with the TypeScript support built into Node.js, so there is no compile step.
npm, pnpm, Yarn or Bun.

Create a site

npm create kilim@latest my-site

In a terminal it asks for anything you leave out: the folder and the template. Choose the template up front with --template (-t):

npm create kilim@latest my-site -- --template docs
pnpm create kilim my-site --template docs

Template	What you get
`blog`	A home page made of blocks, a blog with a paginated list and an RSS feed.
`landing`	A single landing page: hero, stats, features, cards, questions and a call to action.
`docs`	Documentation with a sidebar from folders, search and "On this page".

The command prints the next steps for the package manager you ran it with. In an existing project, kilim init [dir] --template <name> does the same; a folder with files in it is refused unless you add --force, which keeps the files that are already there.

Start the dev server

cd my-site
npm install
npm run dev

The site is at http://localhost:1923/ and reloads when you save a file. The admin at http://localhost:1923/admin/ edits the same files with forms, a rich text editor and a live preview. Both stay on your machine: the dev server only listens on localhost.

Build and check

npx kilim build
npx kilim check
npx kilim preview

kilim build writes the site to dist/, kilim check looks for SEO problems and broken links in it, and kilim preview serves it at http://localhost:1453/ the way a static host would.