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.

The npm package also exposes a type-safe TypeScript SDK for Node projects. See Wiki Programmatic API for SDK installation and usage.

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, and a starter wiki/ folder (Person_Shape.md, Ethan_Davidson.md). 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. Init requires a clean directory (no existing wiki.yml, README.md, or non-empty wiki/). See Wiki Subcommand init for all flags.

Branding

Styling and branding (such as site name, theme color, logo, and favicon) are not managed by the CLI out-of-the-box, which outputs plain, unstyled HTML. To add custom styling, write a custom layout template file and place custom assets under the wiki.assets directory, then configure site.layout in your wiki.yml. See Wiki Configuration — Custom CSS and Wiki Subcommand init.

Alternatively, start from a GitHub template: wiki-template (generic wiki project) 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.

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 CLI — command reference home
Wiki Configuration — tune wiki, graph, site, link, and check severities
Style Guide — document types, shapes, and wikilinks
Wiki Subcommand check — integrity validation and CI checks
Wiki Subcommand lint — convention audits (broken links, filenames, headings)
Wiki Subcommand query — ad-hoc SPARQL from the terminal
Wiki Subcommand render — refresh inline SPARQL tables
Wiki Subcommand serve — local preview and optional SPARQL endpoint
Wiki Subcommand build — static HTML for deployment
Graph Cache — graph reuse and --cache

ContentsOn this page

[hide]

(Top)
Install
From PyPI
From npm
Editable install from this repository
Scaffold a new wiki
Branding
Daily workflow
Work in this repository’s docs wiki
Agent skills
Next steps

Backlinks

Categories:

TechArticle

Talk / Local Notes: Getting Started

Your personal scratchpad for this page (saved locally in browser)

0 characters

View Source: Getting Started

Raw Markdown source code of the document

# Getting Started

## Install

### From PyPI

```bash
pip install wazootech-wiki
wiki --help
```

### From npm

```bash
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.

The npm package also exposes a type-safe TypeScript SDK for Node projects. See [Wiki Programmatic API](Wiki_Programmatic_API.md#typescript-sdk) for SDK installation and usage.

Zero-install (no global install):

```bash
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

```bash
uv pip install -e .
```

## Scaffold a new wiki

From an empty directory:

```bash
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 a starter `wiki/` folder (`Person_Shape.md`, `Ethan_Davidson.md`). 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. Init requires a clean directory (no existing `wiki.yml`, `README.md`, or non-empty `wiki/`). See [Wiki Subcommand init](Wiki_Subcommand_init.md) for all flags.

### Branding

Styling and branding (such as site name, theme color, logo, and favicon) are not managed by the CLI out-of-the-box, which outputs plain, unstyled HTML. To add custom styling, write a custom layout template file and place custom assets under the `wiki.assets` directory, then configure `site.layout` in your `wiki.yml`. See [Wiki Configuration — Custom CSS](Wiki_Configuration.md#custom-css) and [Wiki Subcommand init](Wiki_Subcommand_init.md).

Alternatively, start from a GitHub template: [wiki-template](https://github.com/wazootech/wiki-template) (generic wiki project) or the [LLM Wiki](LLM_Wiki.md) starter [llm-wiki-template](https://github.com/wazootech/llm-wiki-template). See [Wiki CLI templates](Wiki_CLI.md#ecosystem-templates).

## Daily workflow

```bash
# 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:

```bash
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](Deploying_to_GitHub_Pages.md) for the GitHub Actions workflow.

## Agent skills

Coding agents can use the consolidated **`wiki`** skill documented in [Wiki Skills](Wiki_Skills.md).

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

```bash
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 CLI](Wiki_CLI.md) — command reference home
- [Wiki Configuration](Wiki_Configuration.md) — tune `wiki`, `graph`, `site`, `link`, and check severities
- [Style Guide](Style_Guide.md) — document types, shapes, and wikilinks
- [Wiki Subcommand check](Wiki_Subcommand_check.md) — integrity validation and CI checks
- [Wiki Subcommand lint](Wiki_Subcommand_lint.md) — convention audits (broken links, filenames, headings)
- [Wiki Subcommand query](Wiki_Subcommand_query.md) — ad-hoc SPARQL from the terminal
- [Wiki Subcommand render](Wiki_Subcommand_render.md) — refresh inline SPARQL tables
- [Wiki Subcommand serve](Wiki_Subcommand_serve.md) — local preview and optional SPARQL endpoint
- [Wiki Subcommand build](Wiki_Subcommand_build.md) — static HTML for deployment
- [Graph Cache](Graph_Cache.md) — graph reuse and `--cache`

Metadata: Getting Started

RDF representation compiled from frontmatter

{
  "@context": {
    "schema": "https://schema.org/",
    "wiki": "https://wazootech.github.io/wiki/"
  },
  "@id": "wiki:Getting_Started",
  "@type": "schema:TechArticle",
  "schema:description": "Install the wiki CLI and scaffold a new wiki.",
  "schema:headline": "Getting Started"
}

@prefix schema: <https://schema.org/> .
@prefix wiki: <https://wazootech.github.io/wiki/> .

wiki:Getting_Started a schema:TechArticle ;
    schema:description "Install the wiki CLI and scaffold a new wiki." ;
    schema:headline "Getting Started" .

@prefix schema: <https://schema.org/> .
@prefix wiki: <https://wazootech.github.io/wiki/> .

wiki:Getting_Started a schema:TechArticle ;
    schema:description "Install the wiki CLI and scaffold a new wiki." ;
    schema:headline "Getting Started" .

<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:schema="https://schema.org/"
>
  <rdf:Description rdf:about="https://wazootech.github.io/wiki/Getting_Started">
    <rdf:type rdf:resource="https://schema.org/TechArticle"/>
    <schema:headline>Getting Started</schema:headline>
    <schema:description>Install the wiki CLI and scaffold a new wiki.</schema:description>
  </rdf:Description>
</rdf:RDF>

<https://wazootech.github.io/wiki/Getting_Started> <https://schema.org/headline> "Getting Started" .
<https://wazootech.github.io/wiki/Getting_Started> <https://schema.org/description> "Install the wiki CLI and scaffold a new wiki." .
<https://wazootech.github.io/wiki/Getting_Started> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .

@prefix schema: <https://schema.org/> .
@prefix wiki: <https://wazootech.github.io/wiki/> .

_:N52afdb8ba43444d7966999999c379ef5 {
    wiki:Getting_Started a schema:TechArticle ;
        schema:description "Install the wiki CLI and scaffold a new wiki." ;
        schema:headline "Getting Started" .
}

<https://wazootech.github.io/wiki/Getting_Started> <https://schema.org/headline> "Getting Started" .
<https://wazootech.github.io/wiki/Getting_Started> <https://schema.org/description> "Install the wiki CLI and scaffold a new wiki." .
<https://wazootech.github.io/wiki/Getting_Started> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .