오늘 저희는 코드베이스 (codebases)를 위한 문서화를 생성하고 유지 관리하는 오픈 소스 에이전트 (agent) 및 CLI를 출시합니다.

에이전트 (Agents)는 자신이 작업 중인 저장소 (repo)를 이해할 때 더 나은 코드를 작성합니다. 에이전트는 핵심 로직이 어디에 있는지, 파일들이 어떻게 연결되는지, 그리고 코드베이스가 어떤 패턴을 기대하는지 알아야 합니다. 좋은 문서화 (documentation)는 에이전트에게 그러한 컨텍스트 (context)를 제공하며, 이는 더 정보에 기반한 코드 변경과 피할 수 있는 실수를 줄이는 결과로 이어집니다.

문제는 문서화를 최신 상태로 유지하는 것이 어렵다는 점입니다. 초기 문서를 작성하는 데 시간이 걸리며, 코드가 변경될 때마다 이를 업데이트하는 것은 훨씬 더 어렵습니다. PR (Pull Requests)이 빈번하게 발생하는 대규모 저장소 (repos)에서는 문서가 빠르게 구식이 될 수 있습니다.

OpenWiki는 그 작업을 자동으로 처리합니다. 여러분의 저장소 (repo)를 위한 위키 (wiki)를 생성하고, 해당 위키를 코딩 에이전트 (coding agent)에 연결하며, 코드가 변경됨에 따라 이를 최신 상태로 유지합니다.

에이전트를 위한 위키가 필요한 이유

저희는 DeepWiki, AutoWiki, 그리고 Karpathy의 LLM Wiki 개념을 포함하여 코드베이스 위키 (codebase wikis)와 관련된 기존 작업들로부터 영감을 얻었습니다. 공통된 아이디어는 간단합니다. 위키는 모든 컨텍스트 (context)를 하나의 거대한 파일에 강제로 밀어 넣지 않고도, 인간과 에이전트가 코드베이스를 이해할 수 있는 구조화된 방식을 제공한다는 것입니다.

이것이 중요한 이유는 대부분의 코딩 에이전트 (coding agents)가 이미 지침 (instructions)을 위해 AGENTS.md 또는 CLAUDE.md와 같은 파일들을 읽기 때문입니다.

이러한 파일들은 유용하지만, 수백 페이지에 달하는 저장소 문서 (repo documentation)를 저장하기에 적합한 장소는 아닙니다. 이 파일들은 에이전트를 올바른 컨텍스트 (context)로 안내한 다음, 에이전트가 필요한 것을 검색할 수 있도록 해야 합니다.

OpenWiki는 그 모델을 따릅니다. 저장소 위키 (repo wiki)를 생성한 다음, 해당 위키에 대한 참조를 통해 여러분의 에이전트 지침 (agent instruction) 파일들을 업데이트합니다. 거기서부터 여러분의 코딩 에이전트 (coding agent)는 자동으로 문서를 발견하고 사용할 수 있습니다.

시작하기

OpenWiki는 명령줄 (command line)에서 쉽게 실행할 수 있도록 설계되었습니다.

npm으로 설치하세요:

npm install -g openwiki

그런 다음 실행하세요:

openwiki --init

init 명령은 모델 제공자 (model provider)와 API 키 (API key)를 요청한 다음, 여러분의 저장소 (repo)를 위한 문서화를 생성합니다.

OpenWiki는 OpenRouter, Fireworks, Baseten, OpenAI, Anthropic을 포함한 오픈 모델 제공자 (open model provider)와 폐쇄형 모델 제공자 (closed model provider)를 모두 지원합니다. 기본적으로 오픈 모델과 함께 OpenRouter를 사용하지만, 여러분의 환경에 가장 적합한 제공자를 구성할 수 있습니다.

OpenWiki는 DeepAgents를 기반으로 구축되었기 때문에 LangSmith로의 트레이싱 (tracing)도 지원합니다. LangSmith API 키를 제공하면, OpenWiki는 실행 과정을 LangSmith 프로젝트로 트레이싱하므로 에이전트가 문서를 생성하거나 업데이트하는 동안 정확히 어떤 작업을 수행했는지 검사할 수 있습니다.

OpenWiki가 코딩 에이전트와 연결되는 방식

위키 (wiki)를 생성한 후, OpenWiki는 저장소 (repo)의 에이전트 지침 파일 (agent instruction files)을 업데이트합니다. 만약 여러분의 저장소가 AGENTS.md, CLAUDE.md, 또는 두 파일 모두를 사용한다면, OpenWiki는 생성된 위키에 대한 참조를 추가하고 에이전트가 언제 이를 사용해야 하는지 설명합니다.

우리가 이 접근 방식을 선택한 이유는 위키 전체를 지침 파일 안에 넣으면 너무 많은 컨텍스트 (context)가 추가되기 때문입니다. 대규모 저장소에서 위키는 수백 개의 파일에 걸쳐 있을 수 있습니다. 그 모든 것을 매 에이전트 실행 시마다 로드하는 것은 낭비이며 유지 관리하기 어렵습니다.

짧은 참조가 더 효과적입니다. 여러분의 코딩 에이전트는 이미 지침 파일을 읽고 있습니다. OpenWiki가 참조를 추가하면, 여러분의 워크플로 (workflow)를 변경할 필요 없이 에이전트가 저장소 컨텍스트가 필요할 때 위키를 찾을 수 있습니다.

위키를 최신 상태로 유지하기

문서를 한 번 생성하는 것도 유용하지만, 이를 최신 상태로 유지하는 것이 OpenWiki가 더욱 가치 있어지는 지점입니다.

OpenWiki에는 예를 들어 하루에 한 번과 같이 정해진 일정에 따라 실행될 수 있는 GitHub Action이 포함되어 있습니다. 이 액션은 업데이트 플래그 (update flag)와 함께 OpenWiki를 실행합니다. OpenWiki는 마지막 실행 이후 어떤 커밋 (commit)이 반영되었는지 확인하고, git diff를 사용하여 무엇이 변경되었는지 파악한 다음, 관련 컨텍스트를 사용하여 위키를 업데이트합니다.

즉, 이 워크플로는 백그라운드에서 실행될 수 있습니다. 코드베이스 (codebase)가 변경됨에 따라 OpenWiki가 문서를 업데이트합니다. 여러분의 코딩 에이전트는 기존의 지침 파일 참조를 통해 최신 위키를 계속해서 가져오게 됩니다.

코드베이스를 위해 우선적으로 구축됨

이번 첫 번째 릴리스는 코드베이스 (codebases)를 위한 위키에 집중합니다. 목표는 개발자가 상세한 문서를 수동으로 작성하고 유지 관리하도록 요구하지 않으면서도, 에이전트가 자신이 작업하는 저장소 (repos)를 더 쉽게 이해할 수 있도록 만드는 것입니다.

시간이 흐름에 따라, 우리는 OpenWiki 개념이 더 폭넓게 적용될 수 있다고 생각합니다. 에이전트는 코딩뿐만 아니라 다양한 종류의 작업을 위해 지속 가능한 컨텍스트 (context)가 필요합니다. 코드베이스 문서화는 첫 번째 유스케이스 (use case)이지만, 동일한 패턴이 다른 워크플로우 (workflows) 전반에서 에이전트가 유용한 컨텍스트를 유지하는 데에도 도움을 줄 수 있습니다.

사용해 보기

OpenWiki는 오픈 소스 (open source)이며 지금 바로 사용할 수 있습니다.

설치 후 openwiki --init을 실행하면, 몇 분 안에 여러분의 저장소를 위한 위키를 생성할 수 있습니다.

저장소는 여기에서 확인하세요: https://github.com/langchain-ai/openwiki