https://github.com/ryanvu/mai_pr.nvim
Mai Pull Request is a Neovim plugin that helps you generate commit messages and pull requests directly from your Neovim editor.
https://github.com/ryanvu/mai_pr.nvim
lua neovim-plugin nvim nvim-plugin openai-api
Last synced: 11 months ago
JSON representation
Mai Pull Request is a Neovim plugin that helps you generate commit messages and pull requests directly from your Neovim editor.
- Host: GitHub
- URL: https://github.com/ryanvu/mai_pr.nvim
- Owner: ryanvu
- License: mit
- Created: 2024-10-01T20:41:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T06:19:02.000Z (over 1 year ago)
- Last Synced: 2025-02-24T19:01:38.946Z (about 1 year ago)
- Topics: lua, neovim-plugin, nvim, nvim-plugin, openai-api
- Language: Lua
- Homepage:
- Size: 44.9 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mai Pull Request
Mai Pull Request is a Neovim plugin that helps you generate commit messages and pull requests directly from your Neovim editor.
## Features
- Create pull requests from within Neovim
- View diffs of staged files
- Integrates with OpenAI for PR description & commit message generation
## Requirements
- Neovim >= 0.7.0
- Git (installed and configured in your system)
- OpenAI API key (for PR description generation)
## Installation
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
Add the following to your Neovim configuration:
```lua
{
"ryanvu/mai_pr.nvim",
config = function()
require("mai_pull_request").setup({
-- your configuration here
})
end,
dependencies = {
"MunifTanjim/nui.nvim",
},
}
```
## Configuration
You can configure Mai Pull Request by passing options to the `setup` function:
```lua
require("mai_pull_request").setup({
api_key = "your-openai-api-key", -- Set your OpenAI API key here
create_commands = true, -- Set to false if you don't want to create commands
model = "gpt-4o-mini", -- OpenAI model to use
max_tokens = 4096, -- Maximum number of tokens for OpenAI requests
temperature = 0.5, -- Temperature for OpenAI requests
verbose_commit = false, -- Defaults to have non-verbose one-liner commit messages
})
```
## Usage
After installation and configuration, you can use the following commands:
- `:MaiPR`: Create a new pull request for the current branch
- `:MaiDiffToCommit`: View the diff for the current branch
- `:MaiDiffBetweenBranches `: View the diff between two branches
## Default Keymaps
The plugin sets up the following default keymaps:
- `pr`: Create a new pull request (equivalent to `:MaiPR`)
- `vd`: View diff to commit (equivalent to `:MaiDiffToCommit`)
You can customize these keymaps in your Neovim configuration if desired.
## Screenshots
> Generated commit message
> Diff between branches
> Generated PR
## Environment Variables
If you prefer not to store your OpenAI API key in your configuration, you can set it as an environment variable:
```sh
export OPEN_AI_API_KEY=your-api-key-here
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Support
If you encounter any problems or have any questions, please open an issue on the GitHub repository.