Skip to content

Positronic-AI/lit-tui

Repository files navigation

LIT TUI

A lightweight, fast, and beautiful terminal chat interface for Ollama with MCP (Model Context Protocol) integration.

LIT TUI Demo

✨ Features

  • 🚀 Fast: Starts in milliseconds, not seconds
  • 💡 Smart: Optional integration with system-prompt-composer for enhanced prompts
  • 🔧 Extensible: MCP integration for dynamic tool discovery and execution
  • 🎨 Beautiful: Rich terminal interface with syntax highlighting and native terminal appearance
  • ⌨️ Keyboard-first: Efficient navigation designed for developers
  • 📦 Lightweight: No Electron overhead - pure Python performance
  • 🔄 Cross-platform: Works on Linux, macOS, and Windows terminals

🚀 Quick Start

Installation

# Install from PyPI
pip install lit-tui

# Or install from source
git clone https://github.com/Positronic-AI/lit-tui.git
cd lit-tui
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Prerequisites

  • Python 3.8+
  • Ollama running locally
  • A terminal with Unicode support

Usage

# Start lit-tui
lit-tui

# Or with specific model
lit-tui --model llama2

# With debug logging
lit-tui --debug

🛠️ Configuration

lit-tui stores its configuration in ~/.lit-tui/config.json. On first run, it will create a default configuration.

Example Configuration

{
  "ollama": {
    "host": "http://localhost:11434",
    "default_model": "llama2"
  },
  "ui": {
    "font_size": "medium",
    "show_token_count": true
  },
  "storage": {
    "max_sessions": 100,
    "auto_save": true
  },
  "mcp": {
    "enabled": true,
    "servers": []
  }
}

🔧 MCP Integration

lit-tui supports the Model Context Protocol for dynamic tool integration:

{
  "mcp": {
    "enabled": true,
    "servers": [
      {
        "name": "filesystem",
        "command": "mcp-server-filesystem",
        "args": ["--root", "/home/user/projects"]
      },
      {
        "name": "git",
        "command": "mcp-server-git"
      }
    ]
  }
}

⌨️ Keyboard Shortcuts

Key Action
Ctrl+N New chat session
Ctrl+O Open session
Ctrl+Q Quit
ESC Quit with confirmation
Enter Send message
Shift+Enter New line in message
Ctrl+/ or F1 Show help

🎨 Appearance

lit-tui uses your terminal's default theme and colorscheme for a native look and feel. The interface features transparent backgrounds that blend seamlessly with your terminal environment, respecting your personal terminal configuration and color preferences.

🏗️ Architecture

lit-tui is designed as a reference implementation showcasing:

  • Clean async architecture using Python's asyncio
  • Direct protocol integration with Ollama and MCP
  • Terminal-native UI with Textual framework
  • Modular design with clear separation of concerns
  • Performance optimization for responsive chat experience

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development Setup

git clone https://github.com/Positronic-AI/lit-tui.git
cd lit-tui
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev]"
pre-commit install

Quick Development

# Use the development script for easy setup
./dev.sh

Running Tests

pytest

📄 License

MIT License - see LICENSE for details.

🙏 Acknowledgments


Made with ❤️ by LIT - Advancing the field of AI through open-source innovation

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published