langchain-ai/openwiki

OpenWiki – 코드베이스를 위한 자체 호스팅 에이전트 기반 문서

개요 – OpenWiki는 대규모 언어 모델 코딩 에이전트(예: Claude Code, Codex, Cursor, GitHub Copilot, IBM Bob 등)가 리포지토리 내부에 연결된 Markdown 위키를 자동으로 생성하고 최신 상태로 유지할 수 있게 하는 Node 기반 도구입니다. 위키는 사용자가 소유한 일반 파일로 저장되며, 에이전트는 가벼운 모델 프리 도구(openwiki_search, openwiki_read)로 쿼리할 수 있습니다.

주요 기능

• 에이전트 통합 – 많은 인기 코딩 에이전트를 위한 원클릭 설치 프로그램. 에이전트는 자체 인증된 모델 세션을 사용하므로 별도 공급자를 구성할 필요가 없습니다.
• 근거 기반 페이지 – 각 위키 페이지는 소스 증거(코드, 테스트, 문서)에 연결됩니다. 주장은 버전 관리됩니다. 리포지토리가 변경되면 OpenWiki는 증거가 변경된 페이지만 다시 작성합니다.
• 병렬 페이지 워커 – CLI는 여러 페이지를 동시에 문서화할 수 있으며(OPENWIKI_PAGE_CONCURRENCY로 설정), 공급자 속도 제한을 자동으로 처리합니다.
• 워크스페이스 – openwiki link로 관련 리포지토리를 그룹화합니다. 에이전트는 전체 서비스를 검색하고 모든 구성원 위키의 섹션을 읽을 수 있습니다.
• 시각적 탐색기 – openwiki visualize는 위키를 대화형 노드 그래프로 표시하는 로컬 서버를 실행하고, 라이브 Markdown 뷰어 옆에 표시합니다. GitHub Pages에서 호스팅할 수 있는 정적 시각화 도구를 내보낼 수도 있습니다.
• 예약된 CI 업데이트 – 사전 준비된 GitHub Actions, GitLab CI 및 Bitbucket Pipelines 스니펫은 위키가 코드와 분기될 때마다 PR을 엽니다.
• 개인 모드 – 리포지토리 문서 외에도 연결된 소스를 집계하는 개인 지식 위키(openwiki personal)를 만들 수 있습니다.

설치

# Node 22.22+ 필요
npm install -g openwiki   # 전역 설치 (또는 Pi: pi install npm:openwiki)

그런 다음 코딩 에이전트용 통합을 설치합니다(예):

openwiki integrations install codex   # 또는 claude, cursor, bob, kiro, omp, antigravity, copilot

일반적인 워크플로

1. 초기화 – 리포지토리 내에서 에이전트에게 "이 리포지토리의 OpenWiki를 초기화하세요…"라고 요청합니다. 에이전트는 openwiki/ 아래에 연결된 위키를 작성합니다.
2. 쿼리 – 이후 세션에서 에이전트에게 openwiki_search로 주제를 검색하고 openwiki_read로 관련 섹션을 읽도록 요청합니다.
3. 업데이트 – 코드 변경 후 "이 리포지토리의 OpenWiki를 업데이트하세요…"라고 요청합니다. OpenWiki는 diff를 검사하고 기존 주장을 검증하며 필요한 부분만 다시 작성합니다.
4. 탐색 – openwiki visualize를 실행하여 그래프를 탐색하거나 정적 시각화 도구를 내보냅니다.
5. 자동화 – 제공된 CI 워크플로(openwiki-update.yml)를 추가하여 위키를 자동으로 동기화합니다.

구성

• 동시성: OPENWIKI_PAGE_CONCURRENCY=4
• 상태 디렉터리: 기본값은 ~/.openwiki이며 OPENWIKI_CONFIG_DIR로 재정의할 수 있습니다.
• 공급자 선택: CLI는 첫 실행 시 모델 공급자를 묻습니다. 14개의 공급자가 지원됩니다.

중요한 이유 – 문서가 코드와 가깝게 유지되고, 작성한 것과 동일한 LLM에 의해 지속적으로 새로워지며, 완전히 편집 가능한 Markdown으로 남아 있습니다. 에이전트는 추가 API 호출 없이 정확하고 근거 있는 컨텍스트를 검색할 수 있어 코드 이해, 디버깅 및 온보딩이 향상됩니다.

---

빠른 시작

npm install -g openwiki
openwiki integrations install codex   # 에이전트 선택
# 리포지토리 내에서 에이전트 채팅에서:
Initialize this repository's OpenWiki from the current source and tests.

이제 검색 가능하고 시각화 가능한 위키가 생깁니다.