TechArticle

Getting Started

Infobox

headline
Getting Started
description
Install the wiki CLI and scaffold a new wiki.

Install

From PyPI

pip install wazootech-wiki
wiki --help

From npm

npm install -g wazootech-wiki
wiki --help

This installs wiki on PATH. The npm package creates a private Python virtual environment and installs the matching PyPI wazootech-wiki release. Python 3.12 or newer is required on the machine.

Zero-install (no global install):

npx wazootech-wiki init
npx wazootech-wiki check

npx wazootech-wiki and uvx wazootech-wiki accept the same subcommands and flags as wiki.

Editable install from this repository

uv pip install -e .

Scaffold a new wiki

From an empty directory:

wiki init

# GitHub Pages defaults from owner/repo
wiki init --repo wazootech/wiki

# Also initialize a Git repository explicitly
wiki init --git

wiki init writes wiki.yml, README.md, layouts/, assets/logo.svg, and a starter wiki/ folder (Person_Shape.md, Ethan_Davidson.md). The scaffold enables wiki.assets and wires the default layout to the logo file. Use --repo owner/repo to infer GitHub Pages URLs without a prompt, or pass --graph-context-wiki / --site-base-url explicitly. By default it does not create a Git repository; use --git if you want that explicitly. See Wiki Subcommand init for all flags and --force behavior.

Alternatively, start from a GitHub template: wiki-template (generic workspace) or the LLM Wiki starter llm-wiki-template. See Wiki CLI templates.

Daily workflow

# Validate integrity (SHACL, JSON Schema, routes, layout; silent on success)
wiki check

# Validate conventions (filename pattern, headings, link style)
wiki lint

# Refresh embedded SPARQL tables
wiki render

# Reuse a warm graph across repeated one-shot shells
wiki render --cache

# Preview at http://127.0.0.1:8080/wiki/ (default)
wiki serve

# Preferred long-lived preview loop while editing
wiki serve --watch

# Or build static HTML for deployment
wiki build --output-dir _site

Use wiki check -v / wiki lint -v to see warnings. In CI, run both with --strict so warnings fail the job.

Work in this repository’s docs wiki

The published site under docs/wiki/ is built with:

wiki -c docs/wiki.yml check --strict -v
wiki -c docs/wiki.yml lint --strict -v
python -m wiki -c docs/wiki.yml serve --watch
wiki -c docs/wiki.yml render --cache
wiki -c docs/wiki.yml build --output-dir _site --site-base-url /wiki

See Deploying to GitHub Pages for the GitHub Actions workflow.

Agent skills

Coding agents can use the consolidated wiki skill documented in Wiki Skills and Wiki Skill.

After upgrading Wiki CLI or when skills behave unexpectedly, refresh agent skills:

npx skills add wazootech/wiki@wiki -g -y

Do not commit .agents/skills/ to your wiki repo unless you intentionally vendor a snapshot — stale copies miss fixes like deploy workflow templates.

Next steps

Backlinks