New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

@yuankui/auto-commit

Package Overview
Dependencies
Maintainers
0
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@yuankui/auto-commit

AI-powered git commit message generator

latest
Source
npmnpm
Version
1.1.0
Version published
Maintainers
0
Created
Source

Auto Commit

A TypeScript tool that helps generate commit messages using ChatGPT API.

Features

  • Automatically detects changes in your git repository
  • Uses OpenAI's GPT model to suggest commit messages based on your changes
  • Interactive CLI to choose from suggested commit messages
  • Automatically commits changes with the selected message

Setup

  • Install the package:
npm install -g @yuankui/auto-commit
  • Run the tool:
auto-commit

On first run, you'll be prompted to enter your OpenAI API key. The key will be saved in ~/.auto-commit.env for future use.

Development Setup

  • Install dependencies:
npm install
  • Copy .env.example to .env and add your OpenAI API key:
cp .env.example .env

Then edit .env and add your OpenAI API key:

OPENAI_API_KEY=your_api_key_here

Usage

When you have changes you want to commit, simply run:

npm run dev

The tool will:

  • Check for changes in your repository
  • Generate commit message suggestions using ChatGPT
  • Let you choose from the suggested messages
  • Automatically commit your changes with the selected message

Development

  • Build the project:
npm run build
  • Format code:
npm run format
  • Check code formatting:
npm run format:check

Keywords

git

FAQs

Package last updated on 02 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts