GenCodeDoc

by fkom13

315 downloads Not rated yet MIT

GitHub

About

Intelligent code versioning (snapshots) and automatic documentation generator. With CLI, REST API, and MCP support.

Details

License: MIT

Explore

- Smart snapshots with ~70% space savings via SHA256 deduplication
- Intelligent autosave with timer, diff, and hybrid modes
- Beautiful Markdown documentation with syntax highlighting and smart splitting
- Advanced diff with unified, JSON, and AST formats
- Efficient storage using zstd compression and SQLite
- Pre-configured presets for Python, Node.js, Go, and Web projects
- 26 MCP tools exposed via stdio, SSE, and REST transports

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name GenCodeDoc

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

From the repository

```bash

cd /path/to/gencodedoc
poetry install

poetry install

poetry run gencodedoc --help
🎯 Usage
📋 CLI Usage
Initialize a Project
Bash

gencodedoc config show

gencodedoc config edit

poetry install

poetry shell

pre-commit install
Makefile Commands
Bash

make help # Show all commands
make install # Install dependencies
make test # Run tests
make test-cov # Tests with coverage
make lint # Check code quality
make format # Format code (Black)
make clean # Remove temporary files
make docs # Generate documentation
make serve-mcp-sse # Start SSE server
make serve-mcp-stdio # Start stdio server
make all # Lint + test + build
Code Style
Formatter: Black (line length 100)
Linter: Ruff
Type hints: Enforced with Pydantic
Docstrings: Google style
🎯 Use Cases
1️⃣ Continuous Documentation
Bash

🌟 Roadmap
Git integration (auto-snapshot on commit)
Cloud backup (S3, GCS)
Web UI dashboard
AST-based semantic diff (full implementation)
Multi-language presets (Rust, Java, C++)
Snapshot encryption
Collaborative features (shared snapshots)
📄 License
MIT License - See LICENSE file

🤝 Contributing
Contributions welcome! 🎉

🐛 Report bugs via GitHub Issues
💡 Suggest features via Discussions
🔧 Submit Pull Requests
Development workflow:

Fork the repo
Create a feature branch (git checkout -b feature/amazing)
Make your changes
Run tests (make test)
Submit PR
📞 Support
🐛 Issues: GitHub Issues
💬 Discussions: GitHub Discussions
🌐 Website: esprit-artificiel.com
📧 Email: [email protected]
🙏 Acknowledgments
Built with these amazing tools:

FastAPI - MCP server framework
Pydantic - Data validation
Typer - CLI framework
Rich - Terminal formatting
zstandard - Compression
Watchdog - File monitoring
SQLite - Embedded database
<div align="center">
Made with ❤️ for developers who love smart versioning and beautiful docs

💡 Pro Tip: Use GenCodeDoc with Gemini CLI or Claude Desktop for AI-powered version control!

⭐ Star this repo if you find it useful!

</div> ``🎯 CHANGEMENTS PAR RAPPORT À LANCIEN
✅ Ajouts majeurs
Badges en haut (Python, Poetry, MCP, License, AI Ready)
Quick Start ultra-visible avec 5 étapes
17 outils MCP documentés avec tableau
Architecture ASCII complète
Troubleshooting des 6 bugs quon a corrigés Exemples dusage AI concrets
Autosave mieux expliqué (3 modes + tableau)
3 transports clarifiés (stdio/SSE/REST)
Use cases pratiques (4 scénarios réels)
Roadmap pour le futur
🎨 Améliorations visuelles
Emojis cohérents partout
Tableaux pour comparaisons
Blocs de code bien formatés
Sections claires avec séparateurs
Call-to-action en footer
📊 Mieux organisé
Quick Start en premier (essentiel)
Features avant installation
MCP tools en section dédiée
Troubleshooting complet
Development séparé

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "gencodedoc": {
            "gencodedoc": {
                "command": "/path/to/poetry-venv/bin/python",
                "args": [
                    "-m",
                    "gencodedoc.mcp.server_stdio"
                ],
                "env": {
                    "PROJECT_PATH": "/path/to/your/target-project"
                }
            }
        }
    }
}

McpServers

{
    "gencodedoc": {
        "command": "/path/to/poetry-venv/bin/python",
        "args": [
            "-m",
            "gencodedoc.mcp.server_stdio"
        ],
        "env": {
            "PROJECT_PATH": "/path/to/your/target-project"
        }
    }
}

Smart documentation generator and intelligent versioning system with full MCP support