https://github.com/julwrites/llm-nvim
Neovim plugin for llm CLI
https://github.com/julwrites/llm-nvim
Last synced: 10 days ago
JSON representation
Neovim plugin for llm CLI
- Host: GitHub
- URL: https://github.com/julwrites/llm-nvim
- Owner: julwrites
- License: apache-2.0
- Created: 2025-04-14T13:42:12.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2025-04-21T15:13:50.000Z (17 days ago)
- Last Synced: 2025-04-21T16:23:48.329Z (17 days ago)
- Language: Lua
- Size: 210 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - julwrites/llm-nvim - Comprehensive integration with the [llm](https://github.com/simonw/llm) tool. (AI / (requires Neovim 0.5))
- trackawesomelist - julwrites/llm-nvim (⭐1) - Comprehensive integration with the [llm (⭐7.3k)](https://github.com/simonw/llm) tool. (Recently Updated / [Apr 28, 2025](/content/2025/04/28/README.md))
- awesome-neovim-sorted - julwrites/llm-nvim
README
# llm-nvim
A Neovim plugin for integrating with [Simon Willison's llm CLI tool](https://github.com/simonw/llm).
## Feature Demos
### Model, Plugin and Key Management
https://github.com/user-attachments/assets/d8c9b2f8-4617-4534-9a64-05a2447d9380
### Schema Management
https://github.com/user-attachments/assets/b326370e-5752-46af-ba5c-6ae08d157f01
### Fragment Management
https://github.com/user-attachments/assets/2fc30538-6fd5-4cfa-9b7b-7fd7757f20c1
### Template Management
https://github.com/user-attachments/assets/d9e16473-90fe-4ccc-a480-d5452070afc2
## Feature List
- Send prompts to LLMs directly from Neovim
- Process selected text with LLMs
- Explain code in the current buffer
- Start interactive chat sessions with LLMs
- Support for custom models and system prompts
- Manage API keys for different LLM providers
- Use fragments (files, URLs, GitHub repos) with prompts
- Manage fragment aliases
- Manage templates (create, run, edit, delete)
- Manage schemas (create, run, view, edit, set/delete aliases)
- Unified manager window (`:LLMToggle`) to access Models, Plugins, Keys, Fragments, Templates, and Schemas management.
## Requirements
- Neovim 0.7.0 or later
- [llm CLI tool](https://github.com/simonw/llm) installed (`pip install llm` or `brew install llm`)
## Installation
### Using [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'julwrites/llm-nvim'
```
### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use 'julwrites/llm-nvim'
```
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
-- Example lazy.nvim configuration
return {
{
'julwrites/llm-nvim',
-- Optional: Specify dependencies if needed, e.g., for UI components
-- dependencies = { 'nvim-lua/plenary.nvim' },
config = function()
-- Configure the plugin
require('llm').setup({
-- Specify the default LLM model to use
model = 'gpt-4o', -- Or 'claude-3-haiku-20240307', 'llama3', etc.
-- Define a default system prompt (optional)
system_prompt = 'You are a helpful Neovim assistant.',
-- Disable default key mappings if you prefer to set your own
-- no_mappings = true,
-- Enable debug logging (optional)
-- debug = true,
})
-- Example custom key mappings (if no_mappings = true or for overrides)
-- vim.keymap.set('n', 'lp', '(llm-prompt)', { desc = "LLM Prompt" })
-- vim.keymap.set('v', 'ls', '(llm-selection)', { desc = "LLM Selection" })
-- vim.keymap.set('n', 'lt', '(llm-toggle)', { desc = "LLM Toggle Manager" })
end
}
}
```
## Configuration
```lua
-- Setup with configuration options
require('llm').setup({
model = 'gpt-4o', -- Default model to use
system_prompt = 'You are a helpful assistant.', -- Default system prompt
no_mappings = false, -- Set to true to disable default mappings
debug = false, -- Set to true to enable debug output
})
-- Custom mappings
vim.keymap.set('n', 'lp', '(llm-prompt)')
vim.keymap.set('v', 'ls', '(llm-selection)')
vim.keymap.set('n', 'le', '(llm-explain)')
vim.keymap.set('n', 'lc', '(llm-chat)')
vim.keymap.set('n', 'lm', '(llm-models)') -- Note: (llm-select-model) is deprecated
```
## Usage Examples
### Commands
- `:LLM {prompt}` - Send a prompt to the LLM
- `:LLMWithSelection {prompt}` - Send selected text with an optional prompt
- `:LLMChat {model}` - Start an interactive chat session (optional model)
- `:LLMExplain` - Explain the code in the current buffer
- `:LLMToggle [view]` - Open or close the unified manager window. Optionally specify an initial view (Models, Plugins, Keys, Fragments, Templates, Schemas).
- `:LLMModels` - Open the unified manager to the Models view.
- `:LLMPlugins` - Open the unified manager to the Plugins view.
- `:LLMKeys` - Open the unified manager to the API Keys view.
- `:LLMFragments` - Open the unified manager to the Fragments view.
- `:LLMWithFragments` - Send a prompt with fragments (does not use the unified manager).
- `:LLMWithSelectionAndFragments` - Send selected text with fragments (does not use the unified manager).
- `:LLMTemplates` - Open the unified manager to the Templates view.
- `:LLMTemplate` - Select and run a template (does not use the unified manager).
- `:LLMSchemas` - Open the unified manager to the Schemas view.
- `:LLMSchema` - Select and run a schema with various input sources (does not use the unified manager).
### Basic Prompting
1. Type `:LLM Write a short poem about Neovim` and press Enter.
2. A new buffer will open with the LLM's response.
### Working with Code
1. Visually select a block of code.
2. Type `:LLMWithSelection Refactor this code for clarity` and press Enter.
3. The selected code and your prompt will be sent to the LLM.
### Explaining Code
1. Open a code file.
2. Type `:LLMExplain` and press Enter.
3. The LLM will explain the code in the current buffer.
### Chatting
1. Type `:LLMChat` to start a chat session with the default model.
2. Type `:LLMChat llama3` to start a chat specifically with the `llama3` model.
3. The chat happens in a terminal buffer within Neovim.
### Using the Unified Manager
1. Type `:LLMToggle` or press `ll` (default mapping).
2. The manager window opens, likely showing the Models view first.
3. Press `P` to switch to the Plugins view.
4. Press `K` to switch to the API Keys view.
5. Navigate the list using `j` and `k`.
6. Follow the instructions in the header for actions (e.g., press `s` in the Models view to set a default model).
7. Press `q` or `` to close the manager.
### Default Mappings
- `ll` - Toggle the unified manager window
- `llp` - Prompt for input and send to LLM
- `lls` - In visual mode, send selection to LLM
- `lle` - Explain the current buffer
- `llc` - Start a chat session
- `llm` - Open the Models manager view
- `llg` - Open the Plugins manager view
- `llk` - Open the API Keys manager view
- `llf` - Open the Fragments manager view
- `llsf` - Select a file to use as a fragment
- `llwf` - Send a prompt with fragments
- `llwf` - In visual mode, send selection with fragments
- `llt` - Open the Templates manager view
- `llrt` - Select and run a template
- `llcs` - Create a new schema
- `lls` - Open the Schemas manager view
- `llrs` - Select and run a schema
## Development
### Testing
The plugin includes a test suite using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim). To run the tests:
```bash
# Run all tests
./test/run.sh
# Or using the Lua test runner
nvim --headless -l test/run_tests.lua
```
Tests cover:
- Core functionality (prompts, chat, code explanation)
- Model management
- Plugin management
- API key management
- Fragment management
## License
Apache 2.0