alvinunreal/tmuxai

What it solves

TmuxAI is an intelligent terminal assistant designed to provide AI-powered pair programming directly within tmux sessions. It eliminates the need to switch between a terminal and an external AI chat interface by allowing the AI to observe the current terminal state and execute commands on the user's behalf.

How it works

TmuxAI operates within a single tmux window, dividing it into a chat pane for interaction, an execution pane for running commands, and read-only panes for context. It works through three primary modes:

• Observe Mode: The default mode where TmuxAI captures the content of all visible panes, processes the request with an LLM, and suggests commands. If approved, it executes them in the execution pane and monitors the output.
• Prepare Mode: Enhances precision by customizing the shell prompt (bash, zsh, fish) to track command completion and exit codes, removing the need for fixed wait intervals.
• Watch Mode: A proactive mode where the AI continuously monitors terminal activity to suggest more efficient commands or flag errors based on a user-defined goal.

Who it’s for

It is built for developers and system administrators who use tmux as their primary terminal multiplexer and want a deeply integrated AI assistant that understands the real-time context of their shell environment.

Highlights

• Context-Aware Assistance: Reads visible content across all tmux panes to understand the current state of the project.
• Knowledge Bases & Skills: Supports loading markdown-based reference files (Knowledge Bases) and structured, metadata-rich instructions (Skills) to teach the AI specific workflows.
• Command Execution: Can execute commands in a dedicated pane with user confirmation and risk indicators.
• Context Management: Includes a "squashing" feature to summarize chat history and manage token usage.
• External Editor Integration: Allows editing complex prompts in the user's preferred external text editor via keyboard shortcuts.