[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE) ### Git integration See more details in [Features](#features) and [help file](../doc/mini-git.txt). --- ⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-git.md) if you want to mention this module. ⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'. ⦿ See the repository page to learn about common design principles and configuration recipes. --- If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories. ## Demo https://github.com/echasnovski/mini.nvim/assets/24854248/3c2b34cd-f04f-4e30-9ca4-1ff51e2d65a2 **Note**: This demo uses custom `vim.notify()` from [mini.notify](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-notify.md) and diff line number highlighting from [mini.diff](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-diff.md). ## Features - Automated tracking of [Git](https://git-scm.com/) related data: root path, status, HEAD, etc. Exposes buffer-local variables for convenient use in statusline. - `:Git` command for executing any `git` call inside file's repository root with deeper current instance integration (show output as notification/buffer, use to edit commit messages, etc.). - Helper functions to inspect Git history: - `MiniGit.show_range_history()` shows how certain line range evolved. - `MiniGit.show_diff_source()` shows file state as it was at diff entry. - `MiniGit.show_at_cursor()` shows Git related data depending on context. What it doesn't do: - Replace fully featured Git client. Rule of thumb: if feature does not rely on a state of current Neovim (opened buffers, etc.), it is out of scope. For more functionality, use either ['mini.diff'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-diff.md) or fully featured Git client. To read more information, see these tags in help file: - `*:Git*` - `*MiniGit-examples*` - `*MiniGit.enable()*` - `*MiniGit.get_buf_data()*` ## Installation This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository. There are two branches to install from: - `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled). - `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch. Here are code snippets for some common installation methods (use only one):

With mini.deps

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Follow recommended 'mini.deps' installation
	Stable
Standalone plugin	Main	add('echasnovski/mini-git')
	Stable	add({ source = 'echasnovski/mini-git', checkout = 'stable' })

With folke/lazy.nvim

Github repo	Branch	Code snippet
'mini.nvim' library	Main	{ 'echasnovski/mini.nvim', version = false },
	Stable	{ 'echasnovski/mini.nvim', version = '*' },
Standalone plugin	Main	{ 'echasnovski/mini-git', version = false, main = 'mini.git' },
	Stable	{ 'echasnovski/mini-git', version = '*', main = 'mini.git' },

With junegunn/vim-plug

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Plug 'echasnovski/mini.nvim'
	Stable	Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }
Standalone plugin	Main	Plug 'echasnovski/mini-git'
	Stable	Plug 'echasnovski/mini-git', { 'branch': 'stable' }

**Important**: don't forget to call `require('mini.git').setup()` to enable its functionality. **Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following: - Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall. ## Default config ```lua -- No need to copy this inside `setup()`. Will be used automatically. { -- General CLI execution job = { -- Path to Git executable git_executable = 'git', -- Timeout (in ms) for each job before force quit timeout = 30000, }, -- Options for `:Git` command command = { -- Default split direction split = 'auto', }, } ``` ## Similar plugins - [tpope/vim-fugitive](https://github.com/tpope/vim-fugitive) - [NeogitOrg/neogit](https://github.com/NeogitOrg/neogit) - [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)