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

commit-crafter-ai craft

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.0.4.tar.gz (3.1 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.0.4-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.0.4.tar.gz
  • Upload date:
  • Size: 3.1 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.0.4.tar.gz
Algorithm Hash digest
SHA256 3411f1e2d903c23c19c81332f75b268b9ea659cf8a685160904cfcd4a96d10ea
MD5 7e8b4cd2ae0da48c5e230a46f72767c6
BLAKE2b-256 d06b4b17e66213ff09ebcddc238af826887ebf09ed49cbfa41deaf838533ed09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b75c12097b0b6c3407ef88d4adc9eb4b7523cf7c2cd3462b90a17bd374487d95
MD5 2f0725016465ebb5af7d5d6ee5accdcc
BLAKE2b-256 d364e27191fa3a88f5decc7ee2bb4320de099de829bf54832f0e3ee1d1c84046

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