alvinunreal/tmuxai

What it solves

TmuxAI is an intelligent terminal assistant that integrates directly into tmux sessions, acting as a pair programmer. It eliminates the need to switch between the terminal and an external AI chat interface by allowing the AI to observe the contents of your tmux panes and execute commands on your behalf.

How it works

TmuxAI organizes a tmux window into three functional areas: a Chat Pane for interaction, an Exec Pane for running commands, and Read-Only Panes for context. It operates in several modes:

• Observe Mode: The default mode where the AI reads visible pane content, suggests commands, and waits for output before continuing.
• Prepare Mode: Enhances precision by customizing the shell prompt to track command completion and exit codes instead of using fixed wait intervals.
• Prepare Mode: A proactive mode where the AI continuously monitors terminal activity to provide real-time suggestions or flag errors based on a user-defined goal.
• Knowledge Base & Skills: Users can load markdown-based reference files (Knowledge Bases) or structured instructions (Skills) to provide the AI with project-specific context or new capabilities.

Who it’s for

Developers and system administrators who use tmux as their primary terminal multiplexer and want AI-powered assistance that is context-aware of their current terminal environment.

Highlights

• Context-Awareness: Automatically captures shell type, OS, and visible pane content.
• Command Execution: Executes suggested commands in a dedicated pane with user confirmation and risk indicators.
• Context Management: Includes a "squashing" mechanism to summarize chat history and manage token usage.
• Extensibility: Supports custom Knowledge Bases and Skills for specialized workflows.
• External Editor Integration: Allows editing long prompts in a configured external text editor via keyboard shortcuts.