luccahuguet / yazelix

zellij, yazi and nushell adding a File Tree to Helix & helix-friendly keybindigs for zellij
Apache License 2.0
219 stars 11 forks source link
editor helix multiplexer terminal yazi zellij

Yazelix v4.1

Overview

Yazelix integrates yazi, zellij and helix, hence the name, get it?

Preview

yazelix_v41_demo

Improvements of the v4.1 over v4

Improvements of the v4 over v3

Instructions to set it up

  1. Make sure yazi, zellij, helix, and nushell are installed and in your path
  2. Just clone this repo in your ~/.config dir
  3. Take a look at the configure wezterm step on https://github.com/luccahuguet/rustifier to see how to configure yazelix on wezterm
    • If you use another shell, you have to configure it to run something like nu -c "zellij -l welcome --config-dir ~/.config/yazelix/zellij options --layout-dir ~/.config/yazelix/zellij/layouts" on startup
    • or zellij -l welcome --config-dir ~/.config/yazelix/zellij options --layout-dir ~/.config/yazelix/zellij/layout (but you still need nu anyways)
    • Another option, if you wish, run this command manually every time you open yazelix
    • The recommended shell is Wezterm though. More on that in the Notes section below
  4. Optional: Using zoxide enhances the yazelix experience ten-fold, let me tell ya... and it integrates with yazi

That's it, and feel free to open issues and PRs 😉

Why use this project?

Troubleshooting

Possible Improvements

Keybinding remaps

New Zellij Keybinding Previous Keybinding Helix Action that uses that previous key Zellij Action remapped
Ctrl e Ctrl o jump_backward SwitchToMode "Session"
Ctrl y Ctrl s save_selection SwitchToMode "Scroll"
Alt w Alt i shrink_selection MoveTab "Left"
Alt q Alt o expand_selection MoveTab "Right"
Alt m Alt n select_next_sibling NewPane
Alt 2 Ctrl b move_page_up SwitchToMode "Tmux"

If you find a conflict, please open an issue. Keep in mind, though, that compatibility with tmux mode is not a goal of this project.

Details: Base Layout

The initial layout includes one usable pane (actually 4, counting the tab-bar, status-bar and sidebar): image

Discoverability of keybindings

Notes

Contributing to Yazelix

See here in contributing

Similar projects