Favicon of Write-the

Write-the

Local Python CLI generates documentation and tests using OpenAI or OpenRouter remote APIs, with your provider API key.

Screenshot of Write-the website

Write-the is a locally installed Python command-line tool that sends code to a selected OpenAI or OpenRouter API to generate documentation and tests. It's for developers who want generated drafts alongside their codebase. The CLI handles local files while the selected provider handles generation.

The documentation generator covers class and function descriptions, parameter explanations and examples. The test generator produces test cases for existing code. Write-the also supports code refactoring and conversion between code or data formats.

MkDocs scaffolding extends its scope to documentation websites, so the same tool can generate reference text and create a site structure for publishing it. Its own documentation and site use these capabilities, as do the documentation projects for autoresearcher and CUPCAKEAGI.

The software is open source under the MIT license and requires Python. It also includes OpenAI model management.

Similar to Write-the