Skip to content

tsvikas/vibes

Repository files navigation

vibes

Tests uv Ruff Black
Made Using tsvikas/python-template GitHub Discussion PRs Welcome

Overview

Get a commit message from ChatGPT or Claude, with gitmoji ✨.
Talk to the AI and request changes, until you're happy with the message.

Screenshot

Installation

  • Clone the repo
  • Set-up a .env file
  • Use uv to create a venv
  • Link to .venv/bin/vibes

Future improvements: Streamlined installation method.

Usage

Just run vibes in your git repo, to get an LLM to suggest a commit message for your current changes (the index, or the working directory, or the last commit)

Use -r to specify a path to the repo (default .). Use -c to specify a specific commit, or a commit range. Use -d to describe the change to the LLM yourself.

You can chat with the LLM and request changes. When you finish, end the conversation (^C, ^D, exit, quit, or Enter) and use the message.

Future improvements: The ability to control the prompt, and the template.

Development

Getting started

  • install git, uv.
  • git clone this repo: git clone tsvikas/vibes.git
  • run uv run just prepare

Tests and code quality

  • use uv run just format to format the code.
  • use uv run just lint to see linting errors.
  • use uv run just test to run tests.
  • use uv run just check to run all the checks (format, lint, test, and pre-commit).
  • Run a specific tool directly, with uv run pytest/ruff/mypy/black/...

About

Get a commit message from ChatGPT, with emojies! ✨

Resources

License

Stars

Watchers

Forks

Packages

No packages published