Skip to content

kingabzpro/GitHub-Wiki-Agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🤖 GitHub Wiki AI Agent

An AI-powered CLI tool that automatically generates comprehensive GitHub repository wikis using Claude Agent SDK

Python 3.11+ License: MIT

✨ Features

  • 🎯 Automatic Wiki Generation: Creates comprehensive 3-page wikis (Home, Getting Started, Architecture & Tools)
  • 🤖 AI-Powered Analysis: Uses Claude AI to analyze repositories and generate tailored documentation
  • 🌐 MCP Integration: Model Context Protocol support for enhanced GitHub integration
  • 💰 Cost Tracking: Real-time monitoring of API costs, session duration, and usage statistics
  • 🎨 Rich Terminal UI: Beautiful colored interface with tool usage visualization
  • 📝 Smart Content Generation: Automatically creates project-specific documentation based on codebase analysis
  • 🔍 Repository Intelligence: Analyzes project structure, dependencies, and documentation

🚀 Quick Start

Prerequisites

  • Python 3.11 or higher
  • Claude Code
  • GitHub Personal Access Token
  • Repository with GitHub Wiki feature enabled

Before running the Python code, you must open your terminal (Command Prompt or PowerShell) and run these commands to install the Claude Code CLI and authenticate:

Install the CLI:

npm install -g @anthropic-ai/claude-code

Start the Claude Code:

claude

Then type /login to authenticate.

Installation

  1. Install the latest SDK:

    pip install claude-agent-sdk
  2. Clone this repository:

    git clone https://github.com/kingabzpro/GitHub-Wiki-Agent
    cd "GitHub-Wiki-Agent"
  3. Set up environment variables:

    export ANTHROPIC_API_KEY="your-anthropic-api-key"
    export GITHUB_PAT="your-github-personal-access-token"

Usage

Run the CLI tool:

python gh_wiki_cli.py

Example Usage:

=== GitHub Wiki AI Agent (Auto-Mode) ===
MCP Servers: github
Ask me to help with a GitHub wiki by mentioning the repository URL!
Type 'exit' to quit.

>> Create the github wiki for it: https://github.com/kingabzpro/ECom-Intel

[AI analyzes repository and generates comprehensive wiki...]
✅ The GitHub Wiki for ECom-Intel has been created and published successfully!

=== Session Summary ===
Total Turns:   1
Duration:      282.99s
Total Cost:    $0.9047
=======================

🎯 What It Does

The tool automatically creates three comprehensive wiki pages:

  1. Home.md - Project overview, key features, supported platforms, and quick links
  2. Getting-Started.md - Installation guide, API setup, usage instructions, and troubleshooting
  3. Architecture-and-Tools.md - Technical documentation with project structure, data flow, and component details

Generated Content Features:

  • 📊 Visual Elements: Screenshots, ASCII diagrams, and structured tables
  • 🔧 Installation Guides: Step-by-step setup with dependency explanations
  • 📚 Architecture Documentation: Database schemas, component responsibilities, and method tables
  • 🔗 Cross-Linking: Interconnected wiki pages for easy navigation
  • 🛠️ Troubleshooting Section: Common issues and solutions

About

CLI tool for generating comprehensive GitHub repository wikis using Claude Agent SDK

Topics

Resources

License

Stars

Watchers

Forks

Languages