tmux workspace manager, forged in Ruby.

Session manager for tmux. Load tmux sessions through YAML/JSON configuration files. Powered by libtmux for Ruby.

Install

Install the workspace package separately from the core library.

$ gem install libtmux-workspace

gem "libtmux-workspace"

libtmux-workspace parses bounded YAML or JSON into an immutable creation plan. $validate and offline $plan do not contact tmux. $load and plan --live borrow an existing server selected with --socket.

The manager creates a new session. It does not reconcile, replace, or delete a preexisting workspace. Applying a plan authorizes declared shell commands; their delivery does not prove that the pane programs completed.

Start here¶

• Guides covers $validate, $plan, and $load.
• Topics explains the supported format and creation-only model.
• Examples provides a bounded YAML configuration.
• CLI Manual documents commands, flags, output and exit statuses.
• Language API documents the workspace gem.

The source-owned workspace guide is staged from the same revision as the generated reference.

session_name: work
environment:
  PROJECT_MODE: development
windows:
  - window_name: editor
    window_index: 1
    layout: tiled
    panes:
      - shell_command: printf 'editor ready\n'
      - {}

{
  "session_name": "work",
  "environment": {
    "PROJECT_MODE": "development"
  },
  "windows": [
    {
      "window_name": "editor",
      "window_index": 1,
      "layout": "tiled",
      "panes": [
        {
          "shell_command": "printf 'editor ready\\n'"
        },
        {}
      ]
    }
  ]
}