@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
package/docs/Tools/Index.md
DELETED
|
@@ -1,216 +0,0 @@
|
|
|
1
|
-
# Tool System Documentation Index
|
|
2
|
-
|
|
3
|
-
**Quick Reference with Links**
|
|
4
|
-
|
|
5
|
-
This index provides quick navigation to all Tool System documentation with brief descriptions.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 📚 Core Documentation
|
|
10
|
-
|
|
11
|
-
### [README.md](README.md)
|
|
12
|
-
|
|
13
|
-
**Overview and Navigation Guide**
|
|
14
|
-
|
|
15
|
-
Main entry point for Tool System documentation. Provides complete overview of the tool execution system, available tools, approval modes, and integration points.
|
|
16
|
-
|
|
17
|
-
**Topics:** Overview, Tools, Approval Modes, Integration
|
|
18
|
-
**Audience:** All users
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
### [Architecture](Architecture.md)
|
|
23
|
-
|
|
24
|
-
**System Architecture and Design**
|
|
25
|
-
|
|
26
|
-
Complete technical documentation of the Tool System architecture. Covers tool registry, execution engine, approval system, schema validation, and all component interactions.
|
|
27
|
-
|
|
28
|
-
**Topics:** Architecture, Components, Tool Registry, Execution, Security
|
|
29
|
-
**Audience:** Developers, architects
|
|
30
|
-
|
|
31
|
-
**Key Sections:**
|
|
32
|
-
|
|
33
|
-
- System overview and architecture
|
|
34
|
-
- Tool registry and discovery
|
|
35
|
-
- Tool execution engine
|
|
36
|
-
- Approval and policy system
|
|
37
|
-
- Schema validation
|
|
38
|
-
- Result formatting
|
|
39
|
-
- Error handling
|
|
40
|
-
- Security model
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
### [User Guide](UserGuide.md)
|
|
45
|
-
|
|
46
|
-
**Using Tools in OLLM CLI**
|
|
47
|
-
|
|
48
|
-
Comprehensive guide to using tools in OLLM CLI. Covers tool discovery, execution, approval modes, and troubleshooting.
|
|
49
|
-
|
|
50
|
-
**Topics:** Usage, Tools, Approval, Examples, Troubleshooting
|
|
51
|
-
**Audience:** All users
|
|
52
|
-
|
|
53
|
-
**Key Sections:**
|
|
54
|
-
|
|
55
|
-
- What are tools
|
|
56
|
-
- Available tools overview
|
|
57
|
-
- Tool discovery and listing
|
|
58
|
-
- Tool execution
|
|
59
|
-
- Approval modes (YOLO, AUTO, ASK)
|
|
60
|
-
- Tool parameters
|
|
61
|
-
- Common patterns
|
|
62
|
-
- Troubleshooting
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
### [Getting Started](GettingStarted.md)
|
|
67
|
-
|
|
68
|
-
**Extension Tools**
|
|
69
|
-
|
|
70
|
-
Guide to extension tools and the extension system. Covers how extensions provide additional tools through MCP servers.
|
|
71
|
-
|
|
72
|
-
**Topics:** Extensions, MCP Tools, Installation
|
|
73
|
-
**Audience:** All users
|
|
74
|
-
|
|
75
|
-
**Key Sections:**
|
|
76
|
-
|
|
77
|
-
- What are extension tools
|
|
78
|
-
- Finding extensions
|
|
79
|
-
- Installing extensions
|
|
80
|
-
- Using extension tools
|
|
81
|
-
- Extension management
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
### [Manifest Reference](ManifestReference.md)
|
|
86
|
-
|
|
87
|
-
**Extension Manifest Schema**
|
|
88
|
-
|
|
89
|
-
Technical reference for extension manifest files. Defines the schema for extension configuration, including MCP server definitions and permissions.
|
|
90
|
-
|
|
91
|
-
**Topics:** Manifest, Schema, Configuration
|
|
92
|
-
**Audience:** Developers
|
|
93
|
-
|
|
94
|
-
**Key Sections:**
|
|
95
|
-
|
|
96
|
-
- Manifest file format
|
|
97
|
-
- Required fields
|
|
98
|
-
- Optional fields
|
|
99
|
-
- MCP server configuration
|
|
100
|
-
- Permissions system
|
|
101
|
-
- Examples
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
## 📖 Documentation by Topic
|
|
106
|
-
|
|
107
|
-
### Tool Usage
|
|
108
|
-
|
|
109
|
-
- [User Guide](UserGuide.md) - Complete usage guide
|
|
110
|
-
- [README](README.md#available-tools) - Tool reference
|
|
111
|
-
- [Architecture](Architecture.md#tool-execution) - Execution details
|
|
112
|
-
|
|
113
|
-
### Approval System
|
|
114
|
-
|
|
115
|
-
- [User Guide](UserGuide.md#approval-modes) - Approval modes
|
|
116
|
-
- [README](README.md#approval-modes) - Quick reference
|
|
117
|
-
- [Architecture](Architecture.md#approval-system) - Implementation
|
|
118
|
-
|
|
119
|
-
### Extension Tools
|
|
120
|
-
|
|
121
|
-
- [Getting Started](GettingStarted.md) - Extension tools
|
|
122
|
-
- [Manifest Reference](ManifestReference.md) - Manifest schema
|
|
123
|
-
- [Architecture](Architecture.md#mcp-integration) - MCP integration
|
|
124
|
-
|
|
125
|
-
### Configuration
|
|
126
|
-
|
|
127
|
-
- [README](README.md#configuration) - Configuration overview
|
|
128
|
-
- [User Guide](UserGuide.md#configuration) - Detailed settings
|
|
129
|
-
|
|
130
|
-
---
|
|
131
|
-
|
|
132
|
-
## 📖 Documentation by Audience
|
|
133
|
-
|
|
134
|
-
### For New Users
|
|
135
|
-
|
|
136
|
-
1. [README](README.md) - Start here
|
|
137
|
-
2. [User Guide](UserGuide.md) - Using tools
|
|
138
|
-
3. [README](README.md#approval-modes) - Approval modes
|
|
139
|
-
|
|
140
|
-
### For Regular Users
|
|
141
|
-
|
|
142
|
-
1. [User Guide](UserGuide.md#advanced-usage) - Advanced usage
|
|
143
|
-
2. [Getting Started](GettingStarted.md) - Extension tools
|
|
144
|
-
3. [README](README.md#best-practices) - Best practices
|
|
145
|
-
|
|
146
|
-
### For Developers
|
|
147
|
-
|
|
148
|
-
1. [Architecture](Architecture.md) - System design
|
|
149
|
-
2. [Manifest Reference](ManifestReference.md) - Extension development
|
|
150
|
-
3. [User Guide](UserGuide.md#troubleshooting) - Debugging
|
|
151
|
-
|
|
152
|
-
---
|
|
153
|
-
|
|
154
|
-
## 🔗 Related Documentation
|
|
155
|
-
|
|
156
|
-
### Core Systems
|
|
157
|
-
|
|
158
|
-
- [MCP Integration](../MCP/MCP_Index.md) - MCP servers and tools
|
|
159
|
-
- [Hooks System](../Hooks/README.md) - Hook integration
|
|
160
|
-
- [User Interface](../UI&Settings/README.md) - UI documentation
|
|
161
|
-
|
|
162
|
-
### Commands
|
|
163
|
-
|
|
164
|
-
- [Tool Commands](../UI&Settings/Commands.md#tool-management) - CLI commands
|
|
165
|
-
|
|
166
|
-
### Developer Resources
|
|
167
|
-
|
|
168
|
-
- Knowledge DB: `dev_ToolExecution.md` - Architecture details
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
## 📊 Documentation Status
|
|
173
|
-
|
|
174
|
-
### Completed ✅
|
|
175
|
-
|
|
176
|
-
| Document | Status |
|
|
177
|
-
| -------------------- | ----------- |
|
|
178
|
-
| README.md | ✅ Complete |
|
|
179
|
-
| Index.md | ✅ Complete |
|
|
180
|
-
| Architecture.md | ✅ Complete |
|
|
181
|
-
| UserGuide.md | ✅ Complete |
|
|
182
|
-
| GettingStarted.md | ✅ Complete |
|
|
183
|
-
| ManifestReference.md | ✅ Complete |
|
|
184
|
-
|
|
185
|
-
**Overall Progress:** 100% complete (6/6 files)
|
|
186
|
-
|
|
187
|
-
---
|
|
188
|
-
|
|
189
|
-
## 🎯 Quick Links
|
|
190
|
-
|
|
191
|
-
### Common Tasks
|
|
192
|
-
|
|
193
|
-
- List tools → [User Guide](UserGuide.md#listing-tools)
|
|
194
|
-
- Set approval mode → [User Guide](UserGuide.md#setting-approval-mode)
|
|
195
|
-
- Use tools → [User Guide](UserGuide.md#using-tools)
|
|
196
|
-
- Install extensions → [Getting Started](GettingStarted.md)
|
|
197
|
-
|
|
198
|
-
### Understanding Systems
|
|
199
|
-
|
|
200
|
-
- How tools work → [README](README.md)
|
|
201
|
-
- Tool categories → [README](README.md#tool-categories)
|
|
202
|
-
- Approval system → [Architecture](Architecture.md#approval-system)
|
|
203
|
-
- System architecture → [Architecture](Architecture.md)
|
|
204
|
-
|
|
205
|
-
### Tool Reference
|
|
206
|
-
|
|
207
|
-
- File tools → [README](README.md#file-operations)
|
|
208
|
-
- Web tools → [README](README.md#web-tools)
|
|
209
|
-
- Shell tool → [README](README.md#shell-tool)
|
|
210
|
-
- Memory tools → [README](README.md#memory-tools)
|
|
211
|
-
- Goal tools → [README](README.md#goal-tools)
|
|
212
|
-
|
|
213
|
-
---
|
|
214
|
-
|
|
215
|
-
**Last Updated:** January 26, 2026
|
|
216
|
-
**Version:** 0.1.0
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
# Extension Manifest Reference
|
|
2
|
-
|
|
3
|
-
**Complete Schema for Extension Manifests**
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Schema
|
|
8
|
-
|
|
9
|
-
```json
|
|
10
|
-
{
|
|
11
|
-
"name": "string (required)",
|
|
12
|
-
"version": "string (required, semver)",
|
|
13
|
-
"description": "string (required)",
|
|
14
|
-
"author": "string (required)",
|
|
15
|
-
"license": "string (optional)",
|
|
16
|
-
"homepage": "string (optional, URL)",
|
|
17
|
-
"repository": "string (optional, URL)",
|
|
18
|
-
"keywords": ["string (optional)"],
|
|
19
|
-
"components": {
|
|
20
|
-
"skills": ["string (glob patterns)"],
|
|
21
|
-
"settings": ["string (glob patterns)"],
|
|
22
|
-
"servers": ["string (glob patterns)"],
|
|
23
|
-
"hooks": ["string (glob patterns)"]
|
|
24
|
-
},
|
|
25
|
-
"permissions": {
|
|
26
|
-
"filesystem": ["read", "write"],
|
|
27
|
-
"network": ["https://domain.com"],
|
|
28
|
-
"tools": ["tool-name"],
|
|
29
|
-
"hooks": ["event-name"],
|
|
30
|
-
"settings": ["read", "write"]
|
|
31
|
-
},
|
|
32
|
-
"dependencies": {
|
|
33
|
-
"extension-name": "version"
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## Field Reference
|
|
41
|
-
|
|
42
|
-
### name (required)
|
|
43
|
-
|
|
44
|
-
- **Type:** string
|
|
45
|
-
- **Format:** kebab-case
|
|
46
|
-
- **Example:** `"github-integration"`
|
|
47
|
-
|
|
48
|
-
### version (required)
|
|
49
|
-
|
|
50
|
-
- **Type:** string
|
|
51
|
-
- **Format:** Semantic versioning (X.Y.Z)
|
|
52
|
-
- **Example:** `"1.2.0"`
|
|
53
|
-
|
|
54
|
-
### description (required)
|
|
55
|
-
|
|
56
|
-
- **Type:** string
|
|
57
|
-
- **Length:** 50-200 characters
|
|
58
|
-
- **Example:** `"GitHub integration with MCP server and hooks"`
|
|
59
|
-
|
|
60
|
-
### author (required)
|
|
61
|
-
|
|
62
|
-
- **Type:** string
|
|
63
|
-
- **Format:** Name or Name <email>
|
|
64
|
-
- **Example:** `"John Doe <john@example.com>"`
|
|
65
|
-
|
|
66
|
-
### components (optional)
|
|
67
|
-
|
|
68
|
-
- **Type:** object
|
|
69
|
-
- **Fields:** skills, settings, servers, hooks
|
|
70
|
-
- **Values:** Array of glob patterns
|
|
71
|
-
- **Example:**
|
|
72
|
-
|
|
73
|
-
```json
|
|
74
|
-
{
|
|
75
|
-
"skills": ["skills/*.md"],
|
|
76
|
-
"hooks": ["hooks/*.sh"]
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### permissions (optional)
|
|
81
|
-
|
|
82
|
-
- **Type:** object
|
|
83
|
-
- **Fields:** filesystem, network, tools, hooks, settings
|
|
84
|
-
- **Example:**
|
|
85
|
-
|
|
86
|
-
```json
|
|
87
|
-
{
|
|
88
|
-
"filesystem": ["read", "write"],
|
|
89
|
-
"network": ["https://api.github.com"]
|
|
90
|
-
}
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
## Examples
|
|
96
|
-
|
|
97
|
-
### Minimal Extension
|
|
98
|
-
|
|
99
|
-
```json
|
|
100
|
-
{
|
|
101
|
-
"name": "simple-extension",
|
|
102
|
-
"version": "1.0.0",
|
|
103
|
-
"description": "A simple extension",
|
|
104
|
-
"author": "Developer"
|
|
105
|
-
}
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Complete Extension
|
|
109
|
-
|
|
110
|
-
```json
|
|
111
|
-
{
|
|
112
|
-
"name": "github-integration",
|
|
113
|
-
"version": "1.2.0",
|
|
114
|
-
"description": "Complete GitHub integration",
|
|
115
|
-
"author": "OLLM Team <team@ollm.dev>",
|
|
116
|
-
"license": "MIT",
|
|
117
|
-
"homepage": "https://github.com/ollm/ext-github",
|
|
118
|
-
"repository": "https://github.com/ollm/ext-github",
|
|
119
|
-
"keywords": ["github", "git", "integration"],
|
|
120
|
-
"components": {
|
|
121
|
-
"skills": ["skills/*.md"],
|
|
122
|
-
"settings": ["settings/github.json"],
|
|
123
|
-
"servers": ["servers/github-server.js"],
|
|
124
|
-
"hooks": ["hooks/*.sh"]
|
|
125
|
-
},
|
|
126
|
-
"permissions": {
|
|
127
|
-
"filesystem": ["read", "write"],
|
|
128
|
-
"network": ["https://api.github.com"],
|
|
129
|
-
"tools": ["read-file", "write-file", "shell"],
|
|
130
|
-
"hooks": ["pre-execution", "on-git-commit"]
|
|
131
|
-
},
|
|
132
|
-
"dependencies": {
|
|
133
|
-
"base-tools": "^1.0.0"
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
---
|
|
139
|
-
|
|
140
|
-
**Last Updated:** 2026-01-16
|
|
141
|
-
**Version:** 0.1.0
|