This guide gets you up and running with Wiki CLI in minutes. You'll install Wiki, create a new wiki, add content, validate it, and preview it locally.
Prerequisites
Installation
You can install Wiki CLI in the way that fits your workflow:
Deno (recommended for development)
Run Wiki directly with deno run:
deno run -A jsr:@wazoo/wiki --help
Or install globally:
deno install -g -A jsr:@wazoo/wiki
wiki --help
npm
Install the wazootech-wiki package globally:
npm install -g wazootech-wiki
wiki --help
The npm package bundles a Deno runtime, so you don't need Deno or Python installed separately.
PyPI
Install the wazootech-wiki package from PyPI:
pip install wazootech-wiki
wiki --help
The PyPI distribution ships a standalone binary per platform, so no Deno is required at runtime.
Create a new wiki
Initialize a new wiki in an empty directory:
mkdir my-wiki && cd my-wiki
wiki init
This creates a minimal wiki.yml configuration, a README.md, and an empty wiki/ directory for your pages.
Configure your wiki
The generated wiki.yml is the single source of truth for your wiki. At minimum, it defines which directories to index and which validation rules apply.
The scaffold's config already lists wiki/ as the input directory, so this quickstart needs no edits. wiki build writes output to the --output-dir you pass (default _site).
See Wiki Configuration for all available options.
Add content
Create a new page using Markdown:
cat > wiki/Getting_Started.md << 'EOF'
# Getting Started
Welcome to your new wiki!
## Next steps
- Add more pages
- Link between pages using standard [Markdown links](Another_Page.md)
- Validate your content with `wiki check`
EOF
Wiki follows Wikipedia-style filenames for pages (e.g., Getting_Started.md with underscores and preserved capitalization). Avoid spaces in filenames and reserve index.md only for folder index routes.
Link between pages
Use standard Markdown links to connect pages:
[Quickstart](Quickstart.md) [Configuration](Wiki_Configuration.md)
Internal links are validated by wiki lint. See Internal Links in the Style Guide for details.
Format, lint, and check
Before building, validate and format your content. These commands mirror CI:
# Format Markdown mechanically
wiki fmt
# Check conventions and style
wiki lint
# Validate integrity (SHACL, JSON Schema, routes)
wiki check
To run them in strict mode (as CI does):
wiki lint --strict
wiki check --strict
If you're working in this repository (dogfooding), pass the config explicitly:
wiki -c docs/wiki.yml fmt
wiki -c docs/wiki.yml lint --strict
wiki -c docs/wiki.yml check --strict
Build and preview
Build a static site from your wiki:
wiki build
This writes HTML to _site (override with --output-dir).
Preview it locally:
wiki serve
By default, this serves the built site at http://localhost:8080. You can specify a different port with --port.
Automate updates
You can keep your wiki up to date on a schedule by running a custom ingestion script in GitHub Actions. This lets you pull from any source (APIs, feeds, databases) or generate content with your own AI workflow. See Automation for a daily workflow example and setup instructions.
Next steps
- Read the Style Guide for authoring conventions.
- Explore Wiki Configuration to customize validation, linting, and routes.
- Learn about Query and Render to work with the wiki graph.
- See the CLI reference for the full command list.
- Set up Automation to keep your wiki fresh automatically.
You're ready to build your semantic Markdown wiki!