Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 2.95 KB

install.md

File metadata and controls

78 lines (57 loc) · 2.95 KB

Install

git clone https://github.com/abeb021/Tanjun-shell.git
cd Tanjun-shell
bash scripts/setup.sh --hyprland   # or --niri

setup.sh links shell/ to ~/.config/quickshell, writes compositor autostart and binds, and copies lock PAM to ~/.config/tanjun/pam (mode 600). That PAM directory is trusted like sudoers: group- or world-writable files are refused.

Needs Quickshell on PATH. Compositor rice lives next to the shell, not inside it:

compositors/hyprland/   lua, one concern per modules/ file
compositors/niri/       kdl
shell/                  Quickshell (bar, launcher, lock, settings, …)
scripts/setup.sh

Restart the compositor after setup, or start Quickshell yourself:

quickshell -p ~/.config/quickshell

NixOS / Home Manager

The repo ships a flake with homeManagerModules.default and an optional nixosModules.default.

  1. Add a flake input:
tanjun.url = "github:abeb021/Tanjun-shell";
tanjun.inputs.nixpkgs.follows = "nixpkgs";
  1. Import the Home Manager module:
{ inputs, ... }:
{
  imports = [ inputs.tanjun.homeManagerModules.default ];
  programs.tanjun = {
    enable = true;
    compositor = "hyprland"; # or "niri"
  };
}

If you also import the NixOS module, give it the same compositor so it enables the right session and portals:

{
  imports = [ inputs.tanjun.nixosModules.default ];
  programs.tanjun = {
    enable = true;
    compositor = "hyprland"; # or "niri"
  };
}

checkout defaults to the pinned flake source (nix flake update tanjun to move versions). For live edits against a git clone:

programs.tanjun.checkout = "/path/to/Tanjun-shell";

On rebuild, Home Manager:

  • symlinks ~/.local/share/tanjun and ~/.config/quickshell to that checkout
  • writes the Hyprland or niri compositor stub under ~/.config
  • installs tanjun-quickshell (same binary as quickshell -p ~/.config/quickshell) plus the plain quickshell/qs binaries used by the compositor autostart and binds

The other runtime tools (cliphist, wl-clipboard, brightnessctl, playerctl, libqalculate, ffmpeg, compositor helpers) stay in your NixOS modules. Hyprland autostart in the Tanjun rice still starts Quickshell; you can call tanjun-quickshell manually instead.

Do not set QT_QUICK_BACKEND=software in Hyprland env = or shell export. Quickshell no longer forces it. On Hyprland + systemd/uwsm, session variables are copied into systemd --user and D-Bus activation (dbus-update-activation-environment, systemctl --user import-environment) so apps started from the Tanjun launcher inherit the same Qt env as the compositor. A global or compositor-wide software backend then breaks other Qt Quick apps (e.g. AmneziaVPN). Use VAR=value command only when you truly need a one-off override for that process.

Compositor integration on NixOS is the same as on Arch: rice lives in the checkout under compositors/, not inside the HM module.