Skip to content

Installation

João Dias edited this page Jul 28, 2026 · 30 revisions

This is the installation guide for colorshell!
Thanks for being interested on it ❤️

⬇️ Installing the Shell

AUR

Arch Linux or Arch-based distros(e.g.: CachyOS, Manjaro, EndeavourOS, Nyarch Linux...)

yay -Sy colorshell

(or colorshell-git if you want the latest commit version)

Nix/NixOS

You can install colorshell as you would install any flake, thanks to @conroy-cheers!
Please note that this is still in the experimental state and might have something broken ;P

nix profile add "github:retrozinndev/colorshell/main"

Others

Ohh, you'll have to manually build the shell...
Wait, wait, wait!! It isn't as complicated as it looks like! Reach to Manual Installation for a guide.

Manual Installation

  1. Search for equivalent dependencies to those listed in Wiki/Dependencies for your distro.
  2. Install pnpm, curl and jq.
  3. Install colorshell with:
bash <(curl -fsSL https://clsh.retrozinn.dev/install.sh)
  1. Add ~/.local/bin to your PATH:

This one is a bit more personal, do it the way you think it's best.
If you don't know how, I suggest adding it from your hyprland.lua:

hl.env("PATH", os.getenv("PATH") .. ":" .. os.getenv("HOME") .. "/.local/bin");

Starting with Hyprland

To start colorshell automatically with hyprland, add to your hyprland.lua:

hl.on("hyprland.start", function()
    hl.exec_cmd("colorshell");
end);

That's it, now you can enjoy colorshell in your system!! If you run into an problem or bug, consider reporting it by creating a new issue at the Issues page :D

Thank you so much for using colorshell! ❤️

Clone this wiki locally