What is wakawiki?

WakaWiki is a command line tool that writes and keeps up documentation for your codebase, built in Rust. Instead of you writing docs by hand, an AI agent explores your project, reads the files, searches for patterns, and produces structured documentation on its own. The project was inspired by OpenWiki. You can install it with npm or with cargo, Rust's package manager, or build it from source. Once installed, you run wakawiki --init to pick and configure an AI provider. Supported providers include OpenAI, Anthropic, DeepSeek, and OpenRouter, all of which need an API key, plus a local option called opencode that needs no API key at all. After setup, running wakawiki alone starts an interactive documentation session, while wakawiki -p lets you run it once with a specific instruction, useful for automated scripts. The tool works through a loop where it lists files, reads them, searches the codebase, and writes documentation as it goes. If you already have docs and only want to refresh what changed, the --update flag updates just those parts instead of starting over. There is also a --scan mode that skips the AI model entirely and generates instant documentation just by parsing the source code directly, which is fast and predictable but less detailed. Output lands in a wakawiki folder containing an overview file, an architecture file, and other module specific documents, along with a metadata file used to track future updates. It also creates or updates an AGENTS.md file so that AI coding agents know where to find the documentation. The project includes a ready made GitHub Actions workflow so documentation can be regenerated automatically on a schedule and submitted as a pull request. Configuration, including your chosen provider and API key, is stored in a local config file or set through environment variables. WakaWiki is released under the MIT License, so it can be used and modified freely.