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.6.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.6-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 d10059d75c4b86c45054762c8b4147c4b2190459a9580e6a2783540aed0c3b18
MD5 b5bab39e564681b7ff0bb5f5fbc9baf7
BLAKE2b-256 20434c3011c9ce8984f7bc36cd8bf0fe14d5ab64be4c44df6b91e1bdcbf1c92a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a2b5e10458386e78a45bcce1ced959f7a06f074ef7f4bc7ee7ee2957de2d2f4c
MD5 da03cb894b4019f52e0f171d53501eea
BLAKE2b-256 fa9f8887903b7e34add80f25fe6478ecc2d1483c3872f1b065a91b12a515e09f

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