Zero-dependency agent-to-agent codebase wiki for LLMs and AI agents. Autonomously maintained via record-change and mark-green for token-efficient lookup of files, dependencies, health, and summaries — across tiny scripts to 50k+ monorepos. Optional MCP server with rich tools for agents.
Project description
Wikifier
Agent-to-Agent Codebase Wiki — Token-Efficient • Autonomous • Zero-Dependency
Wikifier gives AI agents and LLMs a living, queryable map of any codebase — from tiny scripts to 50k+ file monorepos — so they can look up files, imports, health status, and summaries without dumping full source into context.
The goal is token efficiency. It works as a token-saving agent-operated wiki layer that agents maintain themselves through a strict but lightweight workflow. Primary purpose: help LLMs and agents work on real codebases without wasting context on raw files they don't need right now.
Key capabilities flow naturally from this:
- Fast, targeted lookup through small
file_health.md,library.md(with Mermaid dependency graphs and summaries), per-file*.wiki.mdnotes, health matrix, barrel reports, and incremental status. - Autonomous maintenance: after editing source, agents use
record-change "the why"(this is mandatory) to log intent, thenmark-greenonce the wiki entry is updated. - Support for creating new wiki entries or docs on the fly during agent work.
- Works great with or without MCP. There's an optional
wikifier-mcpserver that provides rich tools such asget_project_status,get_dependencies,get_file_wiki,suggest_next_actions, andcheck_changes. - Handles large projects well thanks to incremental updates, directory scoping, and streaming modes. Everything is zero-dependency (pure Python + Bash).
Mandatory agent protocol (the exact loop agents should follow): check-changes → read the compact file_health.md + pending_updates.md → prioritize → edit → record-change → mark-green → update-maps when imports or structure change. The full LLM-ready details and examples live in skills/run.md (v0.5).
This entire project (including all the M5 dogfood evidence) was built and operated by agents using exactly this mode. It is deliberately not a general-purpose human documentation tool or IDE replacement — agent-to-agent first, always.
See --help, skills/run.md, and the MCP README for concrete usage.
Intended Use: Strictly Agent-to-Agent (Token-Saving)
This is meant strictly as an agent-to-agent wiki layer for token saving:
- Primary purpose: save tokens for agents/LLMs by letting them consult the health matrix, file wikis, barrels, and incremental status instead of re-reading full sources.
- Agents autonomously keep everything current: edit source →
record-change "the why"→ update the corresponding wiki entry →mark-green. - You can create new wiki-maintained files or docs as part of your agent sessions.
- Typical workflow: run
wikifier check-changes, read the smallfile_health.md+pending_updates.md, prioritize (🔴 then 🟡), do the work, record the change with intent, mark it green, and runupdate-mapswhen the dependency picture shifts. - It shouldn't be used for anything more than that. Not general human docs, not an IDE, not for broad non-agent use.
The exact loop and LLM workflow are documented in --help and skills/run.md. All the real-world M5+ evidence in Findings/ was produced by agents following this protocol precisely.
Status & Recent Changes
M5 broad real-world dogfood (85-90%+) on multiple external 5k–50k+ creative projects is complete. See Findings/M5-Dogfood-Progress.md, M5-Dogfood-Assessment-Report.md, and p6_real_world_validation_report.md for full agent diaries, metrics, 9 Guiding Principles traces, and the M5.3 plan.
Recent focus (v4.1.x):
- Human investigation layer separation (only the clean
index.htmlviewer is deployed to targets;diagnostics.htmlis maintainer-only). - Mapping & update speed hygiene (faster candidate collection with scandir + git fast-path, consistent excludes, parser micro-opts).
- Human dashboard UX: prominent Quick actions toolbar with copy-to-clipboard buttons for main commands (check-changes, update-maps, monitor &); big primary buttons in empty states for first-time setup; auto-copy of
wikifier update-mapscommand on first render of "no structure map yet" (session-guarded) so it feels automatic on first run of a fresh project. See v4.1.3 notes.
Full history moved to docs/ and Findings/. The project stays deliberately lean and agent-first.
v4.1.3 (2026-06): Human dashboard command buttons + first-run update-maps UX (very minor polish to the secondary human investigation layer).
- Added visible "Quick actions" bar with easy one-click copy buttons for the primary commands available to humans using the dashboard (check-changes, update-maps, start monitor). Feedback includes exact pasteable command + "run in this project folder then Refresh" guidance + manual refresh link.
- Enhanced empty states ("No structure map yet", "No files yet") with prominent primary buttons for the relevant commands (update-maps prioritized, combined first-time setup for files).
- "Automatically on first run": when the no-map empty state first appears in a browser session, the
wikifier update-mapscommand is auto-copied (guarded by sessionStorage) with a note, making the recommended first action feel automatic. Buttons + instructions guide the user to run in terminal and refresh/poll. - Existing "Rebuild tree" / "Update data" buttons now use the improved copy+feedback UX. Keeps the clean human view (no dense agent internals).
- All under protocol (FRESH, record+mark-green with subid=human-dashboard-commands). No new features or scope change. Complements the existing copy snapshot buttons and guidance.
v4.1.2 (2026-06): Speed improvements for updates on large projects (scandir/git fast-path in collectors, richer early pruning via exclude_patterns.txt, regex hoisting in parsers). Complements scoping, streaming budgets, and incremental dirty + barrel reverse index. No behaviour change.
v4.1.1: Human layer separation enforcement (only index.html copied on init).
v4.1.0: Structure cleanup (historical docs to docs/).
v4.0 + 4.0.1 + M5: Broad dogfood, MCP hardening, zero-dep enforcement, sustained monitor/subagent foundations. See Findings/ for details.
🚀 Installation
Installation & Quick Start (for Agents & Humans)
pip install wikifier
For a project (recommended for agents):
# 1. In the target project (or use WIKIFIER_PROJECT_ROOT)
wikifier init
# 2. Focus monitored_paths.txt for large repos (highly recommended)
# 3. Run the agent loop
wikifier check-changes
wikifier health --summary
# ... edit ...
wikifier record-change "path/to/file.py" "added feature X because Y (agent task Z)"
wikifier mark-green "path/to/file.py"
wikifier update-maps # when imports/structure changed
For MCP / AI agents (Claude Desktop, Cursor, Cline, etc.):
WIKIFIER_PROJECT_ROOT=/abs/path/to/your/project wikifier-mcp
Or pass project_root= on every tool call. Root detection priority: env var > explicit param > upward walk for markers > .mcp.json.
Full protocol, examples, and LLM workflow: skills/run.md (read this first as an agent).
What You Get
- Token-efficient lookup for agents (health matrix, library.md with Mermaid, file wikis, BRC, incremental status).
- Autonomous maintenance:
record-change(the "why") +mark-green. - Incremental + scoped + resumable for large codebases.
- Optional MCP server with 23+ tools for agents.
- Secondary clean
index.htmldashboard (after init) for humans browsing the agent's wiki (chart + file descriptions + copyable snapshots). - True zero dependencies.
See skills/run.md for the exact agent contract and wikifier/mcp/README.md for MCP setup.
Core Commands
| Command | Purpose |
|---|---|
wikifier check-changes |
Incremental scan + health/pending update |
wikifier record-change <file> "reason" |
Log why (required after edits) |
wikifier mark-green <file> |
Mark the wiki entry current |
wikifier update-maps |
Rebuild dependency graph + library.md |
wikifier health --summary |
Quick view (use for agents) |
wikifier monitor & |
Background incremental heartbeat |
For full power use the Python library (from wikifier import ...) or MCP tools directly.
Links
- GitHub: https://github.com/IronAdamant/wikifier
- PyPI: https://pypi.org/project/wikifier/
- Agent Protocol:
skills/run.md - MCP:
wikifier/mcp/README.md - Evidence:
Findings/(M5 dogfood etc.)
For AI search / agents: Wikifier is a zero-dependency, agent-maintained, token-saving codebase wiki with autonomous record-change / mark-green updates, MCP tools, and strong support for large monorepos via scoping and streaming.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wikifier-4.1.3.tar.gz.
File metadata
- Download URL: wikifier-4.1.3.tar.gz
- Upload date:
- Size: 372.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6eea08f010d0fe108e4221ea597975a934ed072a4b2bef06d49c86bf188b24a4
|
|
| MD5 |
044ac6d137f03a54aebc7b14c46fbf70
|
|
| BLAKE2b-256 |
4508ae97b2b41f8e235903a0f8d54d084ff00cb5c2e146f04a94b25b09dd5182
|
Provenance
The following attestation bundles were made for wikifier-4.1.3.tar.gz:
Publisher:
publish.yml on IronAdamant/wikifier
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wikifier-4.1.3.tar.gz -
Subject digest:
6eea08f010d0fe108e4221ea597975a934ed072a4b2bef06d49c86bf188b24a4 - Sigstore transparency entry: 1727325334
- Sigstore integration time:
-
Permalink:
IronAdamant/wikifier@1b3d88a13d0972f728009100d3f1e5008044e8b3 -
Branch / Tag:
refs/tags/v4.1.3 - Owner: https://github.com/IronAdamant
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1b3d88a13d0972f728009100d3f1e5008044e8b3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file wikifier-4.1.3-py3-none-any.whl.
File metadata
- Download URL: wikifier-4.1.3-py3-none-any.whl
- Upload date:
- Size: 335.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e96ca4128f0828ceb8bda04637ce664d093608251997654513844d0a5718de73
|
|
| MD5 |
f5c7637f5276029145bc7f9ccb607b18
|
|
| BLAKE2b-256 |
cbef1030dddafe58c3a9597e1ff1c8f855082d9ea453913afe87f17ba6a51749
|
Provenance
The following attestation bundles were made for wikifier-4.1.3-py3-none-any.whl:
Publisher:
publish.yml on IronAdamant/wikifier
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wikifier-4.1.3-py3-none-any.whl -
Subject digest:
e96ca4128f0828ceb8bda04637ce664d093608251997654513844d0a5718de73 - Sigstore transparency entry: 1727325393
- Sigstore integration time:
-
Permalink:
IronAdamant/wikifier@1b3d88a13d0972f728009100d3f1e5008044e8b3 -
Branch / Tag:
refs/tags/v4.1.3 - Owner: https://github.com/IronAdamant
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1b3d88a13d0972f728009100d3f1e5008044e8b3 -
Trigger Event:
push
-
Statement type: