My main NixOS configuration. Features include a polished Hyprland environment. A fully configured NeoVIM environment, QMK support. A Keyboard shortcut menu pop-down available in the top bar and so much more!
  • Nix 79%
  • Shell 15.7%
  • QML 3.2%
  • Python 1.9%
  • CSS 0.2%
Find a file
2025-12-03 14:00:49 -05:00
cheatsheets docs: document amd-hybrid profile and new driver module 2025-09-18 17:11:48 -04:00
hosts fix(install): show keyboardVariant/consoleKeyMap in summary and fix awk quoting 2025-12-02 23:04:12 -05:00
img Migrating 25.11 updates to Main branch b4 creating stable-2.5 2025-11-29 22:53:16 -05:00
modules UPDATE: services.tui.greetd changed to greetd 2025-12-03 11:08:00 -05:00
profiles flake/drivers/profiles: add amd-hybrid profile and amdgpuID host var 2025-09-18 17:09:01 -04:00
wallpapers +sddm.nix +doas.nix set sddm as default 2025-06-18 20:08:53 -05:00
.warp.md Indexed codebase 2025-09-10 09:52:09 -04:00
CHANGELOG.md Upd CHANGELOG, FAQ for v2.5.3 2025-12-03 11:16:09 -05:00
CODE_OF_CONDUCT.md Updated CONTRIBUTING format added CODE_OF_CONDUCT 2025-08-07 03:21:45 -04:00
CONTRIBUTING.md Updated discord link 2025-08-07 07:54:53 -04:00
FAQ.es.md Upd CHANGELOG, FAQ for v2.5.3 2025-12-03 11:16:09 -05:00
FAQ.md Upd CHANGELOG, FAQ for v2.5.3 2025-12-03 11:16:09 -05:00
flake.lock Migrating 25.11 updates to Main branch b4 creating stable-2.5 2025-11-29 22:53:16 -05:00
flake.nix Migrating 25.11 updates to Main branch b4 creating stable-2.5 2025-11-29 22:53:16 -05:00
install-zaneyos.sh install-zaneyos.sh Chg clone to stable-2.5.3 2025-12-03 14:00:49 -05:00
LICENSE.md Updated date and formatting for LICENSE 2025-08-07 03:37:59 -04:00
README.es.md Added overview feature 2025-11-30 23:23:32 -05:00
README.md Added overview feature 2025-11-30 23:23:32 -05:00
WARP.md Migrating 25.11 updates to Main branch b4 creating stable-2.5 2025-11-29 22:53:16 -05:00
zcli.es.md docs(i18n): align Spanish translations with English originals (TESTING-UPGRADE, UPGRADE-2.3-to-2.4, ZaneyOS-Upgrade, zcli) 2025-08-30 16:56:59 -04:00
zcli.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00

English | Español

ZaneyOS 🟰 Best ❄️ NixOS Configs

** Updated: November 28th,2025

ZaneyOS is a simple way of reproducing my configuration on any NixOS system. This includes the wallpaper, scripts, applications, config files, and more.

Important Note on Noctalia

The first time you login, screen will be blank SUPER + SHIFT + C to exit. Login in, noctalia will start from then on

📸 More Screenshots

Waybar Themes

Noctalia Shell Integration

Additional Features

Cheatsheets and Guides

Please note:

This project has a Wiki. Find out how to use ZaneyOS here! ddubs has put a lot of effort into the FAQ so it should be accurate. However, please if you notice that something is wrong with it create an issue or reach out to us on Discord.

🍖 Requirements

  • You must be running on NixOS, version 24.05+.
  • The zaneyos folder (this repo) is expected to be in your home directory.
  • You must have installed NIXOS using GPT parition with booting with UEFI.
  • ** 500MB minimum /boot partition required. **
  • Systemd-boot is what is supported.
  • For GRUB you will have to brave the internet for a how-to. ☺️
  • Manually editing your host specific files.
  • The host is the specific computer your installing on.

🎹 Pipewire & Notification Menu Controls

  • We are using the latest and greatest audio solution for Linux. Not to mention you will have media and volume controls in the notification center available in the top bar.

🏇 Optimized Workflow & Simple Yet Elegant Neovim

  • Using Hyprland for increased elegance, functionality, and efficiency.
  • No massive NeoVIM project here. This is my simple, easy to understand, yet incredible NeoVIM setup. With language support already added in.

🖥️ Multi Host & User Configuration

  • You can define separate settings for different host machines and users.
  • Easily specify extra packages for your users in the modules/core/user.nix file.
  • Easy to understand file structure and simple, but encompassing, configuration.

👼 An Incredible Community Focused On Support

  • The entire idea of ZaneyOS is to make NixOS an approachable space.
  • NixOS is actually a great community that you will want to be a part of.
  • Many people who are patient and happy to spend their free time helping you are running ZaneyOS.
  • Feel free to reach out on the Discord for any help with anything.

Please do yourself a favor and read the wiki.

📦 How To Install Packages?

  • You can search the Nix Packages & Options pages for what a package may be named or if it has options available that take care of configuration hurdles you may face.
  • To add a package there are the sections for it in modules/core/packages.nix and modules/core/user.nix. One is for programs available system wide and the other for your users environment only.

🙋 Having Issues / Questions?

  • Please feel free to raise an issue on the repo, please label a feature request with the title beginning with [feature request], thank you!

  • Contact us on Discord as well, for a potentially faster response.

  • Don't forget to checkout the FAQ

Hyprland Keybindings

Below are the keybindings for Hyprland, formatted for easy reference. The right column shows keybindings that are specific to Noctalia Shell (only available when barChoice = "noctalia").

Standard Keybindings

Application Launching

  • $modifier + Return → Launch terminal
  • $modifier + Tab → Toggle Quickshell Overview (workspace overview with live previews)
  • $modifier + K → List keybinds
  • $modifier + Shift + W → Open web-search
  • $modifier + Alt + W → Open wallsetter
  • $modifier + Shift + N → Run swaync-client -rs
  • $modifier + W → Launch Web Browser
  • $modifier + Y → Open kitty with yazi
  • $modifier + E → Open emopicker9000
  • $modifier + S → Take a screenshot
  • $modifier + Shift + D → Open Discord
  • $modifier + O → Launch OBS Studio
  • $modifier + Alt + C → Color Picker
  • $modifier + G → Open GIMP
  • $modifier + T → Toggle terminal with pypr
  • $modifier + Alt + M → Open pavucontrol

Window Management

  • $modifier + Q → Kill active window
  • $modifier + P → Toggle pseudo tiling
  • $modifier + Shift + I → Toggle split mode
  • $modifier + F → Toggle fullscreen
  • $modifier + Shift + F → Toggle floating mode
  • $modifier + Alt + F → Float all windows
  • $modifier + Shift + C → Exit Hyprland

Window Movement

  • $modifier + Shift + ← / → / ↑ / ↓ → Move left/right/up/down
  • $modifier + Shift + H / L / K / J → Move left/right/up/down
  • $modifier + Alt + ← / → / ↑ / ↓ → Swap left/right/up/down

Focus Movement

  • $modifier + ← / → / ↑ / ↓ → Move focus left/right/up/down
  • $modifier + H / L / K / J → Move focus left/right/up/down

Workspaces

  • $modifier + 1-10 → Switch to workspace 1-10
  • $modifier + Shift + Space → Move window to special workspace
  • $modifier + Space → Toggle special workspace
  • $modifier + Shift + 1-10 → Move window to workspace 1-10
  • $modifier + Control + → / ← → Switch workspace forward/backward

Window Cycling

  • Alt + Tab → Cycle to next window / Bring active to top

🎨 Noctalia Shell Keybindings

Available when barChoice = "noctalia" in variables.nix

  • $modifier + D → Launcher Toggle
  • $modifier + Shift + Return → Launcher Toggle
  • $modifier + M → Notifications Menu
  • $modifier + V → Clipboard Manager
  • $modifier + Alt + P → Settings Panel
  • $modifier + Shift + , → Settings Panel
  • $modifier + Alt + L → Lock Screen
  • $modifier + Shift + Y → Wallpaper Manager
  • $modifier + X → Power Menu
  • $modifier + C → Control Center
  • $modifier + Ctrl + R → Screen Recorder

Rofi Launcher (Waybar Mode)

Available when barChoice = "waybar" in variables.nix

  • $modifier + D → Launch Rofi Launcher
  • $modifier + Shift + Return → Launch Rofi Launcher

Other Features

  • $modifier + Shift + Return (Waybar) → Application Launcher
  • $modifier + V (Waybar) → Clipboard History via cliphist

Installation:

⚠️ IMPORTANT: These installation methods are for NEW INSTALLATIONS ONLY. If you already have ZaneyOS installed and want to upgrade to v2.4, see the Upgrade Instructions below. Note: There is an issue with upgrade script. It's been removed until it's fixed.

⬇️ Install with script (NEW INSTALLATIONS ONLY)

📜 Script:

This is the easiest and recommended way of starting out for new installations. The script is not meant to allow you to change every option that you can in the flake or help you install extra packages. It is simply here so you can get my configuration installed with as little chances of breakages and then fiddle to your hearts content!

⚠️ WARNING: This script will completely replace any existing ~/zaneyos directory. Do NOT use this if you already have ZaneyOS installed and configured.

Simply copy this and run it:

ZaneyOS First Install Command

nix-shell -p git curl pciutils

Then:

ZaneyOS Install Script Command

sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/stable-2.4/install-zaneyos.sh)

The install process will look something like this:

First Part Of Install

Second Part Of Install

After the install completes your environment will probably look broken. Just reboot and you will see this as your login:

Display Manager

Then after login you should see a screen like this:

Desktop Example

🦽 Manual install process:
  1. Run this command to ensure Git & Vim are installed:
nix-shell -p git vim
  1. Clone this repo & enter it:
cd && git clone https://gitlab.com/zaney/zaneyos.git -b stable-2.4 --depth=1 ~/zaneyos
cd zaneyos

You can still run the `install.sh` script if you want to.
  • You should stay in this folder for the rest of the install
  1. Create the host folder for your machine(s) like so:
cp -r hosts/default hosts/<your-desired-hostname>
git add .
  1. Edit hosts/<your-desired-hostname>/variables.nix.

  2. Edit flake.nix and fill in your username, profile, and hostname.

  3. Generate your hardware.nix like so:

nixos-generate-config --show-hardware-config > hosts/<your-desired-hostname>/hardware.nix
  1. Run this to enable flakes and install the flake replacing hostname with profile. I.e. intel, nvidia, nvidia-laptop, amd-hybrid, or vm
NIX_CONFIG="experimental-features = nix-command flakes"
sudo nixos-rebuild switch --flake .#profile

Now when you want to rebuild the configuration you have access to an alias called fr that will rebuild the flake and you do not have to be in the zaneyos folder for it to work.

Upgrading from ZaneyOS 2.3 to 2.4 -- At this time do NOT user the upgrade script

🚀 IMPORTANT: If you already have ZaneyOS 2.3 installed, use the automated upgrade system instead of reinstalling!

✅ Automated Upgrade Process:

ZaneyOS includes a comprehensive upgrade system that safely migrates your configuration:

cd ~/zaneyos
./upgrade-2.3-to-2.4.sh

🔍 What the Upgrade System Does:

  1. Pre-Upgrade Analysis - Comprehensive scan of your customizations
  2. Complete Backup - Full backup of your current configuration
  3. Automatic Migration - Preserves all your settings and customizations
  4. Safe Upgrade - Uses boot option to prevent display manager conflicts
  5. Easy Revert - One-command rollback if needed

📋 What Gets Automatically Migrated:

  • ✅ All host configurations and variables
  • ✅ Hardware configurations
  • ✅ Custom packages (both global and per-host)
  • ✅ Themes, wallpapers, and monitor settings
  • ✅ Git configuration and personal settings
  • ✅ Terminal preferences with automatic enabling

⚠️ What Requires Manual Attention:

  • Custom flake.nix inputs
  • Personal shell configuration files (zshrc-personal.nix, etc.)
  • Custom module modifications

📚 Complete Documentation:

For detailed upgrade instructions, troubleshooting, and safety information:

  • Read: UPGRADE-2.3-to-2.4.md in your zaneyos directory
  • Analysis Report: Saved automatically as ~/zaneyos-upgrade-analysis-TIMESTAMP.txt

🔄 Easy Revert:

If anything goes wrong, easily revert to 2.3:

cd ~/zaneyos
./upgrade-2.3-to-2.4.sh --revert

Special Recognitions:

Thank you for all your assistance

Hope you enjoy!