Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2 KB

README.md

File metadata and controls

56 lines (35 loc) · 2 KB

zellij-tabula

A Zellij plugin to automatically rename tabs based on the working directory of the contained panes.

🚧 Disclaimer

This project is currently under development and may be subject to frequent changes. Features may be added, modified, or removed without notice. Please use at your own risk and feel free to submit any feedback or suggestions. Thank you for your understanding.

Installation

zellij-tabula requires both a zellij-plugin and a shell plugin to function. As of right now, only zsh is supported.

Requires Zellij 0.40.0 or never.

Installing the Zellij plugin

Add the following to your zellij config, replacing YOUR_HOME_DIRECTORY with the absolute path of your home directory:

load_plugins {
    "https://github.com/bezbac/zellij-tabula/releases/download/v0.2.0/zellij-tabula.wasm" {
        home_dir "YOUR_HOME_DIRECTORY"
    }
}

Installing the zsh plugin

Using sheldon

Add the following to your sheldon plugins.toml config:

[plugins.zellij-tabula]
github = "bezbac/zellij-tabula"
use = ["{{ name }}.plugin.zsh"]
tag = "v0.2.0"

Details for more zsh plugin managers will follow. Please open an issue for suggesting one.

Contributing

Feel free to suggest ideas or report issues by opening an issue.
If you want to contribute code changes you will find some useful information in CONTRIBUTING.md.

License

The content of this repository is licensed under the BSD-3-Clause license. See the LICENSE file for details.

Acknowledgments

This plugin is based on the Zellij's rust-example-plugin.