@tecet/ollm 0.1.4 → 0.1.5

package/docs/README.md

@@ -1,410 +1,3 @@
-# OLLM CLI Documentation
-
-**Complete Documentation for OLLM CLI**
-
-Welcome to the OLLM CLI documentation! This is your complete guide to using, configuring, and extending OLLM CLI.
-
----
-
-## 📚 Quick Navigation
-
-### Getting Started
-
-- **[Introduction](Introduction.md)** - What is OLLM CLI and why use it?
-- **[Installation](Installation.md)** - Install OLLM CLI on your computer
-- **[Quick Start](Quickstart.md)** - Get up and running in 5 minutes
-- **[Troubleshooting](Troubleshooting.md)** - Common issues and solutions
-
-### Core Documentation
-
-- **[User Interface](UI&Settings/README.md)** - Interface, commands, themes, and settings
-- **[Context Management](Context/README.md)** - Context sizing, compression, and VRAM
-- **[Model Management](LLM%20Models/README.md)** - Models, providers, and configuration
-- **[Tools System](Tools/README.md)** - Tool execution and management
-- **[Hooks System](Hooks/README.md)** - Event-driven automation
-- **[MCP Integration](MCP/README.md)** - Model Context Protocol and external services
-- **[Prompts System](Prompts%20System/README.md)** - System prompts and templates
-
-### Development
-
-- **[Development Roadmap](DevelopmentRoadmap/README.md)** - Future plans and releases
-- **[Complete Index](Index.md)** - All documentation organized by topic
-
----
-
-## 🎯 Documentation by Goal
-
-### I want to...
-
-**Get Started**
-
-1. [Install OLLM CLI](Installation.md)
-2. [Learn the basics](Quickstart.md)
-3. [Understand the interface](UI&Settings/UIGuide.md)
-
-**Use OLLM CLI**
-
-1. [Learn all commands](UI&Settings/Commands.md)
-2. [Master keyboard shortcuts](UI&Settings/Keybinds.md)
-3. [Use tools effectively](Tools/UserGuide.md)
-4. [Customize themes](UI&Settings/Themes.md)
-
-**Configure OLLM CLI**
-
-1. [Configure settings](UI&Settings/Configuration.md)
-2. [Manage models](LLM%20Models/README.md)
-3. [Set up MCP servers](MCP/MCP_GettingStarted.md)
-4. [Create hooks](Hooks/UserGuide.md)
-
-**Understand How It Works**
-
-1. [Context management](Context/ContextManagment.md)
-2. [Tool system architecture](Tools/Architecture.md)
-3. [UI architecture](UI&Settings/Architecture.md)
-4. [Prompts system](Prompts%20System/SystemPrompts.md)
-
-**Troubleshoot Issues**
-
-1. [Common problems](Troubleshooting.md)
-2. [Connection issues](Troubleshooting.md#connection-issues)
-3. [Tool problems](Troubleshooting.md#tool-execution-issues)
-4. [Debug mode](Troubleshooting.md#debug-mode)
-
----
-
-## 📖 Documentation Structure
-
-### Core Guides
-
-**[Introduction](Introduction.md)**
-
-- What is OLLM CLI?
-- Why use it?
-- Key features
-- Who is it for?
-
-**[Installation](Installation.md)**
-
-- Prerequisites
-- Installation steps
-- Platform-specific instructions
-- Verification
-
-**[Quick Start](Quickstart.md)**
-
-- First conversation
-- Using tools
-- Essential shortcuts
-- Common tasks
-
-**[Troubleshooting](Troubleshooting.md)**
-
-- Quick fixes
-- Common issues
-- Debug mode
-- Getting help
-
----
-
-### System Documentation
-
-**[User Interface & Settings](UI&Settings/README.md)**
-
-- Interface layout and components
-- Slash commands reference
-- Keyboard shortcuts
-- Themes and customization
-- Terminal integration
-- Configuration options
-
-**[Context Management](Context/README.md)**
-
-- Context sizing and tiers
-- VRAM monitoring
-- Context compression
-- Checkpoint system
-- Memory management
-
-**[Model Management](LLM%20Models/README.md)**
-
-- Model discovery and metadata
-- Provider integration (Ollama)
-- Context window configuration
-- Tool support detection
-- Reasoning model support
-- Memory system
-
-**[Tools System](Tools/README.md)**
-
-- Available tools
-- Tool execution
-- Approval modes
-- Extension tools
-- Tool configuration
-
-**[Hooks System](Hooks/README.md)**
-
-- Event-driven automation
-- Hook types and events
-- Trust model
-- Creating hooks
-- Hook protocol
-
-**[MCP Integration](MCP/README.md)**
-
-- Model Context Protocol
-- MCP servers
-- Tool integration
-- OAuth authentication
-- Server management
-
-**[Prompts System](Prompts%20System/README.md)**
-
-- System prompt construction
-- Prompt templates
-- Prompt routing
-- Operational modes
-- Goal management
-
----
-
-### Development Documentation
-
-**[Development Roadmap](DevelopmentRoadmap/README.md)**
-
-- Current version (v0.1.0)
-- Planned features
-- Release schedule
-- Version history
-
----
-
-## 🎓 Learning Paths
-
-### For New Users
-
-**Day 1: Get Started**
-
-1. Read [Introduction](Introduction.md) (10 min)
-2. Follow [Installation](Installation.md) (10 min)
-3. Complete [Quick Start](Quickstart.md) (15 min)
-4. Explore [UI Guide](UI&Settings/UIGuide.md) (20 min)
-
-**Day 2: Learn Commands**
-
-1. Study [Commands Reference](UI&Settings/Commands.md) (30 min)
-2. Practice [Keyboard Shortcuts](UI&Settings/Keybinds.md) (15 min)
-3. Try different [Themes](UI&Settings/Themes.md) (10 min)
-
-**Day 3: Master Tools**
-
-1. Read [Tools User Guide](Tools/UserGuide.md) (30 min)
-2. Experiment with different tools (30 min)
-3. Configure [Approval Modes](Tools/UserGuide.md#approval-modes) (10 min)
-
-**Week 2: Advanced Features**
-
-1. Learn [Context Management](Context/ContextManagment.md)
-2. Explore [Model Management](LLM%20Models/README.md)
-3. Try [MCP Integration](MCP/MCP_GettingStarted.md)
-4. Create [Custom Hooks](Hooks/UserGuide.md)
-
-### For Developers
-
-**Understanding Architecture**
-
-1. [UI Architecture](UI&Settings/Architecture.md)
-2. [Context Architecture](Context/ContextArchitecture.md)
-3. [Tools Architecture](Tools/Architecture.md)
-4. [Prompts Architecture](Prompts%20System/Architecture.md)
-5. [Hooks Architecture](Hooks/Architecture.md)
-
-**Extending OLLM CLI**
-
-1. [Creating Hooks](Hooks/UserGuide.md)
-2. [MCP Server Development](MCP/MCP_Architecture.md)
-3. [Custom Tools](Tools/GettingStarted.md)
-
----
-
-## 📊 Documentation Status
-
-### Completed ✅
-
-| Section                 | Files   | Status      |
-| ----------------------- | ------- | ----------- |
-| **Getting Started**     | 4 files | ✅ Complete |
-| **UI & Settings**       | 9 files | ✅ Complete |
-| **Context Management**  | 6 files | ✅ Complete |
-| **Model Management**    | 6 files | ✅ Complete |
-| **Tools System**        | 6 files | ✅ Complete |
-| **Hooks System**        | 7 files | ✅ Complete |
-| **MCP Integration**     | 6 files | ✅ Complete |
-| **Prompts System**      | 6 files | ✅ Complete |
-| **Development Roadmap** | 6 files | ✅ Complete |
-
-**Total:** 56 documentation files
-
----
-
-## 🔍 Search Tips
-
-### Finding Information
-
-**By Feature:**
-
-- Tools → [Tools System](Tools/README.md)
-- Hooks → [Hooks System](Hooks/README.md)
-- MCP → [MCP Integration](MCP/README.md)
-- Themes → [Themes Guide](UI&Settings/Themes.md)
-- Commands → [Commands Reference](UI&Settings/Commands.md)
-
-**By Task:**
-
-- Installation → [Installation Guide](Installation.md)
-- Configuration → [Configuration Guide](UI&Settings/Configuration.md)
-- Troubleshooting → [Troubleshooting Guide](Troubleshooting.md)
-- Customization → [UI & Settings](UI&Settings/README.md)
-
-**By Topic:**
-
-- Context → [Context Management](Context/README.md)
-- Models → [Model Management](LLM%20Models/README.md)
-- Prompts → [Prompts System](Prompts%20System/README.md)
-- Architecture → [Index](Index.md#architecture-documentation)
-
----
-
-## 🤝 Contributing
-
-Want to improve the documentation?
-
-1. **Report Issues**
-   - Found an error? [Open an issue](https://github.com/tecet/ollm/issues)
-   - Missing information? Let us know!
-
-2. **Suggest Improvements**
-   - Have ideas? [Start a discussion](https://github.com/tecet/ollm/discussions)
-   - Want to add examples? Submit a PR!
-
-3. **Write Documentation**
-   - Follow existing style and structure
-   - Include examples and diagrams
-   - Test all code snippets
-
----
-
-## 📱 Quick Reference
-
-### Essential Commands
-
-```bash
-/help              # Show all commands
-/model list        # List models
-/theme list        # List themes
-/context stats     # Check context usage
-/clear             # Clear conversation
-/exit              # Exit OLLM CLI
-```
-
-### Essential Shortcuts
-
-```
-Ctrl+K             # Command palette
-Ctrl+P             # Toggle side panel
-Ctrl+?             # Show help
-Ctrl+C             # Exit
-Return             # Send message
-Shift+Return       # New line
-```
-
-### Essential Files
-
-```
-~/.ollm/settings.json          # User settings
-.ollm/settings.json            # Workspace settings
-~/.ollm/session-data/          # Session history
-```
-
----
-
-## 🌐 External Resources
-
-### Official Resources
-
-- **GitHub:** [github.com/tecet/ollm](https://github.com/tecet/ollm)
-- **Issues:** [github.com/tecet/ollm/issues](https://github.com/tecet/ollm/issues)
-- **Discussions:** [github.com/tecet/ollm/discussions](https://github.com/tecet/ollm/discussions)
-
-### Related Projects
-
-- **Ollama:** [ollama.ai](https://ollama.ai)
-- **Model Context Protocol:** [modelcontextprotocol.io](https://modelcontextprotocol.io)
-- **Ink (Terminal UI):** [github.com/vadimdemedes/ink](https://github.com/vadimdemedes/ink)
-
----
-
-## 📝 Documentation Conventions
-
-### Symbols Used
-
-- ✅ Feature implemented
-- ⏳ Feature planned
-- ❌ Feature not available
-- 🔴 Critical issue
-- 🟡 Warning
-- 🟢 Success
-- 🔵 Information
-
-### Code Blocks
-
-```bash
-# Shell commands
-ollm --version
-```
-
-```typescript
-// TypeScript code
-interface Example {
-  name: string;
-}
-```
-
-```yaml
-# Configuration files
-setting: value
-```
-
-### File Paths
-
-- `~/.ollm/` - User directory
-- `.ollm/` - Workspace directory
-- `packages/` - Source code
-
----
-
-## 🎯 Next Steps
-
-**New to OLLM CLI?**
-→ Start with [Introduction](Introduction.md)
-
-**Ready to install?**
-→ Follow [Installation Guide](Installation.md)
-
-**Want to learn quickly?**
-→ Try [Quick Start](Quickstart.md)
-
-**Need help?**
-→ Check [Troubleshooting](Troubleshooting.md)
-
-**Want to explore?**
-→ Browse [Complete Index](Index.md)
-
----
-
-**Last Updated:** January 26, 2026  
-**Version:** 0.1.0  
-**Author:** tecet  
-**License:** MIT
-
-For the latest documentation, visit [github.com/tecet/ollm](https://github.com/tecet/ollm)
+# Documentation (placeholder)
+
+The original docs were moved to `docs2/` during editing. This placeholder ensures packaging succeeds. Replace with full docs when available.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tecet/ollm",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Local-first CLI for open-source LLMs with tools, hooks, and MCP integration",
   "type": "module",
   "bin": {
@@ -10,7 +10,8 @@
     "dist",
     "README.md",
     "LICENSE",
-    "docs"
+    "docs",
+    "scripts/copy-docs-to-user.cjs"
   ],
   "engines": {
     "node": ">=20.0.0"
@@ -21,7 +22,8 @@
     "start": "node dist/cli.js",
     "test": "vitest",
     "prepack": "node ../../scripts/copy-docs-to-package.cjs .",
-    "postpack": "node ../../scripts/remove-docs-from-package.cjs ."
+    "postpack": "node ../../scripts/remove-docs-from-package.cjs .",
+    "postinstall": "node ./scripts/copy-docs-to-user.cjs"
   },
   "keywords": [
     "llm",
@@ -50,7 +52,9 @@
   "license": "Apache-2.0",
   "author": "OLLM CLI Contributors",
   "dependencies": {
+    "@tecet/ollm": "file:tecet-ollm-0.1.5.tgz",
     "@vitest/coverage-v8": "4.0.17",
+    "@xterm/headless": "^6.0.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "esbuild": "0.27.2",
@@ -59,17 +63,16 @@
     "ignore": "^5.3.2",
     "ink": "^6.6.0",
     "ink-spinner": "^5.0.0",
+    "ink-text-input": "^6.0.0",
     "jimp": "^1.6.0",
+    "node-pty": "^1.1.0",
     "picomatch": "^4.0.3",
     "react": "19.2.3",
     "react-devtools-core": "^6.1.2",
+    "sharp": "^0.34.5",
     "shiki": "^3.21.0",
     "simple-git": "^3.30.0",
     "terminal-image": "^1.1.0",
-    "node-pty": "^1.1.0",
-    "@xterm/headless": "^6.0.0",
-    "ink-text-input": "^6.0.0",
-    "sharp": "^0.34.5",
     "vitest": "4.0.17",
     "yaml": "^2.3.4",
     "yargs": "^17.7.0"

package/scripts/copy-docs-to-user.cjs

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+const { existsSync } = require('fs');
+const { mkdir, cp } = require('fs/promises');
+const path = require('path');
+const os = require('os');
+
+(async function main(){
+  try {
+    const pkgScriptsDir = __dirname; // packages/cli/scripts
+    const pkgRoot = path.join(pkgScriptsDir, '..');
+    const bundledDocs = path.join(pkgRoot, 'docs');
+    const userDocs = path.join(os.homedir(), '.ollm', 'docs');
+
+    console.log('[install-docs] bundledDocs=%s', bundledDocs);
+    console.log('[install-docs] userDocs=%s', userDocs);
+
+    if (!existsSync(bundledDocs)) {
+      console.log('[install-docs] no bundled docs found, skipping');
+      return;
+    }
+
+    // Ensure user docs directory exists, then copy/merge bundled docs into it.
+    // We intentionally merge so existing user files aren't overwritten but
+    // missing bundled files are populated.
+    await mkdir(path.join(os.homedir(), '.ollm'), { recursive: true });
+    await mkdir(userDocs, { recursive: true });
+
+    // Use fs.promises.cp with force: false so existing files are not overwritten.
+    await cp(bundledDocs, userDocs, { recursive: true, force: false });
+    console.log('[install-docs] merged bundled docs into user folder');
+  } catch (err) {
+    console.error('[install-docs] failed to copy docs:', err);
+  }
+})();