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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 da11b6f95e4a72af8948e2c0790b165d2d69a241ffaa78792b31ad034fbfa68e
MD5 439921937148bf5e940fac0585b49a49
BLAKE2b-256 6a959391744957ace0d05e97596b020c97252ab9ae09e9f616fc0b8d61efd188

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a2118a2c81c8d5496d080446398d71e80645d7a66b34abb7403f9b4128c0a57
MD5 e51d5a445aec05a246c4c99ef3a43214
BLAKE2b-256 886c731a86060e922d725d1354b2db0194c10cce77ee6d2253bc7104fed08330

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