오늘 OpenWiki를 출시합니다. OpenWiki는 코드베이스 문서를 생성하고 유지 관리하기 위한 오픈소스 에이전트이자 CLI입니다.
에이전트는 작업 중인 리포지토리를 이해할 때 더 나은 코드를 작성합니다. 핵심 로직이 어디에 있는지, 파일이 어떻게 연결되어 있는지, 코드베이스가 어떤 패턴을 기대하는지 알아야 합니다. 좋은 문서는 에이전트에게 그 맥락을 제공하여, 더 정보에 기반한 코드 변경과 불필요한 실수 감소로 이어집니다.
문제는 문서를 최신 상태로 유지하기 어렵다는 점입니다. 초기 문서를 작성하는 데도 시간이 걸리지만, 코드가 변경될 때마다 업데이트하는 것은 훨씬 더 어렵습니다. PR이 빈번한 대규모 리포지토리에서는 문서가 빠르게 구식이 될 수 있습니다.
OpenWiki는 이 작업을 자동으로 처리합니다. 리포지토리에 위키를 생성하고, 그 위키를 코딩 에이전트에 연결하며, 코드가 변경됨에 따라 위키를 최신 상태로 유지합니다.
에이전트를 위한 위키의 이유
저희는 DeepWiki, AutoWiki, Karpathy의 LLM Wiki 개념 등 기존의 코드베이스 위키 관련 작업에서 영감을 받았습니다. 공유된 아이디어는 간단합니다. 위키는 모든 컨텍스트를 하나의 거대한 파일에 강제로 넣지 않고도, 사람과 에이전트가 코드베이스를 구조적으로 이해할 수 있는 방법을 제공합니다.
이는 대부분의 코딩 에이전트가 이미 AGENTS.md나 CLAUDE.md 같은 파일을 지침으로 읽기 때문에 중요합니다. 그러한 파일은 유용하지만, 수백 페이지에 달하는 리포지토리 문서를 저장하기에는 적합한 장소가 아닙니다. 대신 에이전트가 올바른 컨텍스트를 가리키도록 한 뒤, 에이전트가 필요한 것을 검색하도록 해야 합니다.
OpenWiki는 이 모델을 따릅니다. 리포지토리 위키를 생성한 다음, 해당 위키에 대한 참조를 에이전트 지침 파일에 업데이트합니다. 그러면 코딩 에이전트가 자동으로 문서를 발견하고 사용할 수 있습니다.
시작하기
OpenWiki는 명령줄에서 쉽게 실행할 수 있도록 설계되었습니다.
NPM으로 설치합니다:
npm install -g openwiki
그런 다음 실행:
openwiki --init
init 명령은 모델 제공자와 API 키를 묻고, 리포지토리에 대한 문서를 생성합니다.
OpenWiki는 OpenRouter, Fireworks, Baseten, OpenAI, Anthropic을 포함한 오픈 모델 및 클로즈드 모델 제공자를 모두 지원합니다. 기본적으로는 오픈 모델과 함께 OpenRouter를 사용하지만, 설정에 가장 적합한 제공자를 구성할 수 있습니다.
OpenWiki는 DeepAgents 위에 구축되었기 때문에 LangSmith로의 추적도 지원합니다. LangSmith API 키를 제공하면 OpenWiki가 실행 내역을 LangSmith 프로젝트로 추적하여, 문서를 생성하거나 업데이트할 때 에이전트가 정확히 무엇을 했는지 검사할 수 있습니다.
OpenWiki가 코딩 에이전트에 연결되는 방식
위키를 생성한 후, OpenWiki는 리포지토리의 에이전트 지침 파일을 업데이트합니다. 리포지토리가 AGENTS.md, CLAUDE.md 또는 둘 다 사용하는 경우, OpenWiki는 생성된 위키에 대한 참조를 추가하고 에이전트가 언제 이를 사용해야 하는지 설명합니다.
저희는 이 접근 방식을 선택했습니다. 전체 위키를 지침 파일 안에 넣으면 너무 많은 컨텍스트가 추가되기 때문입니다. 대규모 리포지토리에서 위키는 수백 개의 파일에 걸칠 수 있습니다. 이를 모든 에이전트 실행에 로드하는 것은 낭비적이고 유지 관리가 어렵습니다.
짧은 참조가 더 잘 작동합니다. 코딩 에이전트는 이미 지침 파일을 읽습니다. OpenWiki가 참조를 추가하면, 에이전트는 리포지토리 컨텍스트가 필요할 때 위키를 찾을 수 있으며, 워크플로우를 변경할 필요가 없습니다.
위키를 최신 상태로 유지하기
문서를 한 번 생성하는 것은 유용하지만, 최신 상태로 유지하는 것이 OpenWiki가 더 가치를 발휘하는 부분입니다.
OpenWiki에는 예를 들어 하루에 한 번 등 스케줄에 따라 실행될 수 있는 GitHub Action이 포함되어 있습니다. 이 액션은 업데이트 플래그와 함께 OpenWiki를 실행합니다. OpenWiki는 마지막 실행 이후 어떤 커밋이 있었는지 확인하고, git diff를 사용하여 무엇이 변경되었는지 이해한 다음, 관련 컨텍스트로 위키를 업데이트합니다.
이는 워크플로우가 백그라운드에서 실행될 수 있음을 의미합니다. 코드베이스가 변경됨에 따라 OpenWiki가 문서를 업데이트합니다. 코딩 에이전트는 기존 지침 파일 참조를 통해 계속해서 최신 위키를 가져옵니다.
코드베이스 우선으로 설계됨
이 첫 번째 릴리스는 코드베이스용 위키에 중점을 둡니다. 목표는 개발자가 수동으로 상세 문서를 작성하고 유지 관리할 필요 없이, 에이전트가 작업 중인 리포지토리를 더 쉽게 이해할 수 있도록 하는 것입니다.
시간이 지나면서 OpenWiki의 개념이 더 광범위하게 적용될 수 있다고 생각합니다. 에이전트는 코딩뿐만 아니라 다양한 종류의 작업을 위해 지속적인 컨텍스트가 필요합니다. 코드베이스 문서는 첫 번째 사용 사례이지만, 동일한 패턴이 에이전트가 다른 워크플로우에서도 유용한 컨텍스트를 유지하는 데 도움이 될 수 있습니다.
사용해보기
OpenWiki는 오픈소스이며 지금 사용할 수 있습니다.
설치하고 openwiki --init을 실행하면 몇 분 안에 리포지토리용 위키를 생성할 수 있습니다.
리포지토리는 여기에서 확인하세요: https://github.com/langchain-ai/openwiki 그리고 워크스루 동영상을 시청하세요: https://youtu.be/nIVu3zfYprI
