@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.
- package/dist/cli.js +20 -14
- package/dist/cli.js.map +3 -3
- package/dist/services/documentService.d.ts.map +1 -1
- package/dist/services/documentService.js +12 -2
- package/dist/services/documentService.js.map +1 -1
- package/dist/ui/components/docs/DocsPanel.d.ts.map +1 -1
- package/dist/ui/components/docs/DocsPanel.js +1 -1
- package/dist/ui/components/docs/DocsPanel.js.map +1 -1
- package/dist/ui/components/launch/VersionBanner.js +1 -1
- package/dist/ui/components/launch/VersionBanner.js.map +1 -1
- package/dist/ui/components/layout/KeybindsLegend.d.ts.map +1 -1
- package/dist/ui/components/layout/KeybindsLegend.js +1 -1
- package/dist/ui/components/layout/KeybindsLegend.js.map +1 -1
- package/dist/ui/components/tabs/BugReportTab.js +1 -1
- package/dist/ui/components/tabs/BugReportTab.js.map +1 -1
- package/dist/ui/services/docsService.d.ts +12 -27
- package/dist/ui/services/docsService.d.ts.map +1 -1
- package/dist/ui/services/docsService.js +40 -67
- package/dist/ui/services/docsService.js.map +1 -1
- package/docs/README.md +3 -410
- package/package.json +10 -7
- package/scripts/copy-docs-to-user.cjs +34 -0
- package/docs/Context/CheckpointFlowDiagram.md +0 -673
- package/docs/Context/ContextArchitecture.md +0 -898
- package/docs/Context/ContextCompression.md +0 -1102
- package/docs/Context/ContextManagment.md +0 -750
- package/docs/Context/Index.md +0 -209
- package/docs/Context/README.md +0 -390
- package/docs/DevelopmentRoadmap/Index.md +0 -238
- package/docs/DevelopmentRoadmap/OLLM-CLI_Releases.md +0 -419
- package/docs/DevelopmentRoadmap/PlanedFeatures.md +0 -448
- package/docs/DevelopmentRoadmap/README.md +0 -174
- package/docs/DevelopmentRoadmap/Roadmap.md +0 -572
- package/docs/DevelopmentRoadmap/RoadmapVisual.md +0 -372
- package/docs/Hooks/Architecture.md +0 -885
- package/docs/Hooks/Index.md +0 -244
- package/docs/Hooks/KeyboardShortcuts.md +0 -248
- package/docs/Hooks/Protocol.md +0 -817
- package/docs/Hooks/README.md +0 -403
- package/docs/Hooks/UserGuide.md +0 -1483
- package/docs/Hooks/VisualGuide.md +0 -598
- package/docs/Index.md +0 -506
- package/docs/Installation.md +0 -586
- package/docs/Introduction.md +0 -367
- package/docs/LLM Models/Index.md +0 -239
- package/docs/LLM Models/LLM_GettingStarted.md +0 -748
- package/docs/LLM Models/LLM_Index.md +0 -701
- package/docs/LLM Models/LLM_MemorySystem.md +0 -337
- package/docs/LLM Models/LLM_ModelCompatibility.md +0 -499
- package/docs/LLM Models/LLM_ModelsArchitecture.md +0 -933
- package/docs/LLM Models/LLM_ModelsCommands.md +0 -839
- package/docs/LLM Models/LLM_ModelsConfiguration.md +0 -1094
- package/docs/LLM Models/LLM_ModelsList.md +0 -1071
- package/docs/LLM Models/LLM_ModelsList.md.backup +0 -400
- package/docs/LLM Models/README.md +0 -355
- package/docs/MCP/MCP_Architecture.md +0 -1086
- package/docs/MCP/MCP_Commands.md +0 -1111
- package/docs/MCP/MCP_GettingStarted.md +0 -590
- package/docs/MCP/MCP_Index.md +0 -524
- package/docs/MCP/MCP_Integration.md +0 -866
- package/docs/MCP/MCP_Marketplace.md +0 -160
- package/docs/MCP/README.md +0 -415
- package/docs/Prompts System/Architecture.md +0 -760
- package/docs/Prompts System/Index.md +0 -223
- package/docs/Prompts System/PromptsRouting.md +0 -1047
- package/docs/Prompts System/PromptsTemplates.md +0 -1102
- package/docs/Prompts System/README.md +0 -389
- package/docs/Prompts System/SystemPrompts.md +0 -856
- package/docs/Quickstart.md +0 -535
- package/docs/Tools/Architecture.md +0 -884
- package/docs/Tools/GettingStarted.md +0 -624
- package/docs/Tools/Index.md +0 -216
- package/docs/Tools/ManifestReference.md +0 -141
- package/docs/Tools/README.md +0 -440
- package/docs/Tools/UserGuide.md +0 -773
- package/docs/Troubleshooting.md +0 -1265
- package/docs/UI&Settings/Architecture.md +0 -729
- package/docs/UI&Settings/ColorASCII.md +0 -34
- package/docs/UI&Settings/Commands.md +0 -755
- package/docs/UI&Settings/Configuration.md +0 -872
- package/docs/UI&Settings/Index.md +0 -293
- package/docs/UI&Settings/Keybinds.md +0 -372
- package/docs/UI&Settings/README.md +0 -278
- package/docs/UI&Settings/Terminal.md +0 -637
- package/docs/UI&Settings/Themes.md +0 -604
- package/docs/UI&Settings/UIGuide.md +0 -550
|
@@ -1,278 +0,0 @@
|
|
|
1
|
-
# User Interface Documentation
|
|
2
|
-
|
|
3
|
-
**Last Updated:** January 26, 2026
|
|
4
|
-
|
|
5
|
-
Welcome to the OLLM CLI User Interface documentation. This section covers all aspects of the terminal-based user interface, including layout, components, commands, themes, and terminal integration.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Documentation Index
|
|
10
|
-
|
|
11
|
-
### Core UI Documentation
|
|
12
|
-
|
|
13
|
-
- **[UI Guide](./UIGuide.md)** - Complete guide to the main interface layout and components
|
|
14
|
-
- Header bar and status display
|
|
15
|
-
- Chat view and message rendering
|
|
16
|
-
- Side panel and tabs
|
|
17
|
-
- Focus management and navigation
|
|
18
|
-
|
|
19
|
-
- **[Commands Reference](./Commands.md)** - Complete slash command reference
|
|
20
|
-
- Session management commands
|
|
21
|
-
- Context and model commands
|
|
22
|
-
- MCP and extension commands
|
|
23
|
-
- Git and workflow commands
|
|
24
|
-
|
|
25
|
-
- **[Keyboard Shortcuts](./keybinds.md)** - All keyboard shortcuts and keybindings
|
|
26
|
-
- Global shortcuts
|
|
27
|
-
- Chat interaction keys
|
|
28
|
-
- Navigation and focus management
|
|
29
|
-
- Tab and panel controls
|
|
30
|
-
|
|
31
|
-
- **[Themes Guide](./Themes.md)** - Theme system and customization
|
|
32
|
-
- Built-in themes overview
|
|
33
|
-
- Theme management commands
|
|
34
|
-
- Color palette reference
|
|
35
|
-
- Custom theme creation
|
|
36
|
-
|
|
37
|
-
- **[Terminal Guide](./Terminal.md)** - Integrated terminal system
|
|
38
|
-
- Terminal architecture
|
|
39
|
-
- PTY integration
|
|
40
|
-
- ANSI rendering
|
|
41
|
-
- Terminal commands and controls
|
|
42
|
-
|
|
43
|
-
- **[Configuration](./configuration.md)** - UI configuration options
|
|
44
|
-
- Layout settings
|
|
45
|
-
- Display preferences
|
|
46
|
-
- Theme configuration
|
|
47
|
-
- Performance tuning
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## Quick Start
|
|
52
|
-
|
|
53
|
-
### Basic Navigation
|
|
54
|
-
|
|
55
|
-
- `Ctrl+P` - Toggle side panel
|
|
56
|
-
- `Ctrl+1-9` - Switch between tabs
|
|
57
|
-
- `Tab` / `Shift+Tab` - Cycle focus
|
|
58
|
-
- `Ctrl+K` - Open command palette
|
|
59
|
-
|
|
60
|
-
### Essential Commands
|
|
61
|
-
|
|
62
|
-
- `/help` - Show help information
|
|
63
|
-
- `/model list` - List available models
|
|
64
|
-
- `/theme list` - List available themes
|
|
65
|
-
- `/session save <name>` - Save current session
|
|
66
|
-
|
|
67
|
-
### Common Workflows
|
|
68
|
-
|
|
69
|
-
1. **Starting a Chat**
|
|
70
|
-
- Type your message in the input area
|
|
71
|
-
- Press `Return` to send
|
|
72
|
-
- Use `Shift+Return` for new lines
|
|
73
|
-
|
|
74
|
-
2. **Managing Context**
|
|
75
|
-
- Use `/context stats` to check usage
|
|
76
|
-
- Use `/compact` to compress context
|
|
77
|
-
- Use `/snapshot create` to save state
|
|
78
|
-
|
|
79
|
-
3. **Customizing Appearance**
|
|
80
|
-
- Use `/theme list` to see themes
|
|
81
|
-
- Use `/theme use <name>` to switch
|
|
82
|
-
- Settings persist across sessions
|
|
83
|
-
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## UI Architecture
|
|
87
|
-
|
|
88
|
-
### Layout Structure
|
|
89
|
-
|
|
90
|
-
```
|
|
91
|
-
┌─────────────────────────────────────────────────────────────────┐
|
|
92
|
-
│ HEADER BAR │
|
|
93
|
-
│ Model | Context | Mode | Clock │
|
|
94
|
-
├─────────────────────────────────────────────────────────────────┤
|
|
95
|
-
│ │
|
|
96
|
-
│ ┌─────────────────────┬─────────────────────────────────────┐ │
|
|
97
|
-
│ │ │ │ │
|
|
98
|
-
│ │ MAIN CONTENT │ SIDE PANEL (Optional) │ │
|
|
99
|
-
│ │ (Chat/Tabs) │ (Tools/Hooks/Files/MCP/Settings) │ │
|
|
100
|
-
│ │ │ │ │
|
|
101
|
-
│ └─────────────────────┴─────────────────────────────────────┘ │
|
|
102
|
-
│ │
|
|
103
|
-
├─────────────────────────────────────────────────────────────────┤
|
|
104
|
-
│ STATUS BAR │
|
|
105
|
-
│ Status | Keybind Hints | Notifications │
|
|
106
|
-
└─────────────────────────────────────────────────────────────────┘
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Component Hierarchy
|
|
110
|
-
|
|
111
|
-
- **App Container** - Root component
|
|
112
|
-
- **Header Bar** - Model, context, mode display
|
|
113
|
-
- **Main Content Area**
|
|
114
|
-
- **Chat View** - Message history and input
|
|
115
|
-
- **Side Panel** - Tabs for tools, hooks, files, etc.
|
|
116
|
-
- **Status Bar** - Status indicators and hints
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Key Features
|
|
121
|
-
|
|
122
|
-
### Interactive Chat
|
|
123
|
-
|
|
124
|
-
- Real-time streaming responses
|
|
125
|
-
- Syntax highlighting for code blocks
|
|
126
|
-
- Tool call visualization
|
|
127
|
-
- Collapsible reasoning blocks
|
|
128
|
-
- Message history with scrollback
|
|
129
|
-
|
|
130
|
-
### Side Panel Tabs
|
|
131
|
-
|
|
132
|
-
- **Tools** - Manage available tools
|
|
133
|
-
- **Hooks** - Configure automation hooks
|
|
134
|
-
- **Files** - Browse project files
|
|
135
|
-
- **MCP** - Manage MCP servers
|
|
136
|
-
- **Settings** - Configure preferences
|
|
137
|
-
|
|
138
|
-
### Context Management
|
|
139
|
-
|
|
140
|
-
- Real-time token usage display
|
|
141
|
-
- Visual indicators for context limits
|
|
142
|
-
- Automatic compression when needed
|
|
143
|
-
- Snapshot creation and restoration
|
|
144
|
-
|
|
145
|
-
### Theme System
|
|
146
|
-
|
|
147
|
-
- 6 built-in themes
|
|
148
|
-
- Instant theme switching
|
|
149
|
-
- Persistent theme selection
|
|
150
|
-
- Custom theme support (planned)
|
|
151
|
-
|
|
152
|
-
---
|
|
153
|
-
|
|
154
|
-
## Accessibility
|
|
155
|
-
|
|
156
|
-
### Keyboard-First Design
|
|
157
|
-
|
|
158
|
-
- All features accessible via keyboard
|
|
159
|
-
- No mouse required
|
|
160
|
-
- Vim-style alternatives available
|
|
161
|
-
- Clear focus indicators
|
|
162
|
-
|
|
163
|
-
### Screen Reader Support
|
|
164
|
-
|
|
165
|
-
- Text-based UI (no graphics)
|
|
166
|
-
- ANSI escape codes for formatting
|
|
167
|
-
- Clear status messages
|
|
168
|
-
- Semantic structure
|
|
169
|
-
|
|
170
|
-
### Color Blindness Support
|
|
171
|
-
|
|
172
|
-
- Status indicators use symbols + colors
|
|
173
|
-
- High contrast themes available
|
|
174
|
-
- Customizable color schemes
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
## Performance
|
|
179
|
-
|
|
180
|
-
### Rendering Optimization
|
|
181
|
-
|
|
182
|
-
- Efficient React reconciliation
|
|
183
|
-
- Virtual scrolling for long lists
|
|
184
|
-
- Message pagination
|
|
185
|
-
- Lazy loading for large files
|
|
186
|
-
|
|
187
|
-
### Memory Management
|
|
188
|
-
|
|
189
|
-
- Limited message history in memory
|
|
190
|
-
- Older messages in session storage
|
|
191
|
-
- Compression for long conversations
|
|
192
|
-
- Automatic cleanup
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
## Platform Support
|
|
197
|
-
|
|
198
|
-
### Cross-Platform Compatibility
|
|
199
|
-
|
|
200
|
-
- **Windows** - Full support with PowerShell
|
|
201
|
-
- **macOS** - Full support with bash/zsh
|
|
202
|
-
- **Linux** - Full support with bash
|
|
203
|
-
|
|
204
|
-
### Terminal Requirements
|
|
205
|
-
|
|
206
|
-
- **Minimum Size:** 80x24 (columns x rows)
|
|
207
|
-
- **Recommended:** 120x40
|
|
208
|
-
- **Color Support:** 256 colors recommended
|
|
209
|
-
- **Unicode Support:** Required for icons
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
## Related Documentation
|
|
214
|
-
|
|
215
|
-
### Core Systems
|
|
216
|
-
|
|
217
|
-
- [Context Management](../Context/ContextManagment.md) - Context system architecture
|
|
218
|
-
- [MCP Integration](../MCP/MCP_Index.md) - Model Context Protocol
|
|
219
|
-
- [Hooks System](../Hooks/UserGuide.md) - Automation hooks
|
|
220
|
-
- [Tools System](../Tools/UserGuide.md) - Tool management
|
|
221
|
-
|
|
222
|
-
### Developer Resources
|
|
223
|
-
|
|
224
|
-
- [UI Components](../../dev/docs/knowledgeDB/dev_UI_Front.md) - Component architecture
|
|
225
|
-
- [Theme System](../../dev/docs/knowledgeDB/dev_UI_Themes.md) - Theme implementation
|
|
226
|
-
- [Terminal System](../../dev/docs/knowledgeDB/dev_Terminal.md) - Terminal architecture
|
|
227
|
-
|
|
228
|
-
---
|
|
229
|
-
|
|
230
|
-
## Getting Help
|
|
231
|
-
|
|
232
|
-
### In-App Help
|
|
233
|
-
|
|
234
|
-
- `/help` - General help
|
|
235
|
-
- `/help <command>` - Command-specific help
|
|
236
|
-
- `Ctrl+?` - Show keyboard shortcuts
|
|
237
|
-
|
|
238
|
-
### Documentation
|
|
239
|
-
|
|
240
|
-
- Read the [UI Guide](./UIGuide.md) for detailed interface documentation
|
|
241
|
-
- Check [Commands Reference](./Commands.md) for all available commands
|
|
242
|
-
- Review [Keyboard Shortcuts](./keybinds.md) for navigation tips
|
|
243
|
-
|
|
244
|
-
### Community
|
|
245
|
-
|
|
246
|
-
- Report issues on GitHub
|
|
247
|
-
- Join community discussions
|
|
248
|
-
- Contribute improvements
|
|
249
|
-
|
|
250
|
-
---
|
|
251
|
-
|
|
252
|
-
## Tips and Tricks
|
|
253
|
-
|
|
254
|
-
### Productivity Tips
|
|
255
|
-
|
|
256
|
-
1. **Use Keyboard Shortcuts** - Learn the essential shortcuts for faster navigation
|
|
257
|
-
2. **Save Sessions** - Use `/session save` to preserve your work
|
|
258
|
-
3. **Create Snapshots** - Use `/snapshot create` before major changes
|
|
259
|
-
4. **Customize Themes** - Find a theme that works for your eyes
|
|
260
|
-
5. **Learn Commands** - Master slash commands for quick actions
|
|
261
|
-
|
|
262
|
-
### Performance Tips
|
|
263
|
-
|
|
264
|
-
1. **Compress Context** - Use `/compact` when context gets large
|
|
265
|
-
2. **Close Side Panel** - Use `Ctrl+P` to hide panel when not needed
|
|
266
|
-
3. **Limit History** - Clear old messages with `/clear`
|
|
267
|
-
4. **Use Smaller Models** - Switch to faster models for simple tasks
|
|
268
|
-
|
|
269
|
-
### Workflow Tips
|
|
270
|
-
|
|
271
|
-
1. **Use Modes** - Switch modes with `/mode` for specialized assistance
|
|
272
|
-
2. **Enable Hooks** - Automate repetitive tasks with hooks
|
|
273
|
-
3. **Organize Sessions** - Name sessions descriptively for easy resumption
|
|
274
|
-
4. **Review Diffs** - Enable diff review for safer file modifications
|
|
275
|
-
|
|
276
|
-
---
|
|
277
|
-
|
|
278
|
-
**Last Updated:** January 26, 2026
|