An opinionated session manager for zellij trying to be smart.
The goal of this project is to speed up my workflow with zellij sessions. It implements fuzzy finding,
that matches on a combination of session and tab name to directly find the corresponding tab in a
session.
Important
This is an early development version and does not have all features implemented. With future APIs, there will be the last used session at the top. Also one goal is to navigate to the last focused tab & pane, when attaching to a session.
When zj-smart-sessions is installed and configured with the keybindings, simply invoke the keybinding to start the plugin.
It will pop up in a floating window. On first start, it will ask for permissions to fetch certain events and control zellij. After granting permissions, you can navigate with the arrow keys between the sessions. Right arrow key will expand the session or tab; left arrow will fold it again.
The search acts with a fuzzy search and is implemented in a way, that speeds up finding the correct tab in the correct session. Simply start typing to search the session first. If the correct sessions is selected, type a ' '(space) to start fuzzy finding the tab. When you type a ' '(space) again, you can also search for panes in the selected tab.
When pressing the enter key, your session will be switched to the selected destination. The delete key will kill the selected session.
Download the latest binary in the GitHub releases. Place it somewhere, zellij is able to access it. Then the plugin can be included by referencing it either via plugin aliases or directly in the keybindings section of the config.kdl.
You could also refer to the plugin guide from zellij, after downloading the binary: https://zellij.dev/documentation/plugin-loading
Here's an example for creating the keybinding, that override the default session manager, with help of a plugin alias.
plugins {
zj-smart-sessions location="file:/abolute/path/to/zj-smart-sessions.wasm"
}
keybinds {
session {
bind "w" {
LaunchOrFocusPlugin "zj-smart-sessions" {
floating true
};
SwitchToMode "Normal"
}
}
}Add this repository to your inputs and then with the following overlay to your packages.
Then you are able to install and refer to it with pkgs.zj-smart-sessions. When templating the
config file, you can use ${pkgs.zj-smart-sessions}/bin/zj-smart-sessions.wasm as the path.
inputs = {
# ...
zj-smart-sessions = {
url = "github:dj95/zj-smart-sessions";
};
};
# define the outputs of this flake - especially the home configurations
outputs = { self, nixpkgs, zj-smart-sessions, ... }@inputs:
let
inherit (inputs.nixpkgs.lib) attrValues;
overlays = with inputs; [
# ...
(final: prev: {
zj-smart-sessions = zj-smart-sessions.packages.${prev.system}.default;
})
];If you are missing features or find some annoying bugs please feel free to submit an issue or a bugfix within a pull request :)
© 2024 Daniel Jankowski
This project is licensed under the MIT license.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.