Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JosefAlbers/VimLM
VimLM is a Vim plugin that provides an LLM-powered assistant for code editing by allowing users to interact with a local LLM model through Vim commands and automatically ingesting code context.
https://github.com/JosefAlbers/VimLM
Last synced: 2 days ago
JSON representation
VimLM is a Vim plugin that provides an LLM-powered assistant for code editing by allowing users to interact with a local LLM model through Vim commands and automatically ingesting code context.
- Host: GitHub
- URL: https://github.com/JosefAlbers/VimLM
- Owner: JosefAlbers
- License: apache-2.0
- Created: 2025-02-09T05:18:55.000Z (12 days ago)
- Default Branch: main
- Last Pushed: 2025-02-09T20:51:26.000Z (12 days ago)
- Last Synced: 2025-02-09T21:29:17.916Z (12 days ago)
- Language: Python
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-AI-driven-development - VimLM - LLM-powered coding companion for Vim, inspired by GitHub Copilot/Cursor. (Uncategorized / Uncategorized)
README
# VimLM - Local LLM-Powered Coding Assistant for Vim
LLM-powered coding companion for Vim, inspired by GitHub Copilot/Cursor. Integrates contextual code understanding, summarization, and AI assistance directly into your Vim workflow.
## Features
- **Model Agnostic** - Use any MLX-compatible model via a configuration file
- **Vim-Native UX** - Intuitive keybindings and split-window responses
- **Deep Context** - Understands code context from:
- Current file
- Visual selections
- Referenced files
- Project directory structure
- **Conversational Coding** - Iterative refinement with follow-up queries
- **Air-Gapped Security** - 100% offline - no APIs, no tracking, no data leaks
## Requirements
- Apple M-series chip
- Python 3.12.8
## Quick Start
```zsh
pip install vimlm
vimlm
```
## Basic Usage
### 1. **From Normal Mode**
**`Ctrl-l`**: Add current line + file to context
*Example prompt:* `Regex for removing HTML tags from item.content`
### 2. **From Visual Mode**
Select code → **`Ctrl-l`**: Add selected block + current file to context
*Example prompt:* `Convert this to async/await syntax`
### 3. **Follow-Up Conversations**
**`Ctrl-j`**: Continue current thread
*Example follow-up:* `Use Manifest V3 instead`
### 4. **Code Extraction & Replacement**
**`Ctrl-p`**: Insert code blocks from response into:
- Last visual selection (Normal mode)
- Active selection (Visual mode)
**Workflow Example**:
1. Select a block of code in Visual mode
2. Prompt with `Ctrl-l`: `Convert this to async/await syntax`
3. Press `Ctrl-p` to replace selection with generated code
### 5. **Inline Commands**
#### `!include` - Add External Context
```text
!include [PATH] # Add files/folders to context
```
- **`!include`** (no path): Current folder
- **`!include ~/projects/utils.py`**: Specific file
- **`!include ~/docs/api-specs/`**: Entire folder
- **`!include $(...)`**: **Shell expansions (`$(...)`)** and **current file symbol (`%`)** are supported as well
**Example 1 - In-Context Learning**:
```text
AJAX-ify this app !include ~/scrap/hypermedia-applications.summ.md
```
**Example 2 - Git Log Recap**:
```text
Summarize recent changes !include $(git log --oneline -n 50)
```
**Example 3 - Diagnose Server Errors**:
```text
Diagnose server errors !include $(grep -r "500 Internal Error" ./fuzz | head -n 5)
```
#### `!deploy` - Generate Project Files
```text
!deploy [DEST_DIR] # Extract code blocks to directory
```
- **`!deploy`** (no path): Current directory
- **`!deploy ./src`**: Specific directory
*Example:* `Create REST API endpoint !deploy ./api`
#### `!continue` - Resume Generation
```text
!continue [MAX_TOKENS] # Continue stopped response
```
- **`!continue`**: Default 2000 tokens
- **`!continue 3000`**: Custom token limit
*Example:* `tl;dr !include large-file.txt !continue 5000`
#### `!followup` - Thread Continuation
```text
!followup # Equivalent to Ctrl-j
```
*Example:*
Initial: `Create Chrome extension`
Follow-up: `Add dark mode support !followup`
#### **Command Combinations**
Chain multiple commands in one prompt:
```text
Create HTMX component !include ~/lib/styles.css !deploy ./components !continue 4000
```
### 6. **Reusable Command Chains**
Craft and execute complex LLM workflows as single commands, combining prompts, file context, and deployments with command-line `:VimLM`. Store common patterns for later reuse across projects:
```vim
:VimLM prompt [!command1] [!command2]...
```
**Example 1 – CI/CD Fixer Macro**:
```vim
" Debug CI failures using error logs
:VimLM Fix Dockerfile !include .gitlab-ci.yml !include $(tail -n 20 ci.log)
```
**Example 2 – Test Generation Workflow**:
```vim
" Generate unit tests for selected functions and save to test/
:VimLM Write pytest tests for this !include ./src !deploy ./test
```
**Example 3 – Documentation Helper**:
```vim
" Add docstrings to all Python functions in file
:VimLM Add Google-style docstrings !include % !continue 4000
```
### Key Bindings
| Binding | Mode | Action |
|------------|---------------|----------------------------------------|
| `Ctrl-l` | Normal/Visual | Send current file + selection to LLM |
| `Ctrl-j` | Normal | Continue conversation |
| `Ctrl-p` | Normal/Visual | Replace the selection with generated code |
| `Esc` | Prompt | Cancel input |
## Advanced Configuration
VimLM uses a JSON config file with the following configurable parameters:
```json
{
"LLM_MODEL": null,
"NUM_TOKEN": 2000,
"USE_LEADER": false,
"KEY_MAP": {},
"DO_RESET": true,
"SHOW_USER": false,
"SEP_CMD": "!",
"VERSION": "0.0.7",
"DEBUG": true
}
```
### Custom Model Setup
1. **Browse models**: [MLX Community Models on Hugging Face](https://huggingface.co/mlx-community)
2. **Edit config file**:
```json
{
"LLM_MODEL": "mlx-community/DeepSeek-R1-Distill-Qwen-7B-4bit",
"NUM_TOKEN": 9999
}
```
3. **Save to**: `~/vimlm/cfg.json`
4. **Restart VimLM**
### Custom Key Bindings
You can also configure shortcuts:
```json
{
"USE_LEADER": true, // Swap Ctrl for Leader key
"KEY_MAP": { // Remap default keys (l/j/p)
"l": "a", // a instead of l
"j": "s", // s instead of j
"p": "d" // d instead of p
}
}
```
## License
VimLM is licensed under the [Apache-2.0 license](LICENSE).