Skip to content

cognautic-cli v1.2.1

Choose a tag to compare

View all tags
@cognautic cognautic released this 02 Dec 06:19
1.2.1
eb93c3c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Changelog

All notable changes to Cognautic CLI will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[1.2.1] - 2025-12-02

Added - Repository Documenter 📚

Native Git Repository Documentation Generator

Added a built-in feature to automatically generate comprehensive documentation for any public git repository using AI.

Key Features

  • One-Command Documentation - Generate complete documentation with a single command
  • AI-Powered Analysis - Analyzes repository structure, code, and configuration files
  • Architecture Diagrams - Automatically generates Python scripts for creating architecture diagrams using Graphviz
  • Comprehensive Output - Includes project overview, installation instructions, usage guide, code structure, and architecture description
  • Smart File Selection - Intelligently selects key files (README, package.json, requirements.txt, source files, etc.)
  • Automatic Cleanup - Cleans up temporary cloned repositories after analysis

Usage

/docrepo <git_url>

Example:

/docrepo https://github.com/user/awesome-project

Output Files

The command generates two files in your current workspace:

  1. {repo_name}_DOCS.md - Comprehensive documentation in Markdown format
  2. extra/{repo_name}_graph.py - Python script to generate architecture diagram (requires graphviz)

Technical Details

  • Module: cognautic/repo_documenter.py
  • Command: /docrepo integrated into CLI slash commands
  • Shallow Clone: Uses git clone --depth 1 for faster cloning
  • Token Optimization: Limits file contents to prevent context overflow
  • File Size Limits: Only reads source files under 15KB
  • Supported Languages: Python, JavaScript, TypeScript, Rust, Go, Java, C/C++, Ruby, PHP, Vue, Swift, Kotlin, Scala, C#
  • File Creation: AI uses its write_to_file tool to create documentation files (prevents duplication)
Assets 3
Loading