Aidocs CLI – Automatisierte Dokumentation für Front- und Backend

Aidocs CLI ist ein KI‑gestütztes Tool zur automatischen Erstellung von Dokumentation, das Code, Screenshots und UI‑Interaktionen verknüpft, um präzise und stets aktuelle Anleitungen für End‑User und Entwickler zu liefern.

Key Takeaway

Aidocs CLI ist ein KI‑gestütztes Tool zur automatischen Erstellung von Dokumentation, das Code, Screenshots und UI‑Interaktionen verknüpft, um präzise und stets aktuelle Anleitungen für End‑User und Entwickler zu liefern.

Summary

• Ziel und Funktionsweise – Kombiniert drei Quellen: Vision Analysis, Codebase Analysis und Interactive Exploration.
• Installation – macOS/Linux: brew install binarcode/aidocs/aidocs; Python/uv: uv tool install aidocs; pipx: pipx install aidocs; GitHub: uv tool install aidocs --from git+https://github.com/binarcode/aidocs-cli.git; Update: brew upgrade aidocs, aidocs update [--github].
• Setup / Initialisierung – aidocs init .; Optional: --force, --ai cursor; aidocs check prüft Abhängigkeiten.
• Verwendungsflüsse – Dokumentieren einzelner Seiten, Feature‑Flows, das ganze Projekt oder Aktualisierung.
• Semantische Suche (RAG) – /docs:rag für Chunking, Embeddings und pgvector‑DB‑Migration.

Output

Dateien unter docs/ (z. B. docs/users/index.md) und Screenshots im images/‑Ordner. Entwickler‑Dokumente durch --technical (Code‑Snippets, Mermaid‑Diagramme). Live‑Serve: aidocs serve (MkDocs Material).

CLI‑Befehle

Beispiele: aidocs init, aidocs check, aidocs version, aidocs update, aidocs serve.

Related queries

• Welche Befehle benötigt man, um bei aidocs-CLI die Dokumentation für eine einzelne Seite zu erstellen?
• Wie kann ich die Dokumentation nach jeder Codeänderung automatisch aktualisieren?
• Was macht der Befehl /docs:rag und wie wird er eingesetzt?

Quelle: https://github.com/BinarCode/aidocs-cli