opencode/README.md
2025-04-21 13:41:27 +02:00

3.4 KiB

TermAI

⚠️ Early Development Notice: This project is in early development and is not yet ready for production use. Features may change, break, or be incomplete. Use at your own risk.

A powerful terminal-based AI assistant for developers, providing intelligent coding assistance directly in your terminal.

TermAI Demo

Overview

TermAI is a Go-based CLI application that brings AI assistance to your terminal. It provides a TUI (Terminal User Interface) for interacting with various AI models to help with coding tasks, debugging, and more.

Features

  • Interactive TUI: Built with Bubble Tea for a smooth terminal experience
  • Multiple AI Providers: Support for OpenAI, Anthropic Claude, and Google Gemini models
  • Session Management: Save and manage multiple conversation sessions
  • Tool Integration: AI can execute commands, search files, and modify code
  • Vim-like Editor: Integrated editor with Vim keybindings for text input
  • Persistent Storage: SQLite database for storing conversations and sessions

Installation

# Coming soon
go install github.com/kujtimiihoxha/termai@latest

Configuration

TermAI looks for configuration in the following locations:

  • $HOME/.termai.json
  • $XDG_CONFIG_HOME/termai/.termai.json
  • ./.termai.json (local directory)

You can also use environment variables:

  • ANTHROPIC_API_KEY: For Claude models
  • OPENAI_API_KEY: For OpenAI models
  • GEMINI_API_KEY: For Google Gemini models

Usage

# Start TermAI
termai

# Start with debug logging
termai -d

Keyboard Shortcuts

Global Shortcuts

  • ?: Toggle help panel
  • Ctrl+C or q: Quit application
  • L: View logs
  • Backspace: Go back to previous page
  • Esc: Close current view/dialog or return to normal mode

Session Management

  • N: Create new session
  • Enter or Space: Select session (in sessions list)

Editor Shortcuts (Vim-like)

  • i: Enter insert mode
  • Esc: Enter normal mode
  • v: Enter visual mode
  • V: Enter visual line mode
  • Enter: Send message (in normal mode)
  • Ctrl+S: Send message (in insert mode)

Navigation

  • Arrow keys: Navigate through lists and content
  • Page Up/Down: Scroll through content

Architecture

TermAI is built with a modular architecture:

  • cmd: Command-line interface using Cobra
  • internal/app: Core application services
  • internal/config: Configuration management
  • internal/db: Database operations and migrations
  • internal/llm: LLM providers and tools integration
  • internal/tui: Terminal UI components and layouts
  • internal/logging: Logging infrastructure
  • internal/message: Message handling
  • internal/session: Session management

Development

Prerequisites

  • Go 1.23.5 or higher

Building from Source

# Clone the repository
git clone https://github.com/kujtimiihoxha/termai.git
cd termai

# Build the diff script first
go run cmd/diff/main.go

# Build
go build -o termai

# Run
./termai

Acknowledgments

TermAI builds upon the work of several open source projects and developers:

License

[License information coming soon]

Contributing

[Contribution guidelines coming soon]