demo.mov

🤖 Commit

Generate conventional commits with AI

📖 Usage

Ensure you have read, tr, jq, git, tail, sed, and curl installed on your system. Most developers will already have these tools, but if you need to install them, use the following commands for your operating system:

# macOS
$ brew install jq git curl tail sed read tr

# Linux (Debian-based)
$ sudo apt install jq git curl tail sed read tr

# Linux (Red Hat-based)
$ sudo dnf install jq git curl tail sed read tr

# Linux (Arch-based)
$ sudo pacman -S jq git curl tail sed read tr

Or if you already have curl you can run the following script to detect OS and install it automatically.

$ curl -s https://commit.jaw.dev/install.sh | sh

After confirming the installation of these tools, navigate to any project directory that uses git. Within this directory, execute the commit script with the following command:

$ curl -s https://commit.jaw.dev/ | sh

Options

• -ai, --ai-provider Specify AI provider (openai or gemini, default: gemini)
• -k, --api-key Specify the API key for the AI provider
• -dr, --dry-run Run the script without making any changes
• -nv, --no-verify Skip message selection
• -h, --help Display this help message

Example Commands

$ curl -s https://commit.jaw.dev/ | sh -s -- --no-verify
$ curl -s https://commit.jaw.dev/ | sh -s -- --dry-run
$ curl -s https://commit.jaw.dev/ | sh -s -- -ai openai
$ curl -s https://commit.jaw.dev/ | sh -s -- -ai gemini
$ curl -s https://commit.jaw.dev/ | sh -s -- -ai openai --api-key YOUR_API_KEY
$ curl -s https://commit.jaw.dev/ | sh -s -- -ai gemini --api-key YOUR_API_KEY
$ curl -s https://commit.jaw.dev/ | sh -s -- -nv
$ curl -s https://commit.jaw.dev/ | sh -s -- -dr
$ curl -s https://commit.jaw.dev/ | sh -s -- -h
$ curl -s https://commit.jaw.dev/ | sh

📑 Docs

• See RECIPE for recipe guide.
• See DEVELOPMENT for development guide.
• See CONTRIBUTION for contribution guide.

📜 License

Distributed under the MIT License © wajeht. See LICENSE for more information.