TechArticle

wiki init

Infobox

headline: wiki init
description: Scaffold wiki.yml and starter wiki pages interactively.

Create a new workspace in the current directory: wiki.yml, README.md, layouts/, and starter files under wiki/.

Does not use loaded Config; safe to run before a config exists.

Usage

wiki init
wiki init --force
wiki init --git
wiki init --repo wazootech/wiki
wiki init --graph-context-wiki https://example.org/mywiki/ --site-base-url /mywiki

Options

Flag	Description
`--force`	Overwrite existing `wiki.yml`, `README.md`, starter `wiki/` files, and seeded layout files (`layouts/wikipedia.html` and `assets/wikipedia.css` when `--site-layout wikipedia`)
`--git`	Run `git init` after scaffolding
`--repo`	GitHub `owner/repo`; infer `graph.context.wiki` and `site.base_url` for GitHub Pages
`--graph-context-wiki`	Override `graph.context.wiki` (overrides `--repo` inference)
`--site-base-url`	Override `site.base_url` (default `/wiki` or inferred from `--repo`)
`--site-url-style`	Override `site.url_style`: `dir` or `file` (default `dir`)
`--graph-content-predicate`	Override `graph.content_predicate` CURIE (e.g. `schema:articleBody`)
`--link-style`	Override `link.style`: standard page links (`standard`) or wikilinks (`wikilink`)
`--site-name`	First letter used in `assets/logo.svg` only (default name `Wiki CLI` → `W`); does not change copied layout title, sidebar label, or search placeholder; not written to `wiki.yml`
`--wiki-inputs`	Override `wiki.inputs` list (can be specified multiple times, default `[wiki]`)
`--graph-base-iri`	Override `graph.base_iri` URI
`--site-theme-color`	Logo gradient at init only (e.g. `#3b82f6`; not written to `wiki.yml`)
`--graph-implicit-types`	Override `graph.implicit_types` (can be specified multiple times)
`--graph-implicit-types-policy`	Override `graph.implicit_types_policy`: `fallback` or `append`
`--graph-include-file-extension`	Override `graph.include_file_extension` flag (defaults to `--no-graph-include-file-extension`)

URL resolution

When --graph-context-wiki is not passed, init resolves graph.context.wiki in this order:

--repo — GitHub Pages project site: https://{owner}.github.io/{repo}/ and site.base_url: /{repo} (accepts owner/repo, HTTPS, or SSH URLs).
Git remote — If .git already exists or --git was passed, parse git remote get-url origin when it points at GitHub.
Interactive prompt — Custom wiki namespace IRI (default https://wiki.example.org/).

--graph-context-wiki always wins over --repo and remote detection. --site-base-url overrides the inferred path from --repo.

Document subject IRIs default to graph.context.wiki. Set optional graph.base_iri in wiki.yml when auto-generated document IRIs must differ from the wiki: namespace (see Wiki Configuration).

Prompts

When no flag or git remote supplies graph.context.wiki, init prompts once:

Custom wiki namespace IRI (default https://wiki.example.org/) → wiki: in graph.context

Always includes schema, wiki, wazoo, foaf, dc, dcterms, sh, and xsd prefixes. The wazoo URI is fixed in the scaffold (https://schema.wazoo.dev/), like the other built-in prefixes.

Generated config

New workspaces receive a plain wiki.yml rendered from wiki.yml. Jinja variables (such as graph_context_wiki, site_base_url, graph_content_predicate, and link_style) map from init CLI flags into nested blocks.

For every key — schema default, whether init writes it, and which command audits it — see Wiki Configuration → Overview and the per-block defaults tables in Wiki Configuration.

Generated files

layouts/wikipedia.html and assets/wikipedia.css — copied when --site-layout wikipedia (default); full Vector layout with linked stylesheet. With --site-layout minimal, site.layout is omitted and the packaged index.html layout applies.
assets/logo.svg — starter sidebar logo; center glyph is the first letter of --site-name (default Wiki CLI → W); optional --site-theme-color sets the gradient. Sidebar label and search placeholder live in the packaged page layout.
README.md — starter workspace overview and common commands
wiki/Person_Shape.md — starter sh:NodeShape for schema:Person
wiki/Ethan_Davidson.md — starter schema:Person example

ContentsOn this page

[hide]

(Top)
Usage
Options
URL resolution
Prompts
Generated config
Generated files
Related

Backlinks

Categories:

TechArticle

Talk / Local Notes: wiki init

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

0 characters

View Source: wiki init

Raw Markdown source code of the document

# `wiki init`

Create a new workspace in the **current directory**: `wiki.yml`, `README.md`, `layouts/`, and starter files under `wiki/`.

Does not use loaded Config; safe to run before a config exists.

## Usage

```bash
wiki init
wiki init --force
wiki init --git
wiki init --repo wazootech/wiki
wiki init --graph-context-wiki https://example.org/mywiki/ --site-base-url /mywiki
```

## Options

| Flag                             | Description                                                                                                                                                                       |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--force`                        | Overwrite existing `wiki.yml`, `README.md`, starter `wiki/` files, and seeded layout files (`layouts/wikipedia.html` and `assets/wikipedia.css` when `--site-layout wikipedia`)   |
| `--git`                          | Run `git init` after scaffolding                                                                                                                                                  |
| `--repo`                         | GitHub `owner/repo`; infer `graph.context.wiki` and `site.base_url` for GitHub Pages                                                                                              |
| `--graph-context-wiki`           | Override `graph.context.wiki` (overrides `--repo` inference)                                                                                                                      |
| `--site-base-url`                | Override `site.base_url` (default `/wiki` or inferred from `--repo`)                                                                                                              |
| `--site-url-style`               | Override `site.url_style`: `dir` or `file` (default `dir`)                                                                                                                        |
| `--graph-content-predicate`      | Override `graph.content_predicate` CURIE (e.g. `schema:articleBody`)                                                                                                              |
| `--link-style`                   | Override `link.style`: standard page links (`standard`) or wikilinks (`wikilink`)                                                                                                 |
| `--site-name`                    | First letter used in `assets/logo.svg` only (default name `Wiki CLI` → `W`); does not change copied layout title, sidebar label, or search placeholder; not written to `wiki.yml` |
| `--wiki-inputs`                  | Override `wiki.inputs` list (can be specified multiple times, default `[wiki]`)                                                                                                   |
| `--graph-base-iri`               | Override `graph.base_iri` URI                                                                                                                                                     |
| `--site-theme-color`             | Logo gradient at init only (e.g. `#3b82f6`; not written to `wiki.yml`)                                                                                                            |
| `--graph-implicit-types`         | Override `graph.implicit_types` (can be specified multiple times)                                                                                                                 |
| `--graph-implicit-types-policy`  | Override `graph.implicit_types_policy`: `fallback` or `append`                                                                                                                    |
| `--graph-include-file-extension` | Override `graph.include_file_extension` flag (defaults to `--no-graph-include-file-extension`)                                                                                    |

## URL resolution

When `--graph-context-wiki` is not passed, init resolves `graph.context.wiki` in this order:

1. **`--repo`** — GitHub Pages project site: `https://{owner}.github.io/{repo}/` and `site.base_url: /{repo}` (accepts `owner/repo`, HTTPS, or SSH URLs).
1. **Git remote** — If `.git` already exists or `--git` was passed, parse `git remote get-url origin` when it points at GitHub.
1. **Interactive prompt** — **Custom wiki namespace IRI** (default `https://wiki.example.org/`).

`--graph-context-wiki` always wins over `--repo` and remote detection. `--site-base-url` overrides the inferred path from `--repo`.

Document subject IRIs default to `graph.context.wiki`. Set optional `graph.base_iri` in `wiki.yml` when auto-generated document IRIs must differ from the `wiki:` namespace (see [Wiki Configuration](Wiki_Configuration.md)).

## Prompts

When no flag or git remote supplies `graph.context.wiki`, init prompts once:

1. **Custom wiki namespace IRI** (default `https://wiki.example.org/`) → `wiki:` in `graph.context`

Always includes `schema`, `wiki`, `wazoo`, `foaf`, `dc`, `dcterms`, `sh`, and `xsd` prefixes. The `wazoo` URI is fixed in the scaffold (`https://schema.wazoo.dev/`), like the other built-in prefixes.

## Generated config

New workspaces receive a plain `wiki.yml` rendered from [`wiki.yml`](https://github.com/wazootech/wiki/blob/main/src/wiki/templates/wiki.yml). Jinja variables (such as `graph_context_wiki`, `site_base_url`, `graph_content_predicate`, and `link_style`) map from init CLI flags into nested blocks.

For every key — schema default, whether init writes it, and which command audits it — see [Wiki Configuration → Overview](Wiki_Configuration.md#overview) and the per-block defaults tables in [Wiki Configuration](Wiki_Configuration.md).

## Generated files

- `layouts/wikipedia.html` and `assets/wikipedia.css` — copied when `--site-layout wikipedia` (default); full Vector layout with linked stylesheet. With `--site-layout minimal`, `site.layout` is omitted and the packaged `index.html` layout applies.
- `assets/logo.svg` — starter sidebar logo; center glyph is the first letter of `--site-name` (default `Wiki CLI` → `W`); optional `--site-theme-color` sets the gradient. Sidebar label and search placeholder live in the packaged page layout.
- `README.md` — starter workspace overview and common commands
- `wiki/Person_Shape.md` — starter `sh:NodeShape` for `schema:Person`
- `wiki/Ethan_Davidson.md` — starter `schema:Person` example

## Related

- [Getting Started](Getting_Started.md)
- [Wiki Configuration](Wiki_Configuration.md)
- [Wiki Page Layouts](Wiki_Page_Layouts.md)

Metadata: wiki init

RDF representation compiled from frontmatter

{
  "@context": {
    "schema": "https://schema.org/",
    "wiki": "https://wazootech.github.io/wiki/"
  },
  "@id": "wiki:Wiki_Subcommand_init",
  "@type": "schema:TechArticle",
  "schema:description": "Scaffold wiki.yml and starter wiki pages interactively.",
  "schema:headline": "wiki init"
}

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

wiki:Wiki_Subcommand_init a schema:TechArticle ;
    schema:description "Scaffold wiki.yml and starter wiki pages interactively." ;
    schema:headline "wiki init" .

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

wiki:Wiki_Subcommand_init a schema:TechArticle ;
    schema:description "Scaffold wiki.yml and starter wiki pages interactively." ;
    schema:headline "wiki init" .

<?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_init">
    <rdf:type rdf:resource="https://schema.org/TechArticle"/>
    <schema:headline>wiki init</schema:headline>
    <schema:description>Scaffold wiki.yml and starter wiki pages interactively.</schema:description>
  </rdf:Description>
</rdf:RDF>

<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <https://schema.org/headline> "wiki init" .
<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .
<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <https://schema.org/description> "Scaffold wiki.yml and starter wiki pages interactively." .

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

_:Nd0efe8aeabc043fc9d46c4578d826921 {
    wiki:Wiki_Subcommand_init a schema:TechArticle ;
        schema:description "Scaffold wiki.yml and starter wiki pages interactively." ;
        schema:headline "wiki init" .
}

<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <https://schema.org/headline> "wiki init" .
<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://schema.org/TechArticle> .
<https://wazootech.github.io/wiki/Wiki_Subcommand_init> <https://schema.org/description> "Scaffold wiki.yml and starter wiki pages interactively." .