Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/warengonzaga/magic-commit

You can do magicc, you can build anything that you desire. 🪄🔮💻
https://github.com/warengonzaga/magic-commit

ai ai-commit aicommit cli commit devtool git gpt magic openai opencommit terminal tool

Last synced: 22 days ago
JSON representation

You can do magicc, you can build anything that you desire. 🪄🔮💻

Host: GitHub
URL: https://github.com/warengonzaga/magic-commit
Owner: warengonzaga
License: gpl-3.0
Created: 2024-03-01T10:44:22.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-04-05T16:06:00.000Z (7 months ago)
Last Synced: 2024-04-15T07:17:43.788Z (7 months ago)
Topics: ai, ai-commit, aicommit, cli, commit, devtool, git, gpt, magic, openai, opencommit, terminal, tool
Language: JavaScript
Homepage:
Size: 1.59 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- Funding: .github/funding.yml
- License: license
- Code of conduct: code_of_conduct.md
- Security: security.md

Awesome Lists containing this project

README

        # Magic Commit 🪄 [![author/maintainer](https://img.shields.io/badge/by-Waren%20Gonzaga-016eea.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://warengonzaga.com) [![nominate](https://img.shields.io/badge/nominate-%20@warengonzaga%20as%20GitHub%20Star-yellow.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://stars.github.com/nominate)

[![made with](https://img.shields.io/badge/made%20with-Open%20Source%20Software%20PH-0060a0.svg?logo=github&longCache=true&labelColor=181717&style=flat-square)](https://github.com/ossphilippines) [![sponsors](https://img.shields.io/badge/sponsor-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=flat-square)](https://github.com/sponsors/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/magic-commit.svg?logo=github&labelColor=181717&color=green&style=flat-square)](https://github.com/warengonzaga/magic-commit/releases) [![star](https://img.shields.io/github/stars/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&color=yellow&style=flat-square)](https://github.com/warengonzaga/magic-commit/stargazers) [![license](https://img.shields.io/github/license/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&style=flat-square)](https://github.com/warengonzaga/magic-commit/blob/main/license) [![NPM Installs](https://img.shields.io/npm/dt/magicc?color=CB3837&logo=npm&label=installs&labelColor=181717&style=flat-square)](https://npmjs.com/package/magicc)

[![banner](https://raw.githubusercontent.com/warengonzaga/magic-commit/main/.github/assets/repo_banner.jpg)](https://github.com/warengonzaga/magic-commit)

You can do `magicc`, you can build anything that you desire. 🪄🔮💻

**Magic Commit** is a simple and easy-to-use tool that helps you to automatically stage your changes by file and commit them one by one. All you need to do is type `magicc` and accept if you love the suggested commit message in every changed files. It uses `gpt-4o-mini` as the default model from OpenAI to generate commit messages. 🪄

Have suggestions in mind? [Let me know!](https://github.com/warengonzaga/magic-commit/issues)

> [!IMPORTANT]  

> This project is still in it's early stage so expect some bugs and issues. Please report any issues you encounter. Thank you! 🙏

Like this project? **Leave a star**! ⭐⭐⭐⭐⭐

## 😎 Demo

[![demo](https://raw.githubusercontent.com/warengonzaga/magic-commit/main/.github/assets/demo.gif)](https://github.com/warengonzaga/magic-commit)

## 🕹️ Usage

Save all of your changes and after that run the following command:

```bash

magicc

```

This will automatically stage your changes by file and commit them one by one. All you need to do is type `magicc` and accept if you love the suggested commit message in every changed files. 🪄

> [!NOTE]  

> To be able to make it work it requires API key from [OpenAI](https://openai.com) to use the GPT-3 model. You can get your API key by signing up to their website. Once you have the API key, you can set it up by running the following command:

>

> ```bash

> magicc -s=

> ```

>

> This will save your API key to the configuration file and you can now use the `magicc` command. I'm considering to find a provider that offers free API key for this project. 🙏 _(if you are reading this [contact me](mailto:[email protected]).)_

## 📦 Installation

You can install this project via `npm` or `yarn`.

```bash

npm install -g magicc

```

or

```bash

yarn global add magicc

```

## 💖 Motivation

I created this project because I wanted a simple and easy-to-use tool that follows my own git commit standard by default. Additionally, I wanted to learn how to build AI-based developer tools. The goal of this project is to provide a user-friendly experience for everyone. If you're looking for more advanced features, I recommend checking out the other projects mentioned below. 🙏

This project is inspired by the following projects:

- [aicommits](https://github.com/Nutlope/aicommits) - A CLI that writes your git commit messages for you with AI.

- [ai-commit](https://github.com/insulineru/ai-commit) - Make commits easier with ChatGPT, Gitmoji and Conventional Commits.

- [opencommit](https://github.com/di-sukharev/opencommit) - About

Auto-generate impressive commits with AI in 1 second.

- [tgpt](https://github.com/aandrew-me/tgpt) - AI Chatbots in terminal without needing API keys.

## ⚙️ Project Activity

![activity](https://repobeats.axiom.co/api/embed/b89d4c52ac63656f8148143516edd0db0d85788d.svg "Repobeats analytics image")

## 🎯 Contributing

Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you!

Read the project's [contributing guide](./contributing.md) for more info.

## 🐛 Issues

Please report any issues and bugs by [creating a new issue here](https://github.com/warengonzaga/magic-commit/issues/new/choose), also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨

## 🙏 Sponsor

Like this project? **Leave a star**! ⭐⭐⭐⭐⭐

Want to support my work and get some perks? [Become a sponsor](https://github.com/sponsors/warengonzaga)! 💖

Or, you just love what I do? [Buy me a coffee](https://buymeacoffee.com/warengonzaga)! ☕

Recognized my open-source contributions? [Nominate me](https://stars.github.com/nominate) as GitHub Star! 💫

## 📋 Code of Conduct

Read the project's [code of conduct](./code_of_conduct.md).

## 📃 License

This project is licensed under [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0).

## 📝 Author

This project is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/magic-commit/graphs/contributors).

[![contributors](https://contrib.rocks/image?repo=warengonzaga/magic-commit)](https://github.com/warengonzaga/magic-commit/graphs/contributors)

---

💻 with ❤️ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏