/wiki-init once to set up your knowledge base. It scans your project, samples your files to understand your domain, and proposes a custom article structure before writing anything.
If a .wiki-compiler.json already exists, the command shows your current config and asks whether you want to reconfigure or abort — it will not overwrite anything without your confirmation.
Command
Setup flow
1
Auto-detect directories
The command scans your project for markdown-heavy directories — looking for folders named
Knowledge/, docs/, notes/, or content/, and any directory containing 10 or more .md files. Standard non-content folders like node_modules/, .git/, and build/ are excluded automatically.You’ll see a summary like:2
Confirm your sources
You’ll be asked three questions:
- What’s the name for this knowledge base? (e.g., “My Research”, “Project Alpha”, “Team Wiki”)
- Which directories should be compiled from? The auto-detected directories are shown with checkmarks — add or remove as needed.
- Where should the wiki output live? Defaults to
{first_source}/wiki/.
3
Sample source files
The command picks 10–15 representative files spread across your confirmed directories, reads the first ~500 characters of each, and identifies what kinds of content you have: meeting notes, research papers, journal entries, strategy docs, technical specs, and so on.This sampling step is what makes the article structure fit your actual content rather than forcing a generic template.
4
Review the proposed article structure
Based on the sampled files, you’ll see a proposed list of 5–8 sections for each wiki article. Summary is always first and Sources is always last. The middle sections are tailored to your domain.Example proposals:
You can add, remove, or rename sections. Type “regenerate” to get a fresh proposal. Summary and Sources are required and cannot be removed.
5
Write configuration and create output directories
Once you confirm the article structure, the command writes You’ll see a summary confirming what was created, and next steps for your first compile.
.wiki-compiler.json to your project root and creates the output directory:What gets created
.wiki-compiler.json — your wiki configuration, stored at the project root. Contains source directories, output path, article sections, and mode. You can edit it anytime.
Output directory structure — the topics/ folder and supporting state files are created immediately. Topic articles are populated when you run /wiki-compile.
Next steps
After/wiki-init completes:
- Run
/wiki-compileto build your first wiki - Open
{output}/INDEX.mdin Obsidian to browse the result - Edit
article_sectionsin.wiki-compiler.jsonanytime to adjust the structure - When ready, change
"mode"in.wiki-compiler.jsonfromstaging→recommended→primary