Skip to content

Latest commit

 

History

History
78 lines (58 loc) · 2.32 KB

README.md

File metadata and controls

78 lines (58 loc) · 2.32 KB
Raw

bunnai

have ai write commit messages for you in lazygit.

uses openai to generate commit message suggestions based on the diff between the current branch and master. then you can select a commit message from the list and use it to commit your changes.

installation

bun install -g @chhoumann/bunnai

set up with your openai api key & preferred model:

bunnai config

usage

you can specify custom templates. use bunnai config to edit the templates. when you invoke bunnai, you can specify a template name to use with --template.

as a menu

this creates a menu of commit messages based on the diff between the current branch and master.

insert the following custom command into your lazygit config file:

customCommands:
    - key: "<c-a>" # ctrl + a
        description: "pick AI commit"
        command: 'git commit -m "{{.Form.Msg}}"'
        context: "files"
        prompts:
            - type: "menuFromCommand"
            title: "ai Commits"
            key: "Msg"
            command: "bunx bunnai"
            filter: '^(?P<number>\d+)\.\s(?P<message>.+)$'
            valueFormat: "{{ .message }}"
            labelFormat: "{{ .number }}: {{ .message | green }}"

with vim

this allows you to edit the commit message in vim after you've selected it from the menu.

abort comitting by deleting the commit message in vim.

customCommands:
    - key: "<c-a>" # ctrl + a
      description: "Pick AI commit"
      command: 'echo "{{.Form.Msg}}" > .git/COMMIT_EDITMSG && vim .git/COMMIT_EDITMSG && [ -s .git/COMMIT_EDITMSG ] && git commit -F .git/COMMIT_EDITMSG || echo "Commit message is empty, commit aborted."'
      context: "files"
      subprocess: true
      prompts:
          - type: "menuFromCommand"
            title: "AI Commits"
            key: "Msg"
            command: "bunx bunnai"
            filter: '^(?P<number>\d+)\.\s(?P<message>.+)$'
            valueFormat: "{{ .message }}"
            labelFormat: "{{ .number }}: {{ .message | green }}"

acknowledgements

check out these other projects that inspired this one: