diff --git a/docs/TMUXINATOR.md b/docs/TMUXINATOR.md new file mode 100644 index 0000000..b2a750a --- /dev/null +++ b/docs/TMUXINATOR.md @@ -0,0 +1,162 @@ +# Tmuxinator Integration + +The dotfiles now include seamless integration with [tmuxinator](https://github.com/tmuxinator/tmuxinator) for complex project configurations, while maintaining backward compatibility with simple `.tmux` templates. + +## Installation + +```bash +# Arch/CachyOS +sudo pacman -S tmuxinator + +# Or via Ruby gems +gem install tmuxinator +``` + +## Quick Start + +```bash +# Create a new tmuxinator project +txi-new myproject dev + +# Edit the configuration +txi-edit myproject + +# Start the project +txi myproject + +# Or use the unified tw command (auto-detects tmuxinator) +tw myproject +``` + +## Command Reference + +### Tmuxinator Commands (txi-*) + +| Command | Alias | Description | +|---------|-------|-------------| +| `txi ` | - | Start/attach to tmuxinator project | +| `txi-new [template]` | `txin` | Create new project | +| `txi-edit ` | `txie` | Edit project YAML file | +| `txi-list` | `txil` | List all tmuxinator projects | +| `txi-delete ` | `txid` | Delete project | +| `txi-stop ` | `txis` | Stop running session | +| `txi-templates` | `txit` | Show available templates | +| `txi-import