From 58c2b4f80ecdb376e622e2109d2f79bdba1c1439 Mon Sep 17 00:00:00 2001 From: uliboooo Date: Thu, 4 Dec 2025 15:07:49 +0900 Subject: [PATCH] add docs --- docs/index.html | 354 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 354 insertions(+) create mode 100644 docs/index.html diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..748a151 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,354 @@ + + + + + + + Ghost Git Writer (ggw) - AI-Powered Git Assistant + + + + + + + + + + + +
+
+ ✨ Rust製 高速AI Gitアシスタント +
+ +

+ AIにコミットを任せよう +

+ +

+ コミットメッセージ、README、Diffの要約をLLMが自動生成。
+ Rust製のCLIツール ggw でGitワークフローを加速させましょう。 +

+ + +
+
+
+
+
+ user@dev:~/project +
+
+
+ ❯ + ggw commit +
+
+ ⠏ LLM call...finished. +
+
+
+ Generated msg:
+ feat: Set up Emacs with configuration migrated from Neovim +
+
continue?(y/n)> y
+
+
+
+ + +
+
+
+
+ $ + cargo install ghost_git_writer + +
+
+ + GitHubを見る + +
+
+ + +
+
+

Supported LLM Providers

+
+ Gemini + OpenAI + Anthropic + DeepSeek + Ollama (Local) +
+
+
+ + +
+

Git作業を自動化する4つの機能

+
+ +
+
+ +
+

スマートなコミット生成

+

+ 変更内容（diff）を解析し、Conventional Commits形式の適切なメッセージを提案します。日本語出力も対応。 +

+
+ + +
+
+ +
+

README 自動作成

+

+ ソースコードを読み込み、プロジェクトの概要、インストール方法、使い方を含むREADME.mdを生成します。 +

+
+ + +
+
+ +
+

Diff サマリー

+

+ 大量の差分を読むのは大変です。AIが変更点の要約を作成し、何が変わったのかを即座に把握できます。 +

+
+ + +
+
+ +
+

SemVer 推奨

+

+ 変更内容に基づいて、セマンティックバージョニングのどのフィールド（Major/Minor/Patch）を上げるべきかアドバイスします。 +

+
+
+
+ + +
+
+

Usage Examples

+ +
+ +
+

# 特定のモデルと日本語を指定してコミットメッセージを生成

+
+ ggw commit -m gemini/gemini-2.0-flash -l japanese +
+
+ + +
+

# パイプを使ってステージングされた変更を処理

+
+ git diff --staged | ggw commit --stdin +
+
+ + +
+

# 特定のコミットとの差分を要約

+
+ ggw sumdiff -D 76fd1d0 +
+
+
+
+
+ + + + + + + + + \ No newline at end of file