OpenWiki: CLI that writes and maintains agent documentation for your codebase

Who Should Read

AI 코딩 에이전트(GitHub Copilot, Claude 등)를 팀 워크플로에 도입했는데, 에이전트가 코드베이스를 제대로 이해 못해 엉뚱한 코드를 생성하는 문제를 겪고 있는 개발자나 팀 리드.

Core Mechanics

• OpenWiki는 npm으로 전역 설치(`npm install -g openwiki`)하고 `openwiki --init`으로 초기화하면, 현재 코드베이스를 분석해 에이전트 전용 문서를 `openwiki/` 디렉토리에 자동 생성한다.
• 한 번 설치하면 그걸로 끝이 아니라, 제공된 GitHub Actions 워크플로 파일(`openwiki-update.yml`)을 저장소에 추가하면 매일 한 번 자동으로 문서 업데이트 PR을 열어준다. 코드가 바뀌어도 문서가 자동으로 따라온다.
• 생성된 문서는 AGENTS.md(AI 에이전트 범용)와 CLAUDE.md(Anthropic Claude 전용) 파일에도 자동으로 참조 프롬프트를 추가한다. 해당 파일이 없으면 새로 만들어준다. 이를 통해 에이전트가 문서를 먼저 찾아보도록 유도한다.
• 인터랙티브 모드와 one-shot 모드를 둘 다 지원한다. 대화하듯 쓰려면 `openwiki`를 실행하고, 자동화 스크립트에서 쓰려면 `openwiki -p "요청"` 처럼 단일 명령으로 결과만 출력할 수 있다.
• 초기 실행 시 inference provider(어떤 LLM 서비스를 쓸지), API 키, 모델명을 설정한다. 특정 LLM에 종속되지 않고 provider를 선택할 수 있는 구조다.
• 문서가 이미 `openwiki/` 디렉토리에 존재하면 `--update` 명령으로 저장소 변경분만 반영해 갱신한다. 처음부터 다시 쓰는 게 아니라 차분(diff) 방식으로 유지보수하는 방식이다.
• 이 프로젝트 자체의 `openwiki/` 디렉토리가 OpenWiki로 생성한 문서 예시다. 직접 GitHub 저장소에서 어떤 형태의 문서가 나오는지 확인할 수 있다.

Evidence

• "그냥 에이전트한테 문서 써달라고 하면 되는 거 아닌가?"라는 의견이 여럿 나왔다. 이에 대해 OpenWiki의 차별점은 에이전트가 스스로 문서를 유지(maintain)하는 자동화 루프를 제공하는 것이지, 단순히 문서를 한 번 생성하는 게 아니라는 반론이 있었다.
• "결국 TypeScript로 만든 얇은 CLI 래퍼에 불과하다, 프롬프트/스킬로 충분히 대체 가능하다"는 비판이 있었다. 실제로 기능 자체는 좋은 프롬프트만으로도 비슷한 결과를 낼 수 있어 과잉 설계(over-engineered)라는 평가가 나왔다.
• LLM 기반 wiki를 직접 유지해본 사람의 경험담이 공유됐다. 에이전트와 사람 모두가 쉽게 찾아볼 수 있도록 구조와 문서 품질을 유지하는 게 생각보다 훨씬 손이 많이 간다고 했다. OpenWiki 같은 자동화 도구의 필요성이 여기서 나온다.
• "OpenWiki"라는 이름이 사람을 위한 wiki인지 에이전트를 위한 것인지 혼동을 준다는 UX 피드백이 있었다. 'Agent Wiki' 같은 이름이 더 적절하다는 제안도 나왔다.
• 코드 심볼 검색 능력이 Codegraph 같은 도구와 비교해 어떤지에 대한 질문이 있었고, LSP나 code intelligence MCP를 함께 쓰면 더 좋은 결과를 낼 수 있다는 의견이 있었다. 다만 동기나 비즈니스 맥락처럼 코드에서 추론할 수 없는 내용은 여전히 사람이 직접 채워야 한다고 지적했다.

How to Apply

• Claude나 Copilot 같은 AI 코딩 에이전트를 도입했는데 에이전트가 레포 구조를 잘 모르는 경우, `npm install -g openwiki` 후 `openwiki --init`을 실행해 `openwiki/` 문서를 생성하면 에이전트의 컨텍스트 품질을 즉시 높일 수 있다.
• 코드가 자주 바뀌는 활발한 저장소라면, 제공된 `openwiki-update.yml`을 `.github/workflows/`에 추가해 매일 자동으로 문서 업데이트 PR이 열리도록 설정하면 문서를 별도로 관리할 필요가 없어진다.
• CI/CD 파이프라인이나 GitHub Actions에서 one-shot으로 특정 모듈 문서를 생성하고 싶다면, `openwiki -p "Generate documentation for the auth module"` 처럼 비대화형(-p) 모드를 사용하면 스크립트에 쉽게 통합할 수 있다.
• 이미 AGENTS.md나 CLAUDE.md 파일을 관리하고 있다면, OpenWiki가 해당 파일에 문서 참조 프롬프트를 자동으로 추가해주므로 별도의 파일 편집 없이도 에이전트가 생성된 wiki를 자동으로 찾아보게 만들 수 있다.

Code Example

# 전역 설치
npm install -g openwiki

# 초기화 (provider, API key, LLM 설정)
openwiki --init

# 문서 생성 (대화형)
openwiki "Please generate documentation for this repository"

# 문서 생성 (비대화형, CI/CD용)
openwiki -p "Summarize what you can do"

# 기존 문서 업데이트
openwiki --update

# GitHub Actions 자동 업데이트 설정
# .github/workflows/openwiki-update.yml 파일 추가 필요
# 저장소에서 openwiki-update.yml 내용을 복사해서 사용

Terminology

Related Papers

• Show HN: ctx – Search the coding agent history already on your machine

  Claude Code, Cursor, Codex 등 코딩 에이전트가 이전 세션의 논의·결정·실패 시도를 잊지 않도록 SQLite로 인덱싱해 재사용할 수 있게 해주는 오픈소스 CLI 도구다.

• Micro-Agent: Beat Frontier Models with Collaboration Inside Model API

  vLLM 팀이 단일 모델 API 호출 뒤에서 여러 모델이 협업하는 'Micro-Agent' 개념을 공개했습니다. 별도의 에이전트 코드 없이 라우터 레이어에서 모델 조합을 실행해 GPT-4급 결과를 더 저렴하게 낼 수 있다는 아이디어입니다.

• Ornith-1.0: self-improving open-source models for agentic coding

  Gemma 4와 Qwen 3.5를 기반으로 파인튜닝한 코딩 특화 오픈소스 모델로, RL(강화학습)을 통해 스캐폴드(에이전트 실행 구조)까지 함께 최적화하는 방식을 주장하지만, 커뮤니티에서는 벤치마크 과최적화에 불과하다는 의심을 받고 있다.

• Entity Binding Failures in Tool-Augmented Agents

  AI 에이전트가 올바른 도구를 선택해도 잘못된 대상에 실행하는 'Entity Binding 실패' 문제를 정의하고, 이를 막는 실행 정책을 평가한 논문.

• Herdr: Agent multiplexer that lives in your terminal

  여러 AI 코딩 에이전트(Claude, Codex 등)를 하나의 터미널에서 동시에 실행·관리할 수 있는 Rust 기반 오픈소스 툴로, tmux처럼 세션이 유지되고 SSH로 원격 접속도 가능해 멀티 에이전트 워크플로우를 크게 단순화해준다.

• Ornith-1.0: Self-scaffolding LLMs for agentic coding

  모델이 문제 풀이 전략(scaffold)을 직접 생성하고 개선하는 자기강화 학습 프레임워크를 적용한 오픈소스 코딩 특화 LLM으로, 9B 소형 모델부터 397B 대형 모델까지 라인업을 갖추고 SWE-Bench 등 주요 벤치마크에서 Claude Opus 4.7을 능가하는 성능을 보여줬다.

Related Resources

• OpenWiki GitHub 저장소 (langchain-ai/openwiki)
• OpenWiki로 생성된 문서 예시 (openwiki/ 디렉토리)
• GitHub Actions 자동 업데이트 워크플로 예시