Rustifier (WARNING: BARELY TESTED, MIGHT SHOW UNEXPECTED BEHAVIOR)

Rustifier is a tool designed to quickly set up a complete Yazelix environment, integrating Zellij, Yazi, Helix, WezTerm, and Nushell. It offers an easy, opinionated setup with the option to include additional useful Rust-based terminal utilities.

Todo List

[x] Update Yazelix README
[x] Create Yazelix video
[x] maybe create a rustifier_programs folder in users $HOME?
[x] bunch of improvements
[x] move system dependencies of nushell into the script
[ ] Update the testing table
[ ] Add instructions on how to set zoxide
[ ] Add instructions on how to set starship

Compatibility

WARNING: The current version has not been tested yet
Should be compatible with various Linux distributions
This project is experimental and users should exercise caution when installing and use at their own risk.
It's recommended to review the installation scripts and understand the changes that will be made to your system before proceeding.

(stale) A previous version of rustifier was tested with:

Component	Version
OS	Pop!_OS 22.04
DE	COSMIC
Zellij	0.40.1
Helix	helix 24.7 (09297046)
Nushell	0.96.1
Zoxide	0.9.4
Yazi	0.2.5
WezTerm	20240203-110809-5046fc22

Installation

Clone this repository:

mkdir ~/rustifier_programs
git clone https://github.com/luccahuguet/rustifier.git ~/rustifier_programs 
cd rustifier

Setting up base programs
1. Run the setup script:
```
chmod +x setup.sh
./setup.sh
```
  This script will check if Rust, Nushell, and Just are installed. If they're not, it will ask for your permission to install them. These tools are required for Rustifier to function properly.
2. Restart your shell or run exec $SHELL (bash)
Install system dependencies:
- For Ubuntu/Debian-based systems:
```
sudo apt install libssl-dev
```
- For Fedora:
```
sudo dnf install openssl-devel
```
  Note: These may be required for Nushell installation if not already present.

Install Helix

For instance if you want to build it from source:

git clone https://github.com/helix-editor/helix ~/rustifier_programs/helix
cd helix

And then:

cargo install --path helix-term --locked

Install Wezterm. Click here to see many installation options... or for debian/ubuntu systems:

Configure the apt repo:

 curl -fsSL https://apt.fury.io/wez/gpg.key | sudo gpg --yes --dearmor -o /etc/apt/keyrings/wezterm-fury.gpg
 echo 'deb [signed-by=/etc/apt/keyrings/wezterm-fury.gpg] https://apt.fury.io/wez/ * *' | sudo tee /etc/apt/sources.list.d/wezterm.list

And then:

 sudo apt update
 sudo apt install wezterm

Configure WezTerm:
a. Create or open your ~/.wezterm.lua file
b. Add the following content:

  -- Pull in the wezterm API
  local wezterm = require 'wezterm'
  -- This will hold the configuration.
  local config = wezterm.config_builder()
  -- This is where you actually apply your config choices
  -- For example, changing the color scheme:
  config.color_scheme = 'Abernathy'
  -- Spawn a nushell shell in login mode
  config.default_prog = { 'nu', '-c', "zellij -l welcome --config-dir ~/.config/yazelix/zellij options --layout-dir ~/.config/yazelix/zellij/layouts" }
  -- Others
  config.hide_tab_bar_if_only_one_tab = true
  config.window_decorations = "NONE"
  -- and finally, return the configuration to wezterm
  return config

Note: For extra configuration, visit: https://wezfurlong.org/wezterm/config/files.html

Run the installation script:
```
just
```
This will some show installation options on your screen, pick your poison :poison: and follow the steps!
Now it seems everything is installed, right? Please reboot your machine for good measure

What's Included

1. Yazelix Minimal Install

Zellij: Terminal workspace
Yazi: Terminal file manager
Yazelix: Integrating Helix, Yazi and zellij
Nushell: Modern amazing shell written in rust, best fit to yazelix
Starship: Customizable prompt for any shell

2. Yazelix Full Install

Includes all components from the Minimal Install, plus:
Zoxide: Smarter cd command
Gitui: Terminal UI for git
Mise: Development tool version manager

3. All Optional Utilities

Includes everything from the Full Install, plus all of the following:

erdtree: File-tree visualizer and disk usage analyzer
onefetch: Git repository summary in your terminal
rusty-rain: Terminal-based digital rain effect
taplo-cli: TOML toolkit
tokei: Code statistics tool
yazi-cli: Command-line interface for Yazi
zeitfetch: System information tool

4. Custom Optional Install

Includes everything from the Full Install, but lets you pick which additional utilities to install from the list above.

Usage

Open WezTerm.
Yazelix should automatically start, providing an integrated environment with Zellij, Yazi, and Helix.
Use Zellij for terminal multiplexing, Yazi for file management, and Helix for text editing.
Nushell provides a modern shell experience, while Starship offers a customized prompt.
If you chose the Full, All Optional, or Custom installation, utilize the additional utilities as needed in your workflow.

For more information on using Yazelix, refer to the Yazelix README.

cargo-binstall for Installation

Rustifier uses cargo-binstall for installing and updating packages. This approach provides some benefits:

It can install pre-compiled binaries when available, which is often faster than compiling from source.
It falls back to building from source when pre-compiled binaries are not available.
It provides a consistent way to manage installations across all specified programs.

Contributing

Feel free to open issues or submit pull requests to improve Rustifier. While the aim is for a quick, ready-to-use setup, we're open to suggestions that enhance functionality without compromising ease of use.

luccahuguet / rustifier

readme