@tecet/ollm 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/dist/cli.js +20 -14
  2. package/dist/cli.js.map +3 -3
  3. package/dist/services/documentService.d.ts.map +1 -1
  4. package/dist/services/documentService.js +12 -2
  5. package/dist/services/documentService.js.map +1 -1
  6. package/dist/ui/components/docs/DocsPanel.d.ts.map +1 -1
  7. package/dist/ui/components/docs/DocsPanel.js +1 -1
  8. package/dist/ui/components/docs/DocsPanel.js.map +1 -1
  9. package/dist/ui/components/launch/VersionBanner.js +1 -1
  10. package/dist/ui/components/launch/VersionBanner.js.map +1 -1
  11. package/dist/ui/components/layout/KeybindsLegend.d.ts.map +1 -1
  12. package/dist/ui/components/layout/KeybindsLegend.js +1 -1
  13. package/dist/ui/components/layout/KeybindsLegend.js.map +1 -1
  14. package/dist/ui/components/tabs/BugReportTab.js +1 -1
  15. package/dist/ui/components/tabs/BugReportTab.js.map +1 -1
  16. package/dist/ui/services/docsService.d.ts +12 -27
  17. package/dist/ui/services/docsService.d.ts.map +1 -1
  18. package/dist/ui/services/docsService.js +40 -67
  19. package/dist/ui/services/docsService.js.map +1 -1
  20. package/docs/README.md +3 -410
  21. package/package.json +10 -7
  22. package/scripts/copy-docs-to-user.cjs +34 -0
  23. package/docs/Context/CheckpointFlowDiagram.md +0 -673
  24. package/docs/Context/ContextArchitecture.md +0 -898
  25. package/docs/Context/ContextCompression.md +0 -1102
  26. package/docs/Context/ContextManagment.md +0 -750
  27. package/docs/Context/Index.md +0 -209
  28. package/docs/Context/README.md +0 -390
  29. package/docs/DevelopmentRoadmap/Index.md +0 -238
  30. package/docs/DevelopmentRoadmap/OLLM-CLI_Releases.md +0 -419
  31. package/docs/DevelopmentRoadmap/PlanedFeatures.md +0 -448
  32. package/docs/DevelopmentRoadmap/README.md +0 -174
  33. package/docs/DevelopmentRoadmap/Roadmap.md +0 -572
  34. package/docs/DevelopmentRoadmap/RoadmapVisual.md +0 -372
  35. package/docs/Hooks/Architecture.md +0 -885
  36. package/docs/Hooks/Index.md +0 -244
  37. package/docs/Hooks/KeyboardShortcuts.md +0 -248
  38. package/docs/Hooks/Protocol.md +0 -817
  39. package/docs/Hooks/README.md +0 -403
  40. package/docs/Hooks/UserGuide.md +0 -1483
  41. package/docs/Hooks/VisualGuide.md +0 -598
  42. package/docs/Index.md +0 -506
  43. package/docs/Installation.md +0 -586
  44. package/docs/Introduction.md +0 -367
  45. package/docs/LLM Models/Index.md +0 -239
  46. package/docs/LLM Models/LLM_GettingStarted.md +0 -748
  47. package/docs/LLM Models/LLM_Index.md +0 -701
  48. package/docs/LLM Models/LLM_MemorySystem.md +0 -337
  49. package/docs/LLM Models/LLM_ModelCompatibility.md +0 -499
  50. package/docs/LLM Models/LLM_ModelsArchitecture.md +0 -933
  51. package/docs/LLM Models/LLM_ModelsCommands.md +0 -839
  52. package/docs/LLM Models/LLM_ModelsConfiguration.md +0 -1094
  53. package/docs/LLM Models/LLM_ModelsList.md +0 -1071
  54. package/docs/LLM Models/LLM_ModelsList.md.backup +0 -400
  55. package/docs/LLM Models/README.md +0 -355
  56. package/docs/MCP/MCP_Architecture.md +0 -1086
  57. package/docs/MCP/MCP_Commands.md +0 -1111
  58. package/docs/MCP/MCP_GettingStarted.md +0 -590
  59. package/docs/MCP/MCP_Index.md +0 -524
  60. package/docs/MCP/MCP_Integration.md +0 -866
  61. package/docs/MCP/MCP_Marketplace.md +0 -160
  62. package/docs/MCP/README.md +0 -415
  63. package/docs/Prompts System/Architecture.md +0 -760
  64. package/docs/Prompts System/Index.md +0 -223
  65. package/docs/Prompts System/PromptsRouting.md +0 -1047
  66. package/docs/Prompts System/PromptsTemplates.md +0 -1102
  67. package/docs/Prompts System/README.md +0 -389
  68. package/docs/Prompts System/SystemPrompts.md +0 -856
  69. package/docs/Quickstart.md +0 -535
  70. package/docs/Tools/Architecture.md +0 -884
  71. package/docs/Tools/GettingStarted.md +0 -624
  72. package/docs/Tools/Index.md +0 -216
  73. package/docs/Tools/ManifestReference.md +0 -141
  74. package/docs/Tools/README.md +0 -440
  75. package/docs/Tools/UserGuide.md +0 -773
  76. package/docs/Troubleshooting.md +0 -1265
  77. package/docs/UI&Settings/Architecture.md +0 -729
  78. package/docs/UI&Settings/ColorASCII.md +0 -34
  79. package/docs/UI&Settings/Commands.md +0 -755
  80. package/docs/UI&Settings/Configuration.md +0 -872
  81. package/docs/UI&Settings/Index.md +0 -293
  82. package/docs/UI&Settings/Keybinds.md +0 -372
  83. package/docs/UI&Settings/README.md +0 -278
  84. package/docs/UI&Settings/Terminal.md +0 -637
  85. package/docs/UI&Settings/Themes.md +0 -604
  86. package/docs/UI&Settings/UIGuide.md +0 -550
@@ -1,355 +0,0 @@
1
- # Model Management Documentation
2
-
3
- **Last Updated:** January 26, 2026
4
-
5
- Welcome to the Model Management documentation for OLLM CLI. This guide covers model lifecycle management, provider integration, and model capabilities.
6
-
7
- ---
8
-
9
- ## 📚 Documentation Overview
10
-
11
- ### Core Documentation
12
-
13
- - **[Model Index](LLM_Index.md)** - Complete documentation index
14
- - **[Models List](LLM_ModelsList.md)** - Ollama models reference with VRAM requirements
15
- - **[Model Compatibility](LLM_ModelCompatibility.md)** - Tested models and compatibility matrix
16
- - **[Memory System](LLM_MemorySystem.md)** - Cross-session memory guide
17
-
18
- ---
19
-
20
- ## 🎯 What is Model Management?
21
-
22
- The **Model Management** system provides comprehensive control over LLM models and their usage in OLLM CLI:
23
-
24
- ### 1. **Model Discovery & Metadata**
25
-
26
- Track installed models and their capabilities:
27
-
28
- - List available models from provider
29
- - Enrich with metadata from shipped profiles
30
- - Detect tool calling support
31
- - Track context window sizes
32
- - Monitor model parameters and VRAM requirements
33
-
34
- ### 2. **Provider Integration**
35
-
36
- Unified interface for LLM backends:
37
-
38
- - **Current:** Ollama provider (local execution)
39
- - **Planned:** Codex, Claude, Gemini (v0.6.0)
40
- - **Planned:** vLLM and open source providers (v0.9.0)
41
- - Automatic provider health checks
42
- - Model management operations (pull, remove, list)
43
-
44
- ### 3. **Context Window Configuration**
45
-
46
- Flexible context sizing:
47
-
48
- - Auto-detection from model metadata
49
- - Manual context size configuration
50
- - Context profiles (4K, 8K, 16K, 32K, etc.)
51
- - VRAM-aware context sizing
52
- - 85% utilization for optimal performance
53
-
54
- ### 4. **Tool Support Detection**
55
-
56
- Intelligent tool calling capability detection:
57
-
58
- - Auto-detection via test requests
59
- - User confirmation prompts
60
- - Runtime error learning
61
- - Precedence system (user > auto > runtime > profile)
62
-
63
- ### 5. **Reasoning Model Support**
64
-
65
- Special handling for reasoning models:
66
-
67
- - Extended warmup timeouts (120s vs 30s)
68
- - Reasoning content capture and display
69
- - Collapsible reasoning blocks
70
- - Separate reasoning token tracking
71
-
72
- ---
73
-
74
- ## 📖 Documentation Structure
75
-
76
- ```
77
- docs/LLM Models/
78
- ├── README.md ← You are here
79
- ├── LLM_Index.md Complete documentation index
80
- ├── LLM_ModelsList.md Ollama models reference
81
- ├── LLM_ModelCompatibility.md Compatibility matrix
82
- └── LLM_MemorySystem.md Memory system guide
83
- ```
84
-
85
- ---
86
-
87
- ## 🎓 Key Concepts
88
-
89
- ### Model Discovery
90
-
91
- Tracks installed models from provider and enriches with metadata.
92
-
93
- **Process:**
94
-
95
- 1. Query provider for installed models (e.g., Ollama `/api/tags`)
96
- 2. Match with shipped profiles (`LLM_profiles.json`)
97
- 3. Enrich with metadata (context windows, tool support, etc.)
98
- 4. Save to `user_models.json` with user overrides
99
- 5. Display in model selection menu
100
-
101
- **See:** [Model Index](LLM_Index.md)
102
-
103
- ### Provider System
104
-
105
- Abstracts LLM backend communication through unified interface.
106
-
107
- **Current Provider:**
108
-
109
- - **Ollama** - Local execution, full privacy, no API costs
110
- - Auto-start capability
111
- - Model management (pull, remove, list)
112
- - VRAM monitoring integration
113
-
114
- **Planned Providers:**
115
-
116
- - **v0.6.0:** Codex, Claude, Gemini
117
- - **v0.9.0:** vLLM and open source providers
118
-
119
- **See:** Knowledge DB `dev_ProviderSystem.md`
120
-
121
- ### Context Window Management
122
-
123
- Flexible context sizing based on model capabilities and hardware.
124
-
125
- **Features:**
126
-
127
- - Auto-detection from model metadata
128
- - Context profiles (4K, 8K, 16K, 32K, 64K, 128K)
129
- - 85% utilization (pre-calculated in profiles)
130
- - VRAM-aware sizing
131
- - Manual override support
132
-
133
- **See:** [Models List](LLM_ModelsList.md)
134
-
135
- ### Tool Support Detection
136
-
137
- Intelligent detection of tool calling capabilities.
138
-
139
- **Detection Methods:**
140
-
141
- 1. **User Confirmed** - User explicitly confirms (highest priority)
142
- 2. **Auto-Detected** - Automatic test request
143
- 3. **Runtime Error** - Learned from actual errors
144
- 4. **Profile** - Default from shipped profiles (lowest priority)
145
-
146
- **See:** Knowledge DB `dev_ModelManagement.md`
147
-
148
- ### Reasoning Models
149
-
150
- Special handling for models that expose thinking process.
151
-
152
- **Features:**
153
-
154
- - Extended warmup timeouts (120s vs 30s)
155
- - Reasoning content capture (`thinking` field)
156
- - Collapsible reasoning blocks in UI
157
- - Auto-expand during streaming, auto-collapse when complete
158
-
159
- **Examples:** DeepSeek R1, QwQ
160
-
161
- **See:** Knowledge DB `dev_ReasoningModels.md`
162
-
163
- ---
164
-
165
- ## 💡 Common Use Cases
166
-
167
- ### Manage Models
168
-
169
- ```bash
170
- # List available models
171
- /model list
172
-
173
- # Download a model
174
- /model pull llama3.1:8b
175
-
176
- # View model details
177
- /model info llama3.1:8b
178
-
179
- # Keep model loaded
180
- /model keep llama3.1:8b
181
-
182
- # Delete unused model
183
- /model delete old-model:7b
184
- ```
185
-
186
- **Learn more:** [Model Commands](../UserInterface/Commands.md#model-management)
187
-
188
- ### Configure Context Size
189
-
190
- ```bash
191
- # Check current context
192
- /context stats
193
-
194
- # Set context size
195
- /context size 16384
196
-
197
- # Enable auto-sizing
198
- /context auto
199
- ```
200
-
201
- **Learn more:** [Context Management](../Context/ContextManagment.md)
202
-
203
- ### Use Memory System
204
-
205
- ```bash
206
- # Add a memory
207
- /memory add user_name Alice
208
-
209
- # List memories
210
- /memory list
211
-
212
- # Search memories
213
- /memory search project
214
-
215
- # Forget a memory
216
- /memory forget old_preference
217
- ```
218
-
219
- **Learn more:** [Memory System](LLM_MemorySystem.md)
220
-
221
- ---
222
-
223
- ## 🛠️ Configuration
224
-
225
- ### Provider Settings
226
-
227
- ```yaml
228
- # Ollama provider (current)
229
- provider:
230
- ollama:
231
- autoStart: true # Auto-start ollama serve
232
- host: localhost
233
- port: 11434
234
- url: http://localhost:11434
235
- ```
236
-
237
- ### Model Settings
238
-
239
- ```yaml
240
- model:
241
- default: llama3.2:3b
242
- temperature: 0.7
243
- maxTokens: 4096
244
- ```
245
-
246
- ### Context Settings
247
-
248
- ```yaml
249
- context:
250
- targetSize: 8192
251
- autoSize: true
252
- compressionEnabled: true
253
- ```
254
-
255
- ### Memory Settings
256
-
257
- ```yaml
258
- memory:
259
- enabled: true
260
- tokenBudget: 500
261
- ```
262
-
263
- **Learn more:** [Configuration](../UserInterface/configuration.md)
264
-
265
- ---
266
-
267
- ## 🔍 Troubleshooting
268
-
269
- ### Common Issues
270
-
271
- **Ollama not running:**
272
-
273
- - **If auto-start enabled:** Check app logs for startup errors
274
- - **If auto-start disabled:** Run `ollama serve` manually
275
- - **Custom server:** Configure with `/config ollama host <hostname>`
276
-
277
- **Model not found:**
278
-
279
- - Check model name: `/model list`
280
- - Pull the model: `/model pull <name>`
281
- - Verify provider is running
282
-
283
- **Tool calling not working:**
284
-
285
- - Check tool support: Model info shows tool_support field
286
- - Auto-detect: System prompts for confirmation
287
- - Manual override: Confirm in user_models.json
288
-
289
- **Context window issues:**
290
-
291
- - Check model's native context window
292
- - Set appropriate `num_ctx` value
293
- - Use model with larger context window
294
- - Enable context compression
295
-
296
- **Memory not persisting:**
297
-
298
- - Check memory enabled in config
299
- - Verify file permissions
300
- - Check storage location: `~/.ollm/memory.json`
301
-
302
- **See:** [Troubleshooting Guide](../Troubleshooting.md)
303
-
304
- ---
305
-
306
- ## 📊 Implementation Status
307
-
308
- ### Current (v0.1.0)
309
-
310
- - ✅ Model Discovery & Metadata
311
- - ✅ Ollama Provider Integration
312
- - ✅ Context Window Configuration
313
- - ✅ Tool Support Detection
314
- - ✅ Reasoning Model Support (basic)
315
- - ✅ Memory System
316
- - ✅ Model Commands
317
-
318
- ### Planned (v0.6.0)
319
-
320
- - ⏳ Codex Provider
321
- - ⏳ Claude Provider
322
- - ⏳ Gemini Provider
323
- - ⏳ Model Routing System
324
- - ⏳ Prompt Templates
325
- - ⏳ Project Profiles
326
-
327
- ### Planned (v0.9.0)
328
-
329
- - ⏳ vLLM Provider
330
- - ⏳ Open Source Providers
331
- - ⏳ Advanced Routing
332
- - ⏳ Reasoning Analytics
333
-
334
- ---
335
-
336
- ## 🤝 Related Documentation
337
-
338
- ### Core Systems
339
-
340
- - [Context Management](../Context/ContextManagment.md) - Context sizing and VRAM
341
- - [Context Compression](../Context/ContextCompression.md) - Compression system
342
- - [MCP Integration](../MCP/MCP_Index.md) - Model Context Protocol
343
- - [User Interface](../UserInterface/README.md) - UI documentation
344
-
345
- ### Developer Resources
346
-
347
- - Knowledge DB: `dev_ModelManagement.md` - Model management architecture
348
- - Knowledge DB: `dev_ProviderSystem.md` - Provider system design
349
- - Knowledge DB: `dev_ReasoningModels.md` - Reasoning model support
350
-
351
- ---
352
-
353
- **Last Updated:** January 26, 2026
354
- **Version:** 0.1.0
355
- **Status:** Active Development