tony/tmuxp

Features

• Workspace Generators - Generates live tmux sessions and pane layouts by parsing structured YAML or JSON workspace definitions.
• tmux Session Managers - Automates the creation and organization of tmux sessions, windows, and panes using structured configuration files.
• Terminal Session Layouts - Saves an active terminal session arrangement to a file to be edited and replayed later.
• Workspace Initialization Logic - Defines custom builder logic to control how panes are initialized and when they are considered ready.
• Development Environments - Automates the launch of project workspaces with consistent terminal layouts and required startup commands.
• Session Capturers - Converts an active terminal multiplexer session into a portable configuration file to save state.
• Session State Serializers - Captures the state of active tmux sessions and serializes them into portable configuration files for later restoration.
• Shell Command Execution - Executes single or multi-line shell commands in tmux panes with support for custom delays.
• Terminal Multiplexer Integrations - Builds upon libtmux to provide a programmatic layer for controlling terminal multiplexer environments.
• Configuration Parsers - Implements parsing of YAML and JSON files into structured dictionaries to drive the creation of tmux sessions.
• Layout Exporting - Captures the current state of active tmux sessions and saves them as portable YAML or JSON configuration files.
• Session Builder Implementations - Implements a custom protocol to define how workspace configurations are processed and instantiated into active environments.
• Terminal Pane Layouts - Defines precise starting directories, window indices, and pane focus to ensure consistent workspace layouts.
• Terminal Orchestrators - Coordinates the execution of sequences of shell commands and scripts across multiple tmux panes.
• Automated Environment Provisioning - Provisions predefined tmux sessions in a detached state for use in automated pipelines and integration tests.
• Workspace Configurations - Lists available workspace configuration files along with metadata such as file paths and modification times.
• Configuration Inheritance - Implements hierarchical inheritance to propagate default settings from the session level down to individual panes.
• Builder Module Integrations - Integrates custom builder modules by resolving dotted paths and adding trusted directories to the system path.
• Plugin Development Frameworks - Provides a base class and schema for developing plugins that extend session manager functionality.
• Session Configuration Management - Manages the storage of session definitions in standardized directories for easy loading by name.
• Shell Readiness Polling - Ensures shell initialization is complete by polling for the prompt before dispatching layout commands.
• Tmux Configurations - Configures global and session-level tmux options and window-specific settings programmatically.
• Bulk Session Orchestration - Creates several sessions from multiple configuration files in one command and attaches to the final one.
• Pre-Session Hooks - Runs an external script before a session starts to set up environments based on the script exit code.
• Prompt Readiness Detection - Manages whether the builder waits for a shell prompt before dispatching layouts to prevent visual artifacts.
• Session Detachment and Reattachment - Starts predefined sessions in a detached state to enable integration testing within headless pipelines.
• Automatic Workspace Discoveries - Automatically discovers session configurations by walking directory trees and displaying them in list or tree views.
• Workspace Search Filters - Provides filters to locate session files based on names or content within windows and panes.
• Automated Environment Setup - Allows running configurations in detached mode within scripts to programmatically prepare environments for automation.
• Environment Variable Configuration - Assigns custom environment variables at the session, window, or pane level to customize the runtime environment.
• Configuration File Loading - Scans directories and parent folders to locate and load YAML or JSON session layout configurations.
• Environment Variable Resolution - Expands shell environment variables and shorthand syntax within configuration files into full system paths.
• Startup Hooks - Executes custom scripts or commands as hooks to prepare the environment before a session loads.
• Environment Variable Injection - Expands shell environment variables and shorthand paths within configuration files during preprocessing.
• Configuration Validation - Verifies that session configuration files contain all required fields and valid formats before execution.
• Runtime Schema Validations - Validates the structure and required fields of workspace YAML/JSON definitions at runtime to prevent build errors.
• Builder Plugins - Provides a plugin system to extend session creation logic through custom classes and dynamic module loading.
• Session Lifecycle Hooks - Uses custom classes to modify session names and react to reattachments through lifecycle hooks.
• Plugin-Based Logic Extensions - Integrates custom scripts and logic into the session loading process to add specialized functionality.
• Configuration Parsing Extensions - Allows overriding how workspace configurations are parsed and deployed into live sessions using custom classes.
• Pane Command Spawners - Waits for a shell prompt to appear in a pane before sending layout and commands.
• Session Naming & Metadata - Enables the specification of session names and global options to ensure consistent identity across workspace launches.
• CLI Utilities - Session manager for terminal multiplexers.

Star history