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.1.0.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.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 c29badbc8df62385609939826b48cdce0b2fc04f4bd7c6ab43b75eacd5f5a240
MD5 c6e20c6b4a401c59d2ac4a8695973e0a
BLAKE2b-256 b3e923fbd944dea7dd5884e8d954c1deb897f727e4881e820c67076671f03ed9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f8008e444711f2c861f4a20df17c6015fb51584c1b20767c44e59a96cf475e5
MD5 4d8d70aab3a9b1bd1a19ec19cfa9539d
BLAKE2b-256 31d19a077346e9192a2d252bc75710a9c81490ba1b965a7c4e9be942804b3f33

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