Mux

Commands
Navigation
Configuration
Contributing
Screen
Credits

Manage tmux from the safety of your editor!

Mux aims to be a thin wrapper around tmux and GNU screen, providing an interface to allow you to describe layouts which will be called by either command.

There be dragons here. This might work beautifully and make you 10,00% more productive, but it's just as likely to set your Hue lights on fire and empty your bank account.

Commands

Show Mux

The bread and butter, reads your configuration(s) and uses them to create a layout. As it's just using standard tmux, you are feel free to attach from any terminal on the system (or even SSH in from another system!).

Kill mux sessions using current prefix

Using the currently configured prefix, allows you to kill a specific session running.

Kill mux session for current project

Attempst to kill the Mux session running on the current project.

Configure Mux

Unimplemented currently, but will be used to open the relevant configuration file currently being used.

Also provided are a number of commands to navigate within the created layouts.

Coming soon™.

All standard tmux move commands are supported

Direction
The last (previously active) pane
The next pane by number
The previous pane by number
The top pane
The bottom pane
The leftmost pane
The rightmost pane
The top-left pane
The top-right pane
The bottom-left pane
The bottom-right pane
The pane above the active pane
The pane below the active pane
The pane to the left of the active pane
The pane to the right of the active pane

Commands to map to the above directions are appropriately named (e.g. "Move left 1 pane" moves ..... well, left 1 pane).

Configuration

Currently the schema is quite simplistic and only supports creating simple panes and windows. Configuration is handled in a .mux.json file (currently no generator) in project root. If you create the file after the project is loaded, you will also need to reload the window.

A configuration should contain at least 1 window, and every window will always contain a command. Panes are optional but highly recommended.

For example, a schema that looks like

{
    "windows": [
        {
            "title": "yarn",
            "command": "zsh",
            "panes": [
                {
                    "isHorizontal": false,
                    "command": "yarn start"
                },
                {
                    "isHorizontal": true,
                    "command": "yarn test"
                }
            ]
        },
        {
            "title": "API test",
            "command": "zsh"
        }
    ]
}

would give a layout that looks like

Mux layout

Support for move advanced things like pane sizes and naming windows is coming soon™.

Contributing

Below are some example commands to get you started contributing:

git clone https://github.com/elken/mux
git checkout -b my-awesome-feature-name
echo "I'm helping!" > src/extension.ts
git add --all .
git commit -m "I'm helping, honest!"
git push

Then drop me a pull request on GitHub (or from the command line if you use hub)

Config files for linters and editorconfig are coming soon™.

Screen

Screen support is minimal but supports a flat layout. If enough demand for better support arises I will investigate.

In order to get the full experience™ of screen, including vertical splits, you will need to install a patched version of screen (tmux is HIGHLY encouraged but if you feel so inclined then proceed).

OSX

Install using the commands below:

brew install homebrew/dupes/screen brew unlink screen && brew link screen

Reload your terminal configuration or restart vscode to use the new executable.

Linux

Either build manually or attempt to install a patched version from your distro's repository.

Credits

The theme I use in screenshots is Monokai Pro and my tmux setup is here.

Tmux is actively developed and maintained by a number of very talented coders.

mux

elken

Mux