Gencodedoc

🚀 GenCodeDoc

GenCodeDocは、コードプロジェクトの進捗管理を革新する強力なツールです。このツールは、重複排除機能を備えたインテリジェントなスナップショットシステム、Markdownドキュメント生成機能、そして自動化とAIアシスタントとの統合を可能にする完全なインターフェース（CLI、API REST、MCP） を提供します。

詳細な技術ドキュメント（アーキテクチャ、完全なAPIなど）については、をご覧ください。

🚀 クイックスタート

GenCodeDocをインストールしたら、既存のプロジェクトでの使い方は次の通りです。

1. プロジェクトでGenCodeDocを初期化する：

   # プロジェクトディレクトリに移動
   cd /path/to/your/project
   
   # プリセット（例：python）で初期化
   poetry run gencodedoc init --preset python
   

   利用可能なプリセット：python, nodejs, go, web

2. 最初のスナップショットを作成する：

   poetry run gencodedoc snapshot create --message "Version initiale du projet" --tag v1.0
   

3. ドキュメントを生成する：

   poetry run gencodedoc doc generate --output "PROJECT_DOCS.md"
   

   完全なドキュメントが記載されたPROJECT_DOCS.mdファイルが作成されます。

4. （オプション）自動保存を有効にする：

   poetry run gencodedoc config set autosave.enabled true
   

✨ 主な機能

• 📸 インテリジェントなスナップショット : ハッシュによる内容の重複排除機能を利用し、約70％のスペース節約でプロジェクトの「スナップショット」を作成します。
• 🔄 インテリジェントな自動保存 : 時間ベース、変更ベース、またはハイブリッドモードの3種類の自動保存モードで作業を保護します。
• 📝 自動ドキュメント生成 : ファイルのディレクトリ構造とコード抜粋を含む、プロジェクトの完全なMarkdownドキュメントを生成します。
• 🔍 高度な差分比較 : 統合差分（Gitスタイル）、JSON（スクリプト用）、またはセマンティック（AST、実験的）などの方法で、プロジェクトの任意のバージョンを比較します。
• 🔌 三重インターフェース : あなたに最適な方法でGenCodeDocを使用できます。
  • CLI : 完全で直感的なコマンドラインインターフェース。
  • API REST : HTTPを介してあなた自身のアプリケーションにGenCodeDocを統合します。
  • MCP : Model-Context-Protocolを介して公開される17のツールを使用し、IA（Gemini、Claude）でこのツールを操作します。

📦 インストール

前提条件

• Python 3.10以上
• 依存関係の管理にPoetryを使用

インストール手順

1. リポジトリをクローンする：

   git clone https://github.com/VOTRE_NOM/gencodedoc.git
   cd gencodedoc
   

2. Poetryを使って依存関係をインストールする：

   poetry install
   

3. インストールを確認する：

   poetry run gencodedoc --help
   

🔌 MCP統合（AIアシスタント用）

GenCodeDocは、AIによる操作を想定して設計されており、17のツールを3種類のトランスポートモードで公開しています。

• stdio : Gemini CLIなどのCLIクライアント用。
• SSE (Server-Sent Events) : Claude DesktopなどのWebまたはデスクトップアプリケーション用。
• REST : HTTP APIを介した任意のカスタム統合用。

Gemini CLI (stdio) の設定

1. Poetryの仮想環境のパスを見つける：

   # gencodedocのディレクトリから
   poetry env info --path 
   # 返されたパスをコピー
   

2. MCPクライアントの設定にサーバーを追加する： (例：gemini-cliの場合)

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

   /path/to/your/poetry-venvを手順1で取得したパスに、PROJECT_PATHを管理したいプロジェクトのパスに置き換えてください。

SSE / RESTサーバーの起動

# SSEサーバー（Claude Desktop用）
poetry run python -m gencodedoc.mcp.server_sse

# RESTサーバー
poetry run python -m gencodedoc.mcp.server

両サーバーはhttp://127.0.0.1:8000で動作します。

🧰 ツールリファレンス

GenCodeDocは、完全なCLIと豊富なMCP/REST APIを提供します。

主要なCLIコマンド

• gencodedoc init : プロジェクトを初期化します。
• gencodedoc snapshot create|list|show|diff|restore|delete : スナップショットを管理します。
• gencodedoc doc generate|preview|stats : ドキュメントを管理します。
• gencodedoc config show|edit|set|preset|ignore : 設定を管理します。
• gencodedoc status : プロジェクトの現在の状態を表示します。

MCPツール（17のツール）

AI用に利用可能なツールの概要：

• スナップショット管理（6つのツール） : create_snapshot, list_snapshots, get_snapshot_details, restore_snapshot, delete_snapshot, diff_versions。
• ドキュメント（3つのツール） : generate_documentation, preview_structure, get_project_stats。
• プロジェクト管理（2つのツール） : init_project, get_project_status。
• 設定管理（3つのツール） : get_config, set_config_value, apply_preset, manage_ignore_rules。
• 自動保存（3つのツール） : start_autosave, stop_autosave, get_autosave_status。

設定が完了したら、AIに以下のように要求することができます。

"タグv2.1とメッセージ 'Correction du bug de connexion' でスナップショットを作成して" "バージョンv2.0と現在のバージョンの差分を見せて" "プロジェクトの完全なドキュメントを生成して"

🏗️ アーキテクチャと動作原理

GenCodeDocは、設定、バージョン管理、およびドキュメント生成を管理する論理コアを中心に構築されています。このコアは、さまざまなインターフェース（CLI、MCP）を介して公開されています。

ストレージは、パフォーマンスとスペース効率の両方を考慮して最適化されています。

• SQLite は、すべてのメタデータ（スナップショット、ファイルなど）を保存するために使用されます。
• ファイルの内容は、SHA256ハッシュを使用して重複排除されます。同じファイルが100のスナップショットに含まれていても、1回だけ保存されます。
• 内容は、zstandard で圧縮され、ディスク占有領域をさらに削減します。

🤝 コントリビューション

コントリビューションは大歓迎です！

1. プロジェクトをフォークします。
2. 新しい機能用のブランチを作成します (git checkout -b feature/ma-super-feature)。
3. 変更をコミットします (git commit -m 'Ajout de ma super feature')。
4. ブランチをプッシュします (git push origin feature/ma-super-feature)。
5. プルリクエストを作成します。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。