Skip to main content

AI-powered commit message generator

Project description

commit-crafter-ai

Ai tool to craft commit from terminal.

Installation

pip install commit-crafter-ai

Usage

Craft a commit message and directly create a commit

commit-crafter-ai craft

Craft a commit message and copy it to clipboard

commit-crafter-ai craft --copy

License

This project is licensed under the MIT License - see the LICENSE file for details.

Features

  • Generates clear and concise commit messages
  • Follows conventional commit format
  • Provides detailed descriptions of changes
  • Easy to use command-line interface

Requirements

  • Python 3.7+
  • OpenAI API key

Setup

  1. Export your OpenAI API key:
# Linux/macOS
export OPENAI_API_KEY="your-api-key-here"

# Windows (Command Prompt)
set OPENAI_API_KEY=your-api-key-here

# Windows (PowerShell)
$env:OPENAI_API_KEY="your-api-key-here"
  1. The API key can also be added to your shell configuration file (~/.bashrc, ~/.zshrc, etc.) for persistence:
echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.bashrc  # or ~/.zshrc

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

commit_crafter_ai-1.1.2.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

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

commit_crafter_ai-1.1.2-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file commit_crafter_ai-1.1.2.tar.gz.

File metadata

  • Download URL: commit_crafter_ai-1.1.2.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for commit_crafter_ai-1.1.2.tar.gz
Algorithm Hash digest
SHA256 6828c33c230d2f94da085751f63c1ba4151ba1affaa0cc9e979fb6d5f02e4803
MD5 97a408a9aa4fdc694aaa98b36d534547
BLAKE2b-256 48661084c0167671c2f9fad3e73c787b967e655ca53baa860a49ef89ac8ac9c9

See more details on using hashes here.

File details

Details for the file commit_crafter_ai-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for commit_crafter_ai-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cf0458bc324e905cbe8953a2afbce59c57bc82b87040323ee548240c7b5b9110
MD5 8faf2f91c03f623ef0921496fd42c764
BLAKE2b-256 c02da95e32d9c985d8563a537578f7c7c3e549b2590450db5eb935dc19437714

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