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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 d04a5b3b12dc0bca8a60115fa197cbc174ac5fc1400db5cb591c0f7a0e3ab9d2
MD5 a46b36a360c7a562b7be7fce09ab7b59
BLAKE2b-256 0e61a482f81a5b8b36c61906a56318d9c7405377002799b3eef75a970e31b48c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 164891fb09939fc5ee4f24d152d75606f75ada0b8d07283910a4cee0d5b76596
MD5 50dbbd2d91c37e3847833514436a14ec
BLAKE2b-256 18bfa8b25807e82f8c170cb434420193b08f8eb944decd0b01949892584e818d

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