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
Don Williams 6882f1069e upgrade: handle dirty worktrees and missing local main; avoid false success
Problem: Upgrades often run on repos with uncommitted changes and no local 'main' branch. Previous logic tried 'git checkout main && git pull', failed (pathspec main; divergent pull), but still printed success and proceeded, so systems didn’t actually build 2.4.

Fixes:\n- Add switch_to_main_handling_dirty():\n  • Detect dirty tree and prompt: [S]tash (default), [D]iscard, [A]bort.\n  • Ensure local 'main' exists from origin/main (git checkout -B main origin/main).\n  • Use git pull --ff-only; on divergence, prompt to reset to origin/main or abort.\n- Replace unconditional success print with conditional success only after branch operations succeed.\n- Keep prior duplicate-key cleanup for variables.nix (stylixImage, animChoice, waybarChoice).

Result: Robust branch switch that works even with uncommitted changes and absent local main; no more false success messages. Users who don’t commit/push changes can still upgrade reliably via stash or discard paths.
2025-08-30 18:58:35 -04:00
cheatsheets docs: add project guide and minimal agent stub 2025-08-30 15:06:45 -04:00
hosts Updated changelog and upd instructions on doom emacs 2025-08-30 16:37:56 -04:00
img Delete ZaneyOS-v2.3-demo-video.mp4 2025-04-05 06:55:49 +00:00
modules Fixed fastfetch to show system version dynamically 2025-08-30 18:17:49 -04:00
profiles Updated NIX file to nix formatting standard 2025-08-02 11:40:41 -04:00
wallpapers +sddm.nix +doas.nix set sddm as default 2025-06-18 20:08:53 -05:00
.warp.md docs: add project guide and minimal agent stub 2025-08-30 15:06:45 -04:00
CHANGELOG.md Updated changelog and upd instructions on doom emacs 2025-08-30 16:37:56 -04:00
CODE_OF_CONDUCT.md Updated CONTRIBUTING format added CODE_OF_CONDUCT 2025-08-07 03:21:45 -04:00
compare-zaneyos-config.sh 🔍 Advanced Git Comparison System for ZaneyOS Configurations 2025-08-19 14:09:21 -04:00
CONTRIBUTING.md Updated discord link 2025-08-07 07:54:53 -04:00
FAQ.es.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00
FAQ.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00
flake.lock Merge branch 'main' into ddubs-dev 2025-08-30 15:13:02 -04:00
flake.nix Deduplicate nixosConfigurations in flake.nix with mkNixosConfig; preserve profile for installer/zcli 2025-08-29 18:36:09 -04:00
install-zaneyos.sh chore(install): pull from main branch in install script 2025-08-30 15:50:55 -04:00
LICENSE.md Updated date and formatting for LICENSE 2025-08-07 03:37:59 -04:00
README.es.md docs(i18n): update README.es.md to match README.md (full Spanish translation with images) 2025-08-30 16:54:44 -04:00
README.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00
revert-to-2.3.sh Add comprehensive ZaneyOS 2.3 to 2.4 upgrade system 2025-08-16 14:55:12 -04:00
TESTING-UPGRADE.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
TESTING-UPGRADE.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00
UPGRADE-2.3-to-2.4.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
UPGRADE-2.3-to-2.4.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04:00
upgrade-2.3-to-2.4.sh upgrade: handle dirty worktrees and missing local main; avoid false success 2025-08-30 18:58:35 -04:00
ZaneyOS-Upgrade.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
ZaneyOS-Upgrade.md docs(i18n): add English↔Español language switch links at top of translated docs 2025-08-30 16:23:40 -04: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: June 3rd,2025

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

Inspiration for the Waybar config here.

Third waybar option

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 23.11+.
  • 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.

Application Launching

  • $modifier + Return → Launch terminal
  • $modifier + K → List keybinds
  • $modifier + Shift + Return → Launch rofi-launcher
  • $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 + D → Open Discord
  • $modifier + O → Launch OBS Studio
  • $modifier + C → Run hyprpicker -a
  • $modifier + G → Open GIMP
  • $modifier + V → Show clipboard history via cliphist
  • $modifier + T → Toggle terminal with pypr
  • $modifier + 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 window left/right/up/down
  • $modifier + Shift + H / L / K / J → Move window left/right/up/down
  • $modifier + Alt + ← / → / ↑ / ↓ → Swap window left/right/up/down
  • $modifier + Alt + 43 / 46 / 45 / 44 → Swap window 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
  • Alt + Tab → Bring active window to top

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.

⬇️ 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.3/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.3 ~/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, 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

🚀 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!