oAI version 3.0 beta 1
This commit is contained in:
69
README.md
69
README.md
@@ -1,19 +1,21 @@
|
||||
# oAI - OpenRouter AI Chat Client
|
||||
|
||||
A powerful, extensible terminal-based chat client for OpenRouter API with **MCP (Model Context Protocol)** support, enabling AI to access local files and query SQLite databases.
|
||||
A powerful, modern **Textual TUI** chat client for OpenRouter API with **MCP (Model Context Protocol)** support, enabling AI to access local files and query SQLite databases.
|
||||
|
||||
## Features
|
||||
|
||||
### Core Features
|
||||
- 🖥️ **Modern Textual TUI** with async streaming and beautiful interface
|
||||
- 🤖 Interactive chat with 300+ AI models via OpenRouter
|
||||
- 🔍 Model selection with search and filtering
|
||||
- 🔍 Model selection with search, filtering, and capability icons
|
||||
- 💾 Conversation save/load/export (Markdown, JSON, HTML)
|
||||
- 📎 File attachments (images, PDFs, code files)
|
||||
- 💰 Real-time cost tracking and credit monitoring
|
||||
- 🎨 Rich terminal UI with syntax highlighting
|
||||
- 📝 Persistent command history with search (Ctrl+R)
|
||||
- 🎨 Dark theme with syntax highlighting and Markdown rendering
|
||||
- 📝 Command history navigation (Up/Down arrows)
|
||||
- 🌐 Online mode (web search capabilities)
|
||||
- 🧠 Conversation memory toggle
|
||||
- ⌨️ Keyboard shortcuts (F1=Help, F2=Models, Ctrl+S=Stats)
|
||||
|
||||
### MCP Integration
|
||||
- 🔧 **File Mode**: AI can read, search, and list local files
|
||||
@@ -52,12 +54,12 @@ pip install -e .
|
||||
### Option 2: Pre-built Binary (macOS/Linux)
|
||||
|
||||
Download from [Releases](https://gitlab.pm/rune/oai/releases):
|
||||
- **macOS (Apple Silicon)**: `oai_v2.1.0_mac_arm64.zip`
|
||||
- **Linux (x86_64)**: `oai_v2.1.0_linux_x86_64.zip`
|
||||
- **macOS (Apple Silicon)**: `oai_v3.0.0_mac_arm64.zip`
|
||||
- **Linux (x86_64)**: `oai_v3.0.0_linux_x86_64.zip`
|
||||
|
||||
```bash
|
||||
# Extract and install
|
||||
unzip oai_v2.1.0_*.zip
|
||||
unzip oai_v3.0.0_*.zip
|
||||
mkdir -p ~/.local/bin
|
||||
mv oai ~/.local/bin/
|
||||
|
||||
@@ -76,11 +78,14 @@ export PATH="$HOME/.local/bin:$PATH"
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Start the chat client
|
||||
oai chat
|
||||
# Start oAI (launches TUI)
|
||||
oai
|
||||
|
||||
# Or with options
|
||||
oai chat --model gpt-4o --mcp
|
||||
oai --model gpt-4o --online --mcp
|
||||
|
||||
# Show version
|
||||
oai version
|
||||
```
|
||||
|
||||
On first run, you'll be prompted for your OpenRouter API key.
|
||||
@@ -88,12 +93,14 @@ On first run, you'll be prompted for your OpenRouter API key.
|
||||
### Basic Commands
|
||||
|
||||
```bash
|
||||
# In the chat interface:
|
||||
/model # Select AI model
|
||||
/help # Show all commands
|
||||
# In the TUI interface:
|
||||
/model # Select AI model (or press F2)
|
||||
/help # Show all commands (or press F1)
|
||||
/mcp on # Enable file/database access
|
||||
/stats # View session statistics
|
||||
exit # Quit
|
||||
/stats # View session statistics (or press Ctrl+S)
|
||||
/config # View configuration settings
|
||||
/credits # Check account credits
|
||||
Ctrl+Q # Quit
|
||||
```
|
||||
|
||||
## MCP (Model Context Protocol)
|
||||
@@ -184,21 +191,22 @@ MCP allows the AI to interact with your local files and databases.
|
||||
## CLI Options
|
||||
|
||||
```bash
|
||||
oai chat [OPTIONS]
|
||||
oai [OPTIONS]
|
||||
|
||||
Options:
|
||||
-m, --model TEXT Model ID to use
|
||||
-s, --system TEXT System prompt
|
||||
-o, --online Enable online mode
|
||||
--mcp Enable MCP server
|
||||
-v, --version Show version
|
||||
--help Show help
|
||||
```
|
||||
|
||||
Other commands:
|
||||
Commands:
|
||||
```bash
|
||||
oai config [setting] [value] # Configure settings
|
||||
oai version # Show version
|
||||
oai credits # Check credits
|
||||
oai # Launch TUI (default)
|
||||
oai version # Show version information
|
||||
oai --help # Show help message
|
||||
```
|
||||
|
||||
## Configuration
|
||||
@@ -218,14 +226,18 @@ oai/
|
||||
├── oai/
|
||||
│ ├── __init__.py
|
||||
│ ├── __main__.py # Entry point for python -m oai
|
||||
│ ├── cli.py # Main CLI interface
|
||||
│ ├── cli.py # Main CLI entry point
|
||||
│ ├── constants.py # Configuration constants
|
||||
│ ├── commands/ # Slash command handlers
|
||||
│ ├── config/ # Settings and database
|
||||
│ ├── core/ # Chat client and session
|
||||
│ ├── mcp/ # MCP server and tools
|
||||
│ ├── providers/ # AI provider abstraction
|
||||
│ ├── ui/ # Terminal UI utilities
|
||||
│ ├── tui/ # Textual TUI interface
|
||||
│ │ ├── app.py # Main TUI application
|
||||
│ │ ├── widgets/ # Custom widgets
|
||||
│ │ ├── screens/ # Modal screens
|
||||
│ │ └── styles.tcss # TUI styling
|
||||
│ └── utils/ # Logging, export, etc.
|
||||
├── pyproject.toml # Package configuration
|
||||
├── build.sh # Binary build script
|
||||
@@ -266,7 +278,18 @@ pip install -e . --force-reinstall
|
||||
|
||||
## Version History
|
||||
|
||||
### v2.1.0 (Current)
|
||||
### v3.0.0 (Current)
|
||||
- 🎨 **Complete migration to Textual TUI** - Modern async terminal interface
|
||||
- 🗑️ **Removed CLI interface** - TUI-only for cleaner codebase (11.6% smaller)
|
||||
- 🖱️ **Modal screens** - Help, stats, config, credits, model selector
|
||||
- ⌨️ **Keyboard shortcuts** - F1 (help), F2 (models), Ctrl+S (stats), etc.
|
||||
- 🎯 **Capability indicators** - Visual icons for model features (vision, tools, online)
|
||||
- 🎨 **Consistent dark theme** - Professional styling throughout
|
||||
- 📊 **Enhanced model selector** - Search, filter, capability columns
|
||||
- 🚀 **Default command** - Just run `oai` to launch TUI
|
||||
- 🧹 **Code cleanup** - Removed 1,300+ lines of CLI code
|
||||
|
||||
### v2.1.0
|
||||
- 🏗️ Complete codebase refactoring to modular package structure
|
||||
- 🔌 Extensible provider architecture for adding new AI providers
|
||||
- 📦 Proper Python packaging with pyproject.toml
|
||||
|
||||
Reference in New Issue
Block a user