https://github.com/chhoumann/bunnai

cli to inject ai-generated commit messages into lazygit
https://github.com/chhoumann/bunnai

ai bun cli lazygit

Last synced: 2 months ago
JSON representation

cli to inject ai-generated commit messages into lazygit

• Host: GitHub
• URL: https://github.com/chhoumann/bunnai
• Owner: chhoumann
• Created: 2024-02-02T08:43:48.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-04-14T15:14:59.000Z (9 months ago)
• Last Synced: 2024-05-01T16:35:17.953Z (8 months ago)
• Topics: ai, bun, cli, lazygit
• Language: TypeScript
• Homepage:
• Size: 104 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bunnai



  



have ai write commit messages for you in [lazygit](https://github.com/jesseduffield/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

```sh

bun install -g @chhoumann/bunnai

```

set up with your openai api key & preferred model:

```sh

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](https://github.com/jesseduffield/lazygit) config file:

```yaml

customCommands:

    - key: "" # 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\d+)\.\s(?P.+)$'

            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.

```yaml

customCommands:

    - key: "" # 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\d+)\.\s(?P.+)$'

            valueFormat: "{{ .message }}"

            labelFormat: "{{ .number }}: {{ .message | green }}"

```

## acknowledgements

check out these other projects that inspired this one:

-   https://github.com/BuilderIO/ai-shell