Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deifyed/naVi
Your NeoVim assistant
https://github.com/deifyed/naVi
lua neovim neovim-plugin nvim openai
Last synced: about 2 months ago
JSON representation
Your NeoVim assistant
- Host: GitHub
- URL: https://github.com/deifyed/naVi
- Owner: deifyed
- License: mit
- Created: 2023-04-06T13:06:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-16T19:19:26.000Z (over 1 year ago)
- Last Synced: 2024-05-17T00:39:28.178Z (5 months ago)
- Topics: lua, neovim, neovim-plugin, nvim, openai
- Language: Lua
- Homepage:
- Size: 159 KB
- Stars: 33
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# naVi - Your NeoVim assistant
Natural language first based development
## Usage
`navi.Append()` will open a prompt. Use this prompt to tell naVi what to do. For example, insert a React component outline.
`navi.Edit()` will open a prompt using the current selection as context. Use this prompt to get naVi to make
changes to the selected text. For example, remove a bug.
`navi.EditBuffer()` will open a prompt using the current file as context. Use this prompt to get naVi to make
changes to the current file. For example, add a new function.
`navi.Review()` will request a review using the current selection as context. The final report will open in a separate window,
and will not alter the selected text.
`navi.Explain()` will provide an explanation of code using the current selection as context. The explanation will
open in a separate window and will not alter the selected text.
`navi.Chat()` will open a chat interface where you can discuss your code with GPT.
## Installation
### Requirements
- [Rust](https://www.rust-lang.org/tools/install)
- [NeoVim](https://neovim.io/)
### Packer
Add the following to your Packer config
```lua
use({
'deifyed/naVi',
requires = {'jcdickinson/http.nvim', run = 'cargo build --workspace --release'},
})
```
### Lazy
Add the following to your Lazy.vim config
{
'deifyed/naVi',
dependencies = {
{
"jcdickinson/http.nvim", build = "cargo build --workspace --release",
},
},
config = function()
require("navi").setup({ })
end,
keys = {
{ "na", "lua require('navi').Append()", mode = "n", desc = "NaVI append" },
{ "ne", "lua require('navi').Edit()", mode = "v", desc = "NaVI edit" },
{ "nb", "lua require('navi').EditBuffer()", mode = "n", desc = "NaVI edit buffer" },
{ "nr", "lua require('navi').Review()", mode = "v", desc = "NaVI review" },
{ "nx", "lua require('navi').Explain()", mode = "v", desc = "NaVI explain" },
{ "nc", "lua require('navi').Chat()", mode = "n", desc = "NaVI chat" },
},
}
## Configuration
in `~/.config/nvim/after/plugin/navi.lua`:
```lua
local navi = require('navi')
navi.setup({
-- OpenAI token. Required
openai_token = "", -- Alternatively, use environment variable OPENAI_TOKEN=
-- OpenAI model. Optional. Default is gpt-3.5-turbo
openai_model = "gpt-3.5-turbo",
-- OpenAI max tokens. Optional. Default is 512
openai_max_tokens = 512,
-- OpenAI temperature. Optional. Default is 0.6
openai_temperature = 0.6,
-- Debug mode. Optional. Default is false
debug = false, -- Alternatively, use environment variable NAVI_DEBUG=true
-- Setup for input window
prompt_window = {
border = "single",
style = "minimal",
relative = "editor",
},
-- Setup for window showing various reports
report_window = {
-- Specifies if the report will be shown in a vertical window or in a floating window.
window = "floating",
border = "single",
style = "minimal",
relative = "editor",
},
})
-- Set keybindings
vim.api.nvim_set_keymap('v', 'ne', '', { callback = navi.Edit })
vim.api.nvim_set_keymap('i', 'na', '', { callback = navi.Append })
vim.api.nvim_set_keymap('v', 'nr', '', { callback = navi.Review })
vim.api.nvim_set_keymap('v', 'ne', '', { callback = navi.Explain })
vim.api.nvim_set_keymap('n', 'nc', '', { callback = navi.Chat })
```
## Roadmap
- Make the current file context of the chat interface
- Make the chat toggleable
- Improve prompts
## FAQ
- Where can I get an OpenAI token?
> https://platform.openai.com/
- Can naVi close nVim for me?
> AI has come far, but not that far. We'll have to wait for human alignment before attempting this.
- Neat! How can I contribute?
> Great! Check out the [contributing guide](./CONTRIBUTING.md) for more information.