Code Monkey home page Code Monkey logo

commit's Introduction

Tests GitHub release MIT license lint workflow help wanted

commit CLI Tool

commit is an AI-powered commit message generator that helps you streamline your version control workflow.

Overview

Instead of racking your brains for a descriptive commit message, simply run the commit tool. It will automatically stage all changed files in your git repository and craft a concise, meaningful commit message for you.

Features:

  • AI-Powered: Leverages OpenAI to generate commit messages.
  • Automatic Staging: Stages all changed files in the git repository.
  • Customizable: Works with user-provided keys and paths.

Installation:

go install github.com/kaatinga/commit@latest

Usage:

commit [global options] command [command options] [arguments...]

Global Options:

  • --key value: Provide a valid key to work with ChatGPT.
  • --path value: Specify the path to your git repository.
  • --help, -h: Display help information.
  • --version, -v: Print the current version of the tool.

Environment Variable:

The tool can optionally read from the OPENAI_API_KEY environment variable to interface with the OpenAI API. Ensure you set this variable if you don't intend to use the --key option directly.

Example:

commit --key abcdefg --path /home/user/my-repo

or just:

commit

For further help or to view a list of commands, run:

commit help

commit's People

Contributors

kaatinga avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.