arch-wiki skill
A skill keeps an architecture wiki current: it scans code and rebuilds one HTML dashboard with endpoints and Docker.
- 273 ★ on the repository
- Last commit
Minimal access
Why this level
- The agent reads source files and writes files into `docs/architecture`.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/arch-wikiDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewMinimal accessThe tool runs nothing and makes no network calls.
- The agent reads source files and writes files into `docs/architecture`.
This is third-party code. Review the repository files before installing.
What it does
arch-wiki is a skill that, on request, makes an agent read the `architecture.json` manifest, scan changed backend files and update the manifest. The `build_html.py` script then rebuilds one self-contained HTML file with API modules, endpoints, Docker topology, permissions, SQL queries and Swagger documentation. The first run creates the manifest itself: the scanner reads `docker-compose.yml`, route files such as `*.routes.ts` and `routers/*.py`, plus `package.json`. The manifest doubles as a project index for agents, so one file read replaces dozens, and each entry points to a source path.
Who it is for. Backend developers whose API and infrastructure documentation ages faster than the code, and teams whose agent needs a project map.
Good fit when
- An endpoint was added and the wiki should update itself.
- A new colleague needs a map of services and Docker topology.
- An agent burns tokens hunting for routes across hundreds of files.
- Permissions and SQL queries are gathered into one catalog for review.
- The architecture page should ship as one HTML file with no server.
Not a fit when
- The project has no backend and no API routes.
- Routes live at nonstandard paths the scanner does not find.
- External client documentation in an OpenAPI portal format is required.
Example request
Run the arch-wiki skill: I added an orders module, so update the manifest and rebuild the dashboard.Limitations
The auto-scanner targets typical layouts, including `docker-compose.yml`, Express and FastAPI routes, so review and complete the result. The README uses a placeholder `npx github:your-username/arch-wiki`, so substitute the real repository name. The `build_html.py` script is copied into your project's `docs/architecture`. Permissions and SQL queries from the code end up in a shared HTML file, so do not publish the page outside the team without review.
How to disable. Delete `~/.claude/skills/arch-wiki` (or the equivalent for your agent) and the `docs/architecture` folder in the project.
FAQ
What is the output?
A single self-contained `docs/architecture/architecture.html` file and an `architecture.json` manifest. The HTML is never edited by hand.
Which agents fit?
Claude Code, Cursor, Codex, OpenCode and Antigravity. The README shows setup for each.
Must I run Python myself?
No. The agent copies `build_html.py` into `docs/architecture` and runs it.
What does the dashboard cover?
Modules, endpoints, Mermaid diagrams, permissions, SQL queries and interactive Swagger, with a PDF export.
How does the manifest help an agent?
One read gives the agent modules, endpoints, queries and source paths without walking hundreds of files.
Discussion
No questions or reviews yet.
Related
SkillsA skill that draws an interactive isometric map of a repository: buildings sized by real code, flows traced along real calls.
A skill that renders a system architecture as one HTML page with pan, zoom, node focus and a light or dark theme.
An architecture coach skill: questions lead to ADRs, a diagram and a plan, and a repository is audited from its code
A skill maps project architecture, rules and proposed edit scope in an HTML page so users can approve a plan before code changes.
Builds interactive architecture diagrams in one HTML file: animated data flows, environment toggles and a step detail panel
Git-native project context for agents: specs, decisions and rules live in Markdown beside the code and are read before edits
README in short
The manifest comes from a zero-dependency scanner and is completed by the agent. Duplicates from `dist/`, `build/` and `node_modules/` are filtered out.