TechArticle

wiki check

Infobox

headline: wiki check
description: Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter.

Run integrity checks on the wiki: strict SHACL validation, JSON Schema frontmatter validation, route safety, output collisions, and layout frontmatter contracts.

Exits 0 silently on success unless -v is set. See Design Philosophies.

Usage

wiki check
wiki check wiki/Some_Page.md
wiki check wiki/A.md wiki/B.md
wiki check -v
wiki check --strict

Options

Flag	Description
`FILE...`	Optional documents; otherwise entire wiki (scoped mode: SHACL + JSON Schema per file)
`-v`, `--verbose`	Print warnings
`--strict`	Treat warnings as errors (exit 1)

What is checked

Full wiki (default)

wiki check with no FILE argument runs every check below.

Always errors (not configurable)

SHACL — shapes from wiki frontmatter (sh:NodeShape, etc.) on the full RDF graph
Route safety — unsafe path segments (spaces, reserved characters, and similar)
Output collisions — two wiki sources mapping to the same built URL (against default _site layout)

Configurable (`check.*` in `wiki.yaml`)

Rule key	What it audits
`missing_layout_file`	`wazoo:layout` paths that do not resolve to a readable `.html` file
`frontmatter_schema`	Frontmatter that fails JSON Schema validation
`missing_schema_ref`	`wazoo:jsonSchema` paths or URLs that cannot be loaded
`remote_schema_refs`	Policy for remote schema URLs: `allow`, `deny`, or `allowlist`
`remote_schema_hosts`	Hostnames allowed when `remote_schema_refs` is `allowlist`

Default: missing_layout_file, frontmatter_schema, and missing_schema_ref are error. remote_schema_refs defaults to allow.

JSON Schema frontmatter

Bind schemas on sh:NodeShape documents with wazoo:jsonSchema and sh:targetClass. Type-level schemas apply to every matching page; pages may append extra schemas with their own wazoo:jsonSchema (string or list). Local refs resolve under the wiki config root; remote http(s) URLs are fetched at check time unless check.remote_schema_refs is deny or the host is outside check.remote_schema_hosts when using allowlist. Shape binding documents are excluded from instance validation. See SHACL and Style Guide.

Broken links, filename pattern, and heading style are not part of wiki check — use Wiki Subcommand lint.

Scoped mode (one or more FILE args)

wiki check path/to/Page.md (or multiple paths) runs SHACL and JSON Schema per file. Route safety, output collisions, and layout frontmatter rules are full-wiki only. Cross-document SHACL interactions may only appear in a full-wiki check. Broken links on those pages require wiki lint with the same paths.

--strict applies only when warnings exist; scoped mode does not emit warnings today.

Command	Purpose
`wiki lint --strict`	Broken links, filename pattern, headings, link style
`wiki fmt --check`	mdformat consistency
`wiki render --check`	Stale inline SPARQL result blocks
`wiki link --check`	Remaining missing-wikilink opportunities

wiki build runs wiki lint then wiki check before writing output unless --no-check.

Wiki Configuration — check.* severities
SHACL — shape and JSON Schema binding
Wiki Subcommand lint — convention lane
Style Guide

ContentsOn this page

[hide]

(Top)
Usage
Options
What is checked
Full wiki (default)
Always errors (not configurable)
Configurable (check.* in wiki.yaml)
JSON Schema frontmatter
Scoped mode (one or more FILE args)
Related CI commands
Related

Backlinks

Categories:

TechArticle

Talk / Local Notes: wiki check

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

0 characters

View Source: wiki check

Raw Markdown source code of the document

# `wiki check`

Run **integrity** checks on the wiki: strict **SHACL** validation, **JSON Schema** frontmatter validation, route safety, output collisions, and layout frontmatter contracts.

Exits **0 silently** on success unless `-v` is set. See [Design Philosophies](Design_Philosophies.md).

## Usage

```bash
wiki check
wiki check wiki/Some_Page.md
wiki check wiki/A.md wiki/B.md
wiki check -v
wiki check --strict
```

## Options

| Flag              | Description                                                                           |
| ----------------- | ------------------------------------------------------------------------------------- |
| `FILE...`         | Optional documents; otherwise entire wiki (scoped mode: SHACL + JSON Schema per file) |
| `-v`, `--verbose` | Print warnings                                                                        |
| `--strict`        | Treat warnings as errors (exit 1)                                                     |

## What is checked

### Full wiki (default)

`wiki check` with no `FILE` argument runs every check below.

### Always errors (not configurable)

- **SHACL** — shapes from wiki frontmatter (`sh:NodeShape`, etc.) on the full RDF graph
- **Route safety** — unsafe path segments (spaces, reserved characters, and similar)
- **Output collisions** — two wiki sources mapping to the same built URL (against default `_site` layout)

### Configurable (`check.*` in `wiki.yaml`)

| Rule key              | What it audits                                                      |
| --------------------- | ------------------------------------------------------------------- |
| `missing_layout_file` | `wazoo:layout` paths that do not resolve to a readable `.html` file |
| `frontmatter_schema`  | Frontmatter that fails JSON Schema validation                       |
| `missing_schema_ref`  | `wazoo:jsonSchema` paths or URLs that cannot be loaded              |
| `remote_schema_refs`  | Policy for remote schema URLs: `allow`, `deny`, or `allowlist`      |
| `remote_schema_hosts` | Hostnames allowed when `remote_schema_refs` is `allowlist`          |

Default: `missing_layout_file`, `frontmatter_schema`, and `missing_schema_ref` are `error`. `remote_schema_refs` defaults to `allow`.

### JSON Schema frontmatter

Bind schemas on `sh:NodeShape` documents with `wazoo:jsonSchema` and `sh:targetClass`. Type-level schemas apply to every matching page; pages may append extra schemas with their own `wazoo:jsonSchema` (string or list). Local refs resolve under the wiki config root; remote `http(s)` URLs are fetched at check time unless `check.remote_schema_refs` is `deny` or the host is outside `check.remote_schema_hosts` when using `allowlist`. Shape binding documents are excluded from instance validation. See [SHACL](SHACL.md) and [Style Guide](Style_Guide.md#shacl-shapes).

Broken links, filename pattern, and heading style are **not** part of `wiki check` — use [Wiki Subcommand lint](Wiki_Subcommand_lint.md).

### Scoped mode (one or more FILE args)

`wiki check path/to/Page.md` (or multiple paths) runs **SHACL and JSON Schema** per file. Route safety, output collisions, and layout frontmatter rules are **full-wiki only**. Cross-document SHACL interactions may only appear in a full-wiki check. Broken links on those pages require `wiki lint` with the same paths.

`--strict` applies only when warnings exist; scoped mode does not emit warnings today.

### Related CI commands

| Command               | Purpose                                              |
| --------------------- | ---------------------------------------------------- |
| `wiki lint --strict`  | Broken links, filename pattern, headings, link style |
| `wiki fmt --check`    | mdformat consistency                                 |
| `wiki render --check` | Stale inline SPARQL result blocks                    |
| `wiki link --check`   | Remaining missing-wikilink opportunities             |

`wiki build` runs `wiki lint` then `wiki check` before writing output unless `--no-check`.

## Related

- [Wiki Configuration](Wiki_Configuration.md) — `check.*` severities
- [SHACL](SHACL.md) — shape and JSON Schema binding
- [Wiki Subcommand lint](Wiki_Subcommand_lint.md) — convention lane
- [Style Guide](Style_Guide.md)

Metadata: wiki check

RDF representation compiled from frontmatter

{
  "@context": {
    "schema": "https://schema.org/",
    "wiki": "https://wazootech.github.io/wiki/"
  },
  "@id": "wiki:Wiki_Subcommand_check",
  "@type": "schema:TechArticle",
  "schema:description": "Integrity checks \u2014 SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter.",
  "schema:headline": "wiki check"
}

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

wiki:Wiki_Subcommand_check a schema:TechArticle ;
    schema:description "Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter." ;
    schema:headline "wiki check" .

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

wiki:Wiki_Subcommand_check a schema:TechArticle ;
    schema:description "Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter." ;
    schema:headline "wiki check" .

<?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/Wiki_Subcommand_check">
    <rdf:type rdf:resource="https://schema.org/TechArticle"/>
    <schema:headline>wiki check</schema:headline>
    <schema:description>Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter.</schema:description>
  </rdf:Description>
</rdf:RDF>

<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .
<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <https://schema.org/description> "Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter." .
<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <https://schema.org/headline> "wiki check" .

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

_:N513ead79a0674063b7c51a939538121b {
    wiki:Wiki_Subcommand_check a schema:TechArticle ;
        schema:description "Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter." ;
        schema:headline "wiki check" .
}

<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .
<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <https://schema.org/description> "Integrity checks — SHACL validation, JSON Schema frontmatter, route safety, and layout frontmatter." .
<https://wazootech.github.io/wiki/Wiki_Subcommand_check> <https://schema.org/headline> "wiki check" .