Create a knowledge base (CLI)

Use this when you want your docs, not a fork of someone else's knowledge base.

The CLI asks for site title, author name, GitHub username, and repository name. It writes a working Next.js project with a default home, footer, Welcome page, and this Authoring guide.

Pin a version

@latest always scaffolds the newest release. To stay on a known generator, pin it: npx create-kb@0.1.0 my-notes. Your generated site keeps working even when a newer create-kb ships. See Versions and upgrades.

After the command

Then open:

Site: http://localhost:3000
Author Studio: http://localhost:3000/author

Author Studio is local only. Save writes MDX under content/. You still commit and push.

Flags (no prompts)

Flag	Meaning
`--yes` / `-y`	Skip prompts (directory is required)
`--site-title`	Nav brand and SEO title
`--author`	Footer copyright name
`--github-user`	GitHub user (Pages URL)
`--github-repo`	Repo name (`basePath` becomes `/repo`, unless the repo is `user.github.io`)
`--no-git`	Do not run `git init`

From the product repo itself (maintainers, before npm):

What the CLI fills vs what you edit

The CLI writes identity into kb.config.json (name, author, GitHub, Pages basePath). It also writes kb.engine.json with the create-kb version that generated the project. Do not treat kb.engine.json as a design file.

Appearance is yours:

Goal	File
Homepage	`components/HomePageClient.tsx`
Footer and socials	`components/Footer.tsx`
Top nav	`components/Navigation.tsx`
Colors and fonts	`app/globals.css`
Sidebar order	`config/docs-order.config.ts`

The generated README.md repeats this table.