vimlm 0.0.6__py3-none-any.whl → 0.0.7__py3-none-any.whl

vimlm-0.0.7.dist-info/METADATA

@@ -0,0 +1,204 @@
+Metadata-Version: 2.2
+Name: vimlm
+Version: 0.0.7
+Summary: VimLM - LLM-powered Vim assistant
+Home-page: https://github.com/JosefAlbers/vimlm
+Author: Josef Albers
+Author-email: albersj66@gmail.com
+Requires-Python: >=3.12.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nanollama==0.0.5
+Requires-Dist: mlx_lm_utils==0.0.2
+Requires-Dist: watchfiles==1.0.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# VimLM - Local LLM-Powered Coding Assistant for Vim
+
+![vimlm](https://raw.githubusercontent.com/JosefAlbers/VimLM/main/assets/captioned_vimlm.gif)
+
+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  
+
+*Example:* `"AJAX-ify this app !include ~/scrap/hypermedia-applications.summ.md"`
+
+#### `!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. **Command-Line Mode `:VimLM`**
+```vim
+:VimLM "prompt" [!command1] [!command2]...
+```
+Use predefined command chains for repetitive tasks:
+
+**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",           // <Leader>a instead of <Leader>l
+    "j": "s",           // <Leader>s instead of <Leader>j
+    "p": "d"            // <Leader>d instead of <Leader>p
+  }
+}
+```
+
+## License
+
+VimLM is licensed under the [Apache-2.0 license](LICENSE).
+
+

vimlm-0.0.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+vimlm.py,sha256=QrboU-loWuQjTPO5HTJnt_CCxZcV6cclX6UOz438rEM,23126
+vimlm-0.0.7.dist-info/LICENSE,sha256=f1xgK8fAXg_intwnbc9nLkHf7ODPLtgpHs7DetQHOro,11343
+vimlm-0.0.7.dist-info/METADATA,sha256=0V2b8X4pq2uGlyuxyqCUlCYZ7tmlJhPOLZFaDjG0V6s,5668
+vimlm-0.0.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+vimlm-0.0.7.dist-info/entry_points.txt,sha256=mU5V4MYsuIzCc6YB-Ro-6USSHWN5vHw8UDnTEoq0isw,36
+vimlm-0.0.7.dist-info/top_level.txt,sha256=I8GjqoiP--scYsO3AfLhha-6Ax9ci3IvbWvVbPv8g94,6
+vimlm-0.0.7.dist-info/RECORD,,

vimlm.py

@@ -26,13 +26,18 @@ from pathlib import Path
 from string import Template
 import re
 
-DEBUG = True
-LLM_MODEL = None # "mlx-community/DeepSeek-R1-Distill-Qwen-7B-4bit"
-NUM_TOKEN = 2000
-SEP_CMD = '!'
-USE_LEADER = False
-DO_RESET = True
-SHOW_USER = False 
+DEFAULTS = dict(
+    LLM_MODEL = None, # "mlx-community/DeepSeek-R1-Distill-Qwen-7B-4bit"
+    NUM_TOKEN = 2000,
+    USE_LEADER = False,
+    KEY_MAP = {},
+    DO_RESET = True,
+    SHOW_USER = False, 
+    SEP_CMD = '!',
+    VERSION = '0.0.7',
+    DEBUG = True,
+)
+
 VIMLM_DIR = os.path.expanduser("~/vimlm")
 WATCH_DIR = os.path.expanduser("~/vimlm/watch_dir")
 CFG_FILE = 'cfg.json'
@@ -45,6 +50,36 @@ LOG_PATH = os.path.join(VIMLM_DIR, LOG_FILE)
 LTM_PATH = os.path.join(VIMLM_DIR, LTM_FILE)
 OUT_PATH = os.path.join(WATCH_DIR, OUT_FILE) 
 
+def is_old(config):
+    v_str = config.get('VERSION', 0)
+    for min_v, usr_v in zip(DEFAULTS['VERSION'].split('.'), v_str.split('.')):
+        if int(min_v) < int(usr_v):
+            return False
+        elif int(min_v) > int(usr_v): 
+            return True
+    return False
+
+if os.path.exists(WATCH_DIR):
+    shutil.rmtree(WATCH_DIR)
+os.makedirs(WATCH_DIR)
+
+try:
+    with open(CFG_PATH, "r") as f:
+        config = json.load(f)
+    if is_old(config):
+        for p in [CFG_PATH, LOG_PATH, LTM_PATH]:
+            if os.path.isfile(p):
+                os.remove(p)
+        raise ValueError(f'Version mismatch')
+except Exception as e:
+    print(e)
+    config = DEFAULTS
+    with open(CFG_PATH, 'w') as f:
+        json.dump(DEFAULTS, f, indent=2)
+
+for k, v in DEFAULTS.items():
+    globals()[k] = config.get(k, v)
+
 def toout(s, key=None, mode=None):
     key = '' if key is None else ':'+key
     mode = 'w' if mode is None else mode
@@ -64,23 +99,6 @@ def tolog(log, key='debug'):
     with open(LOG_PATH, "w", encoding="utf-8") as log_f:
         json.dump(logs, log_f, indent=2)
 
-if os.path.exists(WATCH_DIR):
-    shutil.rmtree(WATCH_DIR)
-os.makedirs(WATCH_DIR)
-
-try:
-    with open(CFG_PATH, "r") as f:
-        config = json.load(f)
-    DEBUG = config.get("DEBUG", DEBUG)
-    LLM_MODEL = config.get("LLM_MODEL", LLM_MODEL)
-    NUM_TOKEN = config.get("NUM_TOKEN", NUM_TOKEN)
-    SEP_CMD = config.get("SEP_CMD", SEP_CMD)
-    USE_LEADER = config.get("USE_LEADER", USE_LEADER)
-except Exception as e:
-    tolog(str(e))
-    with open(CFG_PATH, 'w') as f:
-        json.dump(dict(DEBUG=DEBUG, LLM_MODEL=LLM_MODEL, NUM_TOKEN=NUM_TOKEN, SEP_CMD=SEP_CMD, USE_LEADER=USE_LEADER), f, indent=2)
-
 toout('Loading LLM...')
 if LLM_MODEL is None:
     from nanollama import Chat
@@ -326,13 +344,27 @@ def process_command(data):
     data['include'] = ''
     for cmd in cmds:
         if cmd.startswith('include'):
-            arg = cmd.removeprefix('include').strip('(').strip(')').strip().strip('"').strip("'").strip()
+            arg = cmd.removeprefix('include').strip().strip('(').strip(')').strip().strip('"').strip("'").strip()
             src = data['dir'] if len(arg) == 0 else arg
-            data['include'] += ingest(src)
+            if arg == '%':
+                continue
+            if src.startswith('`') or src.startswith('$('):
+                shell_cmd = src.strip('`') if src.startswith('`') else src.strip('$()')
+                shell_cmd = shell_cmd.strip()
+                try:
+                    result = subprocess.run(shell_cmd, shell=True, capture_output=True, text=True)
+                    if result.returncode == 0:
+                        data['include'] += f'--- **{shell_cmd}** ---\n```\n{result.stdout.strip()}\n```\n---\n\n'
+                    else:
+                        tolog(f'{shell_cmd} failed {result.stderr.strip()}')
+                except Exception as e:
+                    tolog(f'Error executing {shell_cmd}: {e}')
+            else:
+                data['include'] += ingest(src)
 
     for cmd in cmds:
         if cmd.startswith('deploy'):
-            arg = cmd.removeprefix('deploy').strip('(').strip(')').strip().strip('"').strip("'").strip()
+            arg = cmd.removeprefix('deploy').strip().strip('(').strip(')').strip().strip('"').strip("'").strip()
             if len(data['user_prompt']) == 0:
                 deploy(dest=arg)
                 data['user_prompt'] = ''
@@ -395,8 +427,10 @@ async def process_files(data):
     if 'deploy_dest' in data:
         deploy(dest=data['deploy_dest'], reformat=False)
 
-mapl, mapj, mapp = ('<Leader>l', '<Leader>j', '<Leader>p') if USE_LEADER else ('<C-l>', '<C-j>', '<C-p>')
-
+KEYL = KEY_MAP.get('l', 'l')
+KEYJ = KEY_MAP.get('j', 'j')
+KEYP = KEY_MAP.get('p', 'p')
+mapl, mapj, mapp = (f'<Leader>{KEYL}', f'<Leader>{KEYJ}', f'<Leader>{KEYP}') if USE_LEADER else (f'<C-{KEYL}>', f'<C-{KEYJ}>', f'<C-{KEYP}>')
 VIMLMSCRIPT = Template(r"""
 let s:register_names = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u'] 
 let s:watched_dir = expand('$WATCH_DIR')
@@ -515,19 +549,26 @@ function! ExtractAllCodeBlocks()
     return len(code_blocks)
 endfunction
 
-function! PasteIntoLastVisualSelection()
+function! PasteIntoLastVisualSelection(...)
     let num_blocks = ExtractAllCodeBlocks()
-    echo "Extracted " . num_blocks . " blocks into registers @a-@" . s:register_names[num_blocks - 1] . ". Enter register name: "
-    let register_name = nr2char(getchar())
+    if a:0 > 0
+        let register_name = a:1
+    else
+        echo "Extracted " . num_blocks . " blocks into registers @a-@" . s:register_names[num_blocks - 1] . ". Enter register name: "
+        let register_name = nr2char(getchar())
+    endif
+
     if register_name !~ '^[a-z]$'
         echoerr "Invalid register name. Please enter a single lowercase letter (e.g., a, b, c)."
         return
     endif
+
     let register_content = getreg(register_name)
     if register_content == ''
         echoerr "Register @" . register_name . " is empty."
         return
     endif
+
     let current_mode = mode()
     if current_mode == 'v' || current_mode == 'V' || current_mode == ''
         execute 'normal! "' . register_name . 'p'
@@ -537,6 +578,25 @@ function! PasteIntoLastVisualSelection()
     endif
 endfunction
 
+function! VimLM(...) range
+    let user_input = join(a:000, ' ')
+    if empty(user_input)
+        echo "Usage: :VimLM <prompt> [!command1] [!command2] ..."
+        return
+    endif
+    if line("'<") == line("'>")
+        silent! execute "normal! V\<ESC>"
+    endif
+    silent execute "'<,'>w! " . s:watched_dir . "/yank"
+    silent execute "w! " . s:watched_dir . "/context"
+    let user_file = s:watched_dir . '/user'
+    call writefile([user_input], user_file, 'w')
+    let current_file = expand('%:p')
+    let tree_file = s:watched_dir . '/tree'
+    call writefile([current_file], tree_file, 'w')
+endfunction
+
+command! -range -nargs=+ VimLM call VimLM(<f-args>)
 nnoremap $mapp :call PasteIntoLastVisualSelection()<CR>
 vnoremap $mapp <Cmd>:call PasteIntoLastVisualSelection()<CR>
 vnoremap $mapl <Cmd>:call VisualPrompt()<CR>

vimlm-0.0.6.dist-info/METADATA

@@ -1,158 +0,0 @@
-Metadata-Version: 2.2
-Name: vimlm
-Version: 0.0.6
-Summary: VimLM - LLM-powered Vim assistant
-Home-page: https://github.com/JosefAlbers/vimlm
-Author: Josef Albers
-Author-email: albersj66@gmail.com
-Requires-Python: >=3.12.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: nanollama==0.0.5
-Requires-Dist: mlx_lm_utils==0.0.2
-Requires-Dist: watchfiles==1.0.4
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-
-# VimLM - Local LLM-Powered Coding Assistant for Vim
-
-![vimlm](https://raw.githubusercontent.com/JosefAlbers/VimLM/main/assets/captioned_vimlm.gif)
-
-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
-
-Install:
-
-```zsh
-pip install vimlm
-```
-
-Launch:
-
-```zsh
-vimlm
-```
-
-or
-
-```zsh
-vimlm path/to/your_file
-```
-
-This launches Vim with the LLM in a split window, ready to assist you.
-
-## Basic Usage
-
-1. **From Normal Mode**:
-    - `Ctrl-l`: Adds current line + file to context
-    - Example prompt: "Regex for removing html tags from item.content"
-
-2. **From Visual Mode**:
-    - Select code → `Ctrl-l`: Adds selected block + current file to context
-    - Example prompt: "Convert this to async/await syntax"
-
-3. **Inline Commands**:
-
-!include: Adds specified outside files/folders to context:
-    - `!include` (no path): Current folder
-    - `!include ~/scrap/jph00/hypermedia-applications.summ.md`: Specific folder
-    - `!include ~/wtm/utils.py`: Specific file
-    - Example prompt: "AJAX-ify this app @ ~/scrap/jph00/hypermedia-applications.summ.md"
-
-!deploy: Extract code blocks to files in user specified dir (current dir if none specified).
-
-!continue: Lets the LLM resume the generation from where it had halted due to length limits.
-
-!followup: Continue the thread (equivalent to `Ctrl-j`
-
-4. **Follow-Up**: After initial response:
-    - `Ctrl-j`: Continue thread
-    - Example follow-up: "In Manifest V3"
-
-4. **Code Extraction: Press `Ctrl-p` to choose a code block from the response and insert them into:
-    - The last selected visual block (in Normal mode)
-    - The current selection (in Visual mode)
-    - Example workflow:
-        1. Select a block of code in Visual mode.
-        2. Prompt the LLM with `Ctrl-l` (e.g., "Convert this to async/await syntax").
-        3. Once the response is generated, press `Ctrl-p` to replace the selected block with the extracted code.
-
-### 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
-{
-  "DEBUG": true,
-  "LLM_MODEL": null,
-  "NUM_TOKEN": 2000,
-  "SEP_CMD": "!",
-  "USE_LEADER": false
-}
-```
-
-### 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"
-}
-```
-3. **Save to**:
-
-```
-~/vimlm/config.json
-```
-
-4. **Restart VimLM**
-
-
-### Custom Keybinding
-
-If you prefer using `<Leader>` in place of `<Ctrl>` for the ViMLM key bindings:
-
-```json
-{
-  "USER_LEADER": true
-}
-```
-
-

vimlm-0.0.6.dist-info/RECORD

@@ -1,7 +0,0 @@
-vimlm.py,sha256=_2EKVmfvM-Ikf48XzaxvC0rcLCxiHO4f6_fCslAqyCo,21181
-vimlm-0.0.6.dist-info/LICENSE,sha256=f1xgK8fAXg_intwnbc9nLkHf7ODPLtgpHs7DetQHOro,11343
-vimlm-0.0.6.dist-info/METADATA,sha256=INHaQDN1Id04li0LNWmlkVCIEmnKi9ABpbhAYFGokYE,4233
-vimlm-0.0.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-vimlm-0.0.6.dist-info/entry_points.txt,sha256=mU5V4MYsuIzCc6YB-Ro-6USSHWN5vHw8UDnTEoq0isw,36
-vimlm-0.0.6.dist-info/top_level.txt,sha256=I8GjqoiP--scYsO3AfLhha-6Ax9ci3IvbWvVbPv8g94,6
-vimlm-0.0.6.dist-info/RECORD,,