Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# @aigen/commit-gen 🚀
# commitly 🚀

AI-powered commit message generator using OpenAI. Get meaningful and structured commit messages in seconds!


[![NPM Version](https://img.shields.io/npm/v/fireorm.svg?style=flat)](https://www.npmjs.com/package/@aigen/commit-gen)
[![NPM Version](https://img.shields.io/npm/v/fireorm.svg?style=flat)](https://www.npmjs.com/package/commitly)
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
---
Expand All @@ -22,13 +22,13 @@ AI-powered commit message generator using OpenAI. Get meaningful and structured
No need to install globally. Use it directly via `npx`:

```bash
npx @aigen/commit-gen generate # Generate commit message
npx commitly generate # Generate commit message
```

Alternatively, install globally:

```bash
npm install -g @aigen/commit-gen
npm install -g commitly
```

## 🔥 Usage
Expand All @@ -37,22 +37,22 @@ npm install -g @aigen/commit-gen
Generate a Commit Message

```bash
npx @aigen/commit-gen generate
npx commitly generate
// or
npx @aigen.commit-gen g
npx commitly g
```

## Configure OpenAI API Key
```bash
npx @aigen/commit-gen configure
npx commitly configure
```

This securely stores your API key in `~/.env`.

Commit with AI-generated Message
```bash
git add .
npx @aigen/commit-gen generate
npx commitly generate
```
After generating the commit message, you’ll be asked to confirm before it is committed.

Expand Down
2 changes: 1 addition & 1 deletion cli/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const program = new Command();
setupLogger();

program
.name("@aigen/commit-gen")
.name("commitly")
.description("Generate AI-crafted commit messages")
// .option("-g, --generate", "Generate a commit message")
.version("1.0.2");
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@aigen/commit-gen",
"name": "commitly",
"bin": {
"@aigen/commit-gen": "cli/index.js"
"commitly": "cli/index.js"
},
"main": "./cli/index.js",
"type": "module",
Expand All @@ -22,6 +22,6 @@
"access": "public"
},
"keywords": [
"@aigen/commit-gen"
"commitly"
]
}