deepwiki-rs
Generuj dokumentację architektury i analizuj kod za pomocą AI — bez ręcznego pisania
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Deepwiki-rs to narzędzie do automatycznego generowania dokumentacji technicznej z analizy kodu źródłowego. Wykorzystuje AI do tworzenia diagramów C4, opisów architektury i specyfikacji technicznych na podstawie całej bazy kodu. Obsługuje Rust, Python, Java, Go, C# i JavaScript/TypeScript. Idealne dla zespołów, które chcą szybko udokumentować złożone systemy bez ręcznego opisywania każdego modułu.
Jak używać
Przygotuj ścieżkę do katalogu z kodem źródłowym, który chcesz przeanalizować (np. ./src lub ./project).
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.
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.
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.
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.
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.