deepwiki-rs

AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.

1. Przygotuj ścieżkę do katalogu z kodem źródłowym, który chcesz przeanalizować (np. ./src lub ./project).

2. Uruchom podstawową analizę kodu poleceniem deepwiki-rs -p ./src, gdzie ./src to ścieżka do Twojego projektu. Narzędzie przeskanuje strukturę kodu i wygeneruje dokumentację w domyślnym katalogu ./litho.docs.

3. Jeśli chcesz pełną dokumentację z diagramami C4 i szczegółową architekturą, użyj polecenia deepwiki-rs -p ./project --model-efficient gpt5-mini --model-powerful gpt5. Parametr --model-efficient przyspiesza analizę, a --model-powerful generuje bardziej szczegółowe opisy.

4. Sprawdź wygenerowaną dokumentację w katalogu wyjściowym. Struktura zawiera przegląd projektu, opis architektury, przegląd przepływów pracy i sekcję Deep Dive z szczegółowymi opisami poszczególnych komponentów.

5. Aby zmienić lokalizację plików wyjściowych, dodaj parametr -o /twoja/sciezka. Na przykład deepwiki-rs -p ./src -o ./docs/generated umieści dokumentację w katalogu ./docs/generated.

6. Zintegruj narzędzie z pipelineami CI/CD, aby dokumentacja generowała się automatycznie przy każdym commicie. Pozwala to na bieżące śledzenie zmian w architekturze i strukturze kodu.