tmuxinator/tmuxinator
Tmuxinator
Tmuxinator is a configuration-driven session manager and workspace automation tool for tmux. It acts as a terminal multiplexer orchestrator that translates structured project definitions into shell commands to define and launch complex window and pane layouts.
The project distinguishes itself through declarative configuration and lifecycle management. It utilizes YAML-based mapping and template-based variable injection to create reusable session configurations, while providing hook-based execution to trigger custom scripts during startup, restart, or shutdown.
Its broader capabilities include project environment bootstrapping and workspace layout organization. It supports active session import, pane input synchronization, and the transmission of direct key sequences to automate multi-step initialization tasks.
The tool provides a command-line interface for managing the lifecycle of project configuration files stored in local and global directories.
Features
- Environment Bootstrapping - Automates the initial setup of a complete set of terminal windows and panes tailored to a specific project.
- tmux Session Managers - Provides a configuration-driven system for defining and automating complex tmux window and pane layouts.
- Configuration Templating - Implements structural reuse and anchoring within configuration files to reduce redundancy.
- Environment Variable Templating - Supports dynamic variable expansion and shell-style syntax within configuration files using templates.
- Shell Orchestrators - Provides a mechanism to orchestrate the sequencing of shell commands based on declarative YAML configurations.
- YAML-Based Task Definitions - Uses YAML files as a declarative language to define terminal sessions and window layouts.
- Terminal Session Management - Automatically launches a complete session with all configured windows, panes, and settings applied.
- Terminal Multiplexer Orchestrators - Manages terminal workspace environments through declarative configuration files and lifecycle hooks.
- Workflow Orchestration - Runs custom scripts and lifecycle hooks to initialize tools and interpreters automatically when starting terminal sessions.
- Terminal Session Lifecycle Management - Provides command-line controls to start, stop, delete, or restart sessions in detached or bulk modes.
- Session Layout Definitions - Uses a structured configuration system to specify windows, panes, and root directories for terminal sessions.
- Terminal Configuration Management - Manages terminal session layouts and behavior via structured configuration files.
- Terminal Workspace Layouts - Provides configurations for organizing terminal sessions using split panes and project-specific profiles.
- Workspace Session Managers - Restores pre-defined session configurations from the command line to maintain environment consistency.
- Environment Variable Injection - Injects operating system environment variables into configuration files using template syntax.
- Session Managers - Launches and manages terminal sessions based on saved project configurations.
- Automated Window Initializers - Runs specific commands in windows and panes upon startup using key-sending for multi-step initialization.
- Environment Initializers - Executes specific commands across all windows and panes to initialize interpreters before the session starts.
- Command Sequence Emission - Passes direct key sequences to the shell to automate multi-step setups like remote connections.
- Lifecycle Automation Hooks - Provides hooks to execute custom scripts during project lifecycle events like startup, restart, or shutdown.
- Project Configuration Utilities - Manages project-level settings and detects project roots automatically via hidden configuration files.
- Active Session Import - Allows recording the layout, windows, and panes of a running session into a new configuration file.
- Shell Command Execution - Triggers specific operating system shell commands across all panes before the main session begins.
- Project Configuration Managers - Provides CLI tools for managing the creation, editing, and deletion of project configuration files.
- Lifecycle Hooks - Triggers external shell scripts at specific stages of the terminal session lifecycle, such as startup and shutdown.
- Project Root Resolution - Automatically locates project configuration files by scanning specific directories to associate settings with project roots.
- CLI Utilities - Manager for complex tmux sessions.
- Session Management - Simplifies management of complex tmux sessions.
- Terminal Multiplexers and Workspaces - Manage complex tmux sessions easily.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
