An automated repository documentation generator that analyzes your source files and constructs a comprehensive README instantly.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install thoth-lite
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install thoth-lite using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Thoth Lite -- Auto-Documentation?
Thoth Lite is a developer-focused automated documentation tool designed to analyze source files or folders and instantaneously generate structured markdown READMEs. Acting as an intelligent codebase scanner, it reads through up to 20 files (capturing the first 3000 characters of each) while skipping noisy directories like node_modules or .git. This capability makes it an incredibly powerful utility within the catalog of Openclaw Skills, enabling developers to bypass the tedious manual labor of explaining code structures and setup steps.
By leveraging Python and the rich console library, Thoth Lite parses code structures, identifies programming languages, and outputs file contents directly into your LLM context window. The skill then directs the AI agent to structure a highly readable README containing project overviews, installations, usage instructions, and file architectures. It is the perfect entry-tier tool for maintaining robust repo hygiene without context switching.
Thoth Lite -- Auto-Documentation Use Cases
- Quickly spinning up clean README.md files for newly created repositories or micro-features.
- Providing instant context of code structures to newly onboarded team members.
- Automating the documentation of open-source scripts or quick tools without spending hours drafting manual text.
- Pre-processing repository structures for AI code assistants to feed clean code snippets into generative context windows.
- Upgrading developer workflow pipelines with quick-scanning Openclaw Skills.
How Thoth Lite -- Auto-Documentation Works
- Environment Setup: The skill checks for the PROJECT_PATH environment variable and ensures system dependencies like Python 3 and Pip 3 are available.
- Codebase Scanning: Using a local Python execution, the script recursively walks the target folder, automatically filtering out system and build directories (such as .git, node_modules, venv, etc.) to find matching code files.
- Content Extraction: For up to 20 discovered files, the script reads and extracts the first 3000 characters to build an organized text payload containing the core components of each module.
- Context Injection & Prompting: The accumulated file contents are piped directly into the AI agent alongside a rigid markdown schema constraint.
- README Assembly: The AI parses the code structures and synthesizes a professional README containing sections for project overview, features, installation, usage examples, project directory structures, contribution steps, and licensing details.
Thoth Lite -- Auto-Documentation Setup
Prerequisites
Ensure you have Python 3 and Pip 3 installed. You will also need to configure the PROJECT_PATH environment variable pointing to your target codebase.
Step 1: Install Python Rich Library
Run the following command in your terminal to install the terminal formatting engine:
pip3 install rich --break-system-packages --quiet
Step 2: Configure Environment Variables
Define the path of the project file or folder you want to document:
export PROJECT_PATH='./your-target-folder-or-file'
Thoth Lite -- Auto-Documentation Data Schema & Taxonomy
Target Specifications & Parameters
| Parameter | Description | Required |
|---|---|---|
| PROJECT_PATH | Path to the specific file or root directory to be documented (e.g. ./src or ./main.py). | Yes |
Output Documentation Taxonomy
Thoth Lite forces the AI agent to structure the parsed data strictly into the following schema:
- Project Name: Title of the scanned project.
- Overview: High-level explanation of why the project exists and its main goals.
- Features: Bulleted list of discovered features.
- Installation: Step-by-step setup guide extracted from dependencies (like package.json, requirements.txt, etc.).
- Usage: Synthesized examples of execution commands or integration patterns.
- Project Structure: Highlighted folder hierarchy and key modules.
- Contributing: Standard open-source contribution workflow guidelines.
- License: Automated extraction of licensing data.
Thoth Lite -- Auto-Documentation Advanced Features
- Automated Exclusions: Built-in ignoring of binary, build, and environment folders (like .git, node_modules, .next, dist, pycache) to prevent context bloating.
- Multi-language Parsing Support: Automatically matches and processes extensions for Python, JavaScript, TypeScript, Go, Rust, Java, Shell, YAML, and other configurations.
- Prograde Upgrade Path: Built-in pathways to upgrade to Thoth Standard or Pro for auto-injecting inline docstrings, generating complete changelogs from git history, constructing visual architecture diagrams, and exporting documents directly to .docx files.
- Extensible Integration: Designed to be integrated natively with local AI workflows using modern Openclaw Skills to facilitate zero-friction codebase comprehension.
SKILL.md
Loading
Related Openclaw Skills
Haqq Ethics
An Islamic ethical framework and educational curriculum for AI agents, built entirely on the Quran, Sahih Sunnah with connected chains of transmission, and companion consensus.
Thoth Pro
Thoth Pro is a comprehensive documentation suite that scans codebases, generates complete documentation packages, parses git history, and automatically injects docstrings.
Anubis Standard
An automated career application engine that builds tailored, ATS-optimized resumes and professional cover letters from a raw resume and job description.
URLMitra Link Manager
An AI agent skill to manage, track, and audit branded shortlinks while conducting semantic searches across your URLMitra workspace.
Chess Buddy
A Stockfish-backed chess assistant for analyzing FEN positions, board images, and candidate lines.
Interactive Penetration Test
A vanilla, interactive web application security auditing reference offering structured checklists and read-safe diagnostics.
Featured*
