How do I set up cmp-git with lazy.nvim?

In your lazy.nvim config, add cmp-git as a plugin with dependencies, include it in nvim-cmp sources via the init function, and call setup with options. The README provides a code snippet showing this exact process.

cmp-git vs coc-git, which one should I use?

cmp-git is designed for nvim-cmp in Neovim, offering more customization and support for both GitHub and GitLab. coc-git is for the coc.nvim ecosystem and might be better if you're already using coc.nvim, but cmp-git is more flexible for nvim-cmp users.

Does cmp-git work with private GitHub repositories?

Yes, but it requires setting up authentication. You need to generate a GitHub API token with repo scope and set the GITHUB_API_TOKEN environment variable, or use GitHub CLI with gh auth login, as detailed in the README.

Can I customize the trigger characters in cmp-git?

Yes, you can define custom triggers in the trigger_actions table of the config, but currently, trigger characters must be single characters. This allows for specific behaviors, though it might conflict with other plugins.

Why isn't cmp-git showing completions for my Git commits?

Ensure you have git installed and the trigger character ':' is typed in supported filetypes like gitcommit. Also, check that nvim-cmp is properly configured and the sorting comparators include cmp.config.compare.sort_text as per the README notes.

How to add support for a custom GitLab instance in cmp-git?

Add the hostname to the hosts list in the gitlab section of the setup config, and ensure authentication is set up with tokens or CLI. The README includes an example for configuring private instances.

cmp-git

MITLua

A Neovim completion source for nvim-cmp that provides Git commits, GitHub issues/PRs/mentions, and GitLab issues/MRs/mentions.

GitHub

What is cmp-git?

cmp-git is a Neovim plugin that serves as a completion source for nvim-cmp, providing autocompletion for Git commits, GitHub issues/pull requests/mentions, and GitLab issues/merge requests/mentions. It solves the problem of manually looking up Git references or repository items by offering intelligent suggestions directly in the editor.

Target Audience

Neovim users who frequently work with Git and remote repositories like GitHub or GitLab, especially those writing commit messages or referencing issues/PRs in their workflow.

Value Proposition

Developers choose cmp-git because it integrates Git and repository platform workflows seamlessly into Neovim, reducing context switching and improving productivity with configurable, trigger-based completions.

Overview

Git source for nvim-cmp

Use Cases

Best For

Writing Git commit messages with autocompleted commit hashes
Referencing GitHub issues or pull requests in comments or commit messages

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

421 stars24 forks0 contributors

Mentioning GitHub users in repository discussions

Working with GitLab issues and merge requests from within Neovim

Using private GitHub Enterprise or GitLab instances in Neovim

Customizing autocompletion triggers for specific Git operations

Not Ideal For

Users working with version control systems other than Git, like Mercurial or SVN
Developers who do not use nvim-cmp as their completion engine in Neovim
Projects that require autocompletion for Git branches or tags, which cmp-git does not support
Teams using only basic Git commands without referencing issues or pull requests from GitHub/GitLab

Pros & Cons

Pros

Comprehensive Platform Integration

Supports both GitHub and GitLab for issues, pull/merge requests, and mentions, as shown in the trigger tables, reducing the need to switch between tools.

Flexible Configuration Options

Offers detailed control over limits, sorting, formatting, and state filters for each source, evidenced by the extensive config section in the README.

Private Instance Support

Works with hosted GitHub Enterprise or GitLab instances via the hosts configuration, making it suitable for corporate or private repository workflows.

Customizable Trigger Actions

Allows defining specific trigger characters and actions for different Git operations, enabling tailored completions as per user needs.

Cons

External Dependency Reliance

Requires curl and optionally GitHub CLI or GitLab CLI, along with API token setup for private repos, adding complexity to the initial configuration.

Complex Configuration Overhead

Setup involves manually adding triggers in the trigger_actions table and adjusting nvim-cmp sorting comparators, which can be non-trivial for beginners.

Limited Git Feature Coverage

Does not support completions for common Git elements like branches or tags, focusing only on commits and platform-specific items, which may be insufficient for some workflows.

Frequently Asked Questions

Home

Neovim

nvim-cmp

A completion plugin for neovim coded in Lua.

Stars9,436

Forks436

Last commit2 months ago

nvim-mini/mini.nvim#mini.completion

Library of 40+ independent Lua modules improving Neovim experience with minimal effort

Stars9,231

Forks306

Last commit2 days ago

blink.cmp

Performant, batteries-included completion plugin for Neovim

Fully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot

Stars4,081

Forks158

Last commit2 days ago