Azul

A nvim based terminal multiplexer.

Demo (tldr)

Installation

Requirements

Neovim >= 0.9

You can install azul in several ways.

Linux

git clone https://github.com/cosminadrianpopescu/azul
cd azul
./install.sh

This will install azul inside the ~/.local folder. Then, to run it, you need to run azul if ~/.local/bin, is in your path. Otherwise, you can run directly ~/.local/bin/azul -a <session-name>

To install it in a custom folder:

git clone https://github.com/cosminadrianpopescu/azul
cd azul
AZUL_PREFIX=~/programs/azul ./install.sh

This will install azul in the ~/programs/azul folder. Then, to run it, just run ~/programs/azul/bin/azul -a <session-name>.

To install it in /usr/bin:

git clone https://github.com/cosminadrianpopescu/azul
cd azul
AZUL_PREFIX=/usr sudo ./install.sh

NOTE: In case your nvim executable is not nvim, you need to specify this when installing by using the variable AZUL_NVIM_EXE. For example:

git clone https://github.com/cosminadrianpopescu/azul
cd azul
AZUL_NVIM_EXE=/opt/nvim.appimage ./install.sh

Windows

To install azul in Windows:

powershell.exe ./install.ps1 -prefix=c:/Users/johndoe/azul -nvimexe=c:/Users/johndoe/nvim-win64/bin/nvim-qt.exe

This will install azul inside c:/Users/johndoe/azul assuming that neovim is installed in c:/User/johndoe/nvim-win64.

Then, to run it: c:/Users/johndoe/azul/azul.cmd

Launching

By running ~/.local/bin/azul you will get a list of the current running azul sessions. In order to start a new session, you need to run ~/.local/bin/azul -a <session-name>. This will attach to the session with the name <session-name>, if it exists, or if not it will create a new session and attach to it.

You can run ~/.local/bin/azul -a <session-name> -s '<keys>'. This will send the indicated keys to the current selected pane in the session <session-name>.

You can run ~/.local/bin/azul -h to see the options of the azul. Once, inside, you will notice a status bar and a new terminal will be started.

Advantages over tmux or zellij

Status bar or tabline

You are inside neovim. So, you can use any plugin you want to handle the status bar or the tabline, you can have both, you can have none, the sky (or should I say neovim) is the limit. My status bar that you saw in the demo video is using lualine with a minimal configuration that you can find in the examples folder. But you can choose whatever you like.

Very flexibile shortcuts

Again, you are in neovim. You can have whatever shortcuts neovim supports. You can have these shortcuts inside command mode, inside terminal mode (so inside the real terminal), in normal mode, in visual mode, you name it...

Passthrough mode

As you seen in the video, you can connect to a ssh session, press a shortcut (in my case <C-s>N) and then all the keys are passed to the nested session. To pass the control back, you press the escape shortcut <C-\><C-s> (this is the default, but you can set your own) and you control again the main session. Very neat...

Native on windows

Check out the install.ps1 script. You can install neovim on windows, and then run the install.ps1 script like this:

install.ps1 -prefix c:/Users/johndoe/azul -nvimexe c:/Users/johndoe/nvim-qt/nvim-qt.exe

Make sure the folder from the prefix parameter exists. Then you can run c:/Users/johndoe/azul/azul.cmd.

I think that this is the only native windows terminal multiplexer (not considering tmux or screen or others running under cygwin).

Disadvantages compared with tmux or zellij

Text reflow

At the moment, neovim supports limited text reflow of the terminals. See here. You can reflow the current terminal, but only the current view (not the scrollback buffer). We'll have to wait for this issue to be closed and then azul will also have proper text reflow.

Cursor support

Cursor in neovim in terminal mode is a kind of hack. See here and here for more details. Until these issues are being fixed, azul will have to live with the block cursor inside its terminals. The only thing that we have in azul for configuring the cursor is :highlight TermCursor.

If this is something that you cannot live without (having a proper cursor inside your terminal), again, azul is probably not for you yet.

Terminology

Azul uses the following terminology: tabs, panes and floats

Tabs

A tab is a currently opened environment. You will see the tabs in the bottom left of the status bar when starting the app with the default configuration.

A newly created tab will contain a pane that will occupy all the available space. A pane occupying all the space in a tab cannot be resized or moved. The pane is actually your shell program waiting for commands or executting a command at any given time.

A tab can contain one or several embeded panes or floating panes.

Panes

The pane is the backbone of azul. Each pane contains a running shell (for example /bin/bash for a linux environment).

You can add another pane in a tab by changing to SPLIT mode (for example, for azul workflow, pressing <C-s>s, see Workflows) and splitting to left, right, top or bottom (for azul workflow, in SPLIT mode, clicking on the cursors).

Other then the embeded panes, you can also have floating panes.

Floats

A floating pane is a pane which is extracted from the current tab and displayed on top of the current tab. The floating panes can be shown or hidden.

If the option link_floats_with_tabs is set to true, then each tab will have it's own set of floating panes. Creating a floating pane on the tab 1, for example will not make it visible on the second tab.

If the option link_floats_with_tabs is set to false (the default), then when a floating pane is created, it will be accessible from any of the tabs.

Floating panes are usefull and recommended for short quick jobs and can be discarded once the job is finished.

Workflows

Azul can be used in 4 ways, depending on your preferences: tmux way, zellij way, emacs way or azul way. Each of this way of using azul has it's own shortcuts, modes and delimiter. The shortcuts, together with the delimiter and the modes are called an workflow.

Modes

The tmux, zellij and azul workflows, have multiple modes.

Like in vim, a mode is a certain way of interacting with the app. For example, in PANE RESIZE mode, pressing h, j, k and l will resize the currently selected pane, in FLOAT MOVE mode, same keys will move the currently selected pane while in TERMINAL mode, the keys will be sent you your shell intepreter. The default mode when you start the app is TERMINAL mode. In TERMINAL mode, every key you send is sent automatically to the shell (/bin/bash for linux environments).

The possible modes are:

TERMINAL (all your keys are sent to your shell)
VISUAL (moving the cursor in the terminal buffer will modify the current selection)
PANE SELECT (you can change the currently selected pane)
FLOAT MOVE (you can move the currently selected float pane)
PANE RESIZE (you can resize the currently selected pane)
SPLIT (you can add new splits in the currently selected tab)
TABS (you can change the currently selected tab or add a new one)
AZUL.

The AZUL mode is a special mode in which you interact automatically with azul, rather than the currently selected shell.

In AZUL mode, clicking on cursors or on <pgup>, <pgdown> will navigate in the scroll buffer (all the output that your current shell generated).

From AZUL mode you can switch to VISUAL mode (by clicking v), that will start a selection, that can be extended by using the cursors, or <pgup> and <pgdown>.

In AZUL mode you can also communicate with azul directly by sending it commands. You can click on : and a prompt will appear on top of the status bar. If you type Azul (notice the capital A) and then you click tab, you will see a list of all the possible commands you can send to azul. For more info and for a description of each command, see the Commands section.

To return from AZUL mode to TERMINAL mode, you can click on i or <ins>.

The TERMINAL mode is the mode in which you start azul by default. In TERMINAL mode, all your keys are sent to your current shell.

The current mode is indicated in the left bottom side of your status bar.

Modifiers

For tmux and azul workflows, there is also a modifier. A modifier is a key combination that can be set via the delimiter option (default <C-s>) that when pressed in TERMINAL mode has a special meaning, depending on the workflow. This combination will not be sent automatically to your shell, even when in TERMINAL mode.

With a tmux workflow, the modifier will automatically put azul in AZUL mode. The next key will be sent to azul, instead of your terminal. You can click i or <ins> if you change your mind and you want to get back to TERMINAL mode, or you can press for example p to switch to PANE SELECT mode.

With an azul workflow, the modifier will show you the next possible keys on the bottom of the page, but will stay in TERMINAL mode. If the next key is an azul shortcut, then an azul command will be executed. If no, then both keys (the modifier and the following key) will be sent to the current shell.

Emacs workflow

In this workflow, there are no modes and no modifiers. You are always inside the TERMINAL mode. If you want to access azul special functions (like opening a float), you have to click certain shortcuts prefixed by a standard modifier (ctrl or alt). For example, to open a new float, you need to click on <a-f>. For a full list of shortcuts for this workflow, check the examples/emacs-config.ini file.

Zellij workflow

In this workflow, there are modes, but there is no modifier. You will mostly be in TERMINAL, AZUL or the custom azul modes (PANE SELECT, PANE RESIZE, MOVE, SPLIT or TABS). To switch in a another mode, you have standard shortcuts prefixed by a standard delimiter (ctrl or alt). For example, to change to TABS mode, you can click <C-S-t>. For a full list of shortcuts for this workflow, chek the examples/zellij-config.ini file.

Tmux workflow

In this workflow, you have modes and you also have a modifier. This means, that by default you are in TERMINAL mode and all your keys are sent to your bash interpreter (or cmd for windows). Whenever you want to interact with azul, you need to press your modifier (by default <C-s>). This will put azul from TERMINAL mode in AZUL mode. Now, your key presses will be sent to azul, instead of your bash interpreter, just like with tmux.

Azul workflow

This is the default workflow. After installation, if you don't modify your configuration, when you will start azul, you will find yourself in the azul workflow. This workflow is a combination of all the previous workflows. You are all the time in the TERMINAL mode, you have a modifier (default <C-s>) and you have modes.

Unlike tmux workflow, when you click the modifier azul will remain in TERMINAL mode, but will wait for the next key and is going to interpret it like an azul command. If you wait for 300 ms, then you will also have a help indicating what are the possible commands that you can send to azul.

Mouse support

In azul, you can also use the mouse. By default, you can select with the mouse and you can also move the cursor, which will modify the selection. To disable the mouse, set the mouse option to nothing. Either in your config.ini file in the options section (mouse = ) or in your init.lua file (vim.o.mouse = ""). The default value is a. If you want to see the meaning and possible values, you can check here.

Commands

You can communicate directly with azul from AZUL mode, by clicking : (while in AZUL mode). This will open a prompt on top of the status bar. There, you can type one of the possible commands and then click enter. Azul will execute the command and then return in TERMINAL mode or stay in AZUL mode, depending on the command requested.

Some of the commands can take parameters. For example, AzulSelectPane will take as a parameter the direction in which to select the next pane (left, right, up or down). The parameters are separated by spaces. For example, to select the next pane to the left, in AZUL mode, you need to click the following: :AzulSelectPane left<cr> (the <cr> represents enter).

Possible commands

AzulHideFloats

Hiddens all the floats.

Parameters: none

AzulOpen

Opens a new tab with a new shell.

Parameters: none

AzulEnterMode

Puts azul in the requested mode.

Parameters:

the mode (p or r or s or m or T or n or t or v)

AzulShowFloats

Shows the currently opened floats. If no floats is created yet, then nothing will be shown. If the option link_floats_with_tabs is true, then it shows the currently opened floats on the current tab.

Parameters: none

AzulOpenFloat

Creates a new float on the current tab. If the option link_floats_with_tabs is set to true, then this float will only be visible on the currently selected tab.

Parameters: none

AzulToggleFloats

Toggles the opened floats visibility. If link_floats_with_tabs is true, then it toggles the visibility of opened floats for the current tab.

Parameters: none

AzulMoveCurrentFloat

Moves the currently selected float in the given direction with the given increment.

Parameters:

direction (left, right, up or down) - mandatory
increment (number) - optional. If missing, then the float will be moved by 5 pixels

AzulSelectPane

Selects the next pane in the indicated direction

Parameters:

direction (left, right, up or down)

AzulSendToCurrentPane

Sends the indicated text to the currently selected pane. This commands accepts after it a ! symbol. This means that the characters will be escaped.

For example:

:AzulSendToCurrentPane ls -al<cr> will send to the current pane the literal text ls -al<cr>. The <cr> will not be replaced by an enter.

:AzulSendToCurrentPane! ls -al<cr> will send to the current pane the text ls -al followed by an enter (notice the exclamation marc after the command)

Parameters:

the text to send to the currently selected pane

AzulPositionCurrentFloat

Positions the currently selected floating pane in a region of the screen.

Parameters:

the screen region where to position the float (top, bottom, start or end)

AzulRedraw

Redraws the terminal

Parameters: none

AzulSuspend

Suspends all the azul events. This is an usefull command for advanced users who might want to open something in an underlying nvim buffer. Normally, that something would be overriten by a new shell. In order to prevent this, you can suspend the azul events, finish your job and then resume the azul events.

Parameters: none

AzulResume

Resumes the azul events. This is an usefull command for advanced users who might want to open something in an underlying nvim buffer. Normally, that something would be overriten by a new shell. In order to prevent this, you can suspend the azul events, finish your job and then resume the azul events.

Parameters: none

AzulDisconnect

Disconnects the current session

Parameters: none

AzulSaveLayout

Saves the current layout. Uppon invoking this command, you will be met with a prompt at the bottom of the screen, on top of the status bar, to indicate a file name where you wish to save your layout. You can type a full path to a file, using tab for autocompletion.

Azul has very powerfull features for saving and restoring saved sessions. See the Session restore section

Parameters: none

AzulRestoreLayout

Restores a saved layout. Uppon invoking this command, you will be met with a prompt at the bottom of the screen, on top of the status bar, to indicate a file name where you wish to save your layout. You can type a full path to a file, using tab for autocompletion.

Azul has very powerfull features for saving and restoring saved sessions. See the Session restore section

AzulSetWinId

Sets an azul windows id for the currently selected pane. See the Session restore section for why you would set and how you would use this id

Parameters:

the id of the pane

AzulSetCmd

Sets a command to be launched uppon a restore. For more info, see the Session restore section.

Parameters:

the command to be launched uppon a restore

AzulStartLogging

Starts logging the current terminal scrollback buffer.

Note: this commands does not log what is visibile on the screen. Only what is in the scroll buffer.

Parameters: none

AzulStopLogging

If started, stops the current terminal logging of the scroll buffer.

Parameters: none

AzulSetWinId

Sets an azul windows id for the currently selected pane. See the Session restore section for why you would set and how you would use this id

Parameters:

the id of the pane

AzulTogglePassthrough

Toggles the passthrough mode.

Parameters: the escape sequence

Configuration

Azul can be configured in several ways. For neovim users, you can configure azul directly via an init file placed in ~/.config/azul/init.lua. This will expose the full power and all the configurations of azul. You can check the azul api here.

You have examples of configuration for each workflow inside the examples/ folder (for example, examples/azul.lua). You can get any of the example files, corresponding to each of the possible workflows, rename it to init.lua and copy it to ~/.config/azul folder.

If you don't need to access the full power of neovim or you are not familiar with lua or neovim, you can configure azul via a simple ini file format. The file should be placed in ~/.config/azul/config.ini.

The ini file format is a classical ini format. Each option or shortcut should be on one line separated by an equal. The left side will be the option and the right side the value.

In case of shortcuts, the left side should contain the mode, followed by a dot and then followed by the action (for an workflow other than emacs workflow) or the action directly, for the emacs workflow. For more info see the Shortcuts section

Options

workflow - The current workflow (default azul)
modifier - The default modifier (default <C-s>)
link_floats_with_tabs - If true, then the floats opened in a tab, are displayed only in that tab. Otherwise, the floats will be displayed over all the tabs (default false)
shell - The default shell (default is given by your operating system)
mouse - The mouse support settings (default a)
theme - The status line theme (default dracula). You can see a list of all the possible themes here
termguicolors - If true, then the 24-bit RGB colors are activated (default true). For more info, see here
scrollback - The number of lines saved in the scroll history. The more lines, the bigger the memory consumption of azul (default 2000)
clipboard - The clipboard settings (default unnamedplus). For more info, see Copy/pasting section
encoding - The default encoding of the terminal (default utf-8)
passthrough_escape - The default escape sequence from the passthrough mode (default <C-\><C-s>)
hide_in_passthrough If true, then when in passthrough mode, hide the status line of the passed through session (default false)

Shortcuts

Azul can use any shortcuts that vim can use. As a notation, to set up a ctrl, alt of shift shortcut, you need to enclose the shortcut between < and >. So, for example, to set a ctrl + s shortcut, you would define it as <C-s>. You can see the example files inside the examples folder.

In the ini file, each shortcut will be defined on a row. For azul, tmux or zellij workflows, the shortcuts are defined starting with the mode, followed by a dot and then followed by a possible action.

For example, to set the create_tab action in TABS mode to the letter c, you need to add this to your ini file in the Shortcuts section: tabs.create_tab = c.

If you want for example for emacs workflow to set up the same action to alt + w, you need to add this in your ini file: create_tab = <a-w>.

Some of the actions, will expect a parameter (for example tab_select). For such actions (that expect a parameter), after the action, you need to add another dot and then the value of the parameter.

An action, could have more than one shortcut, even for the same mode. In this case, just put each shortcut on an ini line. For example:

terminal.create_tab = c
terminal.create_tab = C

For example, for tab_select action, which expects the number of tab that you want to select, you need to add the following in your init file.

For an workflow other than emacs: terminal.tab_select.1 = 1.

For an emacs workflow: tab_select.1 = <C-1>.

Possible actions

select_terminal: Selects visually one of the existing pane in the current session
- defaults:
  - azul: terminal.select_terminal = St
  - tmux: azul.select_terminal = St
  - zellij: pane.select_terminal = T
  - emacs: select_terminal = <C-S-t>
select_session: Selects one existing azul session
- defaults:
  - azul: terminal.select_session = Ss
  - tmux: azul.select_session = Ss
  - zellij: pane.select_session = S
  - emacs: select_session = <C-S-s>
create_tab: Creates a new tab
- defaults:
  - azul: terminal.create_tab = c
  - azul: tabs.create_tab = c
  - tmux: azul.create_tab = c
  - tmux: tabs.create_tab = c
  - zellij: tabs.create_tab = c
  - emacs: create_tab = <A-c>
tab_select: Selects an existing tab.
- arguments: The number of the tab to select
- defaults:
  - azul: terminal.tab_select.n = n (where n represents the number of the tab to select)
  - tmux: azul.tab_select.n = n (where n represents the number of the tab to select)
  - emacs: tab_select.n = <A-n> (where n represents the number of the tab to select)
toggle_floats: Toggle the floats visibility
- defaults:
  - azul: terminal.toggle_floats = w
  - tmux: azul.toggle_floats = w
  - zellij: pane.toggle_floats = w
  - emacs: toggle_floats = <A-w>
enter_mode: Enter an azul mode
- arguments: The mode to enter (p or r or s or m or T or n or t or v or P)
- defaults:
  - azul: terminal.enter_mode.X = X (where X is one of the p, r, m, s, T, n, v)
  - azul: resize.enter_mode.t = <cr>
  - azul: resize.enter_mode.t = <esc>
  - azul: resize.enter_mode.t = i
  - azul: pane.enter_mode.t = <cr>
  - azul: pane.enter_mode.t = <esc>
  - azul: pane.enter_mode.t = i
  - azul: move.enter_mode.t = <cr>
  - azul: move.enter_mode.t = <esc>
  - azul: move.enter_mode.t = i
  - azul: split.enter_mode.t = <cr>
  - azul: split.enter_mode.t = <esc>
  - azul: split.enter_mode.t = i
  - azul: tabs.enter_mode.t = <cr>
  - azul: tabs.enter_mode.t = <esc>
  - azul: tabs.enter_mode.t = i
  - tmux: terminal.enter_mode.X = X (where X is one of the p, r, m, s, T, v)
  - tmux: resize.enter_mode.t = <cr>
  - tmux: resize.enter_mode.t = <esc>
  - tmux: resize.enter_mode.t = i
  - tmux: pane.enter_mode.t = <cr>
  - tmux: pane.enter_mode.t = <esc>
  - tmux: pane.enter_mode.t = i
  - tmux: move.enter_mode.t = <cr>
  - tmux: move.enter_mode.t = <esc>
  - tmux: move.enter_mode.t = i
  - tmux: split.enter_mode.t = <cr>
  - tmux: split.enter_mode.t = <esc>
  - tmux: split.enter_mode.t = i
  - tmux: tabs.enter_mode.t = <cr>
  - tmux: tabs.enter_mode.t = <esc>
  - tmux: tabs.enter_mode.t = i
  - zellij: terminal.enter_mode.p = <C-p>
  - zellij: terminal.enter_mode.r = <C-r>
  - zellij: terminal.enter_mode.v = <C-S-v>
  - zellij: terminal.enter_mode.s = <C-s>
  - zellij: terminal.enter_mode.T = <C-S-t>
  - zellij: terminal.enter_mode.n = <C-a>
  - zellij: terminal.enter_mode.m = <C-S-m>
  - zellij: pane.enter_mode.t = <cr>
  - zellij: pane.enter_mode.t = <esc>
  - zellij: pane.enter_mode.t = i
  - zellij: move.enter_mode.t = <cr>
  - zellij: move.enter_mode.t = <esc>
  - zellij: move.enter_mode.t = i
  - zellij: split.enter_mode.t = <cr>
  - zellij: split.enter_mode.t = <esc>
  - zellij: split.enter_mode.t = i
  - zellij: tabs.enter_mode.t = <cr>
  - zellij: tabs.enter_mode.t = <esc>
  - zellij: tabs.enter_mode.t = i
create_float: Creates a new float
- defaults:
  - azul: terminal.create_float = f
  - tmux: azul.create_float = f
  - zellij: pane.create_float = f
  - emacs: create_float = <A-f>
disconnect: Disconnects the current session
- defaults:
  - azul: terminal.disconnect = d
  - tmux: azul.disconnect = d
  - zellij: terminal.disconnect = <C-d>
  - emacs: disconnect = <A-d>
resize_left: Resizes the currently selected pane towards left direction
- defaults:
  - azul: resize.resize_left = h
  - azul: resize.resize_left = <left>
  - tmux: resize.resize_left = h
  - tmux: resize.resize_left = <left>
  - zellij: resize.resize_left = h
  - zellij: resize.resize_left = <left>
  - emacs: resize_left = <C-S-left>
resize_right: Resizes the currently selected pane towards right direction
- defaults:
  - azul: resize.resize_right = l
  - azul: resize.resize_right = <right>
  - tmux: resize.resize_right = l
  - tmux: resize.resize_right = <right>
  - zellij: resize.resize_right = l
  - zellij: resize.resize_right = <right>
  - emacs: resize_up = <C-S-right>
resize_up: Resizes the currently selected pane towards up
- defaults:
  - azul: resize.resize_up = k
  - azul: resize.resize_up = <up>
  - tmux: resize.resize_up = k
  - tmux: resize.resize_up = <up>
  - zellij: resize.resize_up = k
  - zellij: resize.resize_up = <up>
  - emacs: resize_up = <C-S-up>
resize_down: Resizes the currently selected pane towards down
- defaults:
  - azul: resize.resize_down = j
  - azul: resize.resize_down = <down>
  - tmux: resize.resize_down = j
  - tmux: resize.resize_down = <down>
  - zellij: resize.resize_down = j
  - zellij: resize.resize_down = <down>
  - emacs: resize_up = <C-S-down>
select_left: Selects the next panel to the left
- defaults:
  - azul: pane.select_left = h
  - azul: pane.select_left = <left>
  - tmux: pane.select_left = h
  - tmux: pane.select_left = <left>
  - zellij: pane.select_left = h
  - zellij: pane.select_left = <left>
  - emacs: select_left = <A-left>
select_right: Selects the next panel to the right
- defaults:
  - azul: pane.select_right = l
  - azul: pane.select_right = <right>
  - tmux: pane.select_right = l
  - tmux: pane.select_right = <right>
  - zellij: pane.select_right = l
  - zellij: pane.select_right = <right>
  - emacs: select_right = <A-right>
select_up: Selects the next above panel
- defaults:
  - azul: pane.select_up = k
  - azul: pane.select_up = <up>
  - tmux: pane.select_up = k
  - tmux: pane.select_up = <up>
  - zellij: pane.select_up = k
  - zellij: pane.select_up = <up>
  - emacs: select_up = <A-up>
select_down: Selects the next below panel
- defaults:
  - azul: pane.select_down = j
  - azul: pane.select_down = <down>
  - tmux: pane.select_down = j
  - tmux: pane.select_down = <down>
  - zellij: pane.select_down = j
  - zellij: pane.select_down = <down>
  - emacs: select_down = <A-down>
move_left: Moves the currently selected panel to the left
- arguments: The number of columns to move
- defaults:
  - azul: move.move_left.5 = h
  - azul: move.move_left.5 = <left>
  - azul: move.move_left.1 = <C-h>
  - azul: move.move_left.1 = <C-left>
  - tmux: move.move_left.5 = h
  - tmux: move.move_left.5 = <left>
  - tmux: move.move_left.1 = <C-h>
  - tmux: move.move_left.1 = <C-left>
  - zellij: move.move_left.5 = h
  - zellij: move.move_left.5 = <left>
  - zellij: move.move_left.1 = <C-h>
  - zellij: move.move_left.1 = <C-left>
  - emacs: move_left.5 = <C-A-left>
move_right: Moves the currently selected panel to the right
- arguments: The number of columns to move
- defaults:
  - azul: move.move_right.5 = l
  - azul: move.move_right.5 = <right>
  - azul: move.move_right.1 = <C-l>
  - azul: move.move_right.1 = <C-right>
  - tmux: move.move_right.5 = l
  - tmux: move.move_right.5 = <right>
  - tmux: move.move_right.1 = <C-l>
  - tmux: move.move_right.1 = <C-right>
  - zellij: move.move_right.5 = l
  - zellij: move.move_right.5 = <right>
  - zellij: move.move_right.1 = <C-l>
  - zellij: move.move_right.1 = <C-right>
  - emacs: move_right.5 = <C-A-right>
move_up: Moves the currently selected panel towards up
- arguments: The number of columns to move
- defaults:
  - azul: move.move_up.5 = k
  - azul: move.move_up.5 = <up>
  - azul: move.move_up.1 = <C-k>
  - azul: move.move_up.1 = <C-up>
  - tmux: move.move_up.5 = k
  - tmux: move.move_up.5 = <up>
  - tmux: move.move_up.1 = <C-k>
  - tmux: move.move_up.1 = <C-up>
  - zellij: move.move_up.5 = k
  - zellij: move.move_up.5 = <up>
  - zellij: move.move_up.1 = <C-k>
  - zellij: move.move_up.1 = <C-up>
  - emacs: move_up.5 = <C-A-up>
move_down: Moves the currently selected panel towards down
- arguments: The number of columns to move
- defaults:
  - azul: move.move_down.5 = j
  - azul: move.move_down.5 = <down>
  - azul: move.move_down.1 = <C-j>
  - azul: move.move_down.1 = <C-down>
  - tmux: move.move_down.5 = j
  - tmux: move.move_down.5 = <down>
  - tmux: move.move_down.1 = <C-j>
  - tmux: move.move_down.1 = <C-down>
  - zellij: move.move_down.5 = j
  - zellij: move.move_down.5 = <down>
  - zellij: move.move_down.1 = <C-j>
  - zellij: move.move_down.1 = <C-down>
  - emacs: move_down.5 = <C-A-down>
split_left: Splits the currently selected tab to the left
- defaults:
  - azul: pane.split_left = H
  - azul: pane.split_left = <S-left>
  - azul: split.split_left = h
  - azul: split.split_left = <left>
  - tmux: pane.split_left = H
  - tmux: pane.split_left = <S-left>
  - tmux: split.split_left = h
  - tmux: split.split_left = <left>
  - zellij: split.split_left = h
  - zellij: split.split_left = <left>
  - emacs: split_left = <C-left>
split_right: Splits the currently selected tab to the right
- defaults:
  - azul: pane.split_right = L
  - azul: pane.split_right = <S-right>
  - azul: split.split_right = l
  - azul: split.split_right = <right>
  - tmux: pane.split_right = H
  - tmux: pane.split_right = <S-right>
  - tmux: split.split_right = h
  - tmux: split.split_right = <right>
  - zellij: split.split_right = h
  - zellij: split.split_right = <right>
  - emacs: split_right = <C-right>
split_up: Splits the currently selected tab upwards
- defaults:
  - azul: pane.split_up = K
  - azul: pane.split_up = <S-up>
  - azul: split.split_up = k
  - azul: split.split_up = <up>
  - tmux: pane.split_up = K
  - tmux: pane.split_up = <S-up>
  - tmux: split.split_up = k
  - tmux: split.split_up = <up>
  - zellij: split.split_up = k
  - zellij: split.split_up = <up>
  - emacs: split_up = <C-up>
split_down: Splits the currently selected tab downwards
- defaults:
  - azul: pane.split_down = J
  - azul: pane.split_down = <S-down>
  - azul: split.split_down = j
  - azul: split.split_down = <down>
  - tmux: pane.split_down = J
  - tmux: pane.split_down = <S-down>
  - tmux: split.split_down = j
  - tmux: split.split_down = <down>
  - zellij: split.split_down = j
  - zellij: split.split_down = <down>
  - emacs: split_down = <C-down>
move_top: Moves the currently selected float to the top of the screen
- defaults:
  - azul: move.move_top = K
  - azul: move.move_top = <S-up>
  - tmux: move.move_top = K
  - tmux: move.move_top = <S-up>
  - zellij: move.move_top = K
  - zellij: move.move_top = <S-up>
  - emacs: move_top = <C-A-n>
move_bottom: Moves the currently selected float to the bottom of the screen
- defaults:
  - azul: move.move_bottom = J
  - azul: move.move_bottom = <S-down>
  - tmux: move.move_bottom = J
  - tmux: move.move_bottom = <S-down>
  - zellij: move.move_bottom = J
  - zellij: move.move_bottom = <S-down>
  - emacs: move_bottom = <C-A-s>
move_start: Moves the currently selected float to the left of the screen
- defaults:
  - azul: move.move_start = H
  - azul: move.move_start = <S-left>
  - tmux: move.move_start = H
  - tmux: move.move_start = <S-left>
  - zellij: move.move_start = H
  - zellij: move.move_start = <S-left>
  - emacs: move_start = <C-A-w>
move_end: Moves the currently selected float to the right of the screen
- defaults:
  - azul: move.move_end = L
  - azul: move.move_end = <S-right>
  - tmux: move.move_end = L
  - tmux: move.move_end = <S-right>
  - zellij: move.move_end = L
  - zellij: move.move_end = <S-right>
  - emacs: move_end = <C-A-e>
tab_select_first: Selects the first tab
- defaults:
  - azul: tabs.tab_select_first = H
  - azul: tabs.tab_select_first = <S-left>
  - tmux: tabs.tab_select_first = H
  - tmux: tabs.tab_select_first = <S-left>
  - zellij: tabs.tab_select_first = H
  - zellij: tabs.tab_select_first = <S-left>
  - emacs: tab_select_first = <C-x><S-left>
tab_select_last: Selects the last tab
- defaults:
  - azul: tabs.tab_select_last = L
  - azul: tabs.tab_select_last = <S-right>
  - tmux: tabs.tab_select_last = L
  - tmux: tabs.tab_select_last = <S-right>
  - zellij: tabs.tab_select_last = L
  - zellij: tabs.tab_select_last = <S-right>
  - emacs: tab_select_last = <C-x><S-right>
tab_select_previous: Selects the previous tab
- defaults:
  - azul: tabs.tab_select_previous = h
  - azul: tabs.tab_select_previous = <left>
  - tmux: tabs.tab_select_previous = h
  - tmux: tabs.tab_select_previous = <left>
  - zellij: tabs.tab_select_previous = h
  - zellij: tabs.tab_select_previous = <left>
  - emacs: tab_select_previous = <C-x><left>
tab_select_next: Selects the next tab
- defaults:
  - azul: tabs.tab_select_next = l
  - azul: tabs.tab_select_next = <right>
  - tmux: tabs.tab_select_next = l
  - tmux: tabs.tab_select_next = <right>
  - zellij: tabs.tab_select_next = l
  - zellij: tabs.tab_select_next = <right>
  - emacs: tab_select_next = <C-x><right>
copy: Copies the currently selected text into the clipboard.
- defaults:
  - azul: visual.copy = y
  - azul: visual.copy = <C-c>
  - tmux: visual.copy = y
  - tmux: visual.copy = <C-c>
  - zellij: visual.copy = y
  - zellij: visual.copy = <C-c>
  - emacs: copy = <C-c>
paste: Pastes the content of the clipboard into the currently selected pane
- defaults:
  - azul: terminal.paste = pp
  - azul: terminal.paste = <C-v>
  - tmux: terminal.paste = <C-v>
  - zellij: terminal.paste = <C-v>
  - emacs: paste = <C-v>
passthrough: Toggles the passthrough mode.
- defaults:
  - azul: terminal.passthrough = N
  - tmux: terminal.passthrough = N
  - emacs: passthrough = <A-n>

Copy/pasting

In azul, you can copy paste by using the expected <C-c> and <C-v> shortcuts. The interaction between your terminal and the system clipboard is done via the clipboard setting. You can see the meaning of it and also possible options for possible operating systems here.

For vim users, you also have <C-s>pp for example to paste in TERMINAL mode in azul workflow or y in VISUAL mode for multiple workflows.

Whenever you select a text with the mouse, you can then click <C-c> and <C-v>. This will paste the currently selected text into the currently selected pane.

Other than the mouse, a selection can be created using the keyboard. You can switch to VISUAL mode, via the default shortcuts (see the shortcuts section) and then using vim movements (h, j, k, l) or the cursors and <pgup> or <pgdown>.

Passthrough mode

Passthrough mode is a special mode. When you enter passthrough mode, no shortcut is valid anymore. In order to leave this mode, you need to press the passthrough_escape (default <C-\><C-s>)

This solves the issue of running an azul session inside another azul session. Clicking <C-s>P will put you in passthrough mode. So, if for example you are in your main host session, you click <C-s>P then all the controls are passed through the first session down to the second session.

In order to escape back to the host main session, by default you have to press inside the second session <C-\><C-s>. This is the default modifier. This will send the control back to the host main session.

Session restore

Azul has very powerfull options to save and restore a session. By invoking azul command AzulSaveLayout, your layout will be saved in the selected file. This means all the floats and the splits and the tabs.

By calling AzulRestoreLayout, the current layout will be overriten by the layout saved in the file. This means all your current tabs, splits and floats will be closed and the tabs, splits and floats inside the layout file will be re-created.

If you also want to save the commands running in a pane, you have two options.

AzulSetCmd

You can call the function AzulSetCmd. This variable will be saved together with the layout. When AzulRestoreLayout is called, then the command saved in the AzulSetCmd will be sent to the same pane (float or not, in a split or not)

AzulSetWinId

If you are used to the way neovim works and with lua, then you can use instead AzulSetWinId. This will set a variable identifier on the currently selected pane that will be saved together with the layout.

To restore the layout, instead of calling the AzulRestoreLayout command, you can call in a lua file the azul.restore_layout function, which take as a first argument the file where the layout is saved and as a second a callback with 2 parameters: the azul terminal structure and the this id. This gives you a much more flexibility to set up your pane upon a layout restore. For more details, see the azul api

Lua API

If you are a neovim user and you are familiar with lua, you can access the full power of azul and you can have access to all neovim features by configuring it via an init.lua file instead of a simple ini file. See here on how to do this.

Why

I've been a tmux user for years. Then I've discovered zellij and been using for a few months. They are both amazing pieces of software.

I've been using tmux for the obvious reasons. Then, I've switched to zellij because of the floating panels and the edit back buffer in the custom editor. The floating panels I've been searching it for years and suffered without them in tmux. And then when discovering them in zellij, I've helped implementing the edit in back buffer feature and this made me switch without looking back.

However, they both have had some minor issues that were annoying me. For both of them, for example, changing the themes is not that straight forward (:colorscheme tokyonight?).

Copy / pasting in tmux is painful with the tmux buffer. I mean it was the best solution at the time, but still... Synchronizing the terminal, vim and X clipboard was difficult. Especially when working from tty or over ssh.

In this respect, zellij was a big step forward. Open the terminal content inside vim and I was done. But still, it was a shortcut to press to open the content, copy whatever was to copy and then close the editor to go back to the terminal.

And the most annoying issue was the nested session. Open a multiplexer session, ssh to a server and there connect to another session. I've always fixed this by changing the modifier in the ssh session. But this raised issues when keeping the dotfiles under git, since I have to treat this modifier in some way to keep it under git.

Azul solves all these issues. It allows me to have the modal zellij workflow, combined with the tmux modifier approach. And it solves the nested sessions issue.

Cheatsheet

for azul workflow only.

Modifier M: <C-s>

Session

List all sessions from outside of azul: azul
Create or attach to an existing session: azul -a <session-name>
Detach from a session (from inside an azul session): M d
List all sessions and select from inside azul: M Ss

Scrolling and copying

Azul mode: M n in order to move the curser arround freely and scroll
Visual: M v, then one of h i j k to move into a certain direction to select
Copy: select text and then y
paste: <C-v>

Pass-through mode

When for example in an SSH session also running azul, all shortcuts are passed through to the remote azul.

M <C-N> to activate,
<C-\> M to deactivate

Panes

Create new pane (split): M p, then one of H J K L to split into a certain direction
select pane: M p, then one of h i j k to select a certain pane
resize pane: M r, then one of h i j k to resize a pane into a certain direction

Tabs

Create new tab: M c
Switch to tab: M 1, ..., i.e. the tab number.
Switch to first tab: M H
Switch to last tab: M L
Switch to previous tab: M h
Switch to next tab: M l

Floats

Create new float: M f
Toggle float: M w
move float: M m, then one of h i j k to move into a certain direction. ESC to exit.

Azul mode

M n to activate
- you interact automatically with azul.
- You can click on : and a prompt will appear on top of the status bar.
- From Azul mode hit i for Terminal mode or v for visual mode
- If you type Azul (notice the capital A) and then you click tab, you will see a list of all the possible commands you can send to azul. Command reference

Name		Name	Last commit message	Last commit date
examples		examples
nvim		nvim
tests		tests
.gitignore		.gitignore
README-old.md		README-old.md
README.md		README.md
api.md		api.md
azul		azul
install.ps1		install.ps1
install.sh		install.sh

Latest commit

History

Folders and files

Repository files navigation

Azul

Demo (tldr)

Table of contents

Installation

Requirements

Linux

Windows

Launching

Advantages over tmux or zellij

Status bar or tabline

Very flexibile shortcuts

Passthrough mode

Native on windows

Disadvantages compared with tmux or zellij

Text reflow

Cursor support

Terminology

Tabs

Panes

Floats

Workflows

Modes

Modifiers

Emacs workflow

Zellij workflow

Tmux workflow

Azul workflow

Mouse support

Commands

Possible commands

AzulHideFloats

AzulOpen

AzulEnterMode

AzulShowFloats

AzulOpenFloat

AzulToggleFloats

AzulMoveCurrentFloat

AzulSelectPane

AzulSendToCurrentPane

AzulPositionCurrentFloat

AzulRedraw

AzulSuspend

AzulResume

AzulDisconnect

AzulSaveLayout

AzulRestoreLayout

AzulSetWinId

AzulSetCmd

AzulStartLogging

AzulStopLogging

AzulSetWinId

AzulTogglePassthrough

Configuration

Options

Shortcuts

Possible actions

Copy/pasting

Passthrough mode

Session restore

AzulSetCmd

AzulSetWinId

Lua API

Why

Cheatsheet

Session

Scrolling and copying

Pass-through mode

Panes

Tabs

Floats

Azul mode

About

Resources

Stars

Watchers

Forks