Install
From npm
Install with Node.js 18 or newer:
npm install -g wazootech-wiki
wiki --help
The package provides the wiki command and a bundled Deno runtime; system Python and a separately installed Deno are not required. Use npx without a global install:
npx wazootech-wiki --help
npx wazootech-wiki init
npx wazootech-wiki check
From Deno
The @wazoo/wiki package is published on JSR. Install the CLI globally with:
deno install --global --allow-all --name wiki --min-dep-age 0 jsr:@wazoo/wiki/cli
Or import jsr:@wazoo/wiki from a Deno project. For npm projects, use npx jsr add @wazoo/wiki. Deno's minimum dependency age resolves a just-published version to the previous one for about 24 hours; --min-dep-age 0 bypasses that policy.
To work on Wiki itself, use the repository source:
deno run -A src/wiki/cli.ts --help
deno task check
From source
deno run -A src/wiki/cli.ts --help
deno task check
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, and an empty wiki/ folder for your markdown pages. Use --repo owner/repo to infer GitHub Pages URLs without a prompt, or pass --graph-context-wiki / --site-base-url explicitly; in non-interactive contexts (CI, scripts) init skips the prompt and uses the default namespace. By default it does not create a Git repository; use --git if you want that explicitly. Init requires a clean directory (no existing wiki.yml, README.md, or non-empty wiki/). See wiki init for all flags.
Branding
Styling and branding (such as site name, theme color, logo, and favicon) are configured through a custom layout template and assets under wiki.assets; set site.layout in wiki.yml. See Wiki Configuration — Custom CSS and wiki init.
Alternatively, scaffold from a template: wiki init --template wikipedia builds the wikipedia starter from wiki-templates. 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
Run commands from the repository root:
deno run -A src/wiki/cli.ts -c docs/wiki.yml check --strict -v
deno run -A src/wiki/cli.ts -c docs/wiki.yml lint --strict -v
deno run -A src/wiki/cli.ts -c docs/wiki.yml render --cache
deno run -A docs/build.ts --output-dir _site
See Deploying to GitHub Pages for the GitHub Actions workflow.
Agent skills
Coding agents can use the consolidated wiki skill documented in Wiki Skills.
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
- wiki — command reference home
- Wiki Configuration — tune
wiki,graph,site,link, and check severities - Style Guide — document types, shapes, and wikilinks
- Linked Markdown — the wazootech/linked-markdown protocol specification
- wiki check — integrity validation and CI checks
- wiki lint — convention audits (broken links, filenames, headings)
- wiki query — ad-hoc SPARQL from the terminal
- wiki render — refresh inline SPARQL tables
- wiki serve — local preview and optional SPARQL endpoint
- wiki build — static HTML for deployment
- Graph Cache — graph reuse and
--cache