Installation

IMPORTANT

The plugin requires the markdown Tree-sitter parser to be installed with :TSInstall markdown

Requirements

• The curl library
• Neovim 0.10.0 or greater
• (Optional) An API key for your chosen LLM

Installation

The plugin can be installed with the plugin manager of your choice:

Lazy.nvim

{
  "olimorris/codecompanion.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
  },
  config = true
},

Packer

use({
  "olimorris/codecompanion.nvim",
  config = function()
    require("codecompanion").setup()
  end,
  requires = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
  }
}),

vim-plug

call plug#begin()

Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-treesitter/nvim-treesitter'
Plug 'olimorris/codecompanion.nvim'

call plug#end()

lua << EOF
  require("codecompanion").setup()
EOF

Completion

Out of the box, the plugin supports completion with both nvim-cmp and blink.cmp. For the latter, ensure that you've added codecompanion as a source:

sources = {
  default = { "lsp", "path", "snippets", "buffer", "codecompanion" }
},

The plugin also supports native completion.

Troubleshooting

Run :checkhealth codecompanion to check that plugin is installed correctly.