docs(neovim): fix plugin repo name and add missing setup() call by shawilly · Pull Request #628 · agent-sh/agnix

shawilly · 2026-03-05T22:37:12Z

The Neovim install snippets referenced a non-existent agnix.nvim repo.
The correct plugin identifier is agent-sh/agnix, and require("agnix").setup() is required for the plugin to initialize.

Summary

Fix repo name in README.md Neovim install table (agent-sh/agnix.nvim → agent-sh/agnix)
Fix repo name in editors/neovim/README.md for lazy.nvim, packer.nvim, and vim-plug snippets
Add missing require("agnix").setup() call to the README.md snippet

Type of Change

Checklist

Tests added/updated
CHANGELOG.md updated
Documentation updated (if applicable)
cargo fmt && cargo clippy passes

Related Issues

[BUG] neovim installation docs: wrong plugin repo name and missing setup() call in install snippets

Test Plan

Add { "agent-sh/agnix", config = function() require("agnix").setup() end } to a lazy.nvim config
Verify the plugin installs and initializes correctly

The Neovim install snippets referenced a non-existent `agnix.nvim` repo. The correct plugin identifier is `agent-sh/agnix`, and `require("agnix").setup()` is required for the plugin to initialize.

gemini-code-assist · 2026-03-05T22:37:35Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses critical inaccuracies in the Neovim plugin installation documentation. The changes ensure that users can correctly install and initialize the agnix plugin by providing the accurate repository name and including the necessary setup function call in the installation snippets. This improves the user experience and prevents common installation issues.

Highlights

Documentation Fix: Corrected the Neovim plugin repository name from agnix.nvim to agent-sh/agnix in both the main README.md and the editors/neovim/README.md.
Plugin Initialization: Added the essential require("agnix").setup() call to the Neovim installation snippets to ensure proper plugin initialization.

Changelog

README.md
- Updated the Neovim plugin entry to use the correct repository name agent-sh/agnix.
- Included the config = function() require("agnix").setup() end call for proper plugin initialization.
editors/neovim/README.md
- Corrected the plugin repository name from avifenesh/agnix.nvim to agent-sh/agnix in the lazy.nvim snippet.
- Corrected the plugin repository name from avifenesh/agnix.nvim to agent-sh/agnix in the packer.nvim snippet.
- Corrected the plugin repository name from avifenesh/agnix.nvim to agent-sh/agnix in the vim-plug snippet.

Activity

No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request correctly updates the Neovim plugin repository name and adds the required setup() call in the documentation. The changes are accurate and fix the reported issue. I've provided a couple of suggestions to make the lazy.nvim code snippets more concise by leveraging the plugin manager's features. Additionally, please note that website/docs/editor-integration.md and its versioned copy also contain the outdated information and could be updated in this PR for consistency.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

gemini-code-assist · 2026-03-05T22:39:23Z

 | **VS Code** | [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=avifenesh.agnix) |
 | **JetBrains** | [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/30087-agnix) |
-| **Neovim** | `{ "agent-sh/agnix.nvim" }` |
+| **Neovim** | `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` |


The lazy.nvim installation snippet can be made more concise. Instead of using a config function to call setup(), you can use the opts property. lazy.nvim will automatically call the setup function with the provided options. Using opts = {} is shorter and more idiomatic for this case.

Suggested change

| **Neovim** | `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` |

| **Neovim** | `{ "agent-sh/agnix", opts = {} }` |

avifenesh · 2026-03-05T23:32:04Z

@shawilly Thanks!
Please add to changelog, and please address bots reviews.
Im a here and there nvim user, so i dont know to say if the review is right or wrong, i guess you would know better.

Copilot

Pull request overview

Updates Neovim installation documentation to reference the correct plugin repository and ensure the plugin is initialized properly.

Changes:

Fix Neovim plugin repo identifier in README.md editor install table and add the required require("agnix").setup() init call.
Fix Neovim plugin repo identifier in editors/neovim/README.md for lazy.nvim, packer.nvim, and vim-plug snippets.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
README.md	Updates the Neovim install snippet in the editor extensions table to use `agent-sh/agnix` and call `setup()`.
editors/neovim/README.md	Updates plugin manager snippets to point to `agent-sh/agnix` instead of the old repo name.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-05T23:35:52Z

 | **VS Code** | [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=avifenesh.agnix) |
 | **JetBrains** | [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/30087-agnix) |
-| **Neovim** | `{ "agent-sh/agnix.nvim" }` |
+| **Neovim** | `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` |


README still links to https://github.com/agent-sh/agnix.nvim in the header line (earlier in the file), which appears to be the same non-existent repo this PR is fixing in the install snippet. Update that link to the correct Neovim plugin location so users don’t hit a broken URL.

Suggested change

| **Neovim** | `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` |

| **Neovim** | [Neovim plugin (`agent-sh/agnix`)](https://github.com/agent-sh/agnix/tree/main/editors/nvim) – `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` |

Copilot · 2026-03-05T23:35:53Z

 {
-  'avifenesh/agnix.nvim',
+  'agent-sh/agnix',
  ft = { 'markdown', 'json' },


In the lazy.nvim snippet, ft = { 'markdown', 'json' } can prevent the plugin from loading when opening other agnix-supported files first (e.g. .cursorrules), so the BufReadPost auto-attach logic never runs. Consider loading on a general event (e.g. BufReadPre/BufNewFile) and letting the plugin’s internal is_agnix_file gate decide when to attach.

Suggested change

ft = { 'markdown', 'json' },

event = { 'BufReadPre', 'BufNewFile' },

avifenesh · 2026-03-07T12:34:36Z

Thank you for this contribution @shawilly! Since we haven't heard back and this is a straightforward docs fix that's needed, I've taken the liberty of creating #645 with your changes (with co-author credit). The new PR is rebased on the current main branch and ready to merge.

Your contribution is appreciated! 🙏

shawilly · 2026-03-19T16:21:55Z

@avifenesh thank you, very considerate as this had left my mind with some busy times at the ol' 9-5. Thank you for the update and vim support!

docs(neovim): fix plugin repo name and add missing setup() call

d1303d1

The Neovim install snippets referenced a non-existent `agnix.nvim` repo. The correct plugin identifier is `agent-sh/agnix`, and `require("agnix").setup()` is required for the plugin to initialize.

gemini-code-assist Bot reviewed Mar 5, 2026

View reviewed changes

avifenesh requested a review from Copilot March 5, 2026 23:32

Copilot started reviewing on behalf of avifenesh March 5, 2026 23:33 View session

Copilot AI reviewed Mar 5, 2026

View reviewed changes

avifenesh mentioned this pull request Mar 7, 2026

docs(neovim): fix plugin repo name and add missing setup() call [skip changelog] #645

Merged

avifenesh closed this Mar 7, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(neovim): fix plugin repo name and add missing setup() call#628

docs(neovim): fix plugin repo name and add missing setup() call#628
shawilly wants to merge 1 commit intoagent-sh:mainfrom
shawilly:main

shawilly commented Mar 5, 2026

Uh oh!

gemini-code-assist Bot commented Mar 5, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Mar 5, 2026

Uh oh!

avifenesh commented Mar 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 5, 2026

Uh oh!

Copilot AI Mar 5, 2026

Uh oh!

avifenesh commented Mar 7, 2026

Uh oh!

shawilly commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	\| Neovim \| `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` \|
	\| Neovim \| `{ "agent-sh/agnix", opts = {} }` \|

	\| Neovim \| `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` \|
	\| Neovim \| [Neovim plugin (`agent-sh/agnix`)](https://github.com/agent-sh/agnix/tree/main/editors/nvim) – `{ "agent-sh/agnix", config = function() require("agnix").setup() end }` \|

	ft = { 'markdown', 'json' },
	event = { 'BufReadPre', 'BufNewFile' },

Conversation

shawilly commented Mar 5, 2026

Summary

Type of Change

Checklist

Related Issues

Test Plan

Uh oh!

gemini-code-assist Bot commented Mar 5, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

avifenesh commented Mar 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

avifenesh commented Mar 7, 2026

Uh oh!

shawilly commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants