Topics

Explore libtmux’s core functionalities and underlying principles at a high level, while providing essential context and detailed explanations to help you understand its design and usage.

• Traversal
  • Setup
  • Server Level
  • Session Level
  • Window Level
  • Pane Level
  • Filtering and Finding Objects
    • Basic Filtering
    • Partial Matching
    • Case-Insensitive Matching
    • Regex Filtering
    • Chaining Filters
    • Get with Default
  • Checking Relationships
• QueryList Filtering
  • Basic Filtering
    • Exact Match
    • Contains and Startswith
  • Available Lookups
  • Getting a Single Item
  • Chaining Filters
  • Case-Insensitive Filtering
  • Regex Filtering
  • Filtering by List Membership
  • Filtering Across the Hierarchy
  • Real-World Examples
    • Find all editor windows
    • Find windows by naming convention
  • API Reference
• Pane Interaction
  • Sending Commands
    • Basic command execution
    • Send without pressing Enter
    • Literal mode for special characters
    • Suppress shell history
  • Capturing Output
    • Basic capture
    • Capture with line ranges
    • Capture with ANSI escape sequences
    • Join wrapped lines
    • Preserve trailing spaces
    • Capture flags summary
  • Waiting for Output
    • Polling for completion marker
    • Helper function for waiting
  • Querying Pane State
    • Get pane dimensions
    • Get pane information
    • Common format variables
  • Resizing Panes
    • Resize by specific dimensions
    • Resize by adjustment
    • Zoom toggle
  • Clearing the Pane
  • Killing Panes
    • Kill all except current
  • Practical Recipes
    • Recipe: Run command and capture output
    • Recipe: Check for error patterns
• Workspace Setup
  • Creating Windows
    • Basic window creation
    • Create without attaching
    • Create with specific shell
  • Splitting Panes
    • Vertical split (top/bottom)
    • Horizontal split (left/right)
    • Split with specific size
  • Layout Management
    • Available layouts
    • Applying layouts
  • Renaming and Organizing
    • Rename windows
    • Access window properties
  • Practical Recipes
    • Recipe: Create a development workspace
    • Recipe: Create a grid of panes
    • Recipe: Run commands in multiple panes
  • Window Context Managers
• Automation Patterns
  • Process Control
    • Starting long-running processes
    • Checking process status
  • Output Monitoring
    • Waiting for specific output
    • Detecting errors in output
    • Capturing output between markers
  • Multi-Pane Orchestration
    • Running parallel tasks
    • Monitoring multiple panes for completion
  • Context Manager Patterns
    • Temporary session for isolated work
    • Temporary window for subtask
  • Timeout Handling
    • Command with timeout
    • Retry pattern
  • Agentic Workflow Patterns
    • Task queue processor
    • State machine runner
  • Best Practices
    • 1. Always use markers for completion detection
    • 2. Clean up resources
    • 3. Use context managers for automatic cleanup
• Context Managers
  • Server Context Manager
  • Session Context Manager
  • Window Context Manager
  • Pane Context Manager
  • Nested Context Managers
  • Benefits
  • When to Use
• Options and Hooks
  • Options
    • Getting options
    • Setting options
    • Unsetting options
    • Option scopes
    • Global options
  • Hooks
    • Setting and getting hooks
    • Removing hooks
    • Indexed hooks
    • Bulk hook operations
  • tmux version compatibility