Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan7h3x/chatter.nvim
A simple/functional automated plugin to chat with local LLMs
https://github.com/dan7h3x/chatter.nvim
ai llm neovim neovim-config neovim-plugin ollama
Last synced: 6 days ago
JSON representation
A simple/functional automated plugin to chat with local LLMs
- Host: GitHub
- URL: https://github.com/dan7h3x/chatter.nvim
- Owner: Dan7h3x
- License: gpl-3.0
- Created: 2024-09-07T11:07:03.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T08:20:13.000Z (2 months ago)
- Last Synced: 2024-11-12T16:03:31.705Z (6 days ago)
- Topics: ai, llm, neovim, neovim-config, neovim-plugin, ollama
- Language: Lua
- Homepage:
- Size: 25.4 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chatter.nvim
chatter.nvim is a Neovim plugin that provides a chat interface powered by AI models. It allows users to interact with AI models seamlessly within Neovim, featuring a sidebar for chat history, code block highlighting, and more.
## Features
- **AI Chat Interface**: Start a chat with AI models directly in Neovim.
- **Sidebar Display**: View chat history in a dedicated sidebar.
- **Code Block Highlighting**: Automatically highlights code blocks using Treesitter.
- [WIP] **Clipboard Support**: Easily copy code blocks to the clipboard.
- **Customizable Keymaps**: Configure key mappings to suit your workflow.
- **Lazy Loading Support**: Integrates with `lazy.nvim` for efficient loading.
## Requirments
- `ollama` installed on your os.
- `fzf-lua` for selection of local LLMs.
## Installation
### Using Lazy.nvim
To install chatter.nvim with `lazy.nvim`, add the following to your Neovim configuration:
```lua
{
"Dan7h3x/chatter.nvim",
event = "VeryLazy",
dependencies = {
'nvim-lua/plenary.nvim',
"ibhagwan/fzf-lua",
},
keys = { {
"cc", "ChatterStart", desc = "Chatter Start"
}, },
config = function()
require('chatter').setup({
offline_api_url = os.getenv("OLLAMA_HOST") or "http://localhost:8888",
sidebar_width = 60,
sidebar_height = vim.o.lines - 12,
models = {},
highlight = {
title = "Title",
user = "Comment",
assistant = "String",
system = "Type",
error = "ErrorMsg",
loading = "WarningMsg",
}
})
end,
}
```
### Manual Installation
If you prefer to install manually, clone the repository into your Neovim plugins directory:
```bash
git clone https://github.com/Dan7h3x/chatter.nvim.git ~/.config/nvim/lua/chatter
```
Then, add the following to your `init.lua` or `init.vim`:
```lua
require("chatter").setup()
```
## Usage
1. **Open the Chat Interface**: Use the command `:ChatterToggle` to open or close the chat sidebar.
2. **Start a Chat**: Use the command `:ChatterStart` to initiate a chat session.
3. **Send Messages**: Press `i` to enter your message and hit Enter to send.
4. [WIP] **Copy Code Blocks**: Navigate to a code block and press `yc` to copy it to the clipboard.
5. **Clear Chat**: Use the command `:ChatterClear` to clear the chat history.
## Key Mappings
The following key mappings are available by default:
- `i`: Enter message input
- [WIP] `yc`: Copy the current code block to clipboard
- `q`: Close the chat sidebar automatically
- ``: Clear the chat.
- ``: Reload the `chatter.nvim` for selecting another model.
Available commands are `ChatterStart`,`ChatterToggle`,`ChatterClear`,`ChatterRestart`,`ChatterSend`.
## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests. Make sure to follow the [contribution guidelines](CONTRIBUTING.md).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [Neovim](https://neovim.io/) - The extensible Vim-based text editor.
- [Treesitter](https://tree-sitter.github.io/tree-sitter/) - For syntax highlighting.
- [Lazy.nvim](https://github.com/folke/lazy.nvim) - For efficient plugin loading.