Hacker News • 27일 전

오픈위키: 코드베이스 에이전트 문서를 자동 작성·유지보수하는 CLI 도구

IMP

7/10

핵심 요약

오픈위키(OpenWiki)는 개발자의 코드베이스를 분석해 AI 코딩 에이전트를 위한 문서를 자동으로 작성하고 최신 상태로 유지해 주는 CLI(Command Line Interface) 도구입니다. 깃허브 액션(GitHub Actions)과 연동하여 매일 자동으로 문서 변경 사항을 반영하는 PR을 생성할 수 있어, 에이전트가 코드를 탐색할 때 필요한 컨텍스트를 지속적으로 제공한다는 점에서 실무 개발자들에게 매우 유용합니다.

번역된 본문

오픈위키(OpenWiki)는 에이전트를 위해 특별히 제작되었으며, 개발자의 코드베이스에 대한 문서를 작성하고 유지보수해 주는 CLI(Command Line Interface) 도구입니다.

설치 방법

npm install -g openwiki

빠른 시작

오픈위키를 초기화하고 모델과 API 키를 설정한 뒤, 문서를 생성하세요: openwiki --init

문서가 항상 최신 상태로 유지되도록 하려면, 깃허브 액션(GitHub action)을 저장소에 추가하여 매일 자동으로 문서 업데이트 PR을 생성하게 할 수 있습니다: openwiki-update.yml 해당 파일의 내용을 저장소 내의 .github/workflows/openwiki-update.yml 경로에 복사하여 넣으세요.

사용법

대화형 CLI 시작: openwiki

초기 요청과 함께 오픈위키 시작: openwiki "Please generate documentation for this repository"

단일 명령을 실행하고 종료: openwiki -p "Summarize what you can do"

오픈위키 초기화: openwiki --init

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

도움말 보기: openwiki --help

문서가 존재하지 않을 경우, openwiki는 openwiki/ 디렉토리에 초기 문서를 생성합니다. openwiki/ 디렉토리가 이미 존재한다면, 저장소의 변경 사항을 반영하여 해당 문서를 새롭게 고칩니다. 기본적으로 CLI는 각 실행 후에도 계속 열려 있어 추가적인 명령(프롬프트)을 보낼 수 있습니다. 일회성으로 비대화형 실행을 하고 최종 결과만 출력하고 싶다면 -p 또는 --print 옵션을 사용하세요.

openwiki는 컨텍스트를 검색할 때 코딩 에이전트가 해당 문서를 참조하도록 지시하기 위해, 사용자의 AGENTS.md 및/또는 CLAUDE.md 파일에 프롬프트를 자동으로 추가합니다. 저장소에 해당 파일이 아직 없다면 오픈위키가 직접 생성해 줍니다.

첫 대화형 실행 시, 오픈위키는 사용자의 인퍼런스 제공자(Inference provider), API 키, 그리고 사용할 LLM을 구성하도록 안내합니다. 또한 LangSmith API 키를 설정하여 실행 내역을 "openwiki"라는 이름의 LangSmith 트레이싱 프로젝트에 기록할 수도 있습니다 (선택 사항). 이러한 구성 옵션과 비밀 키는 로컬 머신의 ~/.openwiki/.env 파일에 저장됩니다.

맞춤 설정

오픈위키는 기본적으로 OpenRouter, Fireworks, Baseten, OpenAI 및 Anthropic을 지원합니다. 기본적으로 몇 가지 모델(GLM 5.2, Kimi K2.6, Sonnet 5 등)이 사전 정의되어 있지만, 각 인퍼런스 제공자에 대해 사용자가 직접 원하는 사용자 지정 모델 ID를 지정할 수도 있습니다. 추가되었으면 하는 인퍼런스 제공자나 모델이 있다면 PR(Pull Request)을 열어 제안해 주세요!

원문 보기

원문 보기 (영어)

OpenWiki OpenWiki is a CLI that writes and maintains documentation for your codebase, built specifically for agents. Install npm install -g openwiki Quick Start Initialize OpenWiki, configure your model and API key, then generate documentation openwiki --init Then to ensure your documentation stays up-to-date, add the GitHub action to your repository to automatically open a PR once a day with documentation updates: openwiki-update.yml Copy the contents of that file into .github/workflows/openwiki-update.yml in your repository. Usage Start the interactive CLI: openwiki Start OpenWiki with an initial request: openwiki " Please generate documentation for this repository " Run a single command and exit: openwiki -p " Summarize what you can do " Initialize OpenWiki: openwiki --init Update existing documentation: openwiki --update Show help: openwiki --help openwiki creates initial documentation in openwiki/ when no wiki exists. If openwiki/ already exists, it refreshes that documentation from repository changes. By default, the CLI stays open after each run so you can send follow-up messages. Use -p or --print for a one-shot non-interactive run that prints the final assistant output. openwiki will automatically append prompting to your AGENTS.md and/or CLAUDE.md files to instruct your coding agent to reference it when searching for context. If the file does not already exist in your repository, OpenWiki will create it for you. On the first interactive run, OpenWiki will have you configure your inference provider, API key, and LLM. You will also be able to set a LangSmith API key to trace your OpenWiki runs to a LangSmith tracing project named "openwiki" (optional). These configuration options and secrets will be saved to ~/.openwiki/.env on your local machine. Customizing OpenWiki supports OpenRouter, Fireworks, Baseten, OpenAI and Anthropic out of the box. By default, there are a few models pre-defined (GLM 5.2, Kimi K2.6, Sonnet 5, etc) but for each inference provider, OpenWiki will allow you to specify your own custom model ID. If there's an inference provider or model you'd like to see added, please open a PR!

개발자 도구 문서 자동화 오픈소스 코딩 에이전트 생산성