Home

Awesome

Zsh Plugin for Zellij

This plugin provides a terminal environment that uses zellij as a default.

Most of the contents refer to oh-my-zsh/tmux. Thank you so much :smile:

:warning: NOTICE: Zellij now provides its own auto start script. Check the official documentation for details.

Installation

Manual

Clone the Repository:

git clone https://github.com/jaeheonji/zsh-zellij-plugin

Add the following to your .zshrc:

source ~/path/to/zsh-zellij-plugin/zellij.plugin.zsh

Oh-My-Zsh

Clone the Repository:

git clone https://github.com/jaeheonji/zsh-zellij-plugin ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/zellij

Add zellij to your plugin list in .zshrc.

plugins=(
    ...
    zellij
)

Configuration Variables

VariableDescription
ZSH_ZELLIJ_AUTOSTARTAutomatically starts zellij (default: false)
ZSH_ZELLIJ_AUTOCONNECTAutomatically connect to a previous session if it exits (default: true)
ZSH_ZELLIJ_AUTOQUITAutomatically closes terminal once zellij exits (default: ZSH_ZELLIJ_AUTOSTART)
ZSH_ZELLIJ_LAYOUTSet the default layout file in the layout directory
ZSH_ZELLIJ_LAYOUT_PATHSet the default path of layout yaml file

When ZSH_ZELLIJ_LAYOUT and ZSH_ZELLIJ_LAYOUT_PATH are used together, LAYOUT has priority.

License

MIT license