exrc.nvim icon indicating copy to clipboard operation
exrc.nvim copied to clipboard

Secure Project Local Config for Neovim

Warning

Neovim v0.9.0 onwards supports secure .exrc, .nvimrc and .nvim.lua files. You don't need this plugin anymore.

Just enable the 'exrc' option:

vim.o.exrc = true

For more information, check:

  • :help 'exrc'
  • :help exrc

exrc.nvim

Local config file with confirmation for Neovim.

Installation

Install the plugin with your preferred plugin manager. For example, with vim-plug:

Plug 'MunifTanjim/exrc.nvim'

It's recommended to also install nui.nvim for a better UX:

Plug 'MunifTanjim/nui.nvim'

Setup

exrc.nvim needs to be initialized with the require("exrc").setup() function.

For example:

-- disable built-in local config file support
vim.o.exrc = false

require("exrc").setup({
  files = {
    ".nvimrc.lua",
    ".nvimrc",
    ".exrc.lua",
    ".exrc",
  },
})

Commands

ExrcSource

Re-source exrc file:

:ExrcSource

Reset state and re-source exrc file:

:ExrcSource!

Similar Projects

License

Licensed under the MIT License. Check the LICENSE file for details.