README.md

Local Harness Documentation

Welcome to the Local Harness documentation. This guide will help you understand, use, and contribute to the project.

Quick Links

• Main README - Project overview and quick start
• CHANGELOG - Version history and recent changes

User Guide

New to Local Harness? Start here:

• Installation - Building from source and setup
• Features - Complete feature guide
• Commands - NEW Quick reference for all commands
• Configuration - Config file and /config editor

Development

Contributing to Local Harness:

• Deployment - Release and deployment process
• Zig HTTP Client - Working with Zig's HTTP client

Architecture

Understanding how Local Harness works:

• Overview - High-level architecture
• Config Editor - Full-screen TUI config editor architecture
• Config Editor Data Flow - Detailed flow examples
• Tool Calling System - How tool calling works
• Unified Read File - Smart file reading with agent curation

Implementation Notes

• Context Management Changes - Context tracking and compression system
• Performance Optimizations - NEW LLM KV cache improvements (20x speedup)
• Compression Design - Conversation compression strategy
• Memory Leak Fix - Config editor and agent memory fixes

Archive

Historical documentation and implementation notes:

• Tool Calling Fixes - Historical fix documentation
• Tool Calling Actual Fix - The real fix details
• Before/After Flow - Flow comparison
• Task Tools Fix - Task system fixes (outdated)
• Initial Planning - Early planning notes

Project Structure

localharness/
├── README.md              # Main documentation (start here!)
├── CHANGELOG.md           # Version history
├── build.zig              # Build configuration
├── main.zig               # Entry point
├── app.zig                # Core application
├── ui.zig                 # Terminal UI
├── ollama.zig             # Ollama API client
├── lmstudio.zig           # LM Studio API client
├── llm_provider.zig       # Provider abstraction layer
├── tools.zig              # Tool definitions
├── permission.zig         # Permission system
└── docs/                  # Additional documentation (you are here)
    ├── user-guide/        # User-facing guides
    ├── development/       # Developer guides
    ├── architecture/      # Technical architecture
    └── archive/           # Historical documentation

Getting Help

• Issues: Report bugs and request features via GitHub Issues
• Discussions: Use GitHub Discussions for questions