Skip to main content

A CLI tool that generates semantic Japanese commit message prompts for LLMs from Git diff information.

Project description

komitto(コミット)

git diffの情報から、セマンティックな日本語のコミットメッセージプロンプトを生成するためのCLIツールです。生成されたプロンプトは自動的にクリップボードにコピーされ、LLMに貼り付けることで、コミットメッセージを作成できます。

主な機能

  • ステージングされた変更(git diff --staged)を解析
  • 変更内容をLLMが理解しやすいXML形式に変換
  • コミットメッセージ生成用のシステムプロンプトと結合
  • 生成された最終的なプロンプトをクリップボードにコピー
  • 変更に関する追加のコンテキスト(補足情報)をコマンドライン引数で付与する機能

インストール

pip install .

もし開発用にインストールする場合は、以下のコマンドを使用してください。

pip install -e .

使い方

  1. リポジトリで変更を行い、git addでファイルをステージングします。

    git add <変更したファイル>
    
  2. komittoコマンドを実行します。

    komitto
    
  3. ✅ プロンプトをクリップボードにコピーしました! と表示されたら、お使いのLLMのインターフェースにプロンプトを貼り付けてください。

追加コンテキストを渡す

変更の意図や特記事項など、プロンプトに含めたい補足情報がある場合は、引数として渡すことができます。

komitto "この変更は緊急のバグ修正です"

仕組み

  1. git diff --staged を実行し、ステージングされたファイルの差分を取得します。
  2. 差分情報を、ファイルパス、関数/クラス名、変更の種類(追加、修正、削除)などを含む構造化されたXML形式に変換します。
  3. あらかじめ定義されたシステムプロンプト、ユーザーが指定した追加コンテキスト、XML形式の差分情報を結合して、最終的なプロンプTプを生成します。
  4. 生成されたプロンプトをクリップボードにコピーします。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

komitto-0.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

komitto-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file komitto-0.1.0.tar.gz.

File metadata

  • Download URL: komitto-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for komitto-0.1.0.tar.gz
Algorithm Hash digest
SHA256 511d44e3a5c8bdf2586b968a0c9afb2a3ca0dfe692823a4369fd6c318becae1d
MD5 8eb3bcd322d2b2c24b3320943f7a6cd4
BLAKE2b-256 55e2fe63534fb5675c8aa6e80f9c2fbb9d81d9fba09a11717d1eded779d56aa7

See more details on using hashes here.

File details

Details for the file komitto-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: komitto-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for komitto-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e1d6868dc34c8b0117f42ab4081527abc32a6522304d960fb9aef9818939f10
MD5 e9855a984c55d89570210ab6fd8cab2c
BLAKE2b-256 3aefc4ab31122d621d214d03ca37db449749d16661ae899c5e8f0d598af403d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page