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 AI harnesses
uvx wiki-spaces init ~/Wiki              # scaffold + register as default target
uvx wiki-spaces doctor --no-net          # verify

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              # report ## Spaces drift

space add and space remove 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 a markdown-aware MCP backend (markdown-vault-mcp, mdkb, sqmd, or qmd) — 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.4.0.tar.gz (68.5 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.4.0-py3-none-any.whl (88.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wiki_spaces-0.4.0.tar.gz
  • Upload date:
  • Size: 68.5 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.4.0.tar.gz
Algorithm Hash digest
SHA256 bd80346d3de225c878444425aceca15e74890bfa22fa6fb9591842e17e6c9b68
MD5 2e26a9d66b2b8eb6b3157eb00700dfe0
BLAKE2b-256 bc6bc783295f0b792bf3669d8516af42e496319a8eab857ced6bec6bfc6debd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for wiki_spaces-0.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: wiki_spaces-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 88.5 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2997fb4cc9ef4052693acda7b67f97d0aaa90b65c9152e5dffc400e33d6024d0
MD5 1925022e8e04206605d35ac8f7999052
BLAKE2b-256 22907730c61b97cf3f4891ab19b27eb5deaa264f1cf4b448d297add0e8b0c369

See more details on using hashes here.

Provenance

The following attestation bundles were made for wiki_spaces-0.4.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