Generate & explain git commands using plain english.
<do your work>
❯ git-genie commit
Generated command: git commit -m 'Update README with commit message example and instructions'pip install pre-commit# .pre-commit-config.yaml
repos:
- repo: https://github.com/danthelion/git-genie
rev: "v0.1.3"
hooks:
- id: git-genie
args: [ '--mode=append' ] # or --mode=replace to replace the original commit messagepre-commit install --hook-type commit-msg<do your work>
~/Personal/git-genie-pre-commit main* ❯ git add . && git commit -m "git-genie please help me write a commit message"
git-genie................................................................Passed
[main 0dc8c69] git-genie please help me write a commit message
git-genie 🧞: Update .pre-commit-config.yaml for git-genie v0.1.1 Add --fix and --exit-non-zero-on-fix for ruff hooks.
1 file changed, 2 insertions(+), 1 deletion(-)In the above example, the commit message includes the original message and the message generated by git-genie.
If you with to replace the original message, use --mode=replace instead of --mode=append.
The results will be similar to the following:
<do your work>
~/Personal/git-genie-pre-commit main* ⇡ ❯ git commit -m "asdsakdfnlsknflag" 3.10.7 repobuddy 14:26:04
git-genie................................................................Passed
[main 9bf1d83] git-genie 🧞: Update pre-commit hook to use "--mode=replace" and change port mapping to "5435:5435".
2 files changed, 2 insertions(+), 2 deletions(-)Notice the original commit message is not included in the commit message.
You can install the CLI as a standalone program using pip:
pip install git-genie❯ git-genie [OPTIONS] INSTRUCTION
For example:
❯ git-genie --explain "Who was the last person to modify the README.md file?"Options:
--explain,-e: Explain the generated git command automatically.--execute,-x: Execute the generated git command automatically.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help,-h: Show this message and exit.--debug: Enable debug mode. This will pass verbose=True to LangChain, which will print the output of each step.
If no options are provided, the program will run in interactive mode.
Optionally, you can add a "gg" alias to your shell's rc file (e.g. ~/.bashrc) to make the command shorter:
alias gg="git-genie"export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxStandalone CLI usage examples
Generating commit messages is done by using the commit command.
This method will create a concise message based on the changes staged for a commit.
❯ git status
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: README.mdLet's generate a commit message for the changed README.md file:
❯ git-genie commit
Generated commit command:git commit -m 'Update README with commit message example and instructions'
(E)xplain or e(X)ecute or (N)ew?: XBy pressing X, the generated commit command will be executed automatically:
Running command: git commit -m 'Update README with commit message example and instructions'
Output:
[commit_gen 75d69ce] Update README with commit message example and instructions
1 file changed, 19 insertions(+)By default, the program will run in interactive mode, where it will ask you if you would like to explain the generated git command, execute it, or generate a new command.
~/git-genie ❯ git-genie "count how many times the README.md file was modified in the last week"
Generated git command: git log --since=1.week -- README.md | grep "^commit" | wc -l
(E)xplain or e(X)ecute or (N)ew?: E
Explanation
git log -> Show commit logs
--since=1.week -> Show commits more recent than a specific date
-- README.md -> Only commits that affect README.md
| -> Pipe the output of the previous command to the next command
grep "^commit" -> Only show lines that start with "commit"
wc -l -> Count the number of lines
e(X)ecute or (N)ew?: X
Running command: git log --since=1.week -- README.md | grep "^commit" | wc -l
Output:
2By using the --explain flag, the program will print the explanation of the generated git command.
~/git-genie ❯ git-genie "amend all previous commits with new email address" --explain
Generated git command: git rebase -i HEAD~5 --autosquash -m "legacy code"
Explanation
git rebase -> Forward-port local commits to the updated upstream head
-i, --interactive -> Make a list of the commits which are about to be rebased.Let the user edit that list before rebasing.
--autosquash -> Automatically move commits that begin with squash!/fixup! to the beginningof the todo list.
-m, --merge -> Use the given message as the merge commit message.If multiple -m options are given, their values are concatenated as separate paragraphs.
HEAD~5 -> The last 5 commits
legacy code -> The message of the merge commitBy using the --execute flag, the program will execute the generated git command automatically without asking for
confirmation.
~/git-genie ❯ git-genie "print last 5 commits logs, condensed" --execute
Generated git command: git log -5 --oneline
Running command: git log -5 --oneline
Output:
9a33bc3 update email
f76f041 CLI interface
ae8abbd Add pycache to gitignore
67169fd rich print
3bac238 RefactorThis project uses Poetry for dependency management. To install the dependencies, run:
poetry installpoetry run python git_genie/main.py "Who was the last person to modify the README.md file?"
Generated git command: git log -1 --pretty=format:"%an" -- README.md
(E)xplain or e(X)ecute or (N)ew?: X
Running command: git log -1 --pretty=format:"%an" -- README.md
Output:
Daniel Palma