sopaco/deepwiki-rs

Litho (deepwiki‑rs) – Rust로 작성된 AI 기반 문서 생성기

무엇을 하는가 – Litho는 전체 소스코드 리포지토리를 스캔하여 구조, 주석, 종속성을 추출한 후, LLM을 사용해 이 정보를 C4 모델(컨텍스트, 컨테이너, 컴포넌트, 코드 다이어그램)의 완전한 아키텍처 문서로 변환합니다. 출력물은 코드와 동기화된 읽기 쉬운 위키입니다.

왜 중요한가 – 기술 문서를 최신 상태로 유지하는 것은 개발자들에게 지속적인 고통입니다. Litho는 전체 파이프라인을 자동화하여 팀이 마크다운 작성에 소요하는 시간을 줄이고, 더 많은 시간을 코딩에 집중할 수 있도록 합니다. Rust 바이너리로 실행되기 때문에 빠르며, CI/CD 파이프라인에 쉽게 통합할 수 있습니다.

주요 기능 (README에 기술됨)

• 4단계 파이프라인 – 전처리(코드 탐지 및 구문 분석), 조사(LLM 기반 아키텍처 추론), 문서 생성(C4 다이어그램, 마크다운), 검증/강화(Mermaid 구문 수정, 무결성 검사).
• 다중 언어 지원 – Rust, Python, Java, Go, C#, JavaScript 등 다양한 언어를 지원합니다.
• 외부 지식 통합 – PDF, 마크다운, SQL 등 추가 문서를 마운트하여 분석을 풍부하게 할 수 있습니다.
• 데이터베이스 문서화 – SQL 프로젝트에 대해 자동으로 ER 다이어그램을 생성합니다.
• Git 이력 분석 – 아키텍처가 시간이 지남에 따라 어떻게 진화하는지 추적합니다.
• CI/CD 준비 완료 – 각 커밋마다 실행 가능하여 문서를 항상 최신 상태로 유지합니다.
• 에코시스템 도구 –
  • Litho Book: Mermaid 지원과 AI 기반 Q&A 기능을 갖춘 Rust/Axum 마크다운 뷰어입니다.
  • Mermaid Fixer: 마크다운에서 손상된 Mermaid 다이어그램을 스캔하고 AI 보조로 복구하는 유틸리티입니다.

작동 방식 (파이프라인 개요)

1. 전처리 – 코드 스캐너가 파일을 탐지하고 구문을 분석하며 주석을 추출하고 종속성 그래프를 구축합니다.
2. 조사 – 전용 AI 에이전트(시스템 컨텍스트 조사자, 도메인 모듈 탐지기, 워크플로우 조사자 등)가 ReAct 추론 루프를 실행하여 아키텍처 의도를 추론하고 중간 보고서를 생성합니다.
3. 문서 생성 – 에디터가 C4 모델 다이어그램, 개요 페이지, 모듈 수준 문서, 상호 참조를 계층적인 마크다운 트리로 조합합니다.
4. 검증 및 강화 – Mermaid 구문을 검증/수정하고, 완전성 검사를 수행하며, 최종 품질 보고서를 출력합니다.

일반적인 워크플로우

# 크레이트 설치
cargo install deepwiki-rs

# 리포지토리에서 Litho 실행 (예시)
litho generate --repo /path/to/project --output docs/

이 명령어는 마크다운 파일과 Mermaid 다이어그램 디렉터리를 생성하며, 직접 서빙하거나 Litho Book으로 열어 더 나은 UI를 경험할 수 있습니다.

누가 사용해야 하는가

• 자동화되고 최신 상태의 아키텍처 문서를 원하는 개발 팀.
• 유지보수가 적은 위키를 찾는 오픈소스 유지보수자.
• 규정 준수를 위해 감사 가능한 문서가 필요한 기업.

관련 프로젝트 – README는 Litho가 더 새로운 프로젝트인 Terrain으로 대체되었음을 언급합니다. Terrain은 AI 에이전트를 위한 살아있는 코드베이스 지도를 추가하면서도, Litho는 빠른 C4 문서 생성기로서 계속 사용 가능합니다.

---

위 모든 세부 정보는 리포지토리의 README에서 직접 인용되었으며, 추가 기능은 추측하지 않았습니다.