OpenWiki is a command-line interface (CLI) tool designed to automate the writing and maintenance of agent documentation for codebases. It targets developers and teams building AI agents, providing a mechanism to keep documentation synchronized with code changes, thereby enhancing agent context and understanding. The primary benefit is reducing the manual effort required to document code, ensuring accuracy and consistency.

How It Works

OpenWiki operates as a CLI application installed via npm. It leverages large language models (LLMs) to generate and update documentation. Users initialize the tool, configure their preferred LLM inference provider (supporting OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic) and API keys. The CLI can then be run interactively or via a single command to generate initial documentation in an openwiki/ directory or refresh existing documentation based on repository changes. A key feature is its ability to automatically append instructions to AGENTS.md and/or CLAUDE.md files, guiding coding agents to reference the generated documentation.

Quick Start & Requirements

• Install: npm install -g openwiki
• Prerequisites: Node.js and npm. Configuration requires LLM API keys. Optional LangSmith API key for tracing.
• Setup: Run openwiki --init to configure model and API key. Add the provided openwiki-update.yml content to .github/workflows/openwiki-update.yml for automated daily updates via GitHub Actions.
• Docs: Usage instructions are available via openwiki --help.

Highlighted Details

• Automated documentation generation and maintenance for codebases.
• Daily updates via GitHub Actions integration.
• Automatic creation/modification of AGENTS.md and CLAUDE.md to integrate documentation context for coding agents.
• Support for multiple inference providers (OpenRouter, Fireworks, Baseten, OpenAI, Anthropic) and custom model IDs.
• Optional integration with LangSmith for tracing runs.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or roadmap were provided in the README snippet.

Licensing & Compatibility

The license type is not explicitly stated in the provided README snippet. Compatibility for commercial use would depend on the underlying LLM provider licenses and the unspecified license of OpenWiki itself.

Limitations & Caveats

The tool requires Node.js and npm for installation. It relies heavily on external LLM providers, necessitating valid API keys and incurring potential costs. Configuration details and secrets are stored locally in ~/.openwiki/.env. The README does not detail specific limitations, unsupported platforms, or known bugs.