skills.rest
ahmedemad3
ahmedemad3COMMUNITY
Explore all skills by this author →
GitHub

arch-wiki

Scans backend codebases to sync architecture.json and generate an interactive HTML documentation dashboard.

198|22|Updated Jul 26, 2026
Search Tags:#ai context#swagger#mermaid diagrams#api documentation#architecture documentation#codebase scanner#docker topology
One-click install
npx skills add https://github.com/ahmedemad3/arch-wiki --skill arch-wiki-ahmedemad3
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: arch-wiki
Source: https://github.com/ahmedemad3/arch-wiki
Command: npx skills add https://github.com/ahmedemad3/arch-wiki --skill arch-wiki-ahmedemad3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping architecture documentation in sync with a changing codebase is tedious and error-prone. This Skill scans your project for modules, endpoints, Docker services, SQL queries, and permissions, then maintains a machine-readable architecture.json manifest and regenerates a self-contained interactive HTML dashboard. ## Core Features & Use Cases - Automated Codebase Scanning: Detects API routes, Docker topology, permissions, and SQL queries across frameworks like Express, NestJS, FastAPI, Django, and Spring Boot with zero external dependencies. - Interactive HTML Dashboard: Generates a single-file dashboard with Mermaid architecture diagrams, Swagger UI, RBAC permission mapping, SQL query catalog, and one-click PDF export. - AI Context Optimization: Produces architecture.json as a compact index so AI coding assistants can understand your system in one file read instead of scanning hundreds of source files. - Use Case: After adding a new orders module with endpoints and permissions, ask your AI assistant to run the skill; it updates architecture.json and rebuilds the dashboard automatically. ## Quick Start Ask your AI assistant to run the arch-wiki skill on this project to generate the architecture documentation dashboard.

Frequently Asked Questions about arch-wiki

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate architecture documentation from my codebase automatically?▼

Invoke the arch-wiki skill through your AI assistant after installing SKILL.md into your tool's skills folder. It runs build_html.py with --init to scan routes, docker-compose.yml, and package.json, producing architecture.json and an interactive HTML dashboard.

What frameworks does this architecture documentation tool support?▼

It supports Express, NestJS, Fastify, FastAPI, Django, Flask, Rails, Laravel, Spring Boot, and Go frameworks. The scanner adapts route file detection patterns based on the detected framework, such as *.routes.ts for Express or routers/*.py for FastAPI.

Does arch-wiki work with Claude Code, Cursor, and other AI assistants?▼

Yes, it works with Antigravity, Claude Code, Cursor, OpenAI Codex, OpenCode, and any assistant that can read files and run shell commands. You copy SKILL.md into the tool's skills or rules directory and reference it in prompts.

What Python dependencies are required to run the dashboard generator?▼

None beyond the standard library. The build_html.py script uses only json, re, os, sys, and datetime, so it runs on Python 3.8+ without any pip installs.

Why does the Docker Topology tab show an empty placeholder?▼

The placeholder appears when dockerDiagram.nodes in architecture.json is empty, meaning no docker-compose.yml was found or no services were detected. Add Docker services to your compose file and rerun the sync to populate the diagram.

What are the limitations of AI-generated architecture manifests?▼

If architecture.json contains inaccurate or inferred entries, AI assistants may propagate those errors instead of verifying against source code. The manifest should be reviewed for accuracy, especially after automated scans of unusual project structures.

Related Skills

Explore More Software Engineering Skills→
hamzaPixlhamzaPixl
2

pm2

Generate PM2 ecosystem configuration and Makefile shortcuts for multi-service projects.

Community
Intermediate
TheGrowthExponentTheGrowthExponent

Databricks Skills Reference

Organize Databricks development references across 24 skills and patterns.

Official
Intermediate
jaktestowacjaktestowac
113

testing-api-contracts

Validates API responses against OpenAPI or JSON Schema and classifies spec changes as safe, risky, or breaking.

Community
Advanced
yejuneyejune

{{persona::BRAND}}-docs-generation

Generate technical documentation from source code and OpenAPI specifications.

Community
Intermediate