create-wiki-kit
v0.2.0
Published
Scaffold a wiki-kit project
Maintainers
Readme
create-wiki-kit
CLI to scaffold a wiki-kit project.
Quick Start
npx create-wiki-kit my-wiki
cd my-wikiThis clones the wiki-kit template, applies the selected locale, and leaves a ready-to-use project.
Prerequisites
- Node.js 20+
- git
Usage
npx create-wiki-kit [project-name] [options]project-name defaults to wiki-kit if omitted. Use . to scaffold into the current directory.
# New directory
npx create-wiki-kit my-wiki
# Current directory
mkdir my-wiki && cd my-wiki
npx create-wiki-kit .
# Existing directory (must contain only safe files)
cd my-repo
npx create-wiki-kit .
# Japanese locale
npx create-wiki-kit my-wiki --locale jaIf the target directory already exists, it must contain only safe files (.git, .gitignore, LICENSE, README.md, etc.). Any other files are treated as conflicts and the command exits with an error listing them.
Options
| Option | Description |
|---|---|
| --locale <code> | Language for all generated files. Default: en |
| --template-path <path> | Copy from a local template directory instead of fetching from GitHub |
| --template-ref <ref> | Git ref to fetch from the remote template repository |
| -h, --help | Show help |
| -v, --version | Show version |
Locales
14 languages are supported. The --locale option determines the language of CLAUDE.md, templates, wiki scaffolding, and all README files.
| Code | Language | Code | Language |
|------|------------|------|------------|
| de | German | ko | Korean |
| en | English | pt | Portuguese |
| es | Spanish | ru | Russian |
| fr | French | th | Thai |
| id | Indonesian | tr | Turkish |
| it | Italian | vi | Vietnamese |
| ja | Japanese | zh | Chinese |
What It Does
- Fetches the template from wiki-kit-template
- Applies the selected locale (overwrites root files from
locales/<code>/, then removeslocales/) - Removes git history and
.gitkeepfiles
Local Development
Test with a local clone of wiki-kit-template before pushing:
node index.js my-wiki --template-path ../wiki-kit-templateOverride the fetch ref if needed:
node index.js my-wiki --template-ref <commit-sha>Template
- Repository: https://github.com/haya-inc/wiki-kit-template
- Pinned ref:
9b73c2ba532da876690bf43af3c05f80b59c62d0
Inspiration
wiki-kit is based on the LLM Wiki pattern by Andrej Karpathy — a design where an LLM incrementally builds and maintains a structured wiki from raw sources, rather than retrieving documents at query time.
Release
- GitHub Release tags must match the version in
package.json. Avprefix is allowed. - Prereleases are published under the
nextdist-tag on npm; only stable releases go tolatest.
