Skip to content

Getting Started

m4bwav edited this page Oct 4, 2026 · 1 revision

wikiwright is one folder, skills/wikiwright, holding SKILL.md, its references/, the verification templates/ and the helper scripts/wikiwright.py. Each install route below puts that folder where an agent looks for skills.

What it needs

  • An agent that reads SKILL.md skills. Claude Code is the one it was built and tested with; any other agent that loads Agent Skills can read the folder, but none was tested for this wiki.
  • Python 3.9 or later as python (or python3 on macOS and Linux) for the helper. It imports only the standard library. The examples on this wiki ran on Windows 11 with Python 3.14.6 and again with 3.9.25; the only differences were in argparse's layout of the help text. The repository's CI runs the tests on Ubuntu, macOS and Windows with Python 3.9 and 3.13.
  • git, to clone and push the wiki repository.
  • The GitHub CLI, gh, logged in, for preflight (it calls gh repo view and, with --enable, gh repo edit).
  • For the verification run itself, whatever the package needs: Node.js for an npm package, the .NET 10 SDK for a NuGet package. The helper does not need either.

Claude Code, as a plugin

The repository is its own marketplace: .claude-plugin/marketplace.json declares a marketplace named wikiwright with one plugin, wikiwright, so the install name is wikiwright@wikiwright. From a terminal:

$ claude plugin marketplace add https://github.com/m4bwav/wikiwright.git
Clone complete, validating marketplace…
Cleaning up old marketplace cache…
✔ Successfully added marketplace: wikiwright (declared in user settings)
$ claude plugin install wikiwright@wikiwright
Installing plugin "wikiwright@wikiwright"...✔ Successfully installed plugin: wikiwright@wikiwright (scope: user)
$ claude plugin list
  ❯ wikiwright@wikiwright
    Version: 0.9.0
    Scope: user
    Status: ✔ enabled

That ran with Claude Code 2.1.281. Inside a Claude Code session the same two steps are /plugin marketplace add https://github.com/m4bwav/wikiwright.git and /plugin install wikiwright@wikiwright (not run for this wiki).

The short form claude plugin marketplace add m4bwav/wikiwright also worked on that machine and cloned over HTTPS. If it fails with an SSH host key error on yours, use the HTTPS URL above. On Windows the clone can also fail with "Filename too long"; the FAQ has the cause and the fix.

From a clone instead, as the README shows:

git clone https://github.com/m4bwav/wikiwright
claude plugin marketplace add ./wikiwright
claude plugin install wikiwright@wikiwright

GitHub Copilot and other agents

Copy or link skills/wikiwright into the folder your agent reads skills from:

git clone https://github.com/m4bwav/wikiwright.git
cp -r wikiwright/skills/wikiwright ~/.agents/skills/wikiwright

The README names ~/.claude/skills/ and ~/.agents/skills/; use whichever your agent reads, or its own skills folder. A link in place of a copy picks up a git pull without copying again. Loading the skill in Copilot, Codex or Cursor was not tested for this wiki.

gh skill install

GitHub CLI 2.90 and later have a gh skill command group, still in preview. gh skill install m4bwav/wikiwright asks which skill and which agent; without a terminal to ask in, name the skill. On 2026-10-03, gh 2.100.0 installed it into a scratch folder:

$ gh skill install m4bwav/wikiwright wikiwright --dir ghs
Using ref v0.9.0 (a809eff1)

! Skills are not verified by GitHub and may contain prompt injections, hidden instructions, or malicious scripts. Always review skill contents before use.

✓ Installed wikiwright (from m4bwav/wikiwright@v0.9.0) in ghs

gh took the latest release tag, v0.9.0, which is the same commit as master today. It adds a metadata block to the frontmatter of the installed SKILL.md (the repository, path, ref, tree SHA and version), which gh skill update uses; the other files are copied as they are. Installing for a named agent with --agent and --scope was not tested.

A first command

Any install leaves the helper at scripts/wikiwright.py inside the skill folder. From a clone of the repository, check the sample wiki the tests use:

$ python skills/wikiwright/scripts/wikiwright.py --version
0.9.0
$ python skills/wikiwright/scripts/wikiwright.py check tests/fixtures/good-wiki --version 1.2.0
check: 3 pages, 0 errors, 0 warnings
$ echo $?
0

Then, in the repository you want a wiki for, ask the agent: "write a wiki for this repo". Its first step is preflight, and if the wiki has never had a page it asks you for one click on GitHub (How the skill works).

The private overlay

Machine paths, identities and your list of wikis done and owed stay out of the repository. Put them in a markdown file and point the skill at it with the WIKIWRIGHT_OVERLAY environment variable, or save it as ~/.wikiwright/OVERLAY.md. The overlay wins over the skill's defaults. Without one, the defaults stand.

Uninstalling

  • Claude Code: claude plugin uninstall wikiwright@wikiwright, and claude plugin marketplace remove wikiwright to drop the marketplace (not tested).
  • A copied or linked folder: delete it.
  • gh: delete the folder it installed into (not tested).

Clone this wiki locally