Tmuxinator 技术文档

1. 安装指南

通过 RubyGems 安装

gem install tmuxinator

通过 Homebrew 安装

brew install tmuxinator

注意：通过 Homebrew 安装可能会遇到一些问题，建议优先使用 RubyGems 安装。

依赖环境

• Ruby：Tmuxinator 兼容当前维护的 Ruby 版本。如果你的系统提供的 Ruby 版本不受支持，建议使用 RVM 或 rbenv 安装支持的 Ruby 版本。
• tmux：推荐使用 tmux 1.8 或更高版本，但 2.5 版本不支持。

2. 项目的使用说明

创建项目

使用以下命令创建或编辑项目：

tmuxinator new [project]

如果你想在当前目录下创建本地项目配置文件（.tmuxinator.yml），可以使用：

tmuxinator new --local [project]

编辑项目

你可以使用以下命令编辑现有项目：

tmuxinator open [project]

启动项目

创建或编辑项目后，使用以下命令启动项目：

tmuxinator start [project]

其他常用命令

• tmuxinator list：列出所有项目
• tmuxinator delete [project]：删除项目
• tmuxinator implode：删除所有项目

3. 项目API使用文档

项目配置文件

Tmuxinator 使用 YAML 格式的配置文件来定义 tmux 会话的结构。以下是一个示例配置文件：

name: sample
root: ~/

windows:
  - editor:
      layout: main-vertical
      panes:
        - vim
        - guard
  - server: bundle exec rails s
  - logs: tail -f log/development.log

配置项说明

• name: 项目名称。
• root: 项目的根目录。
• windows: 定义 tmux 窗口及其内容。
  • editor: 窗口名称。
    • layout: 窗口布局，如 main-vertical。
    • panes: 窗口中的面板，每个面板可以运行不同的命令。

自定义会话启动

你可以通过 attach 选项控制是否自动附加到 tmux 会话：

attach: false

项目钩子

Tmuxinator 支持在项目启动、停止等不同阶段执行命令：

on_project_start: command
on_project_exit: command

4. 项目安装方式

安装 tmuxinator

通过 RubyGems 安装：

gem install tmuxinator

通过 Homebrew 安装：

brew install tmuxinator

安装 tmux

确保你已经安装了 tmux，推荐版本为 1.8 或更高版本。

配置 shell 编辑器

Tmuxinator 使用默认的 shell 编辑器。你可以通过以下命令查看当前编辑器：

echo $EDITOR

如果需要更改默认编辑器，可以在 ~/.bashrc 或 ~/.zshrc 中添加如下配置：

export EDITOR='vim'

安装补全脚本

如果你通过 RubyGems 安装了 Tmuxinator，需要手动安装补全脚本：

bash

wget https://raw.githubusercontent.com/tmuxinator/tmuxinator/master/completion/tmuxinator.bash -O /etc/bash_completion.d/tmuxinator.bash

zsh

wget https://raw.githubusercontent.com/tmuxinator/tmuxinator/master/completion/tmuxinator.zsh -O /usr/local/share/zsh/site-functions/_tmuxinator

fish

wget https://raw.githubusercontent.com/tmuxinator/tmuxinator/master/completion/tmuxinator.fish -O ~/.config/fish/completions/tmuxinator.fish

通过以上步骤，你可以顺利安装并使用 Tmuxinator 来管理和创建 tmux 会话。