jameshiew/nvim-magic

github github
completion plugin
star 109
stars
alert-circle 10
open issues
users 3
subscribers
git-branch 4
forks
CREATED

2021-09-11

UPDATED

2 months ago

packer

require('packer').startup(function()
  use 'jameshiew/nvim-magic'
end)

paq

require "paq" { 
  'jameshiew/nvim-magic'
}

nvim-magic

ci

A pluggable framework for integrating AI code assistance into Neovim. The goals are to make using AI code assistance unobtrusive, and to make it easy to create and share new flows that use AI code assistance. Go to quickstart for how to install. It currently works with OpenAI Codex.

Features

Completion

Generating a docstring

Asking for an alteration

Quickstart

Prerequisites

  • Neovim (v0.5+)
  • curl

Installation

At the moment, only a backend for OpenAI is implemented, which is bundled in this repo and used by default. Your API key should be made available to your Neovim session in an environment variable OPENAI_API_KEY. See docs/openai.md for more details.

 export OPENAI_API_KEY='your-api-key-here'

Install like any other plugin. It is necessary to call setup() once see docs/config.md if you want to override the default configuration e.g. to turn off the default keymaps.

-- using packer.nvim
use({
    'jameshiew/nvim-magic',
    config = function()
        require('nvim-magic').setup()
    end,
    requires = {
        'nvim-lua/plenary.nvim',
        'MunifTanjim/nui.nvim'
    }
})

Keymaps

These flows have keymaps set by default for visual mode selections (though you can disable this by passing use_default_keymap = false in the setup config).

You can map your own key sequences to the predefined <Plug>s if you don't want to use the default keymaps.

<Plug> default keymap mode action
<Plug>nvim-magic-append-completion <Leader>mcs visual Fetch and append completion
<Plug>nvim-magic-suggest-alteration <Leader>mss visual Ask for an alteration to the selected text
<Plug>nvim-magic-suggest-docstring <Leader>mds visual Generate a docstring