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

Craft a commit message and directly create a commit

commit-crafter-ai craft

Craft a commit message and copy it to clipboard

commit-crafter-ai craft --copy

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.2.0.tar.gz (3.4 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.2.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.2.0.tar.gz
  • Upload date:
  • Size: 3.4 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.2.0.tar.gz
Algorithm Hash digest
SHA256 46ad94a96463312ed4f4521e3fee44e002f2576b2878e00b306977a46855687a
MD5 be3b7b94b5d5413aac73bf0d033a7a63
BLAKE2b-256 de138cee7f29946017c10bd797bf5a52517e53bf259d0ba468845b7327a41679

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d249f82947b40161da0f7111aa5fe9e0479f1dfe4ddfafa8ac8f7796bc282ea
MD5 3bacdc8f82e655b2b4328b18f335ef03
BLAKE2b-256 151a053bd59ffe4370bc8860d46420020acaa7a6c6f722b23212d554b6cceb24

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