Shared Wiki

A small Markdown wiki with a CLI and MCP server. Search linked notes, read context, queue review questions, capture feedback, and propose edits without overwriting existing notes. Proposals record the target's content hash for stale-edit checks.

Philosophy · Architecture and compatibility · Roadmap.

Input and attention plan maps the next additions across the repository.

Requires Python 3.11+. From a checkout or unpacked source distribution:

python3 -m venv .venv
.venv/bin/python -m pip install -e .
cp -R examples/vault vault
.venv/bin/shared-wiki validate
.venv/bin/shared-wiki search "storage"
.venv/bin/shared-wiki queue

Use --vault PATH (before the command) or WIKI_VAULT for another vault. Notes use YAML frontmatter (id, title, created, updated), millisecond timestamps, and [[note.name]] links; see examples.

For an MCP host, launch .venv/bin/shared-wiki-mcp --vault /absolute/path/to/vault over stdio. Writes create separate inbox or proposal notes. Applying proposals, remote synchronization, and Slack/GitHub connectors are not implemented.

PYTHONDONTWRITEBYTECODE=1 .venv/bin/python -m unittest discover -s tests -v

Source distributions include the design docs, tests, and synthetic example vault. Wheels contain only the runtime package and package metadata; provide your own vault when installing a wheel.

Licensed under Apache 2.0.