Skip to main content

Minimal nestable wiki for AI coding harnesses with filesystem access (Claude Code, Codex, Cursor, Windsurf, etc.). A folder + index.md, for any use case (notes, research, recipes, writing, team docs). Spec, conventions catalog, and reference skills. Out of scope: browser-only AI assistants.

Project description

wiki-spaces

A minimal nestable wiki — a folder with index.md, for any use case. Research, recipes, code notes, writing, team docs, a personal life wiki — your shape, your call.

Markdown flavor is Obsidian — wikilinks, frontmatter, callouts, embeds, comments, Bases. One dialect across the spec, the skills, and the tools. Non-Obsidian renderers (GitHub preview, vanilla VS Code, plain markdown viewers) display the content but will not render Obsidian-specific syntax (provenance comments, embeds, .base files) the way Obsidian does — view your wiki in Obsidian for full fidelity.

Audience

wiki-spaces is built for AI coding harnesses with filesystem access — Claude Code, Codex, Cursor, Windsurf, Gemini CLI, Aider, and similar tools that read and write local files. Browser-only AI assistants (ChatGPT in a tab, Claude.ai web) are out of scope: they can't reach the filesystem to read or write your wiki. If your AI lives in a browser, this isn't the tool.

The shape of the wiki — research notes, recipes, journal, team reference, anything — is yours. The harness that drives it is what wiki-spaces assumes you have.

Start

mkdir -p ~/Wiki && echo "# My Wiki" > ~/Wiki/index.md

That's a complete wiki. Add files, folders, anything. The whole spec is one page: AGENTS.md.

Optional tooling

For AI agents to find and act on your wiki, install the helper:

uvx wiki-spaces install                  # link skills into detected harnesses
uvx wiki-spaces init ~/Wiki              # scaffold + register as default target
uvx wiki-spaces doctor --no-net          # verify

install auto-detects and links the skills into whichever of Claude Code, Codex, Gemini CLI, Antigravity, Hermes, and Kiro are present (--all pre-positions for every one). Cursor, Windsurf, GitHub Copilot, and Aider have no global skills directory — they integrate via a rule-file snippet instead (see What you get).

Or pip install wiki-spaces (or uv tool install wiki-spaces) and drop the uvx prefix.

Also available:

uvx wiki-spaces space add projects/foo   # create a space + register it
uvx wiki-spaces space audit              # audit drift, broken links, orphans
uvx wiki-spaces space mount <url> shared/team --as submodule   # mount an external space

space add, space remove, and space mount require a ## Spaces section in the parent's index.md (the navigability contract). Wikis scaffolded via wiki-spaces init get this automatically. Hand-rolled mkdir + echo wikis are Tier 1 and need ## Spaces added to index.md first — either by wiki-spaces init (which registers the wiki in your config) or by editing the file directly.

Let an AI agent do the setup

Paste this to your agent:

Install and set up wiki-spaces for me by following the instructions here:
https://raw.githubusercontent.com/anfreire/wiki-spaces/main/references/SETUP.md

The agent picks tailored defaults, scaffolds, links the skills into your harness, and writes the config.

What you get

Three reference skills your AI agent uses to work with the wiki:

  • wiki-search — find content
  • wiki-update — capture / save / sync
  • wiki-tend — audit, normalize tags, cross-link

For Cursor / Windsurf / Copilot / Aider (no skills concept), see references/HARNESS_INTEGRATION.md. The fastest path is wiki-spaces install --bridge <key> (emits the rule snippet to stdout — pipe it into your project's rules file).

Search at scale

wiki-search works out of the box with grep / ripgrep, which is fine for personal/team wikis up to a few hundred pages. For larger vaults, install qmd — the markdown-aware MCP backend Andrej Karpathy references in the canonical LLM-wiki gist. See CONVENTIONS.md § Recommended search backends.

Learn more

Dependencies

Python >=3.11. uv recommended (handles Python provisioning). git optional.

Prior art

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wiki_spaces-0.5.0.tar.gz (74.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wiki_spaces-0.5.0-py3-none-any.whl (94.3 kB view details)

Uploaded Python 3

File details

Details for the file wiki_spaces-0.5.0.tar.gz.

File metadata

  • Download URL: wiki_spaces-0.5.0.tar.gz
  • Upload date:
  • Size: 74.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wiki_spaces-0.5.0.tar.gz
Algorithm Hash digest
SHA256 8dc02b47f9289bdd35823352894da69f745da3e818a4b51ea28c339ef5731288
MD5 bb1aa3664ce498d9328aa908877a2d61
BLAKE2b-256 6da751f0fcaae06eee38a7ea8c82542e02dc1bf08e49e78301fda6136408e85e

See more details on using hashes here.

Provenance

The following attestation bundles were made for wiki_spaces-0.5.0.tar.gz:

Publisher: release.yml on anfreire/wiki-spaces

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wiki_spaces-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: wiki_spaces-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 94.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wiki_spaces-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bce125eb772e799760c05c6b5a14f81262a90cf4c7e6a7f708709ffba0c51824
MD5 d6ffd90a0459944f80aedf202b21fd92
BLAKE2b-256 eba68d4b72c8159cf7ec467d9760f514ce1bc21f2bf886b19987d9bc2b55e806

See more details on using hashes here.

Provenance

The following attestation bundles were made for wiki_spaces-0.5.0-py3-none-any.whl:

Publisher: release.yml on anfreire/wiki-spaces

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page