A Simple, NuShell Based "Plugin" system for Helix using the power of Zellij!
Under the hood, it creates a special zellij session, focued on using auto-closing panes to support windows in helix.
If you don't want to run the directory directly, you can install it using ln and chmod. First, navigate to the directory where run.nu is located.
Run
chmod +x run.shin your terminal to make the file runnable. Next, use
ln -s run.sh ~/.local/bin/zellix`to link run.nu to your local bin directory, then, to run, just use zellix path/to/module to run instead of having to use nu ./run.nu path/to/module.
In order to actually run the system, you must run the shell file with the following parameters.
module: The location of the actual module path, this is just a folder, which will be added to the environment to support using any module folder.
path: An optional path for helix to open into. This is the same as typing hx {file}
A simple example run, if currently inside of the cloned repository, you can run the program like this
nu ./run.nu example/This will run the code with the example folder as the module.
If you just want to try out zellix, clone the repository, ensure you have zellij and helix installed.
Then, if you want to try out my configuration, you will need at least one of either yazi or aichat.
You'll want to edit your helix configuration to use the following in a keybind, or you can run it in helix by pasting it.
:sh zellij run -c -f -x 10% -y 10% --width 80% --height 80% -- nu $ZELLIX_MOD/yazi.nu Will run the yazi program, and replacing yazi.nu with ai.nu
will run the AI Moudle.
if you want to try how i use it, the following will add keybinds for both yazi and the ai module.
[keys.normal.space.f]
f = "file_picker"
t = ":sh zellij run -c -f -x 10% -y 10% --width 80% --height 80% -- nu $ZELLIX_MOD/yazi.nu"
[keys.normal.space.l]
a = ":sh zellij run -c -f -x 10% -y 10% --width 80% --height 80% -- nu $ZELLIX_MOD/ai.nu"Personally, I use nix with this, but the configuration is still very simple. Look at the example, which I use for my daily driver with helix using my dotfile configuration with nixos and nix-darwin!
For information on how to create plugins, check out the wiki!
At the time of writing this, there is no plugin system for helix, and I dislike the configuration of neovim, so I created this to satiate my desire for more than just an editor systems that can still be controlled through my editor.
Put in a pull request adding a link to a repository containing the code, and I'll look at pulling it in!
- Crickets Get writing some awesome stuff.
At this time, the example directory is not accepting pull requests, as it is my personal usage of this system. But the core itself is welcome to changes to support more custom systems, as well as eventually gaining some form of library to better support easier creation of plugins!
At this time, this is a very rough implementation that hasn't been fully tested. If you choose to use this, please report any bugs you find during usage, and I will fix them ASAP.
