diff --git a/.warp.md b/.warp.md new file mode 100644 index 0000000..c9682bb --- /dev/null +++ b/.warp.md @@ -0,0 +1,11 @@ +# WARP.md + +This file provides guidance to WARP (warp.dev) when working with code in this repository. + +Agent entrypoint +- Start with WARP.md (primary project rules and workflows for agents). +- For extended quick refs and workflows, see cheatsheets/project-guide.md. + +Maintenance note +- Keep both WARP.md and cheatsheets/project-guide.md current. +- Prefer updating WARP.md for canonical rules; use the project guide for quick commands. diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d5052d..269eda2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,45 +1,1211 @@ -## 🗒️ Changelog +# 📋 ZaneyOS Changelog -**ZaneyOS 2.0** +> ** ✨ A comprehensive history of changes, improvements, and updates to +> ZaneyOS** -With this new update of ZaneyOS it is a big rewrite of how things are being done. This update fixes many issues that you guys were facing. As well as makes things a little easier to understand. You now have a lot being stored inside the specific host directory, making use of modules, condensing seperate files down, etc. -My hope is that with this update your ability to grasp the flake and expand it to what you need is much improved. I want to thank everyone for being so supportive! +--- -- Most configuration put into specific hosts directories for the best portability. -- Using modules to condense configuration complexity. -- Simplified options and the complexity around understanding their implementation. -- Rewrote the documentation for improved readability. +# 🚀 **Current Release - ZaneyOS v2.6.1** -**ZaneyOS 2.1** +- Removed `discord` and `discord-canary` + - They use an outdated `electron` + - That build uses and `openssl v1.1.1w` + - That ius OEL and marked insecure in NIXOS + - Users can use an alternativve client until discord is updated +- Disabled `zen browser` in `zaneyos/modules/home/default.nix` + - Needs to be migrated to being enabled via host variable +- Changed from `zen` to `latest` kernel + - Linux kernel v7.0 is much better than 6.19_zen +- Disabled `vfr = true;` in hyprland config + - It's not supportorted after `v54.3` + - Disabling now to avoid error on next update +- Added `awww` as flake input for installs < 25.11 +- Fixed eval warnings: + - `gtk.gtk4.theme` set to `null` + - `git.signing.format` set to `null` +- `nixvim` lualine theme set to `auto` +- Changed to NixOS unstable branch +- Ported `DropTerminal` from `KoolDots` to ZaneyOS + - Replaces pyprland and some python dependencies +- Hyprland updated to v0.54 + - Added support for scrolling and monocle layouts + - Fixed hyprland float-all bindings + - Updated Window Rules for new Hyprland format +- Disabled steam by default +- Removed `adb.enable` no longer supported and not needed for ZaneyOS +- Changed `nixfmt-rfc-style` package for updated `nitfmt` + - `nixfmt-rfc-style` no longer supported +- Fixed other evaluation warnings with `Xorg` package changes -Simple bug fixes. +# 🚀 **Current Release - ZaneyOS v2.6.0** -- Fixed Waybar icons to make them look a bit better. -- Centered the Wofi window always. -- Should have fixed some Steam issues, but I have had some crashes due to Steam so be aware of that. -- The flake got an update, so all the packages are fresh. +#### 📅 **Updated: April 3rd, 2026** -**ZaneyOS 2.2** +- Swapped `awww` for `swww` + - `swww` is no longer maintained + - removed `--format xrgb` flag also no needed -This release has a big theming change as well as including the move back to rofi. It is a massive improvement in many ways. +#### 📅 **Updated: February 19th, 2026** +- Fixed `zcli` GPU detection for newer AMD GPUs + - Fixed the fix to properly detect VMs +- `nixvim.nix` changes + - Disabled Zig language server + - Disabled marksman language server + - Caused dotnet lib to be compiled (takes hours) + +#### 📅 **Updated: February 16th, 2026** + +- Removed `hyprpanel` + - No longer maintained + - Vendor created `wayle` to replace it + - Replaced in ZaneyOS with 'noctalia-shell' + +- `webkitgtk` being built from source + - Removed audacity is called `wxwidgets` + - Created overlay for `tumbler` to disable `libepub` + - These caused the build from source issue + - Building `webkitgtk` takes hours every rebuild/update + +#### 📅 **Updated: January 31st, 2026** + +- Changed default login manager to `TUI` + - Issues recently (again) with SDDM and some GPUs + - Often related to SDDM wayland support option + - Some GPUs need it enabled, others disabled + +#### 📅 **Updated: January 28th, 2026** + +- Disabled gnome in stylix. Caused install failure + +#### 📅 **Updated: January 26th, 2026** + +- `noctalia-shell` regression: + - Removed `noctalia-shell` systemd service + - Caused old version of `noctalia-shell` + - Adjusted `noctalia-shell` bindings to match change +- Default applications now settable + - Globally for all hosts + - `zaneyos/modules/home/xdg.nix` + - Per host + - `zaneyos/hosts/HOSTNAME/variables.nix` + - Host settings override `xdg.nix` settings + +#### 📅 **Updated: January 23rd, 2026** + +- Added additional fonts +- Fixed issue with Hypridle and Home Manager + - Added `systemdTarget = "hyprland-session.target";` + - Thank you `Yang Kexuan` for the fix + - Reference issue: [5899](https://github.com/nix-community/home-manager/issues/5899) + +#### 📅 **Updated: January 5th, 2026** + +- Removed extra newline in `exec-once.nix` +- Fixed typo in `noctalia.nix` +- Added docs reference per systemd spec +- Improved code overall + - Thanks `lichen.gel.calm` for finding these issues +- Disabled `noctalia-shell` systemd service + - Caused older revision of `noctalia-shell` to load + - Now started from hyprland + +#### 📅 **Updated: December 29th, 2025** + +- Removed extra `noctalia-shell` startup +- Added initial support for AMD, NVIDIA Hybrid laptops +- Keypress to recover from DPMS now enabled by default + +#### 📅 **Updated: December 21st, 2025** + +- Added user systemd service for `noctalia-shell` +- Updated Hyprland bindings to accomodate change +- Updated `nixvim` + +## `nixvim` Features Migrated from Bugsvim + +#### Custom Diagnostic Icons + + ```lua + Error = " " + Warn = " " + Hint = "" + Info = "" + ``` + - Custom unicode symbols for each diagnostic severity level + - Integrated into vim.diagnostic.config() for gutter display + +#### Diagnostic Display Options + + - **Sign Column**: Shows diagnostic icons in the gutter with custom text and highlight groups + - **Virtual Text**: Inline diagnostics with custom prefix (`●`) and 2-space spacing + - **Virtual Lines**: Enhanced visibility for error context without cluttering + - **Underline**: Visual underline for error locations + - **Floating Window**: Hover diagnostics with rounded borders and source attribution + - **Severity Sorting**: Errors prioritized over warnings + +### 2. Text Yank Highlighting + + **Migration**: Highlight yanked text for 200ms (IncSearch highlight group) + - Autocmd-based implementation in extraConfigLua + - Uses vim.hl.on_yank for smooth visual feedback + +### 3. LSP Attachment Keybindings + + **Enhanced LSP Integration** with on-attach callbacks: + ``` + K - Hover documentation + gd - Goto definition + gD - Goto declaration + gi - Goto implementation + gr - References + rn - Rename symbol + ca - Code action + ``` + - Buffer-local scope prevents global pollution + - Guard against multiple registrations with flag check + +### 4. Startup Dashboard + + **Migration**: alpha-nvim with custom banner generation + +#### Dynamic Header Generation + + - Primary: `toilet -f ansi-shadow NIXOS` + - Secondary: `figlet -f "ANSI Shadow" NIXOS` + - Tertiary: `figlet NIXOS` + - Fallback: ASCII art banner (9 lines) + +#### Dashboard Buttons + + | Shortcut | Action | Command | + |----------|--------|---------| + | `f` | Find file | Telescope find_files | + | `r` | Recent files | Telescope oldfiles | + | `g` | Live grep | Telescope live_grep | + | `n` | New file | :enew | + | `e` | File browser | Neotree toggle | + | `q` | Quit | :qa | + +#### Footer + + Dynamic version display: `NixVim • Neovim X.Y.Z` + +### 5. Theme Integration + + **Migration**: Tokyo Night colorscheme with Stylix integration + - Tokyo Night colors for status line (lualine) + - Notify background color tied to Stylix palette: `#${config.lib.stylix.colors.base01}` + - Consistent color management across UI components + +## Comprehensive Feature Set + +### UI/Visuals Migrated + + - Lualine status line (Tokyo Night theme) + - Bufferline for buffer management + - Indent-blankline for visual indentation + - Colorizer for inline color display + - Illuminate for reference highlighting + - Which-key for keybinding discovery (Helix preset) + +### Core Editing + + - Treesitter for syntax highlighting + - Neo-tree file browser + - Telescope fuzzy finder with media_files extension + - Project.nvim for project management + - Hop/Leap motion plugins + - vim-surround for text manipulation + - Comment.nvim for toggle comments + +### Advanced Features + + - snacks.nvim ecosystem (terminal, scratch buffers, zen mode, git integration, notifier) + - Noice for enhanced UI/messages + - Notify for notifications + - todo-comments for task navigation + - nvim-autopairs with Treesitter support + +### Language Support + + **LSP Servers**: nil_ls, lua_ls, pyright, ts_ls, html, cssls, clangd, zls, marksman, hyprls, tailwindcss, bashls + + **Formatters**: + - Nix: alejandra + - Lua: stylua + - JavaScript/TypeScript: prettierd + - Shell: shfmt + + **Completion**: blink-cmp with luasnip snippets + +### Development Tools + + - Git integration: gitsigns + diffview + - Markdown preview + - Trouble diagnostics panel + - Terminal: toggleterm with float direction + +## Implementation Details + +### Module Structure + + - **File**: `modules/home/editors/nixvim.nix` (743 lines) + - **Framework**: Nixvim home-manager module + - **Theme**: Tokyo Night (primary), Catppuccin (fallback) + - **Runtime Tools**: 23+ packages (bat, chafa, fd, figlet, lazygit, prettierd, ripgrep, etc.) + +## Keybinding Highlights + + ``` + jk - Exit insert mode + ff - Find files + fm - Find media files + lg - Live grep + fe - File explorer toggle + t - Toggle terminal + . - Toggle comment (line/visual) + z - Zen mode + Z - Zoom + gg - Lazygit + - Terminal (via snacks) + ]t / [t - Next/prev TODO comment + n - Notification history + ``` + +#### 📅 **Updated: December 21st, 2025** + +- Added user systemd service for `noctalia-shell` +- Updated Hyprland bindings to accomodate change +- Updated `nixvim` + +## `nixvim` Features Migrated from Bugsvim + +#### Custom Diagnostic Icons + + ```lua + Error = " " + Warn = " " + Hint = "" + Info = "" + ``` + - Custom unicode symbols for each diagnostic severity level + - Integrated into vim.diagnostic.config() for gutter display + +#### Diagnostic Display Options + + - **Sign Column**: Shows diagnostic icons in the gutter with custom text and highlight groups + - **Virtual Text**: Inline diagnostics with custom prefix (`●`) and 2-space spacing + - **Virtual Lines**: Enhanced visibility for error context without cluttering + - **Underline**: Visual underline for error locations + - **Floating Window**: Hover diagnostics with rounded borders and source attribution + - **Severity Sorting**: Errors prioritized over warnings + +### 2. Text Yank Highlighting + + **Migration**: Highlight yanked text for 200ms (IncSearch highlight group) + - Autocmd-based implementation in extraConfigLua + - Uses vim.hl.on_yank for smooth visual feedback + +### 3. LSP Attachment Keybindings + + **Enhanced LSP Integration** with on-attach callbacks: + ``` + K - Hover documentation + gd - Goto definition + gD - Goto declaration + gi - Goto implementation + gr - References + rn - Rename symbol + ca - Code action + ``` + - Buffer-local scope prevents global pollution + - Guard against multiple registrations with flag check + +### 4. Startup Dashboard + + **Migration**: alpha-nvim with custom banner generation + +#### Dynamic Header Generation + + - Primary: `toilet -f ansi-shadow NIXOS` + - Secondary: `figlet -f "ANSI Shadow" NIXOS` + - Tertiary: `figlet NIXOS` + - Fallback: ASCII art banner (9 lines) + +#### Dashboard Buttons + + | Shortcut | Action | Command | + |----------|--------|---------| + | `f` | Find file | Telescope find_files | + | `r` | Recent files | Telescope oldfiles | + | `g` | Live grep | Telescope live_grep | + | `n` | New file | :enew | + | `e` | File browser | Neotree toggle | + | `q` | Quit | :qa | + +#### Footer + + Dynamic version display: `NixVim • Neovim X.Y.Z` + +### 5. Theme Integration + + **Migration**: Tokyo Night colorscheme with Stylix integration + - Tokyo Night colors for status line (lualine) + - Notify background color tied to Stylix palette: `#${config.lib.stylix.colors.base01}` + - Consistent color management across UI components + +## Comprehensive Feature Set + +### UI/Visuals Migrated + + - Lualine status line (Tokyo Night theme) + - Bufferline for buffer management + - Indent-blankline for visual indentation + - Colorizer for inline color display + - Illuminate for reference highlighting + - Which-key for keybinding discovery (Helix preset) + +### Core Editing + + - Treesitter for syntax highlighting + - Neo-tree file browser + - Telescope fuzzy finder with media_files extension + - Project.nvim for project management + - Hop/Leap motion plugins + - vim-surround for text manipulation + - Comment.nvim for toggle comments + +### Advanced Features + + - snacks.nvim ecosystem (terminal, scratch buffers, zen mode, git integration, notifier) + - Noice for enhanced UI/messages + - Notify for notifications + - todo-comments for task navigation + - nvim-autopairs with Treesitter support + +### Language Support + + **LSP Servers**: nil_ls, lua_ls, pyright, ts_ls, html, cssls, clangd, zls, marksman, hyprls, tailwindcss, bashls + + **Formatters**: + - Nix: alejandra + - Lua: stylua + - JavaScript/TypeScript: prettierd + - Shell: shfmt + + **Completion**: blink-cmp with luasnip snippets + +### Development Tools + + - Git integration: gitsigns + diffview + - Markdown preview + - Trouble diagnostics panel + - Terminal: toggleterm with float direction + +## Implementation Details + +### Module Structure + + - **File**: `modules/home/editors/nixvim.nix` (743 lines) + - **Framework**: Nixvim home-manager module + - **Theme**: Tokyo Night (primary), Catppuccin (fallback) + - **Runtime Tools**: 23+ packages (bat, chafa, fd, figlet, lazygit, prettierd, ripgrep, etc.) + +## Keybinding Highlights + + ``` + jk - Exit insert mode + ff - Find files + fm - Find media files + lg - Live grep + fe - File explorer toggle + t - Toggle terminal + . - Toggle comment (line/visual) + z - Zen mode + Z - Zoom + gg - Lazygit + - Terminal (via snacks) + ]t / [t - Next/prev TODO comment + n - Notification history + ``` + +#### 📅 **Updated: December 21st, 2025** + +- Updated: + - `nixvim.nix` now uses `blink-cmp` for completion/suggestions + - This replaces `nvim-cmp` + - `blink-cmp` is better, integrated in nixvim + - Removed LUA code related to `nvim-cmp` + +- Fixed: + - Output of `zcli list-gens` corrected + - Thanks `@codingismy11to71` + +#### 📅 **Updated: December 14th, 2025** + +- Fixed: +- hyprlock background image +- `--diff-always` to `nh` rebuilds +- Removed extra `Ghz` in `fastfetch` output +- Fixed hard coded directory for cheatsheets path +- Removed hard coded title +- Focus follows mouse + - Consistent with hyprland +- Turned off resize overlay +- Added curosr wrap shader + - Thanks to Steven Scott for the fixes + +#### 📅 **Updated: December 12th, 2025** + +- Fixed: + - `Weather.py` script + - Start menu in waybars +- Ported from ddubsos: + - `kitty-bg` and `ghostty-bg` + - Adds random backgrounds to terminals + - Custom Quickshell logout menu + - Custom startmenu + - Custom logout menu + - Quickshell wallpaper apps + - One for images, one for video wallpapers + - `ly` login manager + - `nwg-dock-hyprland.nix` + - `SUPERCTRL+D` to toggle +- Added: + - More wallpapers + - Video wallpapers + +#### 📅 **Updated: December 9th, 2025** + +- Notifcation history binding had wrong keyword + - Thanks to Kexuan Yang for fixing it + +#### 📅 **Updated: December 7th, 2025** + +- Added `alejandra` formatter to `flake.nix` + - ran `nix fmt ./` and updated all files to current format spec +- Added `alejandra` as default formatter in `nixvim.nix` +- Hybrid GPU detection fails in `install-zaneyos.sh` + - Should be `nvidia-laptop` not `hybrid` + - Thanks to sasek @sasek333 for spotting this + +#### 📅 **Updated: December 6th, 2025** + +- Changed: + - Quickshell now comes fromm NixPkgs. + - No more compiling on rebuilds + - Remove Flake input and input in `quickshell.nix` + +#### 📅 **Updated: December 3rd, 2025** + +- Added: + - Cheatsheets from ddubsOS + - Covers, terminals, emacs, etc + - In English and Spanish + - Zen browser + - Via Flake, for current builds + - Nano customized config +- Pinned: `nixvim` to v25.11 branch +- Added: Support for `kb_variants` at install time. + - Keyboards, like `dvorak`, `coleman,` or `euro` + - Configures, console, SDDM and Hyprland +- Fixed: TUI greetd service name changed to `services.greetd` +- Updated: + - `cachix settings updated for better speed + - Moved to its own `cacheix.nix` file + +#### 📅 **Updated: December 1st, 2025** + +- Added: System keybinds search tool from ddubsOS + - Shows bindings for: + - Hyprland, kitty, wezterm, ghostty, emacs and yazi + - SUPER + K to invoke + - SUPER + SHIFT + K for legacy keybind rofi menu +- Fixed: Added power profiles daemon for noctalia +- Fixed: `gpu-screen-recorder` not installed + - Thanks to `@mugdad11` for finding them +- Fixed: Both rofi and noctalia clipboard + - Both were active on `SUPER + V` + - Now checks for waybar or noctalia shell + - Thanks to `@mugdad11` for finding it +- Fixed: Laptop battery not showing in noctalia shell + - Thanks again `@mugdad11` for finding issue + - And doing the Merge Request to fix it + - `upower` package not installed and `upower` service not enabled + +- NEW: Added `quickshell-overview` integration + - Workspace overview with live window previews + - Toggled via `SUPER + TAB` keybind + - Drag-and-drop workspace navigation + - Uses IPC for seamless integration with Hyprland + - QML code managed via Home Manager activation script +- FIXED: Username wasn't reliably being set in `flake.nix` +- Set ZaneyOS to NixOS v25.11 stable branch +- Moved to `nixvim` for NeoVIM configuration + - Works better + - Fewer issues vs. `nvf.nix` + - `nvf.nix` still included, but commented out +- Added `alacritty.nix` from ddubsOS +- Added `tmux.nix` from ddubosOS (courtesy of Tony,btw) +- Added `vscode.nix` from ddubsOS. + - Pre-configured with many useful plugins + - Also works as template to add more +- Added `antigravity` IDE from Google based on vscodium +- Created `modules/core/overlays.nix` + - Currently only has `antigravity` but more maybe be needed later +- Fixed gestures errors from Hyprland Upgrade +- Added Noctalia Shell as default +- Added Additional waybars from dddubsOS +- Added Addtional Animations from ddubsOS +- Switched to `bindd` for friendlier keybinds descriptions +- Updated keybind parser to use these descriptions +- Keybinds are now conditional on waybar or noctalia shell +- Updated `README.md` and `README.es.md` + - New screenshots + - Updated Keybindings + - Moved screenshots into a markdown suummary to reduce clutter +- Added script to fix `doom iedit` update error +- Moved some modules/home/\*.nix files to their own subdir + - Terminals + - Alacritty + - ghostty + - Kitty + - tmux + - Wezterm + - Editors + - antigravity + - emacs + - evil-helix + - nixvim + - nvf + - vscode + - CLI/Utils + - bat + - Btop + - Bottom + - cava + - fzf + - git + - gh + - lazygit + + Contributors: `@mugdad11` + +#### 📅 **Updated: September 18th, 2025** + +- 🧪 EXPERIMENTAL: AMD+NVIDIA hybrid support (amd-hybrid) + - New driver module: `modules/drivers/nvidia-amd-hybrid.nix` (options: + `enable`, `amdgpuBusID`, `nvidiaBusID`) + - Kernel pin: `boot.kernelPackages` forced to `linuxPackages_6_12` when + enabled (required for RTX 50xx open kernel module) + - New profile: `profiles/amd-hybrid/default.nix` (wires `amdgpuID`/`nvidiaID` + from `hosts//variables.nix`) + - zcli detection updated to recognize `amd-hybrid`; `install-zaneyos.sh` + prompts include `amd-hybrid` + - Added `amdgpuID` to `hosts/*/variables.nix` + - Docs updated (`README`, `WARP.md`, cheatsheets) + - Caution: Can't fully test at this time. Please verify your Bus IDs via + `lspci` and use `zcli rebuild-boot` for safer activation + +#### 📅 **Updated: September 9th, 2025** + +- 🛡️ Installer: Added defensive hostname validation and sanitization + - Prevents invalid hostnames (e.g., with dots) from causing Nix evaluation + errors + - Auto-sanitizes to a compliant hostname (letters/digits with '-' or '\_', 1–63 + chars) and prompts for confirmation + - Explicitly rejects 'default' to avoid template overwrites +- 🧩 Nix: Added assertion in modules/core/network.nix for clearer errors if an + invalid hostname is provided + +#### 📅 **Updated: August 30th, 2025** + +- Merged `dev` branch to `main` in preparation of v2.4 release +- SDDM is now default, but you can change back to TUI greetd +- Now the `hosts/HOSTNAME/variables.nix` has options to enable apps and features + +```nix +# Set Displau Manager + # `tui` for Text login + # `sddm` for graphical GUI (default) + # SDDM background is set with stylixImage + displayManager = "sddm"; + + # Emable/disable bundled applications + tmuxEnable = false; + alacrittyEnable = false; + weztermEnable = false; + ghosttyEnable = false; + vscodeEnable = false; + # Note: This is evil-helix with VIM keybindings by default + helixEnable = false; + #To install: Enable here, rebuild, then run zcli doom install + doomEmacsEnable = false; +``` + +- As a result of this change, you can't just `git pull` and rebuild +- The new variables and other changes will cause the build to fail +- If you are on `zaneyos v2.3` read the upgrade documentation +- Began process to translate documents into Spanish (Machine translated) +- README.es.md +- FAQ.es.md +- ZaneyOS-Upgrade.es.md +- TESTING-UPGRADE.es.md +- UPGRADE-2.3-to-2.4.es.md +- zcli.es.md +- Added `~/zaneyos/cheatsheets/project-guide.md` +- This is an overview of how ZaneyOS is laid out + +#### 📅 **Updated: August 21st, 2025** + +- 📚 **Cheatsheets Library**: Centralized, human-friendly docs under + `cheatsheets/` + - 🔗 Quick Links and directory tree in `cheatsheets/README.md` + - 🧩 Topics added: + - ✍️ Emacs — Getting started, File Explorer, Code Completion, Magit, + Markdown + - 🖥️ Terminals — Ghostty, Tmux, Alacritty, Kitty, WezTerm + - 🪟 Hyprland — Keybindings (SUPERKEY notation) and Window Rules + - 📂 Yazi — Keymap (navigation, selection, search, tabs, modes) + +#### 📅 **Updated: August 20th, 2025** + +- 📝 **Note Management Enhancement**: Added `note-from-clipboard` script and XDG + compliance improvements + - 🚀 **Clipboard Integration**: One-command clipboard text capture using + existing `note` infrastructure + - 🎯 **Smart Content Detection**: Automatically detects text/plain clipboard + content vs images/other formats + - 📮 **Desktop Notifications**: Comprehensive user feedback for success, + failure, and skipped operations + - ⚡ **Instant Timestamping**: Leverages existing colorful note system with + automatic timestamp generation + - 🛡️ **Non-destructive**: Only processes text content, safely ignores non-text + clipboard data + - 💻 **Terminal Ready**: Available system-wide via PATH after rebuild + - 📁 **XDG Compliance**: Notes now saved to `~/.local/share/notes/notes.txt` + following XDG Base Directory Specification + - 🔍 **File Location Display**: Shows full file path in output to prevent user + confusion about note storage location + - 🛠️ **Auto-Directory Creation**: Creates notes directory automatically on + first use + +#### 📅 **Updated: August 19th, 2025** + +- 🔄 **Upgrade System Enhancement**: Comprehensive upgrade infrastructure for + ZaneyOS 2.3 → 2.4 migrations + - 🚀 **Automated Upgrade Script**: `upgrade-2.3-to-2.4.sh` with complete + migration automation + - 💾 **Complete Backup System**: Timestamped backups with organized storage + in `~/.config/zaneyos-backups/` + - 🔍 **Version Validation**: Automatic detection of ZaneyOS 2.3 vs 2.4+ to + prevent incorrect upgrades + - 🧬 **Variable Migration**: Comprehensive migration of 15+ configuration + variables from 2.3 to 2.4 format + - 🖥️ **Terminal Dependency Handling**: Automatic enabling of terminal + applications (critical for 2.4 compatibility) + - 🎨 **Theme Preservation**: Migration of stylixImage, waybarChoice, + animChoice, and monitor settings + - 🛡️ **Safe Build Process**: Uses `boot` instead of `switch` to prevent SDDM + display manager conflicts + - 📝 **Comprehensive Logging**: Detailed logs with timestamps for + troubleshooting + - ↩️ **One-Command Revert**: `revert-to-2.3.sh` and + `upgrade-2.3-to-2.4.sh --revert` for easy rollback + - 📚 **Complete Documentation**: `UPGRADE-2.3-to-2.4.md` with detailed + instructions and troubleshooting + - ⚠️ **Legacy Documentation**: Updated `ZaneyOS-Upgrade.md` to deprecate + manual process and redirect to automated system + - 🔧 **Hardware Preservation**: Automatic migration of hardware.nix and + host-specific configurations + - 🎯 **User Experience**: Interactive prompts, colored output, progress + indicators, and clear error messages + +- 🛠️ **ZCLI Enhancement v1.0.2**: Major upgrade to the ZaneyOS CLI utility with + comprehensive new features + - 🔥 **Doom Emacs Management**: Complete lifecycle management for Doom Emacs + - 🚀 `doom install` - Automated installation using get-doom script with all + required packages + - ✅ `doom status` - Installation verification with version information + display + - 🗑️ `doom remove` - Safe removal with confirmation prompts to prevent + accidents + - 🔄 `doom update` - Package and configuration updates via doom sync + - ⚙️ **Advanced Build Options**: Enhanced command-line arguments for precise + control + - 🔍 `--dry, -n` - Preview mode showing planned changes without execution + - ❓ `--ask, -a` - Interactive confirmation prompts for safety-critical + operations + - 💻 `--cores N` - CPU core limiting for VMs and resource-constrained + systems + - 📋 `--verbose, -v` - Detailed operation logging and verbose output + - 🎯 `--no-nom` - Disable nix-output-monitor for traditional output + - 🏠 **Enhanced Host Management**: Improved host configuration tools + - ➕ `add-host` - Create new host configurations with automated GPU + detection + - ➖ `del-host` - Safely remove host configurations with confirmation + prompts + - 🔄 `update-host` - Enhanced hostname/profile updating with validation + - 🧹 **System Maintenance**: Improved cleanup and diagnostic capabilities + - 🗂️ Automated log cleanup for old build logs during cleanup operations + - 🛠️ Enhanced diagnostic reporting with comprehensive system information + - ✂️ Safer trim operations with user confirmation prompts + - 🛡️ **Safety Features**: Built-in safeguards and error handling + - 🔒 Multiple confirmation prompts for destructive operations + - 📝 Comprehensive error handling and user feedback + - 🎛️ Multiple options can be combined for precise operational control + +#### 📅 **Updated: August 11th, 2025** + +- 🔧 **NeoVIM Enhancement**: Fixed DirtytalkUpdate automation for programming + spellcheck + - ✨ **Auto-download**: Wordlist now downloads automatically on first startup + - 🔄 **Smart detection**: Only downloads if wordlist file doesn't exist + - 💡 **Fallback**: Improved home activation script with better error handling + - ⚡ **Performance**: Added `vim.schedule()` for non-blocking wordlist updates + - 🐛 **Bug Fix**: Re-enabled `programmingWordlist.enable = true` with proper + automation + - 🎯 **User Experience**: Eliminates the manual `:DirtytalkUpdate` prompt + mentioned in previous changelog + - 📚 **Resolves**: The issue referenced in changelog line 81-83 where users + had to manually run the command + +- 🔧 **NeoVIM LSP Enhancement**: Enhanced Nix LSP configuration for better + development experience + - 🎯 **Purpose**: Enables automatic evaluation of Nix inputs for better LSP + functionality + - 📍 **Location**: Added nil LSP configuration with auto-eval-inputs in + luaConfigPost + - 🚀 **Benefits**: + - 💡 Better code completion for Nix files + - 🔍 Enhanced error checking and navigation + - 🧠 Improved IntelliSense for Nix expressions + - ⚙️ **Configuration**: Added `auto-eval-inputs = true` for nil LSP server + +#### 📅 **Updated: August 10th, 2025** + +- ⚡ **ZCLI Enhancement**: Added `rebuild-boot` function to `zcli` + - 🔄 Uses `nh os boot` instead of `nh os switch` + - ⏭️ Configuration activates on next restart instead of immediately + - 🛡️ Safer for kernel updates, driver changes, and system-critical + modifications + - 📝 Added to help menu with proper documentation + +- 🐛 **Bug Fix**: Fixed typo in `detect_gpu_profile()` function + - 🔧 Corrected `detec0.1ted_profile` to `detected_profile` + - ✅ GPU auto-detection for hybrid systems now works properly + +- 📝 **Documentation**: Improved formatting in `ZaneyOS-Upgrade.md` + - 🔧 Fixed incomplete sentence about `zcli rebuild-boot` command availability + - ✨ Improved bullet point clarity and sub-bullet indentation + - 🎨 Fixed code block formatting in migration steps + - 📋 Removed unnecessary quote markers from bash commands + +#### 📅 **Updated: August 7th, 2025** + +- 📊 **Waybars**: Added new waybars + - ➕ `waybar-dwm.nix` + - ➕ `waybar-dwm-2.nix` + - 🎨 Source waybar code by Matt @TheLinuxCast + +- 🔧 **NIX Formatting**: + - Reformatted NIX to NIX formatting standard + +- 🎮 **ZFS Support**: Added `hostID` to `variables.nix` and `network.nix` + - 💾 This is needed by ZFS + - 👏 Thanks to Daniel Emeery for the patch + +- 📝 **Documentation**: Added `tealdeer.nix (TLDR)` with autoupdate + +- 🔧 **ZCLI Fixes**: + - ➕ Added defensive code to `zcli.nix` + - 🔍 For rebuilds, updates, hostname and flake host mistches are checked + - ⚙️ If not same, prompted to auto update the flake.nix + - 💼 Added `$PROJECT` variable to set repo location + - 📝 Default is `zaneyos` + - 📊 Added info on `zcli` utility + - ⬆️ Updated `zcli` now uses `nh` util to select # of generations to keep + - ➕ Added `zcli` CLI util. runs rebuild, update, garbage collection and diags + + ```text + ❯ zcli + + ZaneyOS CLI Utility -- version 1.0 + + Usage: zcli [command] + + Commands: + + rebuild - Rebuild the NixOS system configuration. update - Update the flake and + rebuild the system. update-host - Auto-set host and profile in flake.nix. + + add-host - Add a new host configuration. del-host - Delete a host configuration. + + list-gens - List user and system generations. cleanup - Clean up old system + generations. trim - Trim filesystems to improve SSD performance. diag - Create a + system diagnostic report. + + help - Show this help message. + ``` + +- 🔧 **QT Fixes**: + - 🔄 Update `qt.nix` and `stylix.nix` to `PlatformTheme = "qtct"` + - ⚠️ In unstable `gnome` is now `adwaita` both cause eval warnings + - ⚙️ Setting `qtct` in `qt.nix` now to prevent this issue later + - 🔧 Fixed formatting issue in install script + +- 📝 **NeoVim/NVF Updates**: + - 🐛 Change in `nvf` update prompts you to d/l wordlist ever time + - enter `:DirtytalkUpdate` case sensitive to resolve + - 🔗 `https://github.com/NotAShelf/nvf/pull/991` + - ✅ Re-enabled `css` formatting in `nvf.nix` Thx `mister_simon` for fix + +- 🤖 **AI Tools**: (Clients only) + - ♊️ Added `gemini-cli` Supports `gemini-pro/flash` + - 🛠️ Added `aider chat` Supports many LLMs + - 📝 Added `claude-code` Supports `claude LLMs` + - 🚀 Added `warp terminal` Support multiple LLMs + +- 🦇 **Bat/Theme Updates**: + - 🎨 Set Dracula theme to `bat` command + - ➕ Added `style = all` and set `man` pager to `bat` + +- 🎧 **Audio**: + - Added `low latecny` setting for `pipewire` + +- 📊 **System Monitoring**: + - Added custom config for `btm` htop like cli util + +- 🔧 **Terminal Fixes**: + - ➕ Added workaround for issue where `ghostty` is slow or hangs + - ➕ Added electron ozone env variable to `hint` + +- 🎥 **OBS Studio**: + - Added `obs-studio.nix` + - To allow for customization added common plugins + +- 📺 **TMUX**: + - Updated `tmux.nix` adding popups for lazygit, terminal, edit menu + +- 📜 **Install Script**: + - Improved `install-zaneyos.sh` script Detects GPU and better presentation + +- 📝 **Evil Helix**: + - Added `evil-helix` with language support as option + +- 💻 **VSCode Updates**: + - 🔄 `vscode` update + - ➕ Added `vscode.nix` with plugins for NIX, BASH, JSON, and VIM keybinds + - 👏 Thanks to `delciak` for providing the NIX code for `vscode.nix` + - ➕ Added variable 'enableVscode' in the `hosts/default/variables.nix` + +## 🔧 **Additional Improvements and Fixes**: + +- ⚙️ **Variables**: + - Added vars for `alacritty` `ghostty` `tmux` `wezterm` in `variables.nix` + +- 🖥️ **Display Manager**: + - Added variable `displayManager` in `hosts/hostname/variables.nix` + - ✨ Set to `sddm` will enable SDDM login manager themed by stylix + - 💻 Set to `tui` and you get the greetd text login as before + +- 🔧 **Scripts**: + - `hm-find` script to detect HomeMgr backup files, wasn't imported + +- 📈 **Version**: + - Updated version to v2.3.3 + +- 🖥️ **Wayland**: + - Added `uwsm` package, disabled by default in Hyprland +- ⭐ **Starship**: + - Added alternate `starship` config. `starship-ddubs-1.nix` +- 📚 **Documentation**: + - Added more info in `hosts/default/variables.nix` + - 📋 Listing available terminals, stylix images, waybars + - 📐 Added more info on how to configure monitors + +- 🌈 **Colorful Waybar**: + - Added new waybar from `swordlesbian` Very colorful and bright + +- 🔐 **SDDM**: +- Added `sddm.nix` themed with stylix +- Moved login dialog to left +- Styled with better colors + +- 🖼️ **Theming**: + - Set default stylix image to `mountainscapedark.png` + - 🎨 Provides warmer colors and super nice SDDM background + +- 📝 **Fonts**: + - Added more fonts to `modules/core/fonts.nix` + +- 📱 **Terminal**: + - Added `alacritty` terminal with `Maple MF` font + +- 📦 **Flatpak**: + - Redid `flatpak.nix` + - You add your flatpak apps there + - They get installed/updated during next rebuild + - If you remove it, they flatpak app will be uninstalled on next rebuild + +- ✅ **Formatter**: +- Re-enabled `language formatter` had to disable `css` formatter for now + +## 🔀 **Git Enhancements**: + +- ➕ **Aliases**: Added three git aliases `com`, `gs`, and `gp` + - 💬 `git com` will run `git commit -a` + - 📦 `git gs` will run `git stash` + - ⬇️ `git gp` will run `git pull` + +## 📝 **Editor Improvements**: + +- ✅ **Default Editor**: + - Enabled `neovim` in `packages.nix` to set it to `defaultEditor` +- 🔄 **Relative Numbers**: + - Restored relative line numbering to nvim `lineNumberMode = "relNumber";` +- ➖ **Cleanup**: + - Removed extraneous LUA code for diags w/debug messages from `nvf.nix` +- 🔄 **LSP Changes**: + - NVIM `languages.enableLSP` changed to `vim.settings.lsp.enable` +- 📋 **Clipboard**: + - Updated `nvf.nix`to use a clipboard provider as `useSystemClipobard` is no + longer supported +- 🩺 **Diagnostics**: + - Restored diagnostic messages inline as errors are detected +- 💾 **Hints**: + - When you save a file the LSP will show any applicable hints + +## 📁 ** EZA enhancements **: + +- 🔄 **Organization**: Moved `eza` aliases to `eza.nix` +- 🐚 **Shell Integration**: Enabled `bash`,`zsh`, `fish` integration in + `eza.nix` +- 🌍 **Consistency**: All supported shells aliases are now set in `eza.nix` +- 🗑️ **Cleanup**: Removed `eza` aliases from `zsh/default.nix` and `bash.nix` +- ⚙️ **Defaults**: Set default options for `eza` in `eza.nix` + +## 🔧 **System Fixes & Updates**: + +- 🔧 **Git Command**: git command is install script missing `clone` keyword +- ❌ **GPU Fix**: Commented out AQ_DRM_DEVICES ENV variable. Can break config + with more than two GPUs +- ✏️ **Docs**: spelling corrections in README.md +- 🔗 **Clone**: Updated clone command in README.md to grab 2.3 stable branch +- 🖥️ **VM Display**: Updated `hyprland.nix` to set VMs `Virtual-1` monitors to + 1920x1080@60 +- 🔐 **SSH**: Disabled root login for SSH +- 👥 **Access**: Users allowed password SSH access +- 🔀 **Git Features**: Added features and aliases to `git` command + +## 🐚 **ZSH Configuration**: + +- 🔄 Modified zsh config + +```nix + syntaxHighlighting = { + enable = true; + highlighters = ["main" "brackets" "pattern" "regexp" "root" "line"]; + }; + historySubstringSearch.enable = true; + + history = { + ignoreDups = true; + save = 10000; + size = 10000; + }; +``` + +## 🛠️ **Utility Enhancements**: + +- 🎨 **LazyGit**: Added `lazygit.nix` to theme, customize lazygit util +- 🔍 **FZF**: Added `fzf.nix` to customize fzf util + - 👁️ Added preview to `fzf.nix` Enter to edit +- ➖ **Cleanup**: Removed lazygit from core packages now in lazygit.nix + +## 📊 **Waybar & UI Updates**: + +- ➕ **Jerry's Waybar**: Added `waybar-ddubs-2.nix` Modified ver of Jerry's + waybar +- 🎨 **Colors**: Adjusted some colors in Jerry's waybar +- ➕ **Options**: Added Jerry's waybar as option. `Jerry-waybar.nix` +- ✨ **Blur**: Added option to enable blur on waybar on `hyprland.nix` Thx + SchotjeChrisman + +## 🖥️ **Hyprland Improvements**: + +- ✨ **Animations**: Added new animation `animation-moving`from ML4W repo +- 🔧 **Regression Fix**: Fixed regression in `windowrules.nix` +- 🎨 **Stylix**: +- Stylix was set to unstable - set to 25.05 to stop warning +- ⚙️ **ENV Variables**: + - Hyprland ENV variables were set in two files previously + - Created `env.nix` to move them to a single file +- 🗑️ **Cleanup**: Hyprland animation files had unneeded `inherit`statements +- 📐 **Terminal Size**: Pyprland drop down terminal size changed from 75% to 70% +- 🚫 **Donations**: Disabled Hyprland donation messages +- ⚙️ **ANR Threshold**: + - Set Application Not Responding (ANR) dialog threshold to 20 + - The default threshold of one was too sensitive + - It would trigger on many apps like `waypaper` + +## 🏗️ **System Architecture**: + +- 📌 **Version Pin**: Pinned nixpkgs and homemanager to 25.05 in `flake.nix` +- 🔄 **Lock Update**: Updated `flake.lock`to match changes +- ⬆️ **Hyprland**: Hyprland updated to v0.49 + +- 🔧 **Bug Fixes**: + - Fixed syntax error in `animations-dynamic.nix`file. Thx Brisingr05 +- 🔐 **Lock Fix**: + - Added `hyprlock.enable=true;` in system packages + - This resolves issue with PAM auth errors +- 🗑️ **Cleanup**: Removed unneeded `home.mgr.enable` in `user.nix` Thx + Brisingr05 + +## 📖 **Documentation & Fixes**: + +- ❌ **Disk Module**: Disabled the `df` command in the disk module. Doesn't work + w/zaneyos +- 📋 **Monitor Examples**: Added examples for monitor setup in `variables.nix` +- 🔧 **Yazi Fix**: Merged yazi fix for errors after rebuilds. Thank you Daniel +- 🔄 **Flake Update**: Updated flake 05/27/2025 +- 📚 **FAQ Updates**: Updated `FAQ.md` with Hyprland Keybinds and how to change + waybar +- 📖 **README**: Updated `README` with Hyprland keybinds +- 📜 **Install Script**: Updated install script to pull from the most current + release not the main branch +- 🔍 **Backup Files**: Added `hm-find` to find old backup files preventing + rebuilds/updates from completing +- 🐛 **Yazi Error**: Added how to fix yazi startup error to `FAQ.md` +- 🎨 **FAQ Format**: Fixed formatting in `FAQ.md` causing yazi info from being + hidden + +--- + +# 📚 **Version History** + +                 + +
+ +v2.3 GA Release Notes + +
+ +- With this release there are improvements to Neovim +- The entire file structure has been improved. +- Switched from `nixvim` to `nvf` for neovim configuration. +- Improved `bat` config and includes extras now. +- Added profiles for what kind of system you have based of GPU / VM. +- Reduced the host specific files and made the entire flake more modular. +- Fixed git getting set to wrong user settings. +- Fixed hyprlock conflicting with stylix. +- Setup`nh` in a better fashion. +- Added support for `qmk` out of the box. +- Added `usbutils` for lsusb functionality. +- Massive improvement to Hyprland window rules. +- Removed broken support for Apple Silicon (this may return). +- Install script improved. +- Fixed `nix flake check` not working. +- Added nvidia prime PCI ID variables to host `variables.nix`. +- Added vim keybindings zsh (alt+hjkl). +- Added (ctrl+hjkl) keybinds for vim movement while in insert mode in neovim. +- Supports adb out of the box. +- Ddubs/dwilliam62 helped with the addition of pyprland and scratchpad support. + He is now also a maintainer. +- Can now summon a drop-down terminal with `SUPER, T`. +- Added image used by Stylix into the host variables file. +- Made printing and NFS variables so they can be easily toggled between hosts. +- Added waybar styling choice. +- Kitty, Wezterm, Neovim/nvf, and even Flatpaks all properly themed with Stylix. +- Moved to hyprpolkitagent and fixed qt theming. +- Stylix options that I wanted forced us back on the unstable branch. +- Made Thunar an optional thing, enabled by default. _But for me Yazi is + enough._ + +
+ +
+ +
+
+**ZaneyOS v2.2** + +
+ +- This release has a big theming change +- Move back to rofi. It is a massive improvement in many ways. - Revert the switch from rofi to wofi. Rofi is just better. - Switch from Nix Colors to Stylix. It can build colorschemes from a wallpaper. - Simplified the notification center. - Improved emoji selection menu and options. - Adding fine-cmdline plugin for Neovim. -- Removed theme changing scripts as the theme is generated by the image set with stylix.image in the config.nix file. +- Removed theme changing scripts as the theme is generated by the image set with + stylix.image in the config.nix file. - Starship is now setup in the config.nix file. - Switched from SDDM to tuigreet and greetd. - Added Plymouth for better looking booting. -- Improve the fonts being installed and properly separate them from regular packages. +- Improve the fonts being installed and properly separate them from regular + packages. - Separated Neovim configuration for readability. - Updated flake and added fix for popups going to wrkspc 1 in Hyprland. - Removed a few of the packages that aren't necessary and smartd by default. - Removed unnecessary Hyprland input in flake as home manager doesn't use it. -- Turned off nfs by default +- Turned off nfs by default. - Hyprland plugins are now disabled in the config by default. - Fastfetch is now replacing neofetch. - Btop is back baby! - Switching to Brave as the default to protect user privacy. - Replaced lsd with eza for a better looking experience. + +
+ +
+
+ +
+ +**ZaneyOS v2.1** + +
+ +Simple bug fixes. + +- Fixed Waybar icons to make them look a bit better. +- Centered the Wofi window always. +- Should have fixed some Steam issues, but I have had some crashes due to Steam + so be aware of that. +- The flake got an update, so all the packages are fresh. + +
+ +
+ +
+ +
+ +**ZaneyOS v2.0** + +
+ +With this new update of ZaneyOS it is a big rewrite of how things are being +done. This update fixes many issues that you guys were facing. As well as makes +things a little easier to understand. You now have a lot being stored inside the +specific host directory, making use of modules, condensing seperate files down, +etc. My hope is that with this update your ability to grasp the flake and expand +it to what you need is much improved. I want to thank everyone for being so +supportive! + +- Most configuration put into specific hosts directories for the best + portability. +- Using modules to condense configuration complexity. +- Simplified options and the complexity around understanding their + implementation. +- Rewrote the documentation for improved readability. + +
+ +
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b685277 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,121 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that are welcoming, open, and respectful. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[tylerzanekelley@gmail.com]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interaction in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8872211..1093ca6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,32 +1,81 @@ -# Contributing Guidelines +# 💖 Contributing to ZaneyOS -👋 Hello there! We're thrilled that you're considering contributing to our project. Before you start, please take a moment to read our guidelines. +We're excited that you're interested in contributing to ZaneyOS! Your help is +essential for keeping it great. -## Table of Contents +This document is a guide to help you through the process of contributing to +ZaneyOS. We are a welcoming and friendly community, and we are happy to help you +get started. -- [How Can I Contribute?](#how-can-i-contribute) - - [Reporting Bugs](#reporting-bugs) - - [Suggesting Enhancements](#suggesting-enhancements) - - [Code Contribution](#code-contribution) +## 📜 Code of Conduct -## Code of Conduct +We have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors +to adhere to. Please take a moment to read it before you start contributing. -None. Don't be a turd and we'll be just fine 'round here. 🤠 +## 🚀 How to Contribute -## How Can I Contribute? +There are many ways to contribute to ZaneyOS, from writing code to reporting +bugs and suggesting new features. -### Reporting Bugs +### 🐛 Reporting Bugs -Found a bug? Please ensure the bug was not already reported by searching our [issues](../../issues). If not, open a new issue and fill out the template provided. +If you find a bug, please open an issue on our [issue tracker](../../issues). -### Suggesting Enhancements +When you report a bug, please include the following: -Have an idea for an enhancement? We'd love to hear it! Open an issue and include [Feature Request]. +- A clear and descriptive title. +- A detailed description of the bug, including steps to reproduce it. +- Your environment details (OS, ZaneyOS version, etc.). +- Any relevant logs or screenshots. -### Code Contribution +### ✨ Suggesting Enhancements -1. Fork the repository. -2. Create a new branch for your feature/fix: `git checkout -b feature-branch` -3. Make your changes and commit: `git commit -m 'Add new feature'` -4. Push to your fork: `git push origin feature-branch` -5. Open a pull request with a clear title and description. +If you have an idea for a new feature or an enhancement to an existing one, +please open an issue on our [issue tracker](../../issues). + +When you suggest an enhancement, please include the following: + +- A clear and descriptive title. +- A detailed description of the enhancement, including the problem it solves and + why it would be a good addition to ZaneyOS. +- Any relevant mockups or screenshots. + +### 💻 Code Contributions + +If you want to contribute code to ZaneyOS, please follow these steps: + +1. **Fork the repository** and clone it to your local machine. +2. **Create a new branch** for your changes: `git checkout -b your-branch-name` +3. **Make your changes** and commit them with a clear and descriptive commit + message. +4. **Push your changes** to your fork: `git push origin your-branch-name` +5. **Open a pull request** to the `main` branch of the ZaneyOS repository. + +When you open a pull request, please include the following: + +- A clear and descriptive title. +- A detailed description of the changes, including the problem it solves and how + you solved it. +- Any relevant issue numbers. + +## 🎨 Style Guide + +We have a style guide that we expect all contributors to follow. Please take a +moment to read it before you start contributing. + +- **Git Commit Messages:** We use the + [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) + specification for our commit messages. +- **Code Style:** We use `shfmt` to format our shell scripts. Please make sure + your code is formatted before you open a pull request. + +## 💬 Community + +If you have any questions or want to get in touch with the community, you can +find us on: + +- **Discord:** [Join our Discord server](https://discord.gg/CHZzESXs) +- **Twitter:** [@ZaneyOS](https://twitter.com/ZaneyOS) + +We are happy to help you get started with contributing to ZaneyOS. We look +forward to your contributions! diff --git a/FAQ.es.md b/FAQ.es.md new file mode 100644 index 0000000..5a08953 --- /dev/null +++ b/FAQ.es.md @@ -0,0 +1,1552 @@ +[English](FAQ.md) | [Español](FAQ.es.md) + +# 💬 Preguntas frecuentes de ZaneyOS + +- **Fecha:** 14 de deciembre de 2025 + +**⌨ ¿Dónde puedo ver los atajos de teclado de Hyprland?** + +- La tecla SUPER + K abre un menú searchable con los atajos +- El icono "keys" en el lado derecho de la waybar también abrirá este menú. + +
+**✨🖥️ ZCLI: ¿Qué es y cómo lo uso?** +
+ +La utilidad `zcli` es una herramienta de línea de comandos diseñada para +simplificar la gestión de tu entorno `zaneyos`. Proporciona un conjunto completo +de comandos para realizar tareas comunes como actualizar tu sistema, gestionar +hosts, limpiar generaciones antiguas y gestionar Doom Emacs. + +Para usarlo, abre una terminal y escribe `zcli` seguido de uno de los comandos +listados a continuación: + +## Comandos del Sistema Core: + +- `cleanup`: Limpia generaciones antiguas del sistema. Puedes especificar el + número de generaciones a mantener. Incluye limpieza automatizada de logs de + compilaciones antiguas. +- `diag`: Crea un reporte de diagnóstico completo del sistema usando + `inxi --full`, guardado en `~/diag.txt`. Perfecto para solucionar problemas. +- `list-gens`: Lista tanto generaciones de usuario como de sistema con + información detallada. +- `rebuild`: Recompila la configuración del sistema NixOS con verificaciones de + seguridad mejoradas y manejo de archivos de respaldo. +- `rebuild-boot`: Recompila y establece como boot por defecto (se activa en el + próximo reinicio). Más seguro para cambios importantes del sistema y + actualizaciones del kernel. +- `trim`: Recorta sistemas de archivos para mejorar el rendimiento del SSD con + prompts de confirmación del usuario. +- `update`: Actualiza el flake y recompila el sistema con manejo de errores + completo. +- `update-host`: Establece automáticamente el host y perfil en `flake.nix`. + Características detección inteligente de GPU y validación de hostname. +- `add-host`: Crea configuraciones de host nuevas con detección automática de + GPU, generación de hardware.nix y integración con git. +- `del-host`: Elimina configuraciones de host de forma segura con prompts de + confirmación para prevenir eliminación accidental. + +**Uso:** `zcli add-host [hostname] [profile]`\ +**Perfiles de GPU:** `amd`, `intel`, `nvidia`, `nvidia-hybrid`, y `vm` + +## Opciones Avanzadas de Compilación: + +Los comandos `rebuild`, `rebuild-boot` y `update` soportan opciones mejoradas +para control granular: + +- `--dry, -n`: Modo preview - muestra qué se haría sin ejecutar (dry run) +- `--ask, -a`: Prompts de confirmación interactiva para operaciones críticas de + seguridad +- `--cores N`: Limita operaciones de compilación a N núcleos de CPU (esencial + para VMs y sistemas con recursos limitados) +- `--verbose, -v`: Habilita logs detallados de operación y salida verbose para + troubleshooting +- `--no-nom`: Deshabilita nix-output-monitor para salida tradicional de línea de + comandos + +**Múltiples opciones pueden combinarse** para control preciso sobre tu proceso +de compilación. + +## Gestión de Doom Emacs: + +Gestión completa del ciclo de vida de Doom Emacs con características de +seguridad: + +- `doom install`: Instalación automatizada de Doom Emacs usando el script + get-doom con todos los paquetes requeridos +- `doom status`: Verifica el estado de instalación y muestra información de + versión para verificación +- `doom remove`: Remueve la instalación de Doom Emacs de forma segura con + prompts de confirmación para prevenir eliminación accidental +- `doom update`: Actualiza paquetes de Doom Emacs y configuración vía + `doom sync` + +**Características:** Verificaciones de seguridad integradas, manejo de errores +completo y gestión automática de dependencias. + +```text +❯ zcli +Error: No command provided. +ZaneyOS CLI Utility -- version 1.0.2 + +Usage: zcli [command] [options] + +Commands: + cleanup - Clean up old system generations. Can specify a number to keep. + diag - Create a system diagnostic report. + (Filename: homedir/diag.txt) + list-gens - List user and system generations. + rebuild - Rebuild the NixOS system configuration. + rebuild-boot - Rebuild and set as boot default (activates on next restart). + trim - Trim filesystems to improve SSD performance. + update - Update the flake and rebuild the system. + update-host - Auto set host and profile in flake.nix. + (Opt: zcli update-host [hostname] [profile]) + +Options for rebuild, rebuild-boot, and update commands: + --dry, -n - Show what would be done without doing it + --ask, -a - Ask for confirmation before proceeding + --cores N - Limit build to N cores (useful for VMs) + --verbose, -v - Show verbose output + --no-nom - Don't use nix-output-monitor + +Doom Emacs: + doom install - Install Doom Emacs using get-doom script. + doom status - Check if Doom Emacs is installed. + doom remove - Remove Doom Emacs installation. + doom update - Update Doom Emacs (runs doom sync). + + help - Show this help message. +``` + +**Ejemplos:** + +```bash +# Gestión del sistema +zcli rebuild --dry # Muestra qué se recompilaría +zcli update --cores 4 # Actualiza con máximo 4 núcleos de CPU +zcli rebuild-boot --ask # Recompila para boot con confirmación + +# Gestión de host +zcli add-host mihost amd # Agrega nuevo host con GPU AMD +zcli update-host # Detecta y actualiza info de host automáticamente + +# Doom Emacs +zcli doom install # Instala Doom Emacs +zcli doom status # Verifica estado de instalación +``` + +
+
+ +
+**¿Cómo configuro aplicaciones predeterminadas (PDF, navegador) por host?** + +- Edita `~/zaneyos/hosts//variables.nix` y descomenta `mimeDefaultApps`. +- Home Manager usará esto vía `modules/home/xdg.nix` para escribir tu `~/.config/mimeapps.list`. +- Usa IDs `.desktop` reales de `/usr/share/applications` o `~/.local/share/applications`. + +```nix +# hosts//variables.nix +# Aplicaciones predeterminadas a nivel de host (consumidas por xdg.mimeApps) +# mimeDefaultApps = { +# # PDFs +# "application/pdf" = ["okular.desktop"]; +# "application/x-pdf" = ["okular.desktop"]; +# # Navegador web +# "x-scheme-handler/http" = ["google-chrome.desktop"]; # o brave-browser.desktop, firefox.desktop +# "x-scheme-handler/https" = ["google-chrome.desktop"]; +# "text/html" = ["google-chrome.desktop"]; +# # Archivos +# "inode/directory" = ["thunar.desktop"]; # gestor de archivos +# "text/plain" = ["nvim.desktop"]; # o code.desktop +# }; +``` + +
+ +## Atajos Principales de Hyprland + +A continuación se muestran los atajos de teclado para Hyprland, formateados para +fácil referencia. + +## Lanzamiento de Aplicaciones + +- `$modifier + Return` → Lanzar `Terminal` +- `$modifier + Tab` → Alternar `Quickshell Overview` (visor de espacios con + vistas en vivo) +- `$modifier + K` → Lista atajos +- `$modifier + D` → Lanzar `launcher` +- `$modifier + Shift + Return` → Lanzar `launcher` +- `$modifier + Shift + W` → Abrir `web-search` +- `$modifier + Alt + W` → Abrir `wallsetter` +- `$modifier + Shift + N` → Ejecutar `swaync-client -rs` +- `$modifier + W` → Lanzar `Web Browser` +- `$modifier + Y` → Abrir `kitty` con `yazi` +- `$modifier + E` → Abrir `emopicker9000` +- `$modifier + S` → Tomar captura de pantalla +- `$modifier + Shift + D` → Abrir `Discord` +- `$modifier + O` → Lanzar `OBS Studio` +- `$modifier + C` → Ejecutar `hyprpicker -a` +- `$modifier + G` → Abrir `GIMP` +- `$modifier + V` → Mostrar historial de portapapeles vía `cliphist` +- `$modifier + T` → Alternar terminal con `pypr` +- `$modifier + M` → Abrir `pavucontrol` + +## Gestión de Ventanas + +- `$modifier + Q` → Matar ventana activa +- `$modifier + P` → Alternar tiling pseudo +- `$modifier + Shift + I` → Alternar modo split +- `$modifier + F` → Alternar fullscreen +- `$modifier + Shift + F` → Alternar modo flotante +- `$modifier + Alt + F` → Flotar todas las ventanas +- `$modifier + Shift + C` → Salir de Hyprland + +## Movimiento de Ventanas + +- `$modifier + Shift + ← / → / ↑ / ↓` → Mover ventana + izquierda/derecha/arriba/abajo +- `$modifier + Shift + H / L / K / J` → Mover ventana + izquierda/derecha/arriba/abajo +- `$modifier + Alt + ← / → / ↑ / ↓` → Intercambiar ventana + izquierda/derecha/arriba/abajo +- `$modifier + Alt + 43 / 46 / 45 / 44` → Intercambiar ventana + izquierda/derecha/arriba/abajo + +## Movimiento de Foco + +- `$modifier + ← / → / ↑ / ↓` → Mover foco izquierda/derecha/arriba/abajo +- `$modifier + H / L / K / J` → Mover foco izquierda/derecha/arriba/abajo + +## Espacios de Trabajo + +- `$modifier + 1-10` → Cambiar a espacio de trabajo 1-10 +- `$modifier + Shift + Space` → Mover ventana a espacio de trabajo especial +- `$modifier + Space` → Alternar espacio de trabajo especial +- `$modifier + Shift + 1-10` → Mover ventana a espacio de trabajo 1-10 +- `$modifier + Control + → / ←` → Cambiar espacio de trabajo adelante/atrás + +## Ciclo de Ventanas + +- `Alt + Tab` → Ciclar a siguiente ventana +- `Alt + Tab` → Traer ventana activa al frente + +## Preguntas, configuraciones, actualización, misc... + +
+ +**❄ ¿Por qué creaste ZaneyOS? ** + +
+ +- Al principio, era simplemente mi configuración guardada en un repositorio GIT. +- Fue para promover NixOS y Hyprland. +- Proporcionando una configuración estable y funcional. +- Nunca fue intencionado como una distro completa de NixOS. +- El nombre `ZaneyOS` es un chiste interno entre amigos. +- La intención es que esta configuración pueda usarse como daily driver +- Desarrollar software, jugar juegos vía steam, etc. +- Mi esperanza es que sea útil, y lo modifiques para que se ajuste a tus + necesidades. +- Ese es el punto clave. Hazlo tuyo. +- Crea un fork de ZaneyOS, luego modifícalo. +- Si encuentras un issue y lo arreglas, o proporcionas una nueva característica, + por favor compártelo. +- ZaneyOS no es una distro. En este momento no hay planes para crear un ISO de + instalación. + +
+
+ +
+**🖼️ Configuraciones y configuración** + +
+ +
+**¿Cómo agrego flatpaks?** + +- Edita `~/zaneyos/modules/core/flatpak.nix` +- Hay una lista de apps de ejemplo que puedes usar como plantilla + +```nix + services = { + flatpak = { + enable = true; + + # Lista las aplicaciones Flatpak que quieres instalar + # Usa el ID oficial de aplicación Flatpak (ej. desde flathub.org) + # Ejemplos: + packages = [ + #"com.github.tchx84.Flatseal" #Gestiona permisos flatpak - siempre deberías tener esto + #"com.rtosta.zapzap" # Cliente de WhatsApp + #"io.github.flattool.Warehouse" # Gestiona flatpaks, limpia datos, remueve flatpaks y deps + #"it.mijorus.gearlever" # Gestiona y soporta AppImages + #"io.github.freedoom.Phase1" # Classic Doom FPS 1 + #"io.github.freedoom.Phase2" # Classic Doom FPS 2 + #"io.github.dvlv.boxbuddyrs" # Gestiona distroboxes + + # Agrega otros IDs de Flatpak aquí, ej. "org.mozilla.firefox" + ]; + + # Opcional: Actualiza Flatpaks automáticamente cuando ejecutes nixos-rebuild switch + update.onActivation = true; + }; + }; +``` + +- Asegúrate de usar el nombre correcto del paquete +- Ve a `flathub.org` para verificar o usa `flatpak search PACKAGENAME` +- Guarda el archivo y haz un rebuild con el alias `fr` +- Después puedes ejecutar `flatpak list` para verificar la instalación +- Cuando ejecutas `fu` o `fr` los flatpaks también se actualizarán + +
+ +
+**¿Cómo remuevo flatpaks?** + +- Edita `~/zaneyos/modules/core/flatpak.nix` + +```nix + services = { + flatpak = { + enable = true; + + # Lista las aplicaciones Flatpak que quieres instalar + # Usa el ID oficial de aplicación Flatpak (ej. desde flathub.org) + # Ejemplos: + packages = [ + #"com.github.tchx84.Flatseal" #Gestiona permisos flatpak - siempre deberías tener esto + #"com.rtosta.zapzap" # Cliente de WhatsApp + #"io.github.flattool.Warehouse" # Gestiona flatpaks, limpia datos, remueve flatpaks y deps + #"it.mijorus.gearlever" # Gestiona y soporta AppImages + #"io.github.freedoom.Phase1" # Classic Doom FPS 1 + #"io.github.freedoom.Phase2" # Classic Doom FPS 2 + #"io.github.dvlv.boxbuddyrs" # Gestiona distroboxes + + # Agrega otros IDs de Flatpak aquí, ej. "org.mozilla.firefox" + ]; + + # Opcional: Actualiza Flatpaks automáticamente cuando ejecutes nixos-rebuild switch + update.onActivation = true; + }; + }; +``` + +- Remueve la línea con el paquete que quieres remover o coméntala +- Guarda el archivo y haz un rebuild con el alias `fr` +- Después puedes ejecutar `flatpak list` para verificar que los paquetes(s) + estén removidos +- Nota: Las dependencias base para flatpaks permanecen una vez instaladas. + +
+ +
+**¿Cómo cambio la waybar?** + +- Ve al directorio `~/zaneyos/host/HOSTNAME` +- Edita el archivo `variables.nix` +- Encuentra la línea que comienza con `waybarChoice` +- Cambia el nombre a uno de los archivos disponibles +- `waybar-simple.nix`, `waybar-curved.nix`, o `waybar-ddubs.nix` +- Guarda el archivo y sal +- Necesitas hacer un rebuild para que el cambio sea efectivo +- Ejecuta `fr` "flake rebuild" para iniciar el proceso de rebuild + +```json +# Establecer Waybar +# Incluye alternativas como waybar-simple.nix, waybar-curved.nix & waybar-ddubs.nix +waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; +``` + +
+ +
+** ¿Cómo cambio la zona horaria? ** + +1. En el archivo, `~/zaneyos/modules/core/system.nix` +2. Edita la línea: time.timeZone = "America/New_York"; +3. Guarda el archivo y rebuild usando el alias `fr`. + +
+ +
+**¿Cómo cambio la configuración del monitor? ** + +La configuración del monitor está en el archivo: +`~/zaneyos/hosts//variables.nix` + +Dentro de las comillas la sintaxis es "monitor=adaptador de +video,resolución@refresh rate, auto,escala" El monitor debe estar en minúsculas. +Si no estás seguro de tus dispositivos de video ejecuta `hyprctl monitors` en +una CLI de terminal. La salida se verá similar a esto: + +```text +hyprctl monitors +Monitor HDMI-A-1 (ID 0): + 2560x1440@143.91200 at 0x0 + description: Dell Inc. DELL S3222DGM F45WJK3 + make: Dell Inc. + model: DELL S3222DGM + serial: F45WJK3 + active workspace: 1 (1) + special workspace: 0 () + reserved: 0 52 0 0 + scale: 1.00 + transform: 0 + focused: yes + dpmsStatus: 1 + vrr: false + solitary: 0 + activelyTearing: false + directScanoutTo: 0 + disabled: false + currentFormat: XRGB8888 + mirrorOf: none + availableModes: 2560x1440@59.95Hz 2560x1440@143.91Hz 2560x1440@120.00Hz 1920x1200@59.95Hz 1920x1080@143.86Hz 1920x1080@120.00Hz 1920x1080@119.88Hz 1920x1080@60.00Hz 1920x1080@60.00Hz 1920x1080@59.94Hz 1920x1080@50.00Hz 1600x1200@60.00Hz 1680x1050@59.88Hz 1280x1024@75.03Hz 1280x1024@60.02Hz 1440x900@59.95Hz 1280x800@59.91Hz 1152x864@75.00Hz 1280x720@120.00Hz 1280x720@119.88Hz 1280x720@60.00Hz 1280x720@59.94Hz 1280x720@50.00Hz 1024x768@75.03Hz 1024x768@60.00Hz 800x600@75.00Hz 800x600@60.32Hz 720x576@50.00Hz 720x576@50.00Hz 720x480@60.00Hz 720x480@60.00Hz 720x480@59.94Hz 720x480@59.94Hz 640x480@75.00Hz 640x480@60.00Hz 640x480@59.94Hz 640x480@59.94Hz 720x400@70.08Hz +``` + +Edita la línea `extraMonitorSettings`. **Ejemplos:** + +- Monitor Único: `extraMonitorSettings = "monitor=eDP-1,1920x1080@60,auto,1";` +- Monitores Múltiples: + `extraMonitorSettings = " + monitor=eDP-1,1920x1080@60,auto,auto + monitor=HDMI-A-1,2560x1440@75,auto,auto + ";` + +- Para configuraciones multi-monitor más complejas, puedes usar la aplicación + GUI, `nwg-displays` Esta mostrará tus monitores conectados actualmente + permitiéndote usar el mouse para coincidir cómo están arreglados físicamente. + Ej. qué monitor está a la izquierda, derecha, arriba o abajo. Es muy similar a + la herramienta X11 basada, `arandr` Creará entonces un archivo de + configuración compatible con Hyprland en `~/.config/hypr/monitors.conf` + + + +Después de configurar los monitores como deseas, presiona `Apply` para guardar +los cambios en `~/.config/hypr/monitors.conf`\ +El contenido se verá algo como esto: + +```text +# Generado por nwg-displays el 2025-03-20 a las 13:13:49. No editar manualmente. +monitor=HDMI-A-1,1920x1080@74.97,2136x268,1.0 +monitor=eDP-1,1920x1080@144.0,216x268,1.0 +``` + +Solo necesitas copiar las líneas `monitor=` y pegarlas en el archivo +`variables.nix` como se describe en el proceso arriba. + +Una vez hecho eso. Ejecuta el comando alias `fr` para construir una nueva +generación para hacer efectivos los cambios. + +Más información sobre configurar monitores está disponible en el +[Wiki de Hyprland](https://wiki.hyprland.org/Configuring/Monitors/) + +
+ +
+**¿Cómo agrego aplicaciones a ZaneyOS? ** + +### Hay dos opciones. Una para todos los hosts que tienes, otra para un host específico. + +1. Para aplicaciones que se incluirán en todos los hosts definidos edita el + archivo `~/zaneyos/modules/core/packages.nix` file. + +Hay una sección que comienza con: `environment.systemPackages = with pkgs;` + +Seguida de una lista de paquetes. Estos son requeridos para ZaneyOS. + +Te sugerimos agregar un comentario al final de los nombres de paquetes. Luego +agrega tus paquetes. + +```text + ... + virt-viewer + wget + ### Mis Apps ### + bottom + dua + emacs-nox + fd + gping + lazygit + lunarvim + luarocks + mission-center + ncdu + nvtopPackages.full + oh-my-posh + pyprland + shellcheck + multimarkdown + nodejs_23 + ugrep + zoxide + ]; +} +``` + +2. Para aplicaciones que serán solo en hosts específicos. + +Edita el `host-packages.nix` asociado con ese host. +`~/zaneyos/hosts//host-packages.nix` + +La parte del archivo que necesitas editar se ve como esto: + +```nix +{ pkgs, ... }: { + environment.systemPackages = with pkgs; [ + audacity + discord + nodejs + obs-studio + ]; +} +``` + +Puedes agregar paquetes adicionales, o por ejemplo cambiar `discord` a +`discord-canary` para obtener la versión beta de Discord pero solo en este host. + +
+ +
+ +** Agregué los nombres de paquetes, ahora ¿cómo los instalo ? ** + +- Usa la utilidad `zcli`. `zcli rebuild` +- El alias legacy `fr`, Flake Rebuild está depreciado pero aún disponible + +Si el rebuild se completa exitosamente, se creará una nueva generación con tus +paquetes agregados. + +
+ +
+** ¿Cómo actualizo los paquetes que ya instalé? ** + +- Usa la utilidad `zcli`. `zcli update` +- El `fu`, Flake Update alias está depreciado pero aún disponible +- Cualquiera de estos verificará paquetes actualizados, descargará e instalará. + +
+ +
+** Hice un cambio a mi configuración de ZaneyOS, ¿cómo lo activo? ** + +- Usa la utilidad `zcli`. `zcli rebuild` +- El alias legacy `fr`, Flake Rebuild está depreciado pero aún disponible ** + NOTA: Si **creaste un nuevo archivo\*\* +- necesitarás ejecutar un comando `git add .` en la carpeta `zaneyos` +- Si es exitoso se generará una nueva generación con tus cambios +- Un logout o reboot podría ser requerido dependiendo de qué cambiaste + +
+ +
+** ¿Cómo puedo configurar un kernel diferente en un host específico? ** + +1. Tienes que editar el archivo `hardware.nix` para ese host en + `~/zaneyos/hosts/HOSTNAME/hardware.nix` y override el default. +2. Cerca del top encontrarás esta sección del archivo `hardware.nix`. + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +3. Agrega el override. Ej. para establecer el kernel a 6.12. + +- `boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12;` + +4. El código actualizado se verá como esto: + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +5. Usa el comando `zcli rebuild` o alias `fr` para crear una nueva generación y + reboot para que tome efecto. + +
+ +
+ +** ¿Cuáles son las principales opciones de Kernel en NixOS? ** +NixOS ofrece varios tipos principales de kernel para adaptarse a diferentes necesidades y preferencias. A continuación están las opciones disponibles, excluyendo versiones específicas de kernel: + +1. **`linuxPackages`** + - El kernel estable default, típicamente una versión LTS (Long-Term Support). + LTS en 25.05 (warbler) es 6.12.x Versiones más viejas, 6.6.x, 6.8.x no + están soportadas. + +2. **`linuxPackages_latest`** + - El kernel mainline más reciente, que puede incluir nuevas características + pero podría ser menos estable. + +3. **`linuxPackages_zen`** + - Un kernel optimizado para rendimiento con parches dirigidos a mejorar la + responsividad e interactividad. Comúnmente usado por gamers y usuarios de + desktop. + +4. **`linuxPackages_hardened`** + - Un kernel enfocado en seguridad con parches adicionales de hardening para + protección mejorada. + +5. **`linuxPackages_rt`** + - Un kernel en tiempo real diseñado para baja latencia y aplicaciones + sensibles al tiempo, como producción de audio o robótica. + +6. **`linuxPackages_libre`** + - Un kernel stripped de firmware y drivers propietarios, adhiriéndose a + principios de software libre. + +7. **`linuxPackages_xen_dom0`** + - Un kernel adaptado para correr como host (dom0) en entornos de + virtualización Xen. + +8. **`linuxPackages_mptcp`** + - Un kernel con soporte para Multipath TCP, útil para escenarios avanzados de + networking. + +
+ +
+ +** Tengo generaciones viejas que quiero borrar, ¿cómo puedo hacerlo? ** + +- El alias NixOS Clean Generations `ncg` removerá **TODAS** menos la más actual + generación. Asegúrate de haber booted desde esa generación antes de usar este + alias. También hay un schedule que removerá generaciones viejas + automáticamente con el tiempo. + +
+ +
+ +**¿Cómo cambio el hostname? ** + +Para cambiar el hostname, hay varios pasos y tendrás que reboot para hacer el +cambio efectivo. + +1. Copia el directorio del host que quieres renombrar a un directorio con el + nuevo nombre. + +- `cp -rpv ~/zaneyos/hosts/OLD-HOSTNAME ~/zaneyos/hosts/NEW-HOSTNAME` + +2. Edita el archivo `~/zaneyos/flake.nix`. Cambia la línea: + +- `host = "NEW-HOSTNAME"` + +3. En el directorio `~/zaneyos` ejecuta `git add .` _El rebuild fallará con un + error 'file not found' si olvidas este paso._ + +4. Usa el comando `zcli rebuild` o `fr` alias para crear una nueva generación + con el nuevo hostname. Debes reboot para hacer el cambio efectivo. + +
+
+** ¿Cómo deshabilito el copo de nieve giratorio al inicio? ** + +1. Edita el archivo `~/zaneyos/modules/core/boot.nix` file. +2. Busca: + +```nix +}; + plymouth.enable = true; +}; +``` + +3. Cámbialo a `false` +4. Ejecuta el comando `zcli rebuild` o alias `fr` para crear una nueva + generación. + +
+ +
+ ** ¿Cómo configuro mi laptop híbrida con GPUs Intel/NVIDIA? ** + +1. Ejecuta el script `install-zaneyos.sh` y selecciona el template + `nvidia-laptop` o si configurando manualmente, establece el template en el + `flake.nix` a `nvidia-prime` + +2. En el archivo `~/zaneyos/hosts/HYBRID-HOST/variables.nix` necesitarás + establecer los PCI IDs para las GPUs Intel y NVIDIA. Refiérete a + [esta página](https://nixos.wiki/wiki/Nvidia) para ayudar a determinar esos + valores. + +3. Una vez que todo esté configurado apropiadamente, usa el alias Flake Rebuild + `fr` para crear una nueva generación. + +4. En el archivo `~/zaneyos/modules/home/hyprland/config.nix` hay un ENV + setting`"AQ_DRM_DEVICES,/dev/dri/card0:/dev/dri/card1:/dev/dri/card2"` Esto + establece la GPU primaria y secundaria. Usando la info del weblink arriba + podrías tener que cambiar el orden de estos valores. + +
+ +
+ +
+ +
+**🎨 Stylix** + +
+ +
+¿Cómo habilito o deshabilito Stylix? + +- Para Habilitar: + +1. Edita el archivo `~/zaneyos/modules/core/stylix.nix` file. +2. Comenta desde `base16Scheme` hasta el `};` después de `base0F` + +```nix +# Opciones de Styling + stylix = { + enable = true; + image = ../../wallpapers/Anime-girl-sitting-night-sky_1952x1120.jpg; + #image = ../../wallpapers/Rainnight.jpg; + #image = ../../wallpapers/zaney-wallpaper.jpg; + # base16Scheme = { + # base00 = "282936"; + # base01 = "3a3c4e"; + # base02 = "4d4f68"; + # base03 = "626483"; + # base04 = "62d6e8"; + # base05 = "e9e9f4"; + # base06 = "f1f2f8"; + # base07 = "f7f7fb"; + # base08 = "ea51b2"; + # base09 = "b45bcf"; + # base0A = "00f769"; + # base0B = "ebff87"; + # base0C = "a1efe4"; + # base0D = "62d6e8"; + # base0E = "b45bcf"; + # base0F = "00f769"; + #}; + polarity = "dark"; + opacity.terminal = 1.0; + cursor = { + package = pkgs.bibata-cursors; + name = "Bibata-Modern-Ice"; + size = 24; + }; +``` + +3. Selecciona la imagen que quieres que `stylix` use para la paleta de colores. +4. Ejecuta el comando `zcli rebuild` o `fr` alias para crear una nueva + generación con este esquema de colores. + +- Para deshabilitar descomenta + +1. Edita el archivo `~/zaneyos/modules/core/stylix.nix` file. +2. Descomenta desde `base16Scheme` hasta el `};` después de `base0F` + +```nix + base16Scheme = { + base00 = "282936"; + base01 = "3a3c4e"; + base02 = "4d4f68"; + base03 = "626483"; + base04 = "62d6e8"; + base05 = "e9e9f4"; + base06 = "f1f2f8"; + base07 = "f7f7fb"; + base08 = "ea51b2"; + base09 = "b45bcf"; + base0A = "00f769"; + base0B = "ebff87"; + base0C = "a1efe4"; + base0D = "62d6e8"; + base0E = "b45bcf"; + base0F = "00f769"; +}; +``` + +3. Ejecuta el comando `zcli rebuild` o `fr` alias para construir una nueva + generación con el dracula default o establece tus propios colores custom + +
+ +
+ ¿Cómo cambio la imagen que Stylix usa para tematizar? + +1. Edita el archivo `~/zaneyos/hosts/HOSTNAME/varibles.nix` +2. Cambia el `stylixImage =` al nombre del archivo que quieres usar. Los + wallpapers están en `~/zaneyos/wallpapers` + +```nix +# Establecer Imagen Stylix +stylixImage = ../../wallpapers/AnimeGirlNightSky.jpg; +``` + +
+ +
+ +
+ +
+**🌃 Wallpapers** + +
+ +
+** ¿Cómo agrego más wallpapers? ** + +- Los wallpapers se almacenan en el directorio `~/zaneyos/wallpapers`. +- Simplemente copia los nuevos a ese directorio. +- Debes hacer un rebuild después de agregar nuevos wallpapers. +- Ejecuta el comando `zcli rebuild` o alias `fr` en la CLI. + +
+ +
+ +** ¿Cómo cambio el fondo? ** + +- SUPER + ALT + W seleccionará un nuevo fondo + +
+ +
+ +** ¿Cómo puedo establecer un temporizador para cambiar el wallpaper automáticamente? ** + +1. Edita el archivo `~/zaneyos/modules/home/hyprland/config.nix` file. +2. Comenta la línea `sleep 1.5 && awww img ...` +3. Agrega nueva línea después de eso con `sleep 1 && wallsetter` + +```json +settings = { + exec-once = [ + "dbus-update-activation-environment --all --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "systemctl --user import-environment WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "killall -q awww;sleep .5 && awww init" + "killall -q waybar;sleep .5 && waybar" + "killall -q swaync;sleep .5 && swaync" + "nm-applet --indicator" + "lxqt-policykit-agent" + "pypr &" + #"sleep 1.5 && awww img /home/${username}/Pictures/Wallpapers/zaney-wallpaper.jpg" + "sleep 1 && wallsetter" + ]; +``` + +4. Ejecuta el comando `zcli rebuild` o alias `fr` para crear una nueva + generación. +5. Necesitarás logout o reboot para que el cambio sea efectivo. + +
+ +
+ +**¿Cómo cambio el intervalo en que cambia el wallpaper? ** + +1. Edita el archivo `~/zaneyos/modules/home/scripts/wallsetter` +2. Cambia el valor `TIMEOUT =` . Está en segundos. +3. Ejecuta el comando `zcli rebuild` o alias `fr`, para crear una nueva + generación. +4. Necesitarás logout o reboot para que el cambio sea efectivo. + +
+ +
+ +
+ +
+**⬆ ¿Cómo actualizo ZaneyOS? ** + +
+ +
+ Para versión v2.3 + +Altamente recomendado: Lee `ZaneyOS-Upgrade.md` antes de proceder. Detalla el +upgrade automatizado seguro, respaldo, y proceso de revert. + +Usa el upgrade automatizado v2.3 → v2.4. Ve `ZaneyOS-Upgrade.md` y +`UPGRADE-2.3-to-2.4.md`. Para evitar sobrescribir tu config antes de crear un +respaldo, fetch solo el script sin modificar tu working tree: + +- Git (recomendado): + +```bash +git -C ~/zaneyos fetch origin +git -C ~/zaneyos show origin/main:upgrade-2.3-to-2.4.sh > ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +- Curl: + +```bash +curl -fsSL https://gitlab.com/zaney/zaneyos/-/raw/main/upgrade-2.3-to-2.4.sh -o ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +Luego ejecuta el script: `~/upgrade-2.3-to-2.4.sh`. Creará un respaldo completo +antes de cambiar branches y migrará tus hosts de forma segura desde el respaldo. + +**IMPORTANTE:** + +- NO uses los alias `fu` o `fr` para este upgrade; el script usa un boot build + seguro. +- Si has hecho modificaciones extensas, no ejecutes el script. Lee los docs + arriba y migra manualmente en su lugar. + +
+ +
+ Para versiones v2.0->2.2 + +1. Primero respaldo tu directorio `zaneyos` existente. ej. + `cp -r ~/zaneyos ~/zaneyos-backup` + +2. No hay update directo. Cuando clones la nueva config los archivos de config y + layout han cambiado. + +3. Necesitas instalar zaneyos como una nueva install. `./install-zaneyos.sh` + +4. Una vez que el build se complete y hayas rebooted puedes revisar el nuevo + layout y decidir si algún cambio que hiciste en la versión anterior puede ser + migrado a v2.3. + +
+ +
+ Para versión v1.x + +1. El layout y configuración son completamente diferentes. Virtualmente nada de + 1.x es aplicable a v2.3. + +2. Respalda tu directorio `zaneyos` ej. `cp -r ~/zaneyos ~/zaneyos-backup` + +3. Ejecuta el script `./install-zaneyos.sh` y sigue las nuevas instrucciones de + install. + +
+ +
+ ¿Cómo sé cuándo se lanza una nueva versión de ZaneyOS? + +Será anunciado en el servidor Discord de Zaney +[Discord](https://discord.gg/W7efsSDS). + +
+ +
+ +
+ + + +
**📂 Layout de ZaneyOS v2.3** + +
+ +** 📂 ~/zaneyos ** + +```text +~/zaneyos/ + ├── hosts/ # Carpeta donde se guardan configs de host + │ ├── default # Template de host default + │ └── nixstation # Host de Zaney + ├── img/ # Imágenes para README.md + ├── modules/ # Archivos de config Core, HomeMgr, drivers + │ └── drivers/ # Configs AMD,NVIDA,Intel,VM + │ └── core/ # Servicios, paquetes, fonts, etc + │ └── home/ # Archivos de config Home Manager + │ ├── fastfetch/ # Config Fastfetch + │ ├── hyprland/ # Configs Hyrprland + │ ├── rofi/ # Configs de menú rofi + │ ├── scripts/ # screenshots, wallpaper, etc. + │ ├── waybar/ # Configs waybar en formato NIX + │ ├── wlogout/ # Tema, config para menú logout + │ ├── yazi/ # Archivo config de filemgr TUI + │ └── zsh/ # Tema y settings para ZSH + ├── profiles/ # Templates de hardware video + │ ├── amd/ # Configs video AMD + │ ├── intel/ # Configs video Intel + │ ├── nvidia/ # Configs video NVIDIA discrete + │ ├── nvidia-laptop/ # Configs video NVIDIA Hybrid + │ └── vm/ # Configs Virtual Machine + ├── wallpapers/ # Agrega tus wallpapers aquí + ├── CHANGELOG.md # Lista de cambios + ├── CONTRIBUTING.md # Cómo puedes ayudar + ├── FAQ.md # Preguntas Frecuentes + ├── flake.lock # Guarda info de versión de todos los paquetes instalados + ├── flake.nix # flake que controla config ZaneyOS + ├── install-zaneyos.sh # Script de install para ZaneyOS + ├── LICENSE # Licencia MIT que usa ZaneyOS + └── README.md # Documento introductorio para ZaneyOS +``` + +
+ +
+ +**---> 🧰 Misceláneo** + +
+ +**🪧 Rebuild o update falla con error de Home Manager no puede backup un archivo** + +
+
+ +**Update** +
+ +- Usando el comando `zcli rebuild` o `zcli upgrade` buscará este archivo + causando fallos de rebuild +- Si encuentras otros archivos que causan esto puedes agregarlos en el + `zaneyos/modules/home/scripts/default.nix` +
+ +```text +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: Please do one of the following: +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - Move or remove the above files and try again. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - In standalone mode, use 'home-manager switch -b backup' to back up +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: files automatically. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - When used as a NixOS or nix-darwin module, set +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: 'home-manager.backupFileExtension' +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: to, for example, 'backup' and rebuild. +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Main process exited, code=exited, status=1/FAILURE +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Failed with result 'exit-code'. +May 08 18:33:57 explorer systemd[1]: Failed to start Home Manager environment for dwilliams. +``` + +- Hay un script `hm-find` Que buscará en el journal y si lo encuentra, +- Te promptará para borrar estos backups +- También crea un log +- Nota: El script no es perfecto +- Si obtienes este msg pero `hm-find` no reporta ninguno tendrás que buscar + manualmente ej `journalctl | grep hm-activate` +- Puedes entonces redo tu rebuild +- Usa el comando `zcli rebuild` o `fr` para `flake rebuild` +- El flake ya ha sido actualizado + +
+
+ +
+ +**📚 ¿Cuál es la diferencia entre layouts Master y Dwindle** + +
+
+ +**1. Layout Master** + +- El layout **Master** divide el workspace en dos áreas principales: + - Un **área master** para la ventana primaria, que toma una porción más grande + de la pantalla. + - Un **área stack** para todas las otras ventanas, que están tiled en el + espacio restante. +- Este layout es ideal para workflows donde quieres enfocarte en una ventana + main mientras mantienes otras accesibles. + +**2. Layout Dwindle** + +- El layout **Dwindle** es un layout de tiling basado en árbol binario: + - Cada nueva ventana split el espacio disponible dinámicamente, alternando + entre splits horizontales y verticales. + - Los splits son determinados por el aspect ratio del contenedor padre (ej. + splits más anchos horizontalmente, más altos verticalmente). +- Este layout es más dinámico y distribuye espacio equitativamente entre todas + las ventanas. + +--- + +**Cómo Verificar el Layout Actual** + +Para verificar cuál layout está activo actualmente, usa el comando `hyprctl`: + +`hyprctl getoption general:layout` + +
+ + + + +
+**📦 ¿Cuáles son los keybindings de Yazi y cómo puedo cambiarlos? ** + +

+ +El archivo de configuración de Yazi está localizado en +`~/zaneyos/modules/home/yazi.nix` + +Yazi está configurado como VIM y motions VIM + +El keymap está en el archivo `~/zaneyos/modules/home/yazi/keymap.toml` file + +
+
+ +
+ +** ¿Qué fonts están disponibles en NixOS** + +```nix +{pkgs, ...}: { + fonts = { + packages = with pkgs; [ + dejavu_fonts + fira-code + fira-code-symbols + font-awesome + hackgen-nf-font + ibm-plex + inter + jetbrains-mono + material-icons + maple-mono.NF + minecraftia + nerd-fonts.im-writing + nerd-fonts.blex-mono + noto-fonts + noto-fonts-emoji + noto-fonts-cjk-sans + noto-fonts-cjk-serif + noto-fonts-monochrome-emoji + powerline-fonts + roboto + roboto-mono + symbola + terminus_font + # NERD fonts + nerd-fonts.0xproto + nerd-fonts._3270 + nerd-fonts.agave + nerd-fonts.anonymice + nerd-fonts.arimo + nerd-fonts.aurulent-sans-mono + nerd-fonts.bigblue-terminal + nerd-fonts.bitstream-vera-sans-mono + nerd-fonts.blex-mono + nerd-fonts.caskaydia-cove + nerd-fonts.caskaydia-mono + nerd-fonts.code-new-roman + nerd-fonts.comic-shanns-mono + nerd-fonts.commit-mono + nerd-fonts.cousine + nerd-fonts.d2coding + nerd-fonts.daddy-time-mono + nerd-fonts.departure-mono + nerd-fonts.dejavu-sans-mono + nerd-fonts.droid-sans-mono + nerd-fonts.envy-code-r + nerd-fonts.fantasque-sans-mono + nerd-fonts.fira-code + nerd-fonts.fira-mono + nerd-fonts.geist-mono + nerd-fonts.go-mono + nerd-fonts.gohufont + nerd-fonts.hack + nerd-fonts.hasklug + nerd-fonts.heavy-data + nerd-fonts.hurmit + nerd-fonts.im-writing + nerd-fonts.inconsolata + nerd-fonts.inconsolata-go + nerd-fonts.inconsolata-lgc + nerd-fonts.intone-mono + nerd-fonts.iosevka + nerd-fonts.iosevka-term + nerd-fonts.iosevka-term-slab + nerd-fonts.jetbrains-mono + nerd-fonts.lekton + nerd-fonts.liberation + nerd-fonts.lilex + nerd-fonts.martian-mono + nerd-fonts.meslo-lg + nerd-fonts.monaspace + nerd-fonts.monofur + nerd-fonts.monoid + nerd-fonts.mononoki + nerd-fonts.mplus + nerd-fonts.noto + nerd-fonts.open-dyslexic + nerd-fonts.overpass + nerd-fonts.profont + nerd-fonts.proggy-clean-tt + nerd-fonts.recursive-mono + nerd-fonts.roboto-mono + nerd-fonts.shure-tech-mono + nerd-fonts.sauce-code-pro + nerd-fonts.space-mono + nerd-fonts.symbols-only + nerd-fonts.terminess-ttf + nerd-fonts.tinos + nerd-fonts.ubuntu + nerd-fonts.ubuntu-mono + nerd-fonts.ubuntu-sans + nerd-fonts.victor-mono + nerd-fonts.zed-mono + + ]; + }; +} +``` + +
+ +**---> 🖥️ Terminales ** + +
+**🐱 Kitty** + +
+ +Mi cursor en Kitty es "janky" y salta alrededor. ¿Cómo lo arreglo? + +- Esa característica se llama "cursor_trail" en el archivo + `~/zaneyos/modules/home/kitty.nix`. + +1. Edita ese archivo y cambia el `cursor_trail 1` a `cursor_trail 0` o comenta + esa línea. +2. Usa el alias `zcli rebuild` o `fr` para crear una nueva generación con el + cambio. + +
+ +
+ ¿Cuáles son los keybindings de Kitty y cómo puedo cambiarlos? + +Los bindings de kitty están configurados en `~/zaneyos/modules/home/kitty.nix` + +Los defaults son: + +```text + # Clipboard + map ctrl+shift+v paste_from_selection + map shift+insert paste_from_selection + + # Scrolling + map ctrl+shift+up scroll_line_up + map ctrl+shift+down scroll_line_down + map ctrl+shift+k scroll_line_up + map ctrl+shift+j scroll_line_down + map ctrl+shift+page_up scroll_page_up + map ctrl+shift+page_down scroll_page_down + map ctrl+shift+home scroll_home + map ctrl+shift+end scroll_end + map ctrl+shift+h show_scrollback + + # Gestión de ventana + map alt+n new_window_with_cwd #Abre nueva ventana en directorio actual + #map alt+n new_os_window #Abre nueva ventana en $HOME dir + map alt+w close_window + map ctrl+shift+enter launch --location=hsplit + map ctrl+shift+s launch --location=vsplit + map ctrl+shift+] next_window + map ctrl+shift+[ previous_window + map ctrl+shift+f move_window_forward + map ctrl+shift+b move_window_backward + map ctrl+shift+` move_window_to_top + map ctrl+shift+1 first_window + map ctrl+shift+2 second_window + map ctrl+shift+3 third_window + map ctrl+shift+4 fourth_window + map ctrl+shift+5 fifth_window + map ctrl+shift+6 sixth_window + map ctrl+shift+7 seventh_window + map ctrl+shift+8 eighth_window + map ctrl+shift+9 ninth_window + map ctrl+shift+0 tenth_window + + # Gestión de tab + map ctrl+shift+right next_tab + map ctrl+shift+left previous_tab + map ctrl+shift+t new_tab + map ctrl+shift+q close_tab + map ctrl+shift+l next_layout + map ctrl+shift+. move_tab_forward + map ctrl+shift+, move_tab_backward + + # Misceláneo + map ctrl+shift+up increase_font_size + map ctrl+shift+down decrease_font_size + map ctrl+shift+backspace restore_font_size +``` + +
+
+ +
+ +**🇼 WezTerm** + +
+ +
+ +¿Cómo habilito WezTerm? + +Edita el `/zaneyos/modules/home/wezterm.nix` Cambia `enable = false` a +`enable = true;`\ +Guarda el archivo y rebuild zaneyos con el comando `zcli rebild` o el alias `fr` + +``` +{pkgs, ...}: { + programs.wezterm = { + enable = false; + package = pkgs.wezterm; + }; +``` + +
+ +
+ ¿Cuáles son los keybindings de WezTerm y cómo puedo cambiarlos? + +Los bindings de kitty están configurados en `~/zaneyos/modules/home/wezterm.nix` + +Los defaults son: + +```text +ALT es la tecla META definida para WezTerm + -- Gestión de tab +ALT + t Abrir nuevo Tab +ALT + w Cerrar Tab actual +ALT + n Mover a siguiente Tab +ALT + p Mover a Tab anterior + -- Gestión de pane +ALT + v Crear Split Vertical +ALT + h Crear Split Horizontal +ALT + q Cerrar Pane Actual + -- Navegación de pane (mover entre panes con ALT + Arrows) +ALT + Left Arrow Mover a pane -- Izquierda +ALT + Right Arrow Mover a pane -- Derecha +ALT + Down Arrow Mover a pane -- Abajo +ALT + Up Arrow Mover a pane -- Arriba +``` + +
+
+
+ +
+**👻 Ghostty ** + +
+ +
+ ¿Cómo habilito el terminal ghostty? + +1. Edita el archivo `~/zaneyos/modules/home/ghostty.nix` file. +2. Cambia `enable = true;` +3. Ejecuta el alias `fr` para crear una nueva generación. + +
+ +
+ + ¿Cómo cambio el tema de ghostty? + +1. Edita el archivo `~/zaneyos/modules/home/ghostty.nix` file. +2. Hay varios temas de ejemplo incluidos pero comentados. + +```text +#theme = Aura +theme = Dracula +#theme = Aardvark Blue +#theme = GruvboxDarkHard +``` + +3. Comenta `Dracula` y descomenta uno de los otros o agrega uno de los muchos + temas de ghostty. + +
+ +
+ ¿Cuáles son los keybindings default de ghostty? + +```text + # keybindings + keybind = alt+s>r=reload_config + keybind = alt+s>x=close_surface + + keybind = alt+s>n=new_window + + # tabs + keybind = alt+s>c=new_tab + keybind = alt+s>shift+l=next_tab + keybind = alt+s>shift+h=previous_tab + keybind = alt+s>comma=move_tab:-1 + keybind = alt+s>period=move_tab:1 + + # quick tab switch + keybind = alt+s>1=goto_tab:1 + keybind = alt+s>2=goto_tab:2 + keybind = alt+s>3=goto_tab:3 + keybind = alt+s>4=goto_tab:4 + keybind = alt+s>5=goto_tab:5 + keybind = alt+s>6=goto_tab:6 + keybind = alt+s>7=goto_tab:7 + keybind = alt+s>8=goto_tab:8 + keybind = alt+s>9=goto_tab:9 + + # split + keybind = alt+s>\=new_split:right + keybind = alt+s>-=new_split:down + + keybind = alt+s>j=goto_split:bottom + keybind = alt+s>k=goto_split:top + keybind = alt+s>h=goto_split:left + keybind = alt+s>l=goto_split:right + + keybind = alt+s>z=toggle_split_zoom + + keybind = alt+s>e=equalize_splits +``` + +
+
+
+ +** --> 🪧 Temas relacionados con NixOS general ** + +
+**❄ ¿Qué son los Flakes en NixOS? ** + +
+ +**Flakes** son una característica del package manager Nix que simplifica y +estandariza cómo se gestionan configuraciones, dependencias y paquetes. Si estás +familiarizado con herramientas como `package.json` en JavaScript o `Cargo.toml` +en Rust, flakes sirven un propósito similar en el ecosistema Nix. + +** Características Clave de Flakes: ** + +1. **Pin Dependencias**: + - Flakes lock las versiones de dependencias en un archivo `flake.lock`, + asegurando reproducibilidad entre sistemas. + +2. **Estandarizar Configuraciones**: + - Usan un archivo `flake.nix` para definir cómo build, run o deploy un + proyecto o sistema, haciendo setups más predecibles. + +3. **Mejorar Usabilidad**: + - Flakes simplifican compartir y reusar configuraciones entre diferentes + sistemas o proyectos proporcionando una estructura consistente. + +En esencia, flakes ayudan a gestionar setups de NixOS o proyectos basados en Nix +de una manera más portable y confiable. + +
+ +
+ +
+**🏡 ¿Qué es NixOS Home Manager? ** + +**Home Manager** es una herramienta poderosa en el ecosistema Nix que te permite +gestionar configuraciones y entornos específicos de usuario de manera +declarativa. Con Home Manager, puedes simplificar el setup de dotfiles, settings +de shell, aplicaciones y paquetes de sistema para tu perfil de usuario. + +### Características Clave de Home Manager: + +1. **Configuración Declarativa**: + - Define todos tus settings y preferencias en un solo archivo `home.nix`, + haciendo fácil trackear, compartir y replicar tu setup. + +2. **Soporte Cross-Distribution**: + - Home Manager funciona no solo en NixOS sino también en otras distribuciones + Linux y macOS, permitiéndote estandarizar configuraciones entre + dispositivos. + +3. **Gestión de Entorno de Usuario**: + - Gestiona aplicaciones, variables de entorno, configuraciones de shell y + más—todo aislado a tu perfil de usuario. + +### ¿Por Qué Usar Home Manager? + +Home Manager simplifica la gestión de sistema ofreciendo consistencia, +reproducibilidad y portabilidad. Ya sea que estés customizando tu entorno de +desarrollo o compartiendo configuraciones entre máquinas, proporciona una manera +eficiente de adaptar tu experiencia de usuario. + +
+ +
+**🏭 ¿Qué son los Builds Atómicos?** + +**Builds atómicos** en NixOS aseguran que cualquier cambio de sistema (como +instalar software o actualizar la configuración) se aplique de manera segura y +fail-proof. Esto significa que una actualización de sistema es completamente +exitosa o no tiene efecto alguno, eliminando el riesgo de un estado de sistema +parcialmente aplicado o roto. + +### Cómo Funcionan los Builds Atómicos: + +1. **Generación de Sistema Inmutable**: + - Cada cambio de configuración crea una nueva "generación" del sistema, + mientras las previas permanecen intactas. Puedes fácilmente rollback a una + generación anterior si algo sale mal. + +2. **Comportamiento Transaccional**: + - Similar a transacciones de database, los cambios se aplican atómicamente: o + tienen éxito y se convierten en el nuevo sistema activo, o fallan y dejan + el sistema actual sin cambios. + +3. **Rollbacks Sin Problemas**: + - En caso de errores o issues, puedes reboot y seleccionar una generación + previa de sistema desde el menú de boot para retornar a un estado + funcional. + +### Beneficios de Builds Atómicos: + +- **Confiabilidad**: Tu sistema está siempre en un estado consistente, incluso + si un cambio de configuración falla. +- **Reproducibilidad**: La misma configuración siempre producirá el mismo estado + de sistema, haciendo fácil debuggear o replicar. +- **Facilidad de Rollback**: Revertir a una configuración funcional es tan + simple como reboot y seleccionar la generación previa. + +### ¿Por Qué NixOS Usa Builds Atómicos? + +Esta característica es un cornerstone de la filosofía de diseño declarativo y +reproducible de NixOS, asegurando que la gestión de sistema sea predecible y sin +estrés. + +
+ +
+**❓ Soy nuevo en NIXOS ¿dónde puedo ir para obtener más info? ** + +- [NIXOS Config Guide](https://www.youtube.com/watch?v=AGVXJ-TIv3Y&t=34s) +- [VIMJOYER YouTube Channel](https://www.youtube.com/@vimjoyer/videos) +- [Librephoenix YouTube Channel](https://www.youtube.com/@librephoenix) +- [8 Part Video Series on NIXOS](https://www.youtube.com/watch?v=QKoQ1gKJY5A&list=PL-saUBvIJzOkjAw_vOac75v-x6EzNzZq-) +- [Great guide for NixOS and Flakes](https://nixos-and-flakes.thiscute.world/preface) + +
+ +
+**🏤 ¿Dónde puedo obtener info sobre usar repositorios GIT ** + +- [Managing NIXOS config with GIT](https://www.youtube.com/watch?v=20BN4gqHwaQ) +- [GIT for dummies](https://www.youtube.com/watch?v=K6Q31YkorUE) +- [How GIT works](https://www.youtube.com/watch?v=e9lnsKot_SQ) +- [In depth 1hr video on GIT](https://www.youtube.com/watch?v=S7XpTAnSDL4&t=123s) + +
+ + + + diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..32c6708 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,2710 @@ +[English](FAQ.md) | [Español](FAQ.es.md) + +# 💬 ZaneyOS FAQ + +- **Date:** 14-Decemnber-2025 + +**⌨ Where can I see the Hyprland keybindings?** + +- The SUPER key + K opens a searchable menu with the bindings +- The "keys" icon on the right side of the waybar will also bring up this menu. + +
+**✨🖥️ ZCLI: What is it and how do I use it?** +
+ +The `zcli` utility is a command-line tool designed to simplify the management of +your `zaneyos` environment. It provides a comprehensive set of commands to +perform common tasks such as updating your system, managing hosts, cleaning up +old generations, and managing Doom Emacs. + +To use it, open a terminal and type `zcli` followed by one of the commands +listed below: + +## Core System Commands: + +- `cleanup`: Clean up old system generations. You can specify the number of + generations to keep. Includes automated log cleanup for old build logs. +- `diag`: Create a comprehensive system diagnostic report using `inxi --full`, + saved to `~/diag.txt`. Perfect for troubleshooting. +- `list-gens`: List both user and system generations with detailed information. +- `rebuild`: Rebuild the NixOS system configuration with enhanced safety checks + and backup file handling. +- `rebuild-boot`: Rebuild and set as boot default (activates on next restart). + Safer for major system changes and kernel updates. +- `trim`: Trim filesystems to improve SSD performance with user confirmation + prompts. +- `update`: Update the flake and rebuild the system with comprehensive error + handling. + +## Host Management: + +- `update-host`: Automatically set the host and profile in `flake.nix`. Features + intelligent GPU detection and hostname validation. +- `add-host`: Create new host configurations with automated GPU detection, + hardware.nix generation, and git integration. +- `del-host`: Safely delete host configurations with confirmation prompts to + prevent accidental removal. + +**Usage:** `zcli add-host [hostname] [profile]`\ +**GPU Profiles:** `amd`, `intel`, `nvidia`, `nvidia-hybrid`, and `vm` + +## Advanced Build Options: + +The `rebuild`, `rebuild-boot`, and `update` commands support enhanced options +for fine-grained control: + +- `--dry, -n`: Preview mode - shows what would be done without executing (dry + run) +- `--ask, -a`: Interactive confirmation prompts for safety-critical operations +- `--cores N`: Limit build operations to N CPU cores (essential for VMs and + resource-constrained systems) +- `--verbose, -v`: Enable detailed operation logs and verbose output for + troubleshooting +- `--no-nom`: Disable nix-output-monitor for traditional command-line output + +**Multiple options can be combined** for precise control over your build +process. + +## Doom Emacs Management: + +Complete Doom Emacs lifecycle management with safety features: + +- `doom install`: Automated Doom Emacs installation using the get-doom script + with all required packages +- `doom status`: Check installation status and display version information for + verification +- `doom remove`: Safely remove Doom Emacs installation with confirmation prompts + to prevent accidental deletion +- `doom update`: Update Doom Emacs packages and configuration via `doom sync` + +**Features:** Built-in safety checks, comprehensive error handling, and +automatic dependency management. + +```text +❯ zcli +Error: No command provided. +ZaneyOS CLI Utility -- version 1.0.2 + +Usage: zcli [command] [options] + +Commands: + cleanup - Clean up old system generations. Can specify a number to keep. + diag - Create a system diagnostic report. + (Filename: homedir/diag.txt) + list-gens - List user and system generations. + rebuild - Rebuild the NixOS system configuration. + rebuild-boot - Rebuild and set as boot default (activates on next restart). + trim - Trim filesystems to improve SSD performance. + update - Update the flake and rebuild the system. + update-host - Auto set host and profile in flake.nix. + (Opt: zcli update-host [hostname] [profile]) + +Options for rebuild, rebuild-boot, and update commands: + --dry, -n - Show what would be done without doing it + --ask, -a - Ask for confirmation before proceeding + --cores N - Limit build to N cores (useful for VMs) + --verbose, -v - Show verbose output + --no-nom - Don't use nix-output-monitor + +Doom Emacs: + doom install - Install Doom Emacs using get-doom script. + doom status - Check if Doom Emacs is installed. + doom remove - Remove Doom Emacs installation. + doom update - Update Doom Emacs (runs doom sync). + + help - Show this help message. +``` + +**Examples:** + +```bash +# System management +zcli rebuild --dry # Show what would be rebuilt +zcli update --cores 4 # Update with 4 CPU cores max +zcli rebuild-boot --ask # Rebuild for boot with confirmation + +# Host management +zcli add-host myhost amd # Add new host with AMD GPU +zcli update-host # Auto-detect and update host info + +# Doom Emacs +zcli doom install # Install Doom Emacs +zcli doom status # Check installation status +``` + +
+
+ +## Major Hyprland Keybindings + +Below are the keybindings for Hyprland, formatted for easy reference. + +## Application Launching + +- `$modifier + Return` → Launch `Terminal` +- `$modifier + Tab` → Toggle `Quickshell Overview` (workspace overview with live + previews) +- `$modifier + K` → List keybinds +- `$modifier + D` → Application Launcher +- `$modifier + Shift + Return` → Application 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 + Shift + 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 + +## Questions, settings, updating, misc... + +
+ +**❄ Why did you create ZaneyOS ? ** + +
+ +- In the beginning, it was simply my configuration saved on a GIT repository. +- It was there to promote NixOS and Hyprland. +- Providing a stable, working configuration. +- It has never been intended as a full NixOS distro. +- The `ZaneyOS` name is an inside joke among friends. +- The intent is this configration can be used as a daily driver +- Develop software, play games via steam, etc. +- My hope is that it helpful, and will modify it to fit your needs. +- That is the key take away. Make it your own. +- You create a fork of ZaneyOS, then modify it. +- If you find an issue and fix it, or provide a new feature, please share it. +- ZaneyOS is not a distro. At this time there are no plans to create an install + ISO. + +
+
+ +
+**🖼️ Settings and configuration** + +
+ +
+**How do I set default apps (PDF, browser) per host?** + +- Edit `~/zaneyos/hosts//variables.nix` and uncomment `mimeDefaultApps`. +- Home Manager will consume these via `modules/home/xdg.nix` to write your `~/.config/mimeapps.list`. +- Use real `.desktop` IDs from `/usr/share/applications` or `~/.local/share/applications`. + +```nix +# hosts//variables.nix +# Host-level default applications (picked up by Home Manager xdg.mimeApps) +# mimeDefaultApps = { +# # PDFs +# "application/pdf" = ["okular.desktop"]; +# "application/x-pdf" = ["okular.desktop"]; +# # Web browser +# "x-scheme-handler/http" = ["google-chrome.desktop"]; # or brave-browser.desktop, firefox.desktop +# "x-scheme-handler/https" = ["google-chrome.desktop"]; +# "text/html" = ["google-chrome.desktop"]; +# # Files +# "inode/directory" = ["thunar.desktop"]; # file manager +# "text/plain" = ["nvim.desktop"]; # or code.desktop +# }; +``` + +
+ +
+**How to I add flatpaks? ?** + +- Edit `~/zaneyos/modules/core/flatpak.nix` +- There is a list of sample apps you can use as a template + +```nix + services = { + flatpak = { + enable = true; + + # List the Flatpak applications you want to install + # Use the official Flatpak application ID (e.g., from flathub.org) + # Examples: + packages = [ + #"com.github.tchx84.Flatseal" #Manage flatpak permissions - should always have this + #"com.rtosta.zapzap" # WhatsApp client + #"io.github.flattool.Warehouse" # Manage flatpaks, clean data, remove flatpaks and deps + #"it.mijorus.gearlever" # Manage and support AppImages + #"io.github.freedoom.Phase1" # Classic Doom FPS 1 + #"io.github.freedoom.Phase2" # Classic Doom FPS 2 + #"io.github.dvlv.boxbuddyrs" # Manage distroboxes + + # Add other Flatpak IDs here, e.g., "org.mozilla.firefox" + ]; + + # Optional: Automatically update Flatpaks when you run nixos-rebuild swit ch + update.onActivation = true; + }; + }; +``` + +- Make sure you use the correct package name +- Go to `flathub.org`to verify or use `flatpak search PACKAGENAME` +- Save the file and to a rebuild with the `fr`alias +- After you can run `flatpak list` to verify the install +- When you run `fu` or `fr` the flatpaks will get updated as well + +
+ +
+**How to I remove flatpaks? ?** + +- Edit `~/zaneyos/modules/core/flatpak.nix` + +```nix + services = { + flatpak = { + enable = true; + + # List the Flatpak applications you want to install + # Use the official Flatpak application ID (e.g., from flathub.org) + # Examples: + packages = [ + #"com.github.tchx84.Flatseal" #Manage flatpak permissions - should always have this + #"com.rtosta.zapzap" # WhatsApp client + #"io.github.flattool.Warehouse" # Manage flatpaks, clean data, remove flatpaks and deps + #"it.mijorus.gearlever" # Manage and support AppImages + #"io.github.freedoom.Phase1" # Classic Doom FPS 1 + #"io.github.freedoom.Phase2" # Classic Doom FPS 2 + #"io.github.dvlv.boxbuddyrs" # Manage distroboxes + + # Add other Flatpak IDs here, e.g., "org.mozilla.firefox" + ]; + + # Optional: Automatically update Flatpaks when you run nixos-rebuild swit ch + update.onActivation = true; + }; + }; +``` + +- Either remove the line with the package you want to remove or comment it out +- Save the file and to a rebuild with the `fr`alias +- After you can run `flatpak list` to verify the package(s) are removed +- Note the base dependencies for flatpaks remain once installed. + +
+ +
+**How to I change the waybar?** + +- Go to the `~/zaneyos/host/HOSTNAME` +- Edit the `variables.nix` file +- Find the line that starts `waybarChoice` +- Change the name to one of the available files +- `waybar-simple.nix`, `waybar-curved.nix`, or `waybar-ddubs.nix` +- Save the file and exit +- You need to do a rebuild to make the change effective +- Run `fr` "flake rebuild" to start the rebuild process + +```json +# Set Waybar +# Includes alternates such as waybar-simple.nix, waybar-curved.nix & waybar-ddubs.nix +waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; +``` + +
+ +
+** How do I change the Timezone? ** + +1. In the file, `~/zaneyos/modules/core/system.nix` +2. Edit the line: time.timeZone = "America/New_York"; +3. Save the file and rebuild using the `fr` alias. + +
+ +
+**How do I change the monitor settings? ** + +Monitor settings are in the file: `~/zaneyos/hosts//variables.nix` + +Inside the quotes the syntax is "monitor=video apapter,resolution@refresh rate, +auto,scale" Monitor must be in all lowercase. If you are not sure of your video +devices run `hyprctl monitors` at a terminal CLI. The output will look similar +to this: + +```text +hyprctl monitors +Monitor HDMI-A-1 (ID 0): + 2560x1440@143.91200 at 0x0 + description: Dell Inc. DELL S3222DGM F45WJK3 + make: Dell Inc. + model: DELL S3222DGM + serial: F45WJK3 + active workspace: 1 (1) + special workspace: 0 () + reserved: 0 52 0 0 + scale: 1.00 + transform: 0 + focused: yes + dpmsStatus: 1 + vrr: false + solitary: 0 + activelyTearing: false + directScanoutTo: 0 + disabled: false + currentFormat: XRGB8888 + mirrorOf: none + availableModes: 2560x1440@59.95Hz 2560x1440@143.91Hz 2560x1440@120.00Hz 1920x1200@59.95Hz 1920x1080@143.86Hz 1920x1080@120.00Hz 1920x1080@119.88Hz 1920x1080@60.00Hz 1920x1080@60.00Hz 1920x1080@59.94Hz 1920x1080@50.00Hz 1600x1200@60.00Hz 1680x1050@59.88Hz 1280x1024@75.03Hz 1280x1024@60.02Hz 1440x900@59.95Hz 1280x800@59.91Hz 1152x864@75.00Hz 1280x720@120.00Hz 1280x720@119.88Hz 1280x720@60.00Hz 1280x720@59.94Hz 1280x720@50.00Hz 1024x768@75.03Hz 1024x768@60.00Hz 800x600@75.00Hz 800x600@60.32Hz 720x576@50.00Hz 720x576@50.00Hz 720x480@60.00Hz 720x480@60.00Hz 720x480@59.94Hz 720x480@59.94Hz 640x480@75.00Hz 640x480@60.00Hz 640x480@59.94Hz 640x480@59.94Hz 720x400@70.08Hz +``` + +Edit the `extraMonitorSettings` line. **Examples:** + +- Single Monitor: `extraMonitorSettings = "monitor=eDP-1,1920x1080@60,auto,1";` +- Multiple Monitors: + `extraMonitorSettings = " + monitor=eDP-1,1920x1080@60,auto,auto + monitor=HDMI-A-1,2560x1440@75,auto,auto + ";` + +- For more complex, multi-monitor configurations, you may wish to use the GUI + application, `nwg-displays` This will show your currently connected monitors + allowing you to use the mouse match how they are physicall arranged. E.g. what + monitor is to the left, right, up or down. It is very similar to the X11 based + tool, `arandr` It will then create a Hyprland compatible configuration file at + `~/.config/hypr/monitors.conf` + + + +After you finish configring the monitors as you wish, hit `Apply` to save the +changes to `~/.config/hypr/monitors.conf`\ +The contents will look something like this: + +```text +# Generated by nwg-displays on 2025-03-20 at 13:13:49. Do not edit manually. +monitor=HDMI-A-1,1920x1080@74.97,2136x268,1.0 +monitor=eDP-1,1920x1080@144.0,216x268,1.0 +``` + +You only need to copy the `monitor=` lines and paste them into the +`variables.nix` file as described in the process above. + +Once you have that done. Run the command alias `fr` to build a new generation to +make the chnages effective. + +More information on configuring monitors is available on the +[Hyprland Wiki](https://wiki.hyprland.org/Configuring/Monitors/) + +
+ +
+**How do I add applications to ZaneyOS? ** + +### There are two options. One for all hosts you have, another for a specific host. + +1. For applications to be included in all defined hosts edit the + `~/zaneyos/modules/core/packages.nix` file. + +There is a section that begins with: `environment.systemPackages = with pkgs;` + +Followed by a list of packages These are required for ZaneyOS. + +We suggest you add a comment at the end of the package names. Then add in your +packages. + +```text + ... + virt-viewer + wget + ### My Apps ### + bottom + dua + emacs-nox + fd + gping + lazygit + lunarvim + luarocks + mission-center + ncdu + nvtopPackages.full + oh-my-posh + pyprland + shellcheck + multimarkdown + nodejs_23 + ugrep + zoxide + ]; +} +``` + +2. For applications that will only be on specific host. + +You edit the `host-packages.nix` associated with that host. +`~/zaneyos/hosts//host-packages.nix` + +The part of the file you need to edit, looks like this: + +```nix +{ pkgs, ... }: { + environment.systemPackages = with pkgs; [ + audacity + discord + nodejs + obs-studio + ]; +} +``` + +You can add additional packages, or for example change `discord` to +`discord-canary` to get the beta version of Discord but only on this host. + +
+ +
+ +** I added the package names, now how do I install them ? ** + +- Use the `zcli` utility. `zcli rebuild` +- The legacy `fr`, Flake Rebuild alias, is depreciated but still available + +If the rebuild completes successfully, a new generation with your added packages +will be created. + +
+ +
+** How do I update the packages I've already installed? ** + +- Use the `zcli` utility. `zcli update` +- The `fu`, Flake Update alias, is depreciated but still available +- Either of these will check for updated packages, download and install them. + +
+ +
+** I made a change to my ZaneyOS configuration, how do I activate it? ** + +- Use the `zcli` utility. `zcli rebuild` +- The legacy `fr`, Flake Rebuild alias, is depreciated but still available ** + NOTE: If you **created a new file\*\* +- you will need to run a `git add .` command in the `zaneyos` folder +- If successful a new generation will be generated with your changes +- A logout or reboot could be required depending on what you changed + +
+ +
+** How can I configure a different kernel on a specific host? ** + +1. You have to edit the `hardware.nix` file for that host in + `~/zaneyos/hosts/HOSTNAME/hardware.nix` and override the default. +2. Near the top you will find this section of the `hardware.nix` file. + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +3. Add the override. E.g. to set the kernel to 6.12. + +- `boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12;` + +4. The updated code should look like this: + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +5. Use the command `zcli rebuild` or alias `fr` to create a new generation and + reboot to take effect. + +
+ +
+ +** What are the major Kernel options in NixOS? ** +NixOS offers several major kernel types to cater to different needs and preferences. Below are the available options, excluding specific kernel versions: + +1. **`linuxPackages`** + - The default stable kernel, typically an LTS (Long-Term Support) version. + LTS in 25.05 (warbler) is 6.12.x Older kernels, 6.6.x, 6.8.x are not + supported. + +2. **`linuxPackages_latest`** + - The latest mainline kernel, which may include newer features but could be + less stable. + +3. **`linuxPackages_zen`** + - A performance-optimized kernel with patches aimed at improving + responsiveness and interactivity. Commonly used by gamers and desktop + users. + +4. **`linuxPackages_hardened`** + - A security-focused kernel with additional hardening patches for enhanced + protection. + +5. **`linuxPackages_rt`** + - A real-time kernel designed for low-latency and time-sensitive + applications, such as audio production or robotics. + +6. **`linuxPackages_libre`** + - A kernel stripped of proprietary firmware and drivers, adhering to free + software principles. + +7. **`linuxPackages_xen_dom0`** + - A kernel tailored for running as the host (dom0) in Xen virtualization + environments. + +8. **`linuxPackages_mptcp`** + - A kernel with support for Multipath TCP, useful for advanced networking + scenarios. + +
+ +
+ +** I have older generations I want to delete, how can I do that? ** + +- The `ncg` NixOS Clean Generations alias will remove **ALL** but the most + current generation. Make sure you have booted from that generation before + using this alias. There is also a schedule that will remove older generations + automatically over time. + +
+ +
+ +**How do I change the hostname? ** + +To change the hostname, there are several steps and you will have to reboot to +make the change effective. + +1. Copy the directory of the host you want to rename to a directory with the new + name. + +- `cp -rpv ~/zaneyos/hosts/OLD-HOSTNAME ~/zaneyos/hosts/NEW-HOSTNAME` + +2. Edit the `~/zaneyos/flake.nix` file. Change the line: + +- `host = "NEW-HOSTNAME"` + +3. In the `~/zaneyos` Directory run `git add .` _The rebuild will fail with a + 'file not found' error if you forget this step._ + +4. Use the `zcli rebuild` or fr` alias to create a new generation with the new + hostname. You must reboot to make the change effective. + +
+
+** How do I disable the spinning snowflake at startup? ** + +1. Edit the `~/zaneyos/modules/core/boot.nix` file. +2. Look for: + +```nix +}; + plymouth.enable = true; +}; +``` + +3. Change it to `false` +4. Run the command `zcli rebuild` or use alias `fr` to create a new generation. + +
+ +
+ ** How do I configure my hybrid laptop with Intel/NVIDIA GPUs? ** + +1. Either run the `install-zaneyos.sh` script and select `nvidia-laptop` + template or if configuring manually, set the template in the `flake.nix` to + `nvidia-prime` + +2. In the `~/zaneyos/hosts/HYBRID-HOST/variables.nix` file you will need to set + the PCI IDs for the Intel and NVIDIA GPUs. Refer to + [this page](https://nixos.wiki/wiki/Nvidia) to help determine those values. + +3. Once you have everything configured properly, use the `fr` Flake Rebuild + alias to create a new generation. + +4. In the `~/zaneyos/modules/home/hyprland/config.nix` file is an ENV + setting`"AQ_DRM_DEVICES,/dev/dri/card0:/dev/dri/card1:/dev/dri/card2"` This + sets the primary and secondary GPUs. Using the info from the weblink above + you might have to change the order of these values. + +
+ +
+ +
+ +
+**🎨 Stylix** + +
+ +
+How do I enable or disable Stylix? + +- To Enable: + +1. Edit the `~/zaneyos/modules/core/stylix.nix` file. +2. Comment out from `base16Scheme` to the `};` after `base0F` + +```nix +# Styling Options + stylix = { + enable = true; + image = ../../wallpapers/Anime-girl-sitting-night-sky_1952x1120.jpg; + #image = ../../wallpapers/Rainnight.jpg; + #image = ../../wallpapers/zaney-wallpaper.jpg; + # base16Scheme = { + # base00 = "282936"; + # base01 = "3a3c4e"; + # base02 = "4d4f68"; + # base03 = "626483"; + # base04 = "62d6e8"; + # base05 = "e9e9f4"; + # base06 = "f1f2f8"; + # base07 = "f7f7fb"; + # base08 = "ea51b2"; + # base09 = "b45bcf"; + # base0A = "00f769"; + # base0B = "ebff87"; + # base0C = "a1efe4"; + # base0D = "62d6e8"; + # base0E = "b45bcf"; + # base0F = "00f769"; + #}; + polarity = "dark"; + opacity.terminal = 1.0; + cursor = { + package = pkgs.bibata-cursors; + name = "Bibata-Modern-Ice"; + size = 24; + }; +``` + +3. Select the image you want `stylix` to use for the colorpalette. +4. Run `zcli rebuild` command or `fr` alias to create a new generation with this + colorscheme. + +- To disable uncomment + +1. Edit the `~/zaneyos/modules/core/stylix.nix` file. +2. Uncomment out from `base16Scheme` to the `};` after `base0F` + +```nix + base16Scheme = { + base00 = "282936"; + base01 = "3a3c4e"; + base02 = "4d4f68"; + base03 = "626483"; + base04 = "62d6e8"; + base05 = "e9e9f4"; + base06 = "f1f2f8"; + base07 = "f7f7fb"; + base08 = "ea51b2"; + base09 = "b45bcf"; + base0A = "00f769"; + base0B = "ebff87"; + base0C = "a1efe4"; + base0D = "62d6e8"; + base0E = "b45bcf"; + base0F = "00f769"; +}; +``` + +3. Run the `zcli rebuild` command or `fr` alias to build a new generation with + either the default dracula or set your own custom colors + +
+ +
+ How do I change the image Stylix uses to theme with? + +1. Edit the `~/zaneyos/hosts/HOSTNAME/varibles.nix` +2. Change the `stylixImage =` to the filename you want to use. Wallpapers are in + `~/zaneyos/wallpapers` + +```nix +# Set Stylix Image +stylixImage = ../../wallpapers/AnimeGirlNightSky.jpg; +``` + +
+ +
+ +
+ +
+**🌃 Wallpapers** + +
+ +
+** How do I add more wallpapers? ** + +- Wallpapers are stored in the `~/zaneyos/wallpapers` directory. +- Simply copy the new ones to that diretory. +- You must do a rebuild after adding new wallpapers. +- Run `zcli rebuild` command `fr` alias at the CLI. + +
+ +
+ +** How do I change the background? ** + +- SUPER + ALT + W will select a new background + +
+ +
+ +** How can I set a timer to change the wallpaper automatically? ** + +1. Edit the `~/zaneyos/modules/home/hyprland/config.nix` file. +2. Comment out the line `sleep 1.5 && awww img ...` +3. Add new line after that with `sleep 1 && wallsetter` + +```json +settings = { + exec-once = [ + "dbus-update-activation-environment --all --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "systemctl --user import-environment WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "killall -q awww;sleep .5 && awww init" + "killall -q waybar;sleep .5 && waybar" + "killall -q swaync;sleep .5 && swaync" + "nm-applet --indicator" + "lxqt-policykit-agent" + "pypr &" + #"sleep 1.5 && awww img /home/${username}/Pictures/Wallpapers/zaney-wallpaper.jpg" + "sleep 1 && wallsetter" + ]; +``` + +4. Run the `zcli rebuild` command or `fr` alias to create a new generation. +5. You will need to logout or reboot to make the change effective. + +
+ +
+ +**How do I change the interval the wallpaper changes? ** + +1. Edit the `~/zaneyos/modules/home/scripts/wallsetter` +2. Change the `TIMEOUT =` value. Which is in seconds. +3. Run the `zcli` command or`fr` alias, to create a new generation. +4. You will need to logout or reboot to make the change effective. + +
+ +
+ +
+ +
+**⬆ How do I update ZaneyOS? ** + +
+ +
+ For version v2.3 + +Strongly recommended: Read `ZaneyOS-Upgrade.md` before proceeding. It details +the safe, automated upgrade, backup, and revert process. + +Use the automated v2.3 → v2.4 upgrade. See `ZaneyOS-Upgrade.md` and +`UPGRADE-2.3-to-2.4.md`. To avoid overwriting your config before a backup is +created, fetch just the script without modifying your working tree: + +- Git (recommended): + +```bash +git -C ~/zaneyos fetch origin +git -C ~/zaneyos show origin/main:upgrade-2.3-to-2.4.sh > ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +- Curl: + +```bash +curl -fsSL https://gitlab.com/zaney/zaneyos/-/raw/main/upgrade-2.3-to-2.4.sh -o ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +Then run the script: `~/upgrade-2.3-to-2.4.sh`. It will create a full backup +before switching branches and migrate your hosts safely from the backup. + +**IMPORTANT:** + +- Do NOT use the `fu` or `fr` aliases for this upgrade; the script uses a safe + boot build. +- If you have made extensive modifications, do not run the script. Read the docs + above and migrate manually instead. + +
+ +
+ For versions v2.0->2.2 + +1. First backup your existing `zaneyos` directory. e.g. + `cp -r ~/zaneyos ~/zaneyos-backup` + +2. There is no direct update. When you clone the the new config the config files + and layout have changed. + +3. You need to install zaneyos like a new install. `./install-zaneyos.sh` + +4. Once the build completes and you have rebooted you can review the new layout + and decide what if any changes you made on the earlier version can be + migrated to v2.3. + +
+ +
+ For version v1.x + +1. The layout and configuration are completely different. Virtually noting from + 1.x is applicable to v2.3. + +2. Backup your `zaneyos` directory e.g. `cp -r ~/zaneyos ~/zaneyos-backup` + +3. Run the `./install-zaneyos.sh` script and follow the new install + instructions. + +
+ +
+ How do I know when a new version of ZaneyOS is released? + +It will be announced on the Zaney [Discord](https://discord.gg/W7efsSDS) server. + +
+ +
+ +
+ + + +
**📂 ZaneyOS v2.3 Layout** + +
+ +** 📂 ~/zaneyos ** + +```text +~/zaneyos/ + ├── hosts/ # Folder where host configs are saved + │ ├── default # Default host template + │ └── nixstation # Zaney's host + ├── img/ # Images for README.md + ├── modules/ # Core, HomeMgr, drivers config files + │ └── drivers/ # AMD,NVIDA,Intel,VM config files + │ └── core/ # Services, packages, fonts, etc + │ └── home/ # Home Manager config files + │ ├── fastfetch/ # Fastfetch config + │ ├── hyprland/ # Hyrprland configs + │ ├── rofi/ # rofi menu configs + │ ├── scripts/ # screenshots, wallpaper, etc. + │ ├── waybar/ # waybar configs in NIX format + │ ├── wlogout/ # Theme, config for logout menu + │ ├── yazi/ # TUI filemgr config file + │ └── zsh/ # Theme and settings for ZSH + ├── profiles/ # Video hardware templates + │ ├── amd/ # AMD Video config files + │ ├── intel/ # Intel video config files + │ ├── nvidia/ # NVIDIA discrete video config files + │ ├── nvidia-laptop/ # NVIDIA Hybrid video config files + │ └── vm/ # Virtual Machine config files + ├── wallpapers/ # Add your wallpapers here + ├── CHANGELOG.md # List of changes + ├── CONTRIBUTING.md # How you can help + ├── FAQ.md # Frequently Asked Questions + ├── flake.lock # Saves version info on all installed packages + ├── flake.nix # flake that controls ZaneyOS config + ├── install-zaneyos.sh # Install script for ZaneyOS + ├── LICENSE # MIT license ZaneyOS is using + └── README.md # Intro document for ZaneyOS +``` + +
+ +
+ +**---> 🧰 Miscellaneous** + +
+ +**🪧 Rebuild or update fails with Home Manager error can't backup a file** + +
+
+ +**Update** +
+ +- Using the `zcli rebuild` or `zcli update` will search for this file causing + rebuild failures +- If you find other files that cause this you can add them in the + `zaneyos/modules/home/scripts/default.nix` +
+ +```text +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: Please do one of the following: +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - Move or remove the above files and try again. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - In standalone mode, use 'home-manager switch -b backup' to back up +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: files automatically. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - When used as a NixOS or nix-darwin module, set +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: 'home-manager.backupFileExtension' +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: to, for example, 'backup' and rebuild. +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Main process exited, code=exited, status=1/FAILURE +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Failed with result 'exit-code'. +May 08 18:33:57 explorer systemd[1]: Failed to start Home Manager environment for dwilliams. +``` + +- There is a script `hm-find` That will search the journal and if found, +- It will prompt you to delete these backups +- It creates a log as well +- Note: The script is not perfect +- If you get this msg but `hm-find` doesn't report any you will have to search + manually e.g `journalctl | grep hm-activate` +- You can now redo your rebuild +- Use the `zcli rebuild` or `fr` alias +- If you ran `fu` for `flake update` you can now do `zcli rebuild` or `fr` for + `flake rebuild` +- The flake has already been updated + +
+
+ +
+ +**📚 What is the difference between Master and Dwindle layouts** + +
+
+ +**1. Master Layout** + +- The **Master** layout divides the workspace into two main areas: + - A **master area** for the primary window, which takes up a larger portion of + the screen. + - A **stack area** for all other windows, which are tiled in the remaining + space. +- This layout is ideal for workflows where you want to focus on a single main + window while keeping others accessible. + +**2. Dwindle Layout** + +- The **Dwindle** layout is a binary tree-based tiling layout: + - Each new window splits the available space dynamically, alternating between + horizontal and vertical splits. + - The splits are determined by the aspect ratio of the parent container (e.g., + wider splits horizontally, taller splits vertically). +- This layout is more dynamic and evenly distributes space among all windows. + +--- + +**How to Verify the Current Layout** + +To check which layout is currently active, use the `hyprctl` command: + +`hyprctl getoption general:layout` + +
+ + + + +
+**📦 What are the Yazi keybindings and how can I change them? ** + +

+ +The Yazi configuration file is located in `~/zaneyos/modules/home/yazi.nix` + +Yazi is configured like VIM and VIM motions + +The keymap is in the `~/zaneyos/modules/home/yazi/keymap.toml` file + +
+
+ +
+ +** What fonts are avialable in NixOS** + +```nix +{pkgs, ...}: { + fonts = { + packages = with pkgs; [ + dejavu_fonts + fira-code + fira-code-symbols + font-awesome + hackgen-nf-font + ibm-plex + inter + jetbrains-mono + material-icons + maple-mono.NF + minecraftia + nerd-fonts.im-writing + nerd-fonts.blex-mono + noto-fonts + noto-fonts-emoji + noto-fonts-cjk-sans + noto-fonts-cjk-serif + noto-fonts-monochrome-emoji + powerline-fonts + roboto + roboto-mono + symbola + terminus_font + # NERD fonts + nerd-fonts.0xproto + nerd-fonts._3270 + nerd-fonts.agave + nerd-fonts.anonymice + nerd-fonts.arimo + nerd-fonts.aurulent-sans-mono + nerd-fonts.bigblue-terminal + nerd-fonts.bitstream-vera-sans-mono + nerd-fonts.blex-mono + nerd-fonts.caskaydia-cove + nerd-fonts.caskaydia-mono + nerd-fonts.code-new-roman + nerd-fonts.comic-shanns-mono + nerd-fonts.commit-mono + nerd-fonts.cousine + nerd-fonts.d2coding + nerd-fonts.daddy-time-mono + nerd-fonts.departure-mono + nerd-fonts.dejavu-sans-mono + nerd-fonts.droid-sans-mono + nerd-fonts.envy-code-r + nerd-fonts.fantasque-sans-mono + nerd-fonts.fira-code + nerd-fonts.fira-mono + nerd-fonts.geist-mono + nerd-fonts.go-mono + nerd-fonts.gohufont + nerd-fonts.hack + nerd-fonts.hasklug + nerd-fonts.heavy-data + nerd-fonts.hurmit + nerd-fonts.im-writing + nerd-fonts.inconsolata + nerd-fonts.inconsolata-go + nerd-fonts.inconsolata-lgc + nerd-fonts.intone-mono + nerd-fonts.iosevka + nerd-fonts.iosevka-term + nerd-fonts.iosevka-term-slab + nerd-fonts.jetbrains-mono + nerd-fonts.lekton + nerd-fonts.liberation + nerd-fonts.lilex + nerd-fonts.martian-mono + nerd-fonts.meslo-lg + nerd-fonts.monaspace + nerd-fonts.monofur + nerd-fonts.monoid + nerd-fonts.mononoki + nerd-fonts.mplus + nerd-fonts.noto + nerd-fonts.open-dyslexic + nerd-fonts.overpass + nerd-fonts.profont + nerd-fonts.proggy-clean-tt + nerd-fonts.recursive-mono + nerd-fonts.roboto-mono + nerd-fonts.shure-tech-mono + nerd-fonts.sauce-code-pro + nerd-fonts.space-mono + nerd-fonts.symbols-only + nerd-fonts.terminess-ttf + nerd-fonts.tinos + nerd-fonts.ubuntu + nerd-fonts.ubuntu-mono + nerd-fonts.ubuntu-sans + nerd-fonts.victor-mono + nerd-fonts.zed-mono + + ]; + }; +} +``` + +
+ +**---> 🖥️ Terminals ** + +
+**🐱 Kitty** + +
+ +My cursor in Kitty is "janky" and it jumps around. How do I fix that? + +- That feature is called "cursor_trail" in the + `~/zaneyos/modules/home/kitty.nix` file. + +1. Edit that file and change the `cursor_trail 1` to `cursor_trail 0` or comment + out that line. +2. Use the command `zcli rebuild` or the alias `fr` to create a new generation + with the change. + +
+ +
+ What are the Kitty keybindings and how can I change them? + +The kitty bindings are configured in `~/zaneyos/modules/home/kitty.nix` + +The defaults are: + +```text + # Clipboard + map ctrl+shift+v paste_from_selection + map shift+insert paste_from_selection + + # Scrolling + map ctrl+shift+up scroll_line_up + map ctrl+shift+down scroll_line_down + map ctrl+shift+k scroll_line_up + map ctrl+shift+j scroll_line_down + map ctrl+shift+page_up scroll_page_up + map ctrl+shift+page_down scroll_page_down + map ctrl+shift+home scroll_home + map ctrl+shift+end scroll_end + map ctrl+shift+h show_scrollback + + # Window management + map alt+n new_window_with_cwd #Opens new window in current directory + #map alt+n new_os_window #Opens new window in $HOME dir + map alt+w close_window + map ctrl+shift+enter launch --location=hsplit + map ctrl+shift+s launch --location=vsplit + map ctrl+shift+] next_window + map ctrl+shift+[ previous_window + map ctrl+shift+f move_window_forward + map ctrl+shift+b move_window_backward + map ctrl+shift+` move_window_to_top + map ctrl+shift+1 first_window + map ctrl+shift+2 second_window + map ctrl+shift+3 third_window + map ctrl+shift+4 fourth_window + map ctrl+shift+5 fifth_window + map ctrl+shift+6 sixth_window + map ctrl+shift+7 seventh_window + map ctrl+shift+8 eighth_window + map ctrl+shift+9 ninth_window + map ctrl+shift+0 tenth_window + + # Tab management + map ctrl+shift+right next_tab + map ctrl+shift+left previous_tab + map ctrl+shift+t new_tab + map ctrl+shift+q close_tab + map ctrl+shift+l next_layout + map ctrl+shift+. move_tab_forward + map ctrl+shift+, move_tab_backward + + # Miscellaneous + map ctrl+shift+up increase_font_size + map ctrl+shift+down decrease_font_size + map ctrl+shift+backspace restore_font_size +``` + +
+
+ +
+ +**🇼 WezTerm** + +
+ +
+ +How do I enable WezTerm? + +Edit the `/zaneyos/modules/home/wezterm.nix` Change `enable = false` to +`enable = true;`\ +Save the file and rebuild zaneyos with the `fr` command. + +``` +{pkgs, ...}: { + programs.wezterm = { + enable = false; + package = pkgs.wezterm; + }; +``` + +
+ +
+ What are the WezTerm keybindings and how can I change them? + +The kitty bindings are configured in `~/zaneyos/modules/home/wezterm.nix` + +The defaults are: + +```text +ALT is the defined META key for WezTerm + -- Tab management +ALT + t Open new Tab +ALT + w Close current Tab +ALT + n Move to next Tab +ALT + p Move to previous Tab + -- Pane management +ALT + v Create Vertical Split +ALT + h Create Horizontal Split +ALT + q Close Current Pane + -- Pane navigation (move between panes with ALT + Arrows) +ALT + Left Arrow Move to pane -- Left +ALT + Right Arrow Move to pane -- Right +ALT + Down Arrow Move to pane -- Down +ALT + Up Arrow Move to pane -- Down +``` + +
+
+
+ +
+**👻 Ghostty ** + +
+ +
+ How do I enable the ghostty terminal? + +1. Edit the `~/zaneyos/modules/home/ghostty.nix` file. +2. Change `enable = true;` +3. Run the command alias `fr` to create a new generation. + +
+ +
+ + How do I change the ghostty theme? + +1. Edit the `~/zaneyos/modules/home/ghostty.nix` file. +2. There are several example themes included but commented out. + +```text +#theme = Aura +theme = Dracula +#theme = Aardvark Blue +#theme = GruvboxDarkHard +``` + +3. Comment out `Dracula` and either uncomment one of the others or add one of + ghostty's many themes. + +
+ +
+ What are the default ghostty keybindings? + +```text + # keybindings + keybind = alt+s>r=reload_config + keybind = alt+s>x=close_surface + + keybind = alt+s>n=new_window + + # tabs + keybind = alt+s>c=new_tab + keybind = alt+s>shift+l=next_tab + keybind = alt+s>shift+h=previous_tab + keybind = alt+s>comma=move_tab:-1 + keybind = alt+s>period=move_tab:1 + + # quick tab switch + keybind = alt+s>1=goto_tab:1 + keybind = alt+s>2=goto_tab:2 + keybind = alt+s>3=goto_tab:3 + keybind = alt+s>4=goto_tab:4 + keybind = alt+s>5=goto_tab:5 + keybind = alt+s>6=goto_tab:6 + keybind = alt+s>7=goto_tab:7 + keybind = alt+s>8=goto_tab:8 + keybind = alt+s>9=goto_tab:9 + + # split + keybind = alt+s>\=new_split:right + keybind = alt+s>-=new_split:down + + keybind = alt+s>j=goto_split:bottom + keybind = alt+s>k=goto_split:top + keybind = alt+s>h=goto_split:left + keybind = alt+s>l=goto_split:right + + keybind = alt+s>z=toggle_split_zoom + + keybind = alt+s>e=equalize_splits +``` + +
+
+
+ +** --> 🪧 General NixOS related topics ** + +
+**❄ What are Flakes in NixOS? ** + +
+ +**Flakes** are a feature of the Nix package manager that simplifies and +standardizes how configurations, dependencies, and packages are managed. If +you're familiar with tools like `package.json` in JavaScript or `Cargo.toml` in +Rust, flakes serve a similar purpose in the Nix ecosystem. + +** Key Features of Flakes: ** + +1. **Pin Dependencies**: + - Flakes lock the versions of dependencies in a `flake.lock` file, ensuring + reproducibility across systems. + +2. **Standardize Configurations**: + - They use a `flake.nix` file to define how to build, run, or deploy a + project or system, making setups more predictable. + +3. **Improve Usability**: + - Flakes simplify sharing and reusing configurations across different systems + or projects by providing a consistent structure. + +In essence, flakes help manage NixOS setups or Nix-based projects in a more +portable and reliable way. + +
+ +
+ +
+**🏡 What is NixOS Home Manager? ** + +**Home Manager** is a powerful tool in the Nix ecosystem that allows you to +declaratively manage user-specific configurations and environments. With Home +Manager, you can streamline the setup of dotfiles, shell settings, applications, +and system packages for your user profile. + +### Key Features of Home Manager: + +1. **Declarative Configuration**: + - Define all your settings and preferences in a single `home.nix` file, + making it easy to track, share, and replicate your setup. + +2. **Cross-Distribution Support**: + - Home Manager works not only on NixOS but also on other Linux distributions + and macOS, allowing you to standardize configurations across devices. + +3. **User Environment Management**: + - Manage applications, environment variables, shell configurations, and + more—all isolated to your user profile. + +### Why Use Home Manager? + +Home Manager simplifies system management by offering consistency, +reproducibility, and portability. Whether you’re customizing your development +environment or sharing configurations between machines, it provides an efficient +way to tailor your user experience. + +
+ +
+**🏭 What are Atomic Builds?** + +**Atomic builds** in NixOS ensure that any system change (like installing +software or updating the configuration) is applied in a safe and fail-proof way. +This means that a system update is either fully successful or has no effect at +all, eliminating the risk of a partially applied or broken system state. + +### How Atomic Builds Work: + +1. **Immutable System Generation**: + - Every configuration change creates a new "generation" of the system, while + the previous ones remain untouched. You can easily roll back to an earlier + generation if something goes wrong. + +2. **Transaction-Like Behavior**: + - Similar to database transactions, changes are applied atomically: either + they succeed and become the new active system, or they fail and leave the + current system unchanged. + +3. **Seamless Rollbacks**: + - In case of errors or issues, you can reboot and select a previous system + generation from the boot menu to return to a working state. + +### Benefits of Atomic Builds: + +- **Reliability**: Your system is always in a consistent state, even if a + configuration change fails. +- **Reproducibility**: The same configuration will always produce the same + system state, making it easy to debug or replicate. +- **Ease of Rollback**: Reverting to a working configuration is as simple as + rebooting and selecting the previous generation. + +### Why NixOS Uses Atomic Builds: + +This feature is a cornerstone of NixOS's declarative and reproducible design +philosophy, ensuring that system management is predictable and stress-free. + +
+ +
+**❓ I am new to NIXOS where can I go to get more info? ** + +- [NIXOS Config Guide](https://www.youtube.com/watch?v=AGVXJ-TIv3Y&t=34s) +- [VIMJOYER YouTube Channel](https://www.youtube.com/@vimjoyer/videos) +- [Librephoenix YouTube Channel](https://www.youtube.com/@librephoenix) +- [8 Part Video Series on NIXOS](https://www.youtube.com/watch?v=QKoQ1gKJY5A&list=PL-saUBvIJzOkjAw_vOac75v-x6EzNzZq-) +- [Great guide for NixOS and Flakes](https://nixos-and-flakes.thiscute.world/preface) + +
+ +
+**🏤 Where can I get info on using GIT repositories ** + +- [Managing NIXOS config with GIT](https://www.youtube.com/watch?v=20BN4gqHwaQ) +- [GIT for dummies](https://www.youtube.com/watch?v=K6Q31YkorUE) +- [How GIT works](https://www.youtube.com/watch?v=e9lnsKot_SQ) +- [In depth 1hr video on GIT](https://www.youtube.com/watch?v=S7XpTAnSDL4&t=123s) + +
+ +
+**How to I change the waybar?** + +- Go to the `~/zaneyos/host/HOSTNAME` +- Edit the `variables.nix` file +- Find the line that starts `waybarChoice` +- Change the name to one of the available files +- `waybar-simple.nix`, `waybar-curved.nix`, or `waybar-ddubs.nix` +- Save the file and exit +- You need to do a rebuild to make the change effective +- Run the `zcli rebuild` command or `fr` "flake rebuild" to start the rebuild + process + +```json +# Set Waybar +# Includes alternates such as waybar-simple.nix, waybar-curved.nix & waybar-ddubs.nix +waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; +``` + +
+ +
+** How do I change the Timezone? ** + +1. In the file, `~/zaneyos/modules/core/system.nix` +2. Edit the line: time.timeZone = "America/New_York"; +3. Save the file and rebuild using the `fr` alias. + +
+ +
+**How do I change the monitor settings? ** + +Monitor settings are in the file: `~/zaneyos/hosts//variables.nix` + +Inside the quotes the syntax is "monitor=video apapter,resolution@refresh rate, +auto,scale" Monitor must be in all lowercase. If you are not sure of your video +devices run `hyprctl monitors` at a terminal CLI. The output will look similar +to this: + +```text +hyprctl monitors +Monitor HDMI-A-1 (ID 0): + 2560x1440@143.91200 at 0x0 + description: Dell Inc. DELL S3222DGM F45WJK3 + make: Dell Inc. + model: DELL S3222DGM + serial: F45WJK3 + active workspace: 1 (1) + special workspace: 0 () + reserved: 0 52 0 0 + scale: 1.00 + transform: 0 + focused: yes + dpmsStatus: 1 + vrr: false + solitary: 0 + activelyTearing: false + directScanoutTo: 0 + disabled: false + currentFormat: XRGB8888 + mirrorOf: none + availableModes: 2560x1440@59.95Hz 2560x1440@143.91Hz 2560x1440@120.00Hz 1920x1200@59.95Hz 1920x1080@143.86Hz 1920x1080@120.00Hz 1920x1080@119.88Hz 1920x1080@60.00Hz 1920x1080@60.00Hz 1920x1080@59.94Hz 1920x1080@50.00Hz 1600x1200@60.00Hz 1680x1050@59.88Hz 1280x1024@75.03Hz 1280x1024@60.02Hz 1440x900@59.95Hz 1280x800@59.91Hz 1152x864@75.00Hz 1280x720@120.00Hz 1280x720@119.88Hz 1280x720@60.00Hz 1280x720@59.94Hz 1280x720@50.00Hz 1024x768@75.03Hz 1024x768@60.00Hz 800x600@75.00Hz 800x600@60.32Hz 720x576@50.00Hz 720x576@50.00Hz 720x480@60.00Hz 720x480@60.00Hz 720x480@59.94Hz 720x480@59.94Hz 640x480@75.00Hz 640x480@60.00Hz 640x480@59.94Hz 640x480@59.94Hz 720x400@70.08Hz +``` + +Edit the `extraMonitorSettings` line. **Examples:** + +- Single Monitor: `extraMonitorSettings = "monitor=eDP-1,1920x1080@60,auto,1";` +- Multiple Monitors: + `extraMonitorSettings = " + monitor=eDP-1,1920x1080@60,auto,auto + monitor=HDMI-A-1,2560x1440@75,auto,auto + ";` + +- For more complex, multi-monitor configurations, you may wish to use the GUI + application, `nwg-displays` This will show your currently connected monitors + allowing you to use the mouse match how they are physicall arranged. E.g. what + monitor is to the left, right, up or down. It is very similar to the X11 based + tool, `arandr` It will then create a Hyprland compatible configuration file at + `~/.config/hypr/monitors.conf` + + + +After you finish configring the monitors as you wish, hit `Apply` to save the +changes to `~/.config/hypr/monitors.conf`\ +The contents will look something like this: + +```text +# Generated by nwg-displays on 2025-03-20 at 13:13:49. Do not edit manually. +monitor=HDMI-A-1,1920x1080@74.97,2136x268,1.0 +monitor=eDP-1,1920x1080@144.0,216x268,1.0 +``` + +You only need to copy the `monitor=` lines and paste them into the +`variables.nix` file as described in the process above. + +Once you have that done. Run the command `zcli rebuild` or alias `fr` to build a +new generation to make the changes effective. + +More information on configuring monitors is available on the +[Hyprland Wiki](https://wiki.hyprland.org/Configuring/Monitors/) + +
+ +
+**How do I add applications to ZaneyOS? ** + +### There are two options. One for all hosts you have, another for a specific host. + +1. For applications to be included in all defined hosts edit the + `~/zaneyos/modules/core/packages.nix` file. + +There is a section that begins with: `environment.systemPackages = with pkgs;` + +Followed by a list of packages These are required for ZaneyOS. + +We suggest you add a comment at the end of the package names. Then add in your +packages. + +```text + ... + virt-viewer + wget + ### My Apps ### + bottom + dua + emacs-nox + fd + gping + lazygit + lunarvim + luarocks + mission-center + ncdu + nvtopPackages.full + oh-my-posh + pyprland + shellcheck + multimarkdown + nodejs_23 + ugrep + zoxide + ]; +} +``` + +2. For applications that will only be on specific host. + +You edit the `host-packages.nix` associated with that host. +`~/zaneyos/hosts//host-packages.nix` + +The part of the file you need to edit, looks like this: + +```nix +{ pkgs, ... }: { + environment.systemPackages = with pkgs; [ + audacity + discord + nodejs + obs-studio + ]; +} +``` + +You can add additional packages, or for example change `discord` to +`discord-canary` to get the beta version of Discord but only on this host. + +
+ +
+ +** I added the package names, now how do I install them ? ** + +- Use the command `zcli rebuild` or `fr`, Flake Rebuild alias. + +If the rebuild completes successfully, a new generation with your added packages +will be created. + +
+ +
+** How do I update the packages I've already installed? ** + +- Use the command `zcli update` or the `fu`, Flake Update alias. This will check + for updated packages, download and install them. + +
+ +
+** I made a change to my ZaneyOS configuration, how do I activate it? ** + +- Use the command `zcli rebuild` or `fr` Flake Rebuild alias. If you **created a + new file** please note you will need to run a `git add .` command in the + `zaneyos` folder. If successful, a new generation will be generated with your + changes. A logout or reboot could be required depending on what you changed. + +
+ +
+** How can I configure a different kernel on a specific host? ** + +1. You have to edit the `hardware.nix` file for that host in + `~/zaneyos/hosts/HOSTNAME/hardware.nix` and override the default. +2. Near the top you will find this section of the `hardware.nix` file. + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +3. Add the override. E.g. to set the kernel to 6.12. + +- `boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12;` + +4. The updated code should look like this: + +```nix +boot.initrd.availableKernelModules = ["xhci_pci" "ahci" "nvme" "usbhid" "usb_storage" "sd_mod" "rtsx_usb_sdmmc"]; +boot.kernelPackages = lib.mkForce pkgs.linuxPackages_6_12; +boot.initrd.kernelModules = []; +boot.kernelModules = ["kvm-intel"]; +boot.extraModulePackages = []; +``` + +5. Use the command `zcli rebuild` or the alias `fr` to create a new generation + and reboot to take effect. + +
+ +
+ +** What are the major Kernel options in NixOS? ** +NixOS offers several major kernel types to cater to different needs and preferences. Below are the available options, excluding specific kernel versions: + +1. **`linuxPackages`** + - The default stable kernel, typically an LTS (Long-Term Support) version. + LTS in 25.05 (warbler) is 6.12.x Older kernels, 6.6.x, 6.8.x are not + supported. + +2. **`linuxPackages_latest`** + - The latest mainline kernel, which may include newer features but could be + less stable. + +3. **`linuxPackages_zen`** + - A performance-optimized kernel with patches aimed at improving + responsiveness and interactivity. Commonly used by gamers and desktop + users. + +4. **`linuxPackages_hardened`** + - A security-focused kernel with additional hardening patches for enhanced + protection. + +5. **`linuxPackages_rt`** + - A real-time kernel designed for low-latency and time-sensitive + applications, such as audio production or robotics. + +6. **`linuxPackages_libre`** + - A kernel stripped of proprietary firmware and drivers, adhering to free + software principles. + +7. **`linuxPackages_xen_dom0`** + - A kernel tailored for running as the host (dom0) in Xen virtualization + environments. + +8. **`linuxPackages_mptcp`** + - A kernel with support for Multipath TCP, useful for advanced networking + scenarios. + +
+ +
+ +** I have older generations I want to delete, how can I do that? ** + +- The `zcli cleanup` command or the `ncg` `(NixOS Clean Generations)` alias will + remove **ALL** but the most current generation. Make sure you have booted from + that generation before using this alias. There is also a schedule that will + remove older generations automatically over time. + +
+ +
+ +**How do I change the hostname? ** + +To change the hostname, there are several steps and you will have to reboot to +make the change effective. + +1. Copy the directory of the host you want to rename to a directory with the new + name. + +- `cp -rpv ~/zaneyos/hosts/OLD-HOSTNAME ~/zaneyos/hosts/NEW-HOSTNAME` + +2. Edit the `~/zaneyos/flake.nix` file. Change the line: + +- `host = "NEW-HOSTNAME"` + +3. In the `~/zaneyos` Directory run `git add .` _The rebuild will fail with a + 'file not found' error if you forget this step._ + +4. Use the command `zcli rebuild` or the `fr` alias to create a new generation + with the new hostname. You must reboot to make the change effective. + +
+
+** How do I disable the spinning snowflake at startup? ** + +1. Edit the `~/zaneyos/modules/core/boot.nix` file. +2. Look for: + +```nix +}; + plymouth.enable = true; +}; +``` + +3. Change it to `false` +4. Run the command `zcli rebuild` or the alias `fr` to create a new generation. + +
+ +
+ ** How do I configure my hybrid laptop with Intel/NVIDIA GPUs? ** + +1. Either run the `install-zaneyos.sh` script and select `nvidia-laptop` + template or if configuring manually, set the template in the `flake.nix` to + `nvidia-prime` + +2. In the `~/zaneyos/hosts/HYBRID-HOST/variables.nix` file you will need to set + the PCI IDs for the Intel and NVIDIA GPUs. Refer to + [this page](https://nixos.wiki/wiki/Nvidia) to help determine those values. + +3. Once you have everything configured properly, use the command `zcli rebuild` + or the `fr` Flake Rebuild alias to create a new generation. + +4. In the `~/zaneyos/modules/home/hyprland/config.nix` file is an ENV + setting`"AQ_DRM_DEVICES,/dev/dri/card0:/dev/dri/card1"` This sets the primary + and secondary GPUs. Using the info from the weblink above you might have to + change the order of these values. + +
+ + + + + +
+**🎨 Stylix** + +
+ +
+How do I enable or disable Stylix? + +- To Enable: + +1. Edit the `~/zaneyos/modules/core/stylix.nix` file. +2. Comment out from `base16Scheme` to the `};` after `base0F` + +```nix +# Styling Options + stylix = { + enable = true; + image = ../../wallpapers/Anime-girl-sitting-night-sky_1952x1120.jpg; + #image = ../../wallpapers/Rainnight.jpg; + #image = ../../wallpapers/zaney-wallpaper.jpg; + # base16Scheme = { + # base00 = "282936"; + # base01 = "3a3c4e"; + # base02 = "4d4f68"; + # base03 = "626483"; + # base04 = "62d6e8"; + # base05 = "e9e9f4"; + # base06 = "f1f2f8"; + # base07 = "f7f7fb"; + # base08 = "ea51b2"; + # base09 = "b45bcf"; + # base0A = "00f769"; + # base0B = "ebff87"; + # base0C = "a1efe4"; + # base0D = "62d6e8"; + # base0E = "b45bcf"; + # base0F = "00f769"; + #}; + polarity = "dark"; + opacity.terminal = 1.0; + cursor = { + package = pkgs.bibata-cursors; + name = "Bibata-Modern-Ice"; + size = 24; + }; +``` + +3. Select the image you want stylix to use for the colorpalette. +4. Run command `zcli rebuild` or the `fr` alias to create a new generation with + this colorscheme. + +- To disable uncomment + +1. Edit the `~/zaneyos/modules/core/stylix.nix` file. +2. Uncomment out from `base16Scheme` to the `};` after `base0F` + +```nix + base16Scheme = { + base00 = "282936"; + base01 = "3a3c4e"; + base02 = "4d4f68"; + base03 = "626483"; + base04 = "62d6e8"; + base05 = "e9e9f4"; + base06 = "f1f2f8"; + base07 = "f7f7fb"; + base08 = "ea51b2"; + base09 = "b45bcf"; + base0A = "00f769"; + base0B = "ebff87"; + base0C = "a1efe4"; + base0D = "62d6e8"; + base0E = "b45bcf"; + base0F = "00f769"; +}; +``` + +3. Run the command `zcli rebuild` or the `fr` alias to build a new generation + with either the default dracula or set your own custom colors + +
+ +
+ How do I change the image Stylix uses to theme with? + +1. Edit the `~/zaneyos/hosts/HOSTNAME/varibles.nix` +2. Change the `stylixImage =` to the filename you want to use. Wallpapers are in + `~/zaneyos/wallpapers` + +```nix +# Set Stylix Image +stylixImage = ../../wallpapers/AnimeGirlNightSky.jpg; +``` + +
+ +
+ +
+ +
+**🌃 Wallpapers** + +
+ +
+** How do I add more wallpapers? ** + +- Wallpapers are stored in the `~/zaneyos/wallpapers` directory. +- Simply copy the new ones to that diretory. +- You must do a rebuild after adding new wallpapers. +- Run the command `zcli rebuild` or the `fr` alias at the CLI. + +
+ +
+ +** How do I change the background? ** + +- SUPER + ALT + W will select a new background + +
+ +
+ +** How can I set a timer to change the wallpaper automatically? ** + +1. Edit the `~/zaneyos/modules/home/hyprland/config.nix` file. +2. Comment out the line `sleep 1.5 && awww img ...` +3. Add new line after that with `sleep 1 && wallsetter` + +```json +settings = { + exec-once = [ + "dbus-update-activation-environment --all --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "systemctl --user import-environment WAYLAND_DISPLAY XDG_CURRENT_DESKTOP" + "killall -q awww;sleep .5 && awww init" + "killall -q waybar;sleep .5 && waybar" + "killall -q swaync;sleep .5 && swaync" + "nm-applet --indicator" + "lxqt-policykit-agent" + "pypr &" + #"sleep 1.5 && awww img /home/${username}/Pictures/Wallpapers/zaney-wallpaper.jpg" + "sleep 1 && wallsetter" + ]; +``` + +4. Run the command `zcli rebuild` or the alias `fr` to create a new generation. +5. You will need to logout or reboot to make the change effective. + +
+ +
+ +**How do I change the interval the wallpaper changes? ** + +1. Edit the `~/zaneyos/modules/home/scripts/wallsetter` +2. Change the `TIMEOUT =` value. Which is in seconds. +3. Run the command `zcli rebuild` or alias `fr` to create a new generation. +4. You will need to logout or reboot to make the change effective. + +
+ +
+ +
+ +
+**⬆ How do I update ZaneyOS? ** + +
+ +
+ For version v2.3 + +Use the automated v2.3 → v2.4 upgrade. See ZaneyOS-Upgrade.md and +UPGRADE-2.3-to-2.4.md. To avoid overwriting your config before a backup is +created, fetch just the script without modifying your working tree: + +- Git (recommended): + +```bash +git -C ~/zaneyos fetch origin +git -C ~/zaneyos show origin/main:upgrade-2.3-to-2.4.sh > ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +- Curl: + +```bash +curl -fsSL https://gitlab.com/zaney/zaneyos/-/raw/main/upgrade-2.3-to-2.4.sh -o ~/upgrade-2.3-to-2.4.sh +chmod +x ~/upgrade-2.3-to-2.4.sh +``` + +Then run the script: `~/upgrade-2.3-to-2.4.sh`. It will create a full backup +before switching branches and migrate your hosts safely from the backup. + +**IMPORTANT:** + +- Do NOT use the `fu` or `fr` aliases for this upgrade; the script uses a safe + boot build. +- If you have made extensive modifications, do not run the script. Read the docs + above and migrate manually instead. + +
+ +
+ For versions v2.0->2.2 + +1. First backup your existing `zaneyos` directory. e.g. + `cp -r ~/zaneyos ~/zaneyos-backup` + +2. There is no direct update. When you clone the the new config the config files + and layout have changed. + +3. You need to install zaneyos like a new install. `./install-zaneyos.sh` + +4. Once the build completes and you have rebooted you can review the new layout + and decide what if any changes you made on the earlier version can be + migrated to v2.3. + +
+ +
+ For version v1.x + +1. The layout and configuration are completely different. Virtually noting from + 1.x is applicable to v2.3. + +2. Backup your `zaneyos` directory e.g. `cp -r ~/zaneyos ~/zaneyos-backup` + +3. Run the `./install-zaneyos.sh` script and follow the new install + instructions. + +
+ +
+ How do I know when a new version of ZaneyOS is released? + +It will be announced on the Zaney [Discord](https://discord.gg/W7efsSDS) server. + +
+ +
+ +
+ + + +
**📂 ZaneyOS v2.3 Layout** + +
+ +** 📂 ~/zaneyos ** + +```text +~/zaneyos/ + ├── hosts/ # Folder where host configs are saved + │ ├── default # Default host template + │ └── nixstation # Zaney's host + ├── img/ # Images for README.md + ├── modules/ # Core, HomeMgr, drivers config files + │ └── drivers/ # AMD,NVIDA,Intel,VM config files + │ └── core/ # Services, packages, fonts, etc + │ └── home/ # Home Manager config files + │ ├── fastfetch/ # Fastfetch config + │ ├── hyprland/ # Hyrprland configs + │ ├── rofi/ # rofi menu configs + │ ├── scripts/ # screenshots, wallpaper, etc. + │ ├── waybar/ # waybar configs in NIX format + │ ├── wlogout/ # Theme, config for logout menu + │ ├── yazi/ # TUI filemgr config file + │ └── zsh/ # Theme and settings for ZSH + ├── profiles/ # Video hardware templates + │ ├── amd/ # AMD Video config files + │ ├── intel/ # Intel video config files + │ ├── nvidia/ # NVIDIA discrete video config files + │ ├── nvidia-laptop/ # NVIDIA Hybrid video config files + │ └── vm/ # Virtual Machine config files + ├── wallpapers/ # Add your wallpapers here + ├── CHANGELOG.md # List of changes + ├── CONTRIBUTING.md # How you can help + ├── FAQ.md # Frequently Asked Questions + ├── flake.lock # Saves version info on all installed packages + ├── flake.nix # flake that controls ZaneyOS config + ├── install-zaneyos.sh # Install script for ZaneyOS + ├── LICENSE # MIT license ZaneyOS is using + └── README.md # Intro document for ZaneyOS +``` + +
+ +
+ +**---> 🧰 Miscellaneous** + +
+ +**🪧 Rebuild or update fails with Home Manager error can't backup a file** + +
+
+ +```text +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: Please do one of the following: +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - Move or remove the above files and try again. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - In standalone mode, use 'home-manager switch -b backup' to back up +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: files automatically. +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: - When used as a NixOS or nix-darwin module, set +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: 'home-manager.backupFileExtension' +May 08 18:33:57 explorer hm-activate-dwilliams[92420]: to, for example, 'backup' and rebuild. +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Main process exited, code=exited, status=1/FAILURE +May 08 18:33:57 explorer systemd[1]: home-manager-dwilliams.service: Failed with result 'exit-code'. +May 08 18:33:57 explorer systemd[1]: Failed to start Home Manager environment for dwilliams. +``` + +- Update: If you use the command `zcli rebuild` or `zcli upgrade` it will remove + the common cause of this If you find an issue and fix it, or provide a new + feature, please share it. +- If you find more files that cause it you can add them to + `~/zaneyos/modules/home/scripts/default.nix` +- There is a script `hm-find` That will search the journal and if found, +- It will prompt you to delete these backups +- It creates a log as well +- Note: The script is not perfect +- If you get this msg but `hm-find` doesn't report any you will have to search + manually e.g `journalctl | grep hm-activate` +- You can now redo your rebuild +- If you ran `fu` for `flake update` you can now do `fr` for `flake rebuild` +- The flake has already been updated + +
+
+ +
+ +**📚 What is the difference between Master and Dwindle layouts** + +
+
+ +**1. Master Layout** + +- The **Master** layout divides the workspace into two main areas: + - A **master area** for the primary window, which takes up a larger portion of + the screen. + - A **stack area** for all other windows, which are tiled in the remaining + space. +- This layout is ideal for workflows where you want to focus on a single main + window while keeping others accessible. + +**2. Dwindle Layout** + +- The **Dwindle** layout is a binary tree-based tiling layout: + - Each new window splits the available space dynamically, alternating between + horizontal and vertical splits. + - The splits are determined by the aspect ratio of the parent container (e.g., + wider splits horizontally, taller splits vertically). +- This layout is more dynamic and evenly distributes space among all windows. + +--- + +**How to Verify the Current Layout** + +To check which layout is currently active, use the `hyprctl` command: + +`hyprctl getoption general:layout` + +
+ + + + +
+**📦 What are the Yazi keybindings and how can I change them? ** + +

+ +The Yazi configuration file is located in `~/zaneyos/modules/home/yazi.nix` + +`Yazi` is configured like VIM and VIM motions + +The keymap is in the `~/zaneyos/modules/home/yazi/keymap.toml` file + +
+
+ +
+ +** What fonts are avialable in NixOS** + +```nix +{pkgs, ...}: { + fonts = { + packages = with pkgs; [ + dejavu_fonts + fira-code + fira-code-symbols + font-awesome + hackgen-nf-font + ibm-plex + inter + jetbrains-mono + material-icons + maple-mono.NF + minecraftia + nerd-fonts.im-writing + nerd-fonts.blex-mono + noto-fonts + noto-fonts-emoji + noto-fonts-cjk-sans + noto-fonts-cjk-serif + noto-fonts-monochrome-emoji + powerline-fonts + roboto + roboto-mono + symbola + terminus_font + # NERD fonts + nerd-fonts.0xproto + nerd-fonts._3270 + nerd-fonts.agave + nerd-fonts.anonymice + nerd-fonts.arimo + nerd-fonts.aurulent-sans-mono + nerd-fonts.bigblue-terminal + nerd-fonts.bitstream-vera-sans-mono + nerd-fonts.blex-mono + nerd-fonts.caskaydia-cove + nerd-fonts.caskaydia-mono + nerd-fonts.code-new-roman + nerd-fonts.comic-shanns-mono + nerd-fonts.commit-mono + nerd-fonts.cousine + nerd-fonts.d2coding + nerd-fonts.daddy-time-mono + nerd-fonts.departure-mono + nerd-fonts.dejavu-sans-mono + nerd-fonts.droid-sans-mono + nerd-fonts.envy-code-r + nerd-fonts.fantasque-sans-mono + nerd-fonts.fira-code + nerd-fonts.fira-mono + nerd-fonts.geist-mono + nerd-fonts.go-mono + nerd-fonts.gohufont + nerd-fonts.hack + nerd-fonts.hasklug + nerd-fonts.heavy-data + nerd-fonts.hurmit + nerd-fonts.im-writing + nerd-fonts.inconsolata + nerd-fonts.inconsolata-go + nerd-fonts.inconsolata-lgc + nerd-fonts.intone-mono + nerd-fonts.iosevka + nerd-fonts.iosevka-term + nerd-fonts.iosevka-term-slab + nerd-fonts.jetbrains-mono + nerd-fonts.lekton + nerd-fonts.liberation + nerd-fonts.lilex + nerd-fonts.martian-mono + nerd-fonts.meslo-lg + nerd-fonts.monaspace + nerd-fonts.monofur + nerd-fonts.monoid + nerd-fonts.mononoki + nerd-fonts.mplus + nerd-fonts.noto + nerd-fonts.open-dyslexic + nerd-fonts.overpass + nerd-fonts.profont + nerd-fonts.proggy-clean-tt + nerd-fonts.recursive-mono + nerd-fonts.roboto-mono + nerd-fonts.shure-tech-mono + nerd-fonts.sauce-code-pro + nerd-fonts.space-mono + nerd-fonts.symbols-only + nerd-fonts.terminess-ttf + nerd-fonts.tinos + nerd-fonts.ubuntu + nerd-fonts.ubuntu-mono + nerd-fonts.ubuntu-sans + nerd-fonts.victor-mono + nerd-fonts.zed-mono + + ]; + }; +} +``` + +
+ +**---> 🖥️ Terminals ** + +
+**🐱 Kitty** + +
+ +My cursor in Kitty is "janky" and it jumps around. How do I fix that? + +- That feature is called "cursor_trail" in the + `~/zaneyos/modules/home/kitty.nix` file. + +1. Edit that file and change the `cursor_trail 1` to `cursor_trail 0` or comment + out that line. +2. Use the command alias `zcli rebuild` or the `fr` to create a new generation + with the change. + +
+ +
+ What are the Kitty keybindings and how can I change them? + +The kitty bindings are configured in `~/zaneyos/modules/home/kitty.nix` + +The defaults are: + +```text + # Clipboard + map ctrl+shift+v paste_from_selection + map shift+insert paste_from_selection + + # Scrolling + map ctrl+shift+up scroll_line_up + map ctrl+shift+down scroll_line_down + map ctrl+shift+k scroll_line_up + map ctrl+shift+j scroll_line_down + map ctrl+shift+page_up scroll_page_up + map ctrl+shift+page_down scroll_page_down + map ctrl+shift+home scroll_home + map ctrl+shift+end scroll_end + map ctrl+shift+h show_scrollback + + # Window management + map alt+n new_window_with_cwd #Opens new window in current directory + #map alt+n new_os_window #Opens new window in $HOME dir + map alt+w close_window + map ctrl+shift+enter launch --location=hsplit + map ctrl+shift+s launch --location=vsplit + map ctrl+shift+] next_window + map ctrl+shift+[ previous_window + map ctrl+shift+f move_window_forward + map ctrl+shift+b move_window_backward + map ctrl+shift+` move_window_to_top + map ctrl+shift+1 first_window + map ctrl+shift+2 second_window + map ctrl+shift+3 third_window + map ctrl+shift+4 fourth_window + map ctrl+shift+5 fifth_window + map ctrl+shift+6 sixth_window + map ctrl+shift+7 seventh_window + map ctrl+shift+8 eighth_window + map ctrl+shift+9 ninth_window + map ctrl+shift+0 tenth_window + + # Tab management + map ctrl+shift+right next_tab + map ctrl+shift+left previous_tab + map ctrl+shift+t new_tab + map ctrl+shift+q close_tab + map ctrl+shift+l next_layout + map ctrl+shift+. move_tab_forward + map ctrl+shift+, move_tab_backward + + # Miscellaneous + map ctrl+shift+up increase_font_size + map ctrl+shift+down decrease_font_size + map ctrl+shift+backspace restore_font_size +``` + +
+
+ +
+ +**🇼 WezTerm** + +
+ +
+ +How do I enable WezTerm? + +Edit the `/zaneyos/modules/home/wezterm.nix` Change `enable = false` to +`enable = true;`\ +Save the file and rebuild `zaneyos` with the `zcli rebild` command or the `fr` +alias + +``` +{pkgs, ...}: { + programs.wezterm = { + enable = false; + package = pkgs.wezterm; + }; +``` + +
+ +
+ What are the WezTerm keybindings and how can I change them? + +The kitty bindings are configured in `~/zaneyos/modules/home/wezterm.nix` + +The defaults are: + +```text +ALT is the defined META key for WezTerm + -- Tab management +ALT + t Open new Tab +ALT + w Close current Tab +ALT + n Move to next Tab +ALT + p Move to previous Tab + -- Pane management +ALT + v Create Vertical Split +ALT + h Create Horizontal Split +ALT + q Close Current Pane + -- Pane navigation (move between panes with ALT + Arrows) +ALT + Left Arrow Move to pane -- Left +ALT + Right Arrow Move to pane -- Right +ALT + Down Arrow Move to pane -- Down +ALT + Up Arrow Move to pane -- Down +``` + +
+
+
+ +
+**👻 Ghostty ** + +
+ +
+ How do I enable the ghostty terminal? + +1. Edit the `~/zaneyos/modules/home/ghostty.nix` file. +2. Change `enable = true;` +3. Run the command alias `fr` to create a new generation. + +
+ +
+ + How do I change the ghostty theme? + +1. Edit the `~/zaneyos/modules/home/ghostty.nix` file. +2. There are several example themes included but commented out. + +```text +#theme = Aura +theme = Dracula +#theme = Aardvark Blue +#theme = GruvboxDarkHard +``` + +3. Comment out `Dracula` and either uncomment one of the others or add one of + ghostty's many themes. + +
+ +
+ What are the default `ghostty` keybindings? + +```text + # keybindings + keybind = alt+s>r=reload_config + keybind = alt+s>x=close_surface + + keybind = alt+s>n=new_window + + # tabs + keybind = alt+s>c=new_tab + keybind = alt+s>shift+l=next_tab + keybind = alt+s>shift+h=previous_tab + keybind = alt+s>comma=move_tab:-1 + keybind = alt+s>period=move_tab:1 + + # quick tab switch + keybind = alt+s>1=goto_tab:1 + keybind = alt+s>2=goto_tab:2 + keybind = alt+s>3=goto_tab:3 + keybind = alt+s>4=goto_tab:4 + keybind = alt+s>5=goto_tab:5 + keybind = alt+s>6=goto_tab:6 + keybind = alt+s>7=goto_tab:7 + keybind = alt+s>8=goto_tab:8 + keybind = alt+s>9=goto_tab:9 + + # split + keybind = alt+s>\=new_split:right + keybind = alt+s>-=new_split:down + + keybind = alt+s>j=goto_split:bottom + keybind = alt+s>k=goto_split:top + keybind = alt+s>h=goto_split:left + keybind = alt+s>l=goto_split:right + + keybind = alt+s>z=toggle_split_zoom + + keybind = alt+s>e=equalize_splits +``` + +
+
+
+ +** --> 🪧 General NixOS related topics ** + +
+**❄ What are Flakes in NixOS? ** + +
+ +**Flakes** are a feature of the Nix package manager that simplifies and +standardizes how configurations, dependencies, and packages are managed. If +you're familiar with tools like `package.json` in JavaScript or `Cargo.toml` in +Rust, flakes serve a similar purpose in the Nix ecosystem. + +** Key Features of Flakes: ** + +1. **Pin Dependencies**: + - Flakes lock the versions of dependencies in a `flake.lock` file, ensuring + reproducibility across systems. + +2. **Standardize Configurations**: + - They use a `flake.nix` file to define how to build, run, or deploy a + project or system, making setups more predictable. + +3. **Improve Usability**: + - Flakes simplify sharing and reusing configurations across different systems + or projects by providing a consistent structure. + +In essence, flakes help manage NixOS setups or Nix-based projects in a more +portable and reliable way. + +
+ +
+ +
+**🏡 What is NixOS Home Manager? ** + +**Home Manager** is a powerful tool in the Nix ecosystem that allows you to +declaratively manage user-specific configurations and environments. With Home +Manager, you can streamline the setup of dotfiles, shell settings, applications, +and system packages for your user profile. + +### Key Features of Home Manager: + +1. **Declarative Configuration**: + - Define all your settings and preferences in a single `home.nix` file, + making it easy to track, share, and replicate your setup. + +2. **Cross-Distribution Support**: + - Home Manager works not only on NixOS but also on other Linux distributions + and macOS, allowing you to standardize configurations across devices. + +3. **User Environment Management**: + - Manage applications, environment variables, shell configurations, and + more—all isolated to your user profile. + +### Why Use Home Manager? + +Home Manager simplifies system management by offering consistency, +reproducibility, and portability. Whether you’re customizing your development +environment or sharing configurations between machines, it provides an efficient +way to tailor your user experience. + +
+ +
+**🏭 What are Atomic Builds?** + +**Atomic builds** in NixOS ensure that any system change (like installing +software or updating the configuration) is applied in a safe and fail-proof way. +This means that a system update is either fully successful or has no effect at +all, eliminating the risk of a partially applied or broken system state. + +### How Atomic Builds Work: + +1. **Immutable System Generation**: + - Every configuration change creates a new "generation" of the system, while + the previous ones remain untouched. You can easily roll back to an earlier + generation if something goes wrong. + +2. **Transaction-Like Behavior**: + - Similar to database transactions, changes are applied atomically: either + they succeed and become the new active system, or they fail and leave the + current system unchanged. + +3. **Seamless Rollbacks**: + - In case of errors or issues, you can reboot and select a previous system + generation from the boot menu to return to a working state. + +### Benefits of Atomic Builds: + +- **Reliability**: Your system is always in a consistent state, even if a + configuration change fails. +- **Reproducibility**: The same configuration will always produce the same + system state, making it easy to debug or replicate. +- **Ease of Rollback**: Reverting to a working configuration is as simple as + rebooting and selecting the previous generation. + +### Why NixOS Uses Atomic Builds: + +This feature is a cornerstone of NixOS's declarative and reproducible design +philosophy, ensuring that system management is predictable and stress-free. + +
+ +
+**❓ I am new to NIXOS where can I go to get more info? ** + +- [NIXOS Config Guide](https://www.youtube.com/watch?v=AGVXJ-TIv3Y&t=34s) +- [VIMJOYER YouTube Channel](https://www.youtube.com/@vimjoyer/videos) +- [Librephoenix YouTube Channel](https://www.youtube.com/@librephoenix) +- [8 Part Video Series on NIXOS](https://www.youtube.com/watch?v=QKoQ1gKJY5A&list=PL-saUBvIJzOkjAw_vOac75v-x6EzNzZq-) +- [Great guide for NixOS and Flakes](https://nixos-and-flakes.thiscute.world/preface) + +
+ +
+**🏤 Where can I get info on using GIT repositories ** + +- [Managing NIXOS config with GIT](https://www.youtube.com/watch?v=20BN4gqHwaQ) +- [GIT for dummies](https://www.youtube.com/watch?v=K6Q31YkorUE) +- [How GIT works](https://www.youtube.com/watch?v=e9lnsKot_SQ) +- [In depth 1hr video on GIT](https://www.youtube.com/watch?v=S7XpTAnSDL4&t=123s) + +
diff --git a/LICENSE b/LICENSE.md similarity index 74% rename from LICENSE rename to LICENSE.md index 61995de..6b847f3 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,9 +1,13 @@ -MIT License +# 📜 License -Copyright (c) 2024 Tyler Kelley +### ZaneyOS is licensed under the MIT License. + +## MIT License + +**Copyright (c) 2025 Tyler Kelley** Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal +of this software and associated documentation files (the "Software" ), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is @@ -12,10 +16,10 @@ furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE.** diff --git a/README.es.md b/README.es.md new file mode 100644 index 0000000..1e83376 --- /dev/null +++ b/README.es.md @@ -0,0 +1,303 @@ +[English](README.md) | [Español](README.es.md) + +
+ +## ZaneyOS 🟰 Mejores Configs ❄️ NixOS + +\*\* Actualizado: 16 de enero de 2026 + +ZaneyOS es una forma sencilla de reproducir mi configuración en cualquier sistema NixOS. +Incluye el fondo de pantalla, scripts, aplicaciones, archivos de configuración y más. + + + +
+ +
+📸 Más capturas de pantalla + +### Temas de Waybar + + + + + +### Integración de Noctalia Shell + + + + + + + + + +### Características adicionales + + + + + +
+ +
+ +### Chuletas y Guías + +- Guía para Principiantes de Nix: [English](cheatsheets/nix-beginner-guide.md) | [Español](cheatsheets/nix-beginner-guide.es.md) +- Guía de Personalización de Hyprland: [English](cheatsheets/hyprland-customization-guide.md) | [Español](cheatsheets/hyprland-customization-guide.es.md) + +#### 🍖 Requisitos + +- Debes estar ejecutando NixOS, versión 23.11+. +- Se espera que la carpeta `zaneyos` (este repo) esté en tu directorio home. +- Debes haber instalado NixOS usando partición **GPT** con arranque **UEFI**. +- ** Se requiere un /boot de mínimo 500MB. ** +- Se soporta systemd-boot. +- Para GRUB tendrás que buscar una guía en internet. ☺️ +- Edición manual de archivos específicos de tu host. +- El host es la máquina específica donde estás instalando. + +#### 🎹 PipeWire y controles del centro de notificaciones + +- Usamos la solución de audio más reciente y robusta para Linux. Además, tendrás + controles de medios y volumen en el centro de notificaciones en la barra superior. + +#### 🏇 Flujo optimizado y Neovim simple pero elegante + +- Usando Hyprland para mayor elegancia, funcionalidad y eficiencia. +- No hay un proyecto Neovim masivo aquí. Es mi configuración simple, fácil de entender y + excelente, con soporte de lenguajes ya añadido. + +#### 🖥️ Configuración multi‑host y multi‑usuario + +- Puedes definir ajustes separados para diferentes máquinas y usuarios. +- Especifica fácilmente paquetes extra para tus usuarios en `modules/core/user.nix`. +- Estructura de archivos fácil de entender y configuración simple pero abarcadora. + +#### 👼 Una comunidad increíble centrada en el soporte + +- La idea de ZaneyOS es hacer de NixOS un espacio accesible. +- NixOS es una gran comunidad de la que querrás formar parte. +- Muchas personas pacientes y con ganas de ayudar te apoyan usando ZaneyOS. +- No dudes en pasar por el Discord para pedir ayuda. + +#### 📦 ¿Cómo instalo paquetes? + +- Puedes buscar en [Nix Packages](https://search.nixos.org/packages?) y + [Options](https://search.nixos.org/options?) para conocer el nombre del paquete + o si tiene opciones que faciliten su configuración. +- Para añadir un paquete hay secciones en `modules/core/packages.nix` y + `modules/core/user.nix`. Uno para programas disponibles a nivel del sistema y + otro sólo para el entorno del usuario. + +#### 🙋 ¿Problemas / Preguntas? + +- Siéntete libre de abrir un issue en el repo. Por favor etiqueta las solicitudes + de funcionalidades comenzando el título con [feature request], ¡gracias! +- Contáctanos también en [Discord](https://discord.gg/XhZmNTnhtp) para una respuesta potencialmente más rápida. + +# Atajos de Hyprland + +A continuación los atajos de Hyprland, en formato de referencia rápida. La columna de la derecha muestra atajos específicos de **Noctalia Shell** (solo disponibles cuando `barChoice = "noctalia"`). + + + + + + +
+ +## Atajos estándar + +### Lanzamiento de aplicaciones + +- `$modifier + Return` → Lanzar `terminal` +- `$modifier + Tab` → Alternar `Quickshell Overview` (visor de espacios con vistas en vivo) +- `$modifier + K` → Listar atajos +- `$modifier + Shift + W` → Abrir `web-search` +- `$modifier + Alt + W` → Abrir `wallsetter` +- `$modifier + Shift + N` → Ejecutar `swaync-client -rs` +- `$modifier + W` → Abrir `Navegador web` +- `$modifier + Y` → Abrir `kitty` con `yazi` +- `$modifier + E` → Abrir `emopicker9000` +- `$modifier + S` → Tomar captura de pantalla +- `$modifier + Shift + D` → Abrir `Discord` +- `$modifier + O` → Lanzar `OBS Studio` +- `$modifier + Alt + C` → Selector de color +- `$modifier + G` → Abrir `GIMP` +- `$modifier + T` → Alternar terminal con `pypr` +- `$modifier + Alt + M` → Abrir `pavucontrol` + +### Gestión de ventanas + +- `$modifier + Q` → Cerrar ventana activa +- `$modifier + P` → Alternar pseudo tiling +- `$modifier + Shift + I` → Alternar modo dividido +- `$modifier + F` → Alternar pantalla completa +- `$modifier + Shift + F` → Alternar modo flotante +- `$modifier + Alt + F` → Flotar todas las ventanas +- `$modifier + Shift + C` → Salir de Hyprland + +### Movimiento de ventanas + +- `$modifier + Shift + ← / → / ↑ / ↓` → Mover izq./der./arriba/abajo +- `$modifier + Shift + H / L / K / J` → Mover izq./der./arriba/abajo +- `$modifier + Alt + ← / → / ↑ / ↓` → Intercambiar izq./der./arriba/abajo + +### Movimiento de foco + +- `$modifier + ← / → / ↑ / ↓` → Mover foco izq./der./arriba/abajo +- `$modifier + H / L / K / J` → Mover foco izq./der./arriba/abajo + +### Espacios de trabajo + +- `$modifier + 1-10` → Cambiar al espacio 1-10 +- `$modifier + Shift + Space` → Mover ventana a espacio especial +- `$modifier + Space` → Alternar espacio especial +- `$modifier + Shift + 1-10` → Mover ventana al espacio 1-10 +- `$modifier + Control + → / ←` → Cambiar espacio adelante/atrás + +### Ciclo de ventanas + +- `Alt + Tab` → Ir a siguiente ventana / Traer activa al frente + + + +## 🎨 Atajos de Noctalia Shell + +_Disponibles cuando `barChoice = "noctalia"` en `variables.nix`_ + +- `$modifier + D` → Alternar iniciador +- `$modifier + Shift + Return` → Alternar iniciador +- `$modifier + M` → Menú de notificaciones +- `$modifier + V` → Gestor de portapapeles +- `$modifier + Alt + P` → Panel de configuración +- `$modifier + Shift + ,` → Panel de configuración +- `$modifier + Alt + L` → Bloquear pantalla +- `$modifier + Shift + Y` → Gestor de fondos +- `$modifier + X` → Menú de energía +- `$modifier + C` → Centro de control +- `$modifier + Ctrl + R` → Grabadora de pantalla + +### Iniciador Rofi (Modo Waybar) + +_Disponible cuando `barChoice = "waybar"` en `variables.nix`_ + +- `$modifier + D` → Lanzar Rofi +- `$modifier + Shift + Return` → Lanzar Rofi + +### Otras características + +- `$modifier + Shift + Return` (Waybar) → Iniciador de aplicaciones +- `$modifier + V` (Waybar) → Historial del portapapeles con `cliphist` + +
+ +## Instalación: + +> **⚠️ IMPORTANTE:** Estos métodos son sólo para **NUEVAS INSTALACIONES**. +> Si ya tienes ZaneyOS instalado y quieres actualizar a v2.4, consulta las [Instrucciones de actualización](#actualizar-de-zaneyos-23-a-24) más abajo. + +
+ ⬇️ Instalar con script (SÓLO NUEVAS INSTALACIONES) + +### 📜 Script: + +Es la forma más fácil y recomendada para comenzar en **nuevas instalaciones**. El script no pretende +permitirte cambiar todas las opciones del flake ni ayudarte a instalar paquetes extra. +Está para que obtengas mi configuración con el menor riesgo de roturas y luego puedas ajustarla a tu gusto. + +> **⚠️ ADVERTENCIA:** Este script reemplazará completamente cualquier directorio ~/zaneyos existente. +> NO lo uses si ya tienes ZaneyOS instalado y configurado. + +Copia y ejecuta: + +![Comando de primera instalación de ZaneyOS](img/first-install-cmd.jpg) + +``` +nix-shell -p git curl pciutils +``` + +Luego: + +![Comando del script de instalación de ZaneyOS](img/install-script.jpg) + +``` +sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/main/install-zaneyos.sh) +``` + +#### El proceso de instalación se verá así: + +![Primera parte de la instalación](img/1.jpg) + +![Segunda parte de la instalación](img/2.jpg) + +#### Tras completar, puede que el escritorio se vea roto. Reinicia y verás el login así: + +![Gestor de acceso](img/3.jpg) + +#### Tras iniciar sesión deberías ver algo como esto: + +![Ejemplo de escritorio](img/4.jpg) + +
+ +
+ 🦽 Proceso de instalación manual: + +1. Asegura Git y Vim instalados: + +``` +nix-shell -p git vim +``` + +2. Clona este repo y entra: + +``` +cd && git clone https://gitlab.com/zaney/zaneyos.git -b main --depth=1 ~/zaneyos +cd zaneyos + +También puedes ejecutar el script `install.sh` si quieres. +``` + +- _Permanece en esta carpeta para el resto de la instalación._ + +3. Crea la carpeta del host para tu(s) máquina(s): + +``` +cp -r hosts/default hosts/ +git add . +``` + +4. Edita `hosts//variables.nix`. + +5. Edita `flake.nix` y completa tu username, perfil y hostname. + +6. Genera tu hardware.nix: + +``` +nixos-generate-config --show-hardware-config > hosts//hardware.nix +``` + +7. Ejecuta esto para habilitar flakes e instalar, reemplazando hostname por el perfil (p. ej. `intel`, `nvidia`, `nvidia-laptop`, `amd-hybrid` o `vm`): + +``` +NIX_CONFIG="experimental-features = nix-command flakes" +sudo nixos-rebuild switch --flake .#profile +``` + +Ahora, cuando quieras reconstruir, tienes el alias `fr` que reconstruye el flake y no necesitas estar en la carpeta `zaneyos` para que funcione. + +
+ +### Reconocimientos especiales: + +Gracias por toda su ayuda + +- KoolDots https://github.com/LinuxBeginnings +- Jakookit https://github.com/jakookit +- Justaguylinux https://codeberg.org/Justaguylinux +- Jerry Starke https://github.com/JerrySM64 + +## ¡Disfruta! diff --git a/README.md b/README.md index 35ad922..375ced2 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,98 @@ +[English](README.md) | [Español](README.es.md) +
-## ZaneyOS 2.2 +## ZaneyOS 🟰 Best ❄️ NixOS Configs + +\*\* Updated: January 16th, 2026 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 -**Inspiration for the Waybar config -[here](https://github.com/justinlime/dotfiles).** +> The first time you login, screen will be blank SUPER + SHIFT + C to exit. +> Login in, noctalia will start from then on + +
-> **This project has a [Wiki](https://zaney.org/wiki/zaneyos-2.2/). Find out how -> to use ZaneyOS here!** **I have put a lot of effort into the -> [documentation](https://zaney.org/wiki/zaneyos-2.2/) so it should be accurate. -> However, please if you notice that something is wrong with it create an issue -> or reach out to me on Discord.** +
+📸 More Screenshots -#### 🍖 Requirements +### Waybar Themes -- You must be running on NixOS. -- The zaneyos folder (this repo) is expected to be in your home directory. -- Must have installed using GPT & UEFI. 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, Spotify, & Notification Menu Controls + -- We are using the latest and greatest audio solution for Linux. If you like - listening to music Spotify comes pre-installed out of the box. Not to mention - you will have media and volume controls in the notification center available - in the top bar. +### Noctalia Shell Integration -#### 🏇 Optimized Workflow, tmpfs For Speed, & Simple Yet Elegant Neovim + -- Using scratchpads with Hyprland for increased functionality and effeciency. -- A tmpfs for the /tmp directory is created improving rebuild time and reducing - strain on hdd/ssd. -- No massive Neovim project here. This is my simple, easy to understand, yet - incredible Neovim setup. You can grep recursively through entire folders and - find specific files without ever leaving the text editor! + -#### 🖥️ Multi Host & User Configuration + -- You can now define separate settings for different host machines and users! -- Easily specify extra packages for your users in the users.nix file. -- Easy to understand file structure and simple, but encompassing, - configuratiion. + -#### 👼 An Incredible Community Focused On Support +### Additional Features -- The entire idea of ZaneyOS is to make NixOS an approachable space that is - actually a great community that you want to be in. -- 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](https://zaney.org/wiki/zaneyos-2.2/). +### Cheatsheets and Guides -
+- Nix Beginner Guide: [English](cheatsheets/nix-beginner-guide.md) | + [Español](cheatsheets/nix-beginner-guide.es.md) +- Hyprland Customization Guide: + [English](cheatsheets/hyprland-customization-guide.md) | + [Español](cheatsheets/hyprland-customization-guide.es.md) + +#### 🍖 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, using `nixvim` for an + 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. #### 📦 How To Install Packages? @@ -71,81 +100,224 @@ Please do yourself a favor and [Options](https://search.nixos.org/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 config.nix and users.nix in - your host folder. One is for programs available system wide and the other for - your users environment only. +- 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 me on [Discord](https://discord.gg/2cRdBs8) as well, for a potentially +- Contact us on [Discord](https://discord.gg/XhZmNTnhtp) as well, for a potentially faster response. -### ⬇️ Install +# Hyprland Keybindings -#### 📜 Script: +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"`). -This is the easiest and recommended way of starting out. 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! + + + + + +
+ +## 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](#upgrading-from-zaneyos-23-to-24) 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](img/first-install-cmd.jpg) + ``` -nix-shell -p git curl +nix-shell -p git curl pciutils ``` Then: +![ZaneyOS Install Script Command](img/install-script.jpg) + ``` -sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/stable-2.2/install-zaneyos.sh) +sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/main/install-zaneyos.sh) ``` -#### 🦽 Manual: +#### The install process will look something like this: -Run this command to ensure Git & Vim are installed: +![First Part Of Install](img/1.jpg) + +![Second Part Of Install](img/2.jpg) + +#### After the install completes your environment will probably look broken. Just reboot and you will see this as your login: + +![Display Manager](img/3.jpg) + +#### Then after login you should see a screen like this: + +![Desktop Example](img/4.jpg) + +
+ +
+ 🦽 Manual install process: + +1. Run this command to ensure Git & Vim are installed: ``` nix-shell -p git vim ``` -Clone this repo & enter it: +2. Clone this repo & enter it: ``` -git clone -b stable-2.2 --single-branch https://gitlab.com/zaney/zaneyos.git +cd && git clone https://gitlab.com/zaney/zaneyos.git -b main --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_ -Create the host folder for your machine(s) +3. Create the host folder for your machine(s) like so: ``` cp -r hosts/default hosts/ git add . ``` -**🪧🪧🪧 Edit `hosts//config.nix` and -`hosts//variables.nix` 🪧🪧🪧** - -Generate your hardware.nix like so: +4. Edit `hosts//variables.nix` + ```nixos-generate-config --show-hardware-config > hosts//hardware.nix``` -``` -nixos-generate-config --show-hardware-config > hosts//hardware.nix ``` -Run this to enable flakes and install the flake replacing hostname with whatever -you put as the hostname: +7. 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 .#hostname + +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 flake-rebuild that will rebuild the flake! +called `fr` that will rebuild the flake and you do not have to be in the +`zaneyos` folder for it to work. -Hope you enjoy! +### Special Recognitions: + +Thank you for all your assistance + +- KoolDots https://github.com/LinuxBeginnings +- JakKoolit https://github.com/Jakoolit +- Justaguylinux https://codeberg.org/Justaguylinux +- Jerry Starke https://github.com/JerrySM64 + +## Hope you enjoy! +``` diff --git a/WARP.md b/WARP.md new file mode 100644 index 0000000..abdb5a9 --- /dev/null +++ b/WARP.md @@ -0,0 +1,83 @@ +# WARP.md + +This file provides guidance to WARP (warp.dev) when working with code in this repository. + +Project: ZaneyOS — NixOS flake for desktop systems with per-host overrides, GPU/VM profiles, and an integrated Home Manager layer. + +Important repo expectations +|- This repo is expected at: ~/zaneyos (programs.nh.flake points here). If you keep it elsewhere, update modules/core/nh.nix accordingly. +|- Target OS: NixOS 23.11+; UEFI + GPT expected; systemd-boot is supported out of the box (see README for details). + +Common commands +|- Rebuild and switch (preferred via nh/zcli) + - fr # zsh alias → nh os switch --hostname + - fu # zsh alias → nh os switch --hostname --update + - zcli rebuild [--dry|--ask|--cores N|--verbose|--no-nom] + - zcli update [--dry|--ask|--cores N|--verbose|--no-nom] +|- Rebuild for next boot (safer for bigger changes) + - zcli rebuild-boot [same options] + - sudo nixos-rebuild boot --flake .# +|- Direct NixOS (without nh/zcli) + - sudo nixos-rebuild switch --flake .# +|- Validate the flake + - nix flake check +|- Format Nix files (nixfmt-rfc-style is included) + - find . -name "*.nix" -print0 | xargs -0 nixfmt +|- Configuration comparison (compare against upstream) + - ./modules/src/compare-zaneyos-config.sh # compares against official repo + - ./modules/src/compare-zaneyos-config.sh --branch stable-2.4 # specific branch +|- Host management (zcli) + - zcli update-host [hostname] [profile] # auto-detect if args omitted + - zcli add-host [profile] # copies hosts/default, can gen hardware.nix + - zcli del-host +|- Diagnostics and maintenance + - zcli diag # writes ~/diag.txt + - zcli cleanup # prunes generations (interactive) + - zcli trim # runs fstrim with confirmation +|- 2.3 → 2.4 upgrade (existing installs) + - ./upgrade-2.3-to-2.4.sh # automated analysis, backup, and upgrade + - ./upgrade-2.3-to-2.4.sh --revert + +Notes on profiles and hosts +|- Profiles represent hardware targets: amd, intel, nvidia, nvidia-laptop (intel+NVIDIA hybrid), amd-hybrid (AMD+NVIDIA hybrid), vm. +|- Use the profile in flake targets like .#vm or .#nvidia, or via nh's --hostname. +|- Host-specific settings live under hosts//; variables.nix holds UX and feature toggles: barChoice (noctalia or waybar), waybarChoice (when barChoice="waybar"), clock24h, etc. + +High-level architecture (big picture) +|- flake.nix + - Inputs: nixpkgs 25.11, home-manager 25.11, stylix, nvf, nix-flatpak, noctalia; nixvim and quickshell are included but currently inactive (uncommitted to outputs). + - Defines system, host, profile, username; constructs nixosConfigurations via mkNixosConfig. + - Each configuration imports profiles/. +- profiles//default.nix + - Imports host and stacks: ../../hosts/${host}, ../../modules/drivers, ../../modules/core. + - Toggles drivers and VM guest services per profile; the nvidia-laptop and amd-hybrid profiles consume Bus IDs from host variables. +- hosts// + - default.nix imports hardware.nix and host-packages.nix. + - variables.nix is the primary control surface (display manager, terminal/browser defaults, waybarChoice, stylix image, 24h clock, Thunar/printing/NFS flags, intel/nvidia Bus IDs, etc.). +|- modules/core + - Composes NixOS modules: boot, flatpak, fonts, hardware, network, nfs, nh, quickshell, packages, printing, display manager (greetd/sddm), security, services (PipeWire/SSH/Bluetooth/fstrim; smartd conditional), steam, stylix, syncthing, system (nix settings, locales, env), thunar, user (Home Manager), virtualization, xserver. + - quickshell.nix installs quickshell with Qt6 dependencies and required environment variables (needed for noctalia-shell). + - nh.nix enables nh and pins programs.nh.flake to ~/zaneyos. + - user.nix integrates Home Manager and creates users.${username}, passing { inputs, username, host, profile } to the home layer. +- modules/drivers + - AMD, Intel, NVIDIA, NVIDIA Prime, NVIDIA AMD-Hybrid, and VM guest services; nvidia-prime options (enable, intelBusID, nvidiaBusID) are consumed by the nvidia-laptop profile; nvidia-amd-hybrid options (enable, amdgpuBusID, nvidiaBusID) are consumed by the amd-hybrid profile. +|- modules/home + - Composes the user environment: Hyprland, bar/shell choice (noctalia-shell or Waybar via barChoice), Rofi, Yazi, terminals (Kitty/WezTerm/Ghostty/Alacritty toggles), Zsh/Bash config, Git, NVF/Neovim, OBS, swaync, scripts, Stylix, optional Doom Emacs/VSCodium/Helix. + - default.nix conditionally imports barModule: either noctalia.nix (when barChoice="noctalia") or waybarChoice (when barChoice="waybar"). + - noctalia.nix installs noctalia-shell and seeds ~/.config/quickshell/noctalia-shell from the package distribution. + - scripts/default.nix installs zcli; zcli wraps rebuild/update/boot, cleanup, diagnostics, host management, and Doom lifecycle. +- Shell aliases (zsh) + - fr and fu are defined in modules/home/zsh/default.nix, parameterized by the active profile. + +Key development choices +- Repo location matters: nh and zcli assume ~/zaneyos; move it and adjust modules/core/nh.nix. +- Validation is via nix flake check; there is no separate unit test suite. +- Formatting is via nixfmt-rfc-style (provided in system packages). + +Useful docs in-repo +- README.md: requirements, install and upgrade overview (including the 2.3→2.4 process). +- zcli.md: full CLI docs, commands, options, and examples. +- cheatsheets/project-guide.md: quick commands, architecture summary, and common workflows. +- cheatsheets/: Hyprland and terminal/editor quick references. + + diff --git a/cheatsheets/README.es.md b/cheatsheets/README.es.md new file mode 100644 index 0000000..7f4ec67 --- /dev/null +++ b/cheatsheets/README.es.md @@ -0,0 +1,66 @@ +[English](./README.md) | Español + +# Índice de Cheatsheets (ZaneyOS) +Estos documentos cubren tanto el uso general como la configuración específica definida en la configuración de NixOS "ZaneyOS". + +- Uso general: Consejos prácticos centrados en tareas y los principales flujos de trabajo. +- Específicos de ZaneyOS: Notas que reflejan cómo se configuran las herramientas en este repositorio (modules/home/*) para que el comportamiento coincida con su sistema. + +## 🔗 Enlaces Rápidos +- Emacs + - [Los 10 mejores consejos para empezar](emacs/emacs.getting-started.top10.md) + - [Explorador de archivos](emacs/emacs.file-explorer.cheatsheet.md) + - [Autocompletado de código](emacs/emacs.code-completion.cheatsheet.md) + - [Magit (Git)](emacs/emacs.magit.cheatsheet.md) + - [Markdown](emacs/emacs.markdown.cheatsheet.md) +- Ghostty + - [Cheatsheet de Ghostty](ghostty/ghostty.cheatsheet.md) +- Tmux + - [Cheatsheet de Tmux](tmux/tmux.cheatsheet.md) +- Alacritty + - [Cheatsheet de Alacritty](alacritty/alacritty.cheatsheet.md) +- Kitty + - [Cheatsheet de Kitty](kitty/kitty.cheatsheet.md) +- WezTerm + - [Cheatsheet de WezTerm](wezterm/wezterm.cheatsheet.md) +- Hyprland + - [Atajos de teclado](hyprland/hyprland.binds.cheatsheet.md) + - [Reglas de ventana](hyprland/hyprland.windowrules.cheatsheet.md) +- Yazi + - [Mapa de teclas](yazi/yazi.keymap.cheatsheet.md) + +## 📚 Cómo usar +- Navegue por el área que le interese (por ejemplo, Emacs, Ghostty). +- Comience con los documentos de "primeros pasos" o "consejos principales" para obtener resultados rápidos. +- Consulte las cheatsheets específicas de cada herramienta para los comandos diarios y luego verifique cualquier configuración específica de ZaneyOS. + +## 📂 Árbol de Directorios + +``` +cheatsheets/ +├── emacs/ +│ ├── emacs.code-completion.cheatsheet.md +│ ├── emacs.file-explorer.cheatsheet.md +│ ├── emacs.getting-started.top10.md +│ ├── emacs.magit.cheatsheet.md +│ └── emacs.markdown.cheatsheet.md +├── ghostty/ +│ └── ghostty.cheatsheet.md +├── tmux/ +│ └── tmux.cheatsheet.md +├── alacritty/ +│ └── alacritty.cheatsheet.md +├── kitty/ +│ └── kitty.cheatsheet.md +├── wezterm/ +│ └── wezterm.cheatsheet.md +├── hyprland/ +│ ├── hyprland.binds.cheatsheet.md +│ └── hyprland.windowrules.cheatsheet.md +└── yazi/ + └── yazi.keymap.cheatsheet.md +``` + +## 🛠️ Notas +- El cheatsheet de Ghostty refleja los atajos de teclado de modules/home/terminals/ghostty.nix (ZaneyOS). +- Los documentos de Emacs siguen el mismo estilo de markdown para mayor consistencia y una lectura rápida. diff --git a/cheatsheets/README.md b/cheatsheets/README.md new file mode 100644 index 0000000..c4c901c --- /dev/null +++ b/cheatsheets/README.md @@ -0,0 +1,66 @@ +English | [Español](./README.es.md) + +# Cheatsheets Index (ZaneyOS) +These documents cover both general usage and the specific configuration as defined in the NixOS configuration "ZaneyOS". + +- General use: Practical, task-focused tips and top workflows. +- ZaneyOS specifics: Notes reflecting how tools are configured in this repository (modules/home/*) so behavior matches your system. + +## 🔗 Quick Links +- Emacs + - [Getting Started Top 10](emacs/emacs.getting-started.top10.md) + - [File Explorer](emacs/emacs.file-explorer.cheatsheet.md) + - [Code Completion](emacs/emacs.code-completion.cheatsheet.md) + - [Magit (Git)](emacs/emacs.magit.cheatsheet.md) + - [Markdown](emacs/emacs.markdown.cheatsheet.md) +- Ghostty + - [Ghostty Cheatsheet](ghostty/ghostty.cheatsheet.md) +- Tmux + - [Tmux Cheatsheet](tmux/tmux.cheatsheet.md) +- Alacritty + - [Alacritty Cheatsheet](alacritty/alacritty.cheatsheet.md) +- Kitty + - [Kitty Cheatsheet](kitty/kitty.cheatsheet.md) +- WezTerm + - [WezTerm Cheatsheet](wezterm/wezterm.cheatsheet.md) +- Hyprland + - [Keybindings](hyprland/hyprland.binds.cheatsheet.md) + - [Window Rules](hyprland/hyprland.windowrules.cheatsheet.md) +- Yazi + - [Keymap](yazi/yazi.keymap.cheatsheet.md) + +## 📚 How to use +- Browse the area you care about (e.g., Emacs, Ghostty). +- Start with the “getting started” or “top tips” docs for quick wins. +- Refer to tool-specific cheatsheets for day-to-day commands, then cross-check any ZaneyOS-specific settings. + +## 📂 Directory Tree + +``` +cheatsheets/ +├── emacs/ +│ ├── emacs.code-completion.cheatsheet.md +│ ├── emacs.file-explorer.cheatsheet.md +│ ├── emacs.getting-started.top10.md +│ ├── emacs.magit.cheatsheet.md +│ └── emacs.markdown.cheatsheet.md +├── ghostty/ +│ └── ghostty.cheatsheet.md +├── tmux/ +│ └── tmux.cheatsheet.md +├── alacritty/ +│ └── alacritty.cheatsheet.md +├── kitty/ +│ └── kitty.cheatsheet.md +├── wezterm/ +│ └── wezterm.cheatsheet.md +├── hyprland/ +│ ├── hyprland.binds.cheatsheet.md +│ └── hyprland.windowrules.cheatsheet.md +└── yazi/ + └── yazi.keymap.cheatsheet.md +``` + +## 🛠️ Notes +- Ghostty cheatsheet reflects bindings from modules/home/terminals/ghostty.nix (ZaneyOS). +- Emacs docs follow the same markdown style for consistency and quick scanning. diff --git a/cheatsheets/add-gnome.md b/cheatsheets/add-gnome.md new file mode 100644 index 0000000..b36cdc5 --- /dev/null +++ b/cheatsheets/add-gnome.md @@ -0,0 +1,58 @@ +# Add GNOME Desktop (overview) + +This guide gives **basic steps** and **which files to edit** to add GNOME to ZaneyOS. + +In NixOS, you enable it through NixOS options in a module (a `.nix` file), then pick a display manager (login screen). +This repo already has **SDDM** (graphical) and **LY** (text) login support. You can keep using either — both can start GNOME sessions. + +## Files to edit (minimal list) + +1. `modules/core/default.nix` + - Import your new GNOME module so it becomes part of the system config. + +2. `modules/core/xserver.nix` + - GNOME needs `services.xserver.enable = true;` (this file currently disables X11). + +3. `modules/core/gnome.nix` (new file you create) + - Turn on GNOME’s desktop manager. + +4. `hosts//variables.nix` + - Make sure your `displayManager` is set to either `"sddm"` or `"tui"` (for LY), since those are already supported here. + +## Suggested minimal GNOME module (example) + +```nix path=null start=null +{ ... }: +{ + services.xserver = { + enable = true; + desktopManager.gnome.enable = true; + }; +} +``` + +## Where to import the GNOME module + +In `modules/core/default.nix`, add your GNOME file to the imports list: + +```nix path=null start=null +imports = [ + # ... + ./gnome.nix + # ... +]; +``` + +## Flatpak: GNOME Extensions Manager + +To add the Flatpak app **Extension Manager** (for GNOME extensions), edit `modules/core/flatpak.nix` and add its ID: + +```nix path=null start=null +services.flatpak.packages = [ + "com.mattjakeman.ExtensionManager" +]; +``` + +## `git add .` and rebuild + +Once you have the file created. In the ZaneyOS directory run `git add . ` then `zcli rebuild` diff --git a/cheatsheets/alacritty/alacritty.cheatsheet.es.md b/cheatsheets/alacritty/alacritty.cheatsheet.es.md new file mode 100644 index 0000000..19bd1eb --- /dev/null +++ b/cheatsheets/alacritty/alacritty.cheatsheet.es.md @@ -0,0 +1,23 @@ +[English](./alacritty.cheatsheet.md) | Español + +# Alacritty en ZaneyOS — Resumen y Cheatsheet +## 🚀 Resumen de modules/home/terminals/alacritty.nix + +- Programa + - Alacritty habilitado. + - Familia de fuentes (predeterminada): Maple NF; tamaño: 15. + - Estilos configurados: Regular, Negrita, Cursiva, Negrita Cursiva. + +--- + +## ⚙️ Opciones Predeterminadas (según configuración) + +Fuente +- normal: Maple NF Regular +- bold: Maple NF Negrita +- italic: Maple NF Cursiva +- bold_italic: Maple NF Negrita Cursiva +- size: 15 + +Notas +- Usa lib.mkDefault para la familia de fuentes, por lo que otros módulos pueden anularla. diff --git a/cheatsheets/alacritty/alacritty.cheatsheet.md b/cheatsheets/alacritty/alacritty.cheatsheet.md new file mode 100644 index 0000000..6047f92 --- /dev/null +++ b/cheatsheets/alacritty/alacritty.cheatsheet.md @@ -0,0 +1,24 @@ +English | [Español](./alacritty.cheatsheet.es.md) + +# Alacritty on ZaneyOS — Summary & Cheatsheet +## 🚀 Summary of modules/home/terminals/alacritty.nix + +- Program + - Alacritty enabled. + - Font family (default): Maple NF; size: 15. + - Styles configured: Regular, Bold, Italic, Bold Italic. + +--- + +## ⚙️ Default Options (as configured) + +Font +- normal: Maple NF Regular +- bold: Maple NF Bold +- italic: Maple NF Italic +- bold_italic: Maple NF Bold Italic +- size: 15 + +Notes +- Uses lib.mkDefault for font family, so other modules can override. + diff --git a/cheatsheets/emacs/emacs.code-completion.cheatsheet.es.md b/cheatsheets/emacs/emacs.code-completion.cheatsheet.es.md new file mode 100644 index 0000000..1c4d7bc --- /dev/null +++ b/cheatsheets/emacs/emacs.code-completion.cheatsheet.es.md @@ -0,0 +1,129 @@ +[English](./emacs.code-completion.cheatsheet.md) | Español + +# Cheatsheet de Autocompletado y Búsqueda de Código en Doom Emacs +## 🚀 **Lo que Tienes (Como nvim-cmp + blink.cmp)** + +Si tu configuración de Doom incluye: +- **Company Mode** - Framework de autocompletado +- **LSP Mode** - Soporte para el Protocolo de Servidor de Lenguaje +- **Tree-sitter** - Análisis de sintaxis avanzado +- **Herramientas de búsqueda** - Búsqueda de documentación y definiciones + +## ⌨️ **Autocompletado de Código (Company)** + +### **Controles de Autocompletado:** +- `TAB` o `C-SPC` - **Aceptar autocompletado** +- `C-n` / `j` - **Siguiente autocompletado** (modo evil) +- `C-p` / `k` - **Anterior autocompletado** (modo evil) +- `C-w` - **Mostrar documentación** para el autocompletado +- `C-s` - **Buscar/filtrar autocompletados** +- `ESC` o `C-g` - **Cancelar autocompletado** + +### **Autocompletado Manual:** +- `M-/` - **Completar en el punto** (disparador manual) +- `C-M-/` - **Expandir abreviatura** + +## 🔍 **Búsqueda y Navegación de Código** + +### **Ir a Definición/Referencias:** +- `gd` - **Ir a la definición** (modo evil) +- `gD` - **Ir a la declaración** +- `gr` - **Ir a las referencias** +- `SPC c d` - **Buscar definición** +- `SPC c D` - **Buscar referencias** +- `SPC c i` - **Buscar implementaciones** + +### **Búsqueda de Documentación:** +- `K` - **Buscar documentación** (modo evil) +- `SPC c k` - **Buscar documentación** +- `SPC c K` - **Buscar en conjuntos de documentos** +- `C-h f` - **Describir función** +- `C-h v` - **Describir variable** + +### **Navegación de Símbolos:** +- `SPC c j` - **Saltar a símbolo en el búfer** +- `SPC c J` - **Saltar a símbolo en el proyecto** +- `SPC s i` - **Buscar símbolo** + +## 🛠️ **Características de LSP (Servidor de Lenguaje)** + +### **Acciones de LSP:** +- `SPC c a` - **Acciones de código** (refactorizar, arreglar, etc.) +- `SPC c r` - **Renombrar símbolo** +- `SPC c f` - **Formatear búfer/región** +- `SPC c o` - **Organizar importaciones** + +### **Navegación de Errores:** +- `]e` - **Siguiente error** +- `[e` - **Error anterior** +- `SPC c x` - **Listar errores** + +### **Información de LSP:** +- `SPC c l` - **Menú de LSP** +- `SPC c h` - **Mostrar información al pasar el ratón** +- `SPC c s` - **Mostrar firma** + +## 🎯 **Características Específicas del Lenguaje** + +### **C/C++ (clang-tools)** +- Autocompletado completo para funciones, variables, tipos +- Ir a la definición a través de archivos +- Comprobación de errores y diagnósticos +- Formateo de código con clang-format + +### **Nix (nil LSP)** +- Autocompletado del lenguaje Nix +- Documentación de funciones +- Comprobación de sintaxis +- Ir a la definición para expresiones de Nix + +### **JSON (vscode-json-languageserver)** +- Autocompletado basado en esquemas +- Validación y comprobación de errores +- Ir a la definición en archivos JSON + +## ⚡ **Consejos Profesionales** + +### **Búsqueda Difusa en Todo:** +- `SPC f f` - **Buscar archivos** +- `SPC /` - **Buscar en el proyecto** +- `SPC s s` - **Buscar en el búfer** +- `SPC p p` - **Cambiar de proyecto** + +### **Mejor Navegación:** +- `C-o` - **Retroceder** (después de saltar a la definición) +- `C-i` - **Avanzar** +- `SPC j j` - **Saltar a un carácter** (como easymotion) + +### **Ajustes de Autocompletado:** +- Los autocompletados aparecen después de 0.2 segundos de escribir +- Mínimo 1 carácter para activarse +- Muestra la documentación en una ventana emergente +- Funciona tanto con Company como con LSP + +## 🔧 **Solución de Problemas** + +### **Si el autocompletado no funciona:** +1. Comprueba si el servidor LSP se está ejecutando: `SPC c l` +2. Reinicia LSP: `SPC c l r` +3. Comprueba si hay errores de sintaxis: `SPC c x` + +### **Rendimiento:** +- Los servidores LSP se inician automáticamente cuando abres archivos compatibles +- El autocompletado está optimizado para una respuesta rápida +- Usa `SPC h r r` para recargar la configuración de Doom después de los cambios + +## 🚀 **Flujo de Trabajo de Inicio Rápido** + +1. **Abre un archivo de código** (`.c`, `.nix`, `.json`) +2. **Empieza a escribir** - los autocompletados aparecen automáticamente +3. **Navega con `j/k`** y **acepta con `TAB`** +4. **Usa `gd`** para saltar a las definiciones +5. **Usa `K`** para ver la documentación +6. **Usa `SPC c a`** para acciones de código + +## 📚 **Servidores de Lenguaje Incluidos** +- **C/C++**: `clang-tools` (clangd) +- **Nix**: `nil` +- **JSON**: `vscode-json-languageserver` +- ¡Se pueden añadir más por lenguaje según sea necesario! diff --git a/cheatsheets/emacs/emacs.code-completion.cheatsheet.md b/cheatsheets/emacs/emacs.code-completion.cheatsheet.md new file mode 100644 index 0000000..ae6069d --- /dev/null +++ b/cheatsheets/emacs/emacs.code-completion.cheatsheet.md @@ -0,0 +1,129 @@ +English | [Español](./emacs.code-completion.cheatsheet.es.md) + +# Doom Emacs Code Completion & Lookup Cheatsheet +## 🚀 **What You Have (Like nvim-cmp + blink.cmp)** + +If your Doom config includes: +- **Company Mode** - Auto-completion framework +- **LSP Mode** - Language Server Protocol support +- **Tree-sitter** - Advanced syntax parsing +- **Lookup tools** - Documentation and definition lookup + +## ⌨️ **Code Completion (Company)** + +### **Auto-completion Controls:** +- `TAB` or `C-SPC` - **Accept completion** +- `C-n` / `j` - **Next completion** (evil mode) +- `C-p` / `k` - **Previous completion** (evil mode) +- `C-w` - **Show documentation** for completion +- `C-s` - **Search/filter completions** +- `ESC` or `C-g` - **Cancel completion** + +### **Manual Completion:** +- `M-/` - **Complete at point** (manual trigger) +- `C-M-/` - **Expand abbreviation** + +## 🔍 **Code Lookup & Navigation** + +### **Go to Definition/References:** +- `gd` - **Go to definition** (evil mode) +- `gD` - **Go to declaration** +- `gr` - **Go to references** +- `SPC c d` - **Find definition** +- `SPC c D` - **Find references** +- `SPC c i` - **Find implementations** + +### **Documentation Lookup:** +- `K` - **Lookup documentation** (evil mode) +- `SPC c k` - **Lookup documentation** +- `SPC c K` - **Lookup in docsets** +- `C-h f` - **Describe function** +- `C-h v` - **Describe variable** + +### **Symbol Navigation:** +- `SPC c j` - **Jump to symbol in buffer** +- `SPC c J` - **Jump to symbol in project** +- `SPC s i` - **Search for symbol** + +## 🛠️ **LSP Features (Language Server)** + +### **LSP Actions:** +- `SPC c a` - **Code actions** (refactor, fix, etc.) +- `SPC c r` - **Rename symbol** +- `SPC c f` - **Format buffer/region** +- `SPC c o` - **Organize imports** + +### **Error Navigation:** +- `]e` - **Next error** +- `[e` - **Previous error** +- `SPC c x` - **List errors** + +### **LSP Info:** +- `SPC c l` - **LSP menu** +- `SPC c h` - **Show hover info** +- `SPC c s` - **Show signature** + +## 🎯 **Language-Specific Features** + +### **C/C++ (clang-tools)** +- Full completion for functions, variables, types +- Go to definition across files +- Error checking and diagnostics +- Code formatting with clang-format + +### **Nix (nil LSP)** +- Nix language completion +- Function documentation +- Syntax checking +- Go to definition for Nix expressions + +### **JSON (vscode-json-languageserver)** +- Schema-based completion +- Validation and error checking +- Go to definition in JSON files + +## ⚡ **Pro Tips** + +### **Fuzzy Search Everything:** +- `SPC f f` - **Find files** +- `SPC /` - **Search in project** +- `SPC s s` - **Search buffer** +- `SPC p p` - **Switch projects** + +### **Better Navigation:** +- `C-o` - **Go back** (after jumping to definition) +- `C-i` - **Go forward** +- `SPC j j` - **Jump to character** (like easymotion) + +### **Completion Tweaks:** +- Completions appear after 0.2 seconds of typing +- Minimum 1 character to trigger +- Shows documentation in popup +- Works with both Company and LSP + +## 🔧 **Troubleshooting** + +### **If completion isn't working:** +1. Check if LSP server is running: `SPC c l` +2. Restart LSP: `SPC c l r` +3. Check syntax errors: `SPC c x` + +### **Performance:** +- LSP servers auto-start when you open supported files +- Completion is optimized for fast response +- Use `SPC h r r` to reload Doom config after changes + +## 🚀 **Quick Start Workflow** + +1. **Open a code file** (`.c`, `.nix`, `.json`) +2. **Start typing** - completions appear automatically +3. **Navigate with `j/k`** and **accept with `TAB`** +4. **Use `gd`** to jump to definitions +5. **Use `K`** to see documentation +6. **Use `SPC c a`** for code actions + +## 📚 **Language Servers Included** +- **C/C++**: `clang-tools` (clangd) +- **Nix**: `nil` +- **JSON**: `vscode-json-languageserver` +- More can be added per language as needed! diff --git a/cheatsheets/emacs/emacs.file-explorer.cheatsheet.es.md b/cheatsheets/emacs/emacs.file-explorer.cheatsheet.es.md new file mode 100644 index 0000000..36f95bb --- /dev/null +++ b/cheatsheets/emacs/emacs.file-explorer.cheatsheet.es.md @@ -0,0 +1,306 @@ +[English](./emacs.file-explorer.cheatsheet.md) | Español + +# Cheatsheet del Explorador de Archivos de Doom Emacs +## 🗂️ **¿Qué es Dired?** + +Dired (Directory Editor) es el gestor de archivos incorporado de Emacs que te permite navegar, gestionar y manipular archivos y directorios de manera eficiente. +- Navega por los directorios con el teclado +- Marca, copia, mueve y elimina archivos +- Ejecuta comandos en múltiples archivos a la vez +- Se integra con otras herramientas y búferes de Emacs + +## 📋 **Requisitos** +- Doom Emacs (Dired está incorporado) +- **Treemacs**: Debe estar habilitado en `~/.doom.d/init.el` (descomenta la línea `treemacs`) +- Herramientas opcionales para una funcionalidad mejorada: + - `rsync` - Sincronización y copia rápida de archivos + - `fd` o `find` - Búsqueda de archivos mejorada + - `rg` (ripgrep) o `ag` (the_silver_searcher) - Búsqueda rápida de texto + - `exa` o `lsd` - Listados de directorios mejorados + - `trash-cli` - Eliminación segura de archivos a la papelera + - `zip`/`unzip`, `tar`, `gzip` - Manejo de archivos comprimidos + +## ⌨️ **Abriendo Exploradores de Archivos** + +### **Dired (Gestor de Archivos Incorporado):** +- `SPC .` - **Abrir Dired** en el directorio actual +- `SPC f d` - **Buscar directorio** (abrir Dired en una ruta específica) +- `C-x d` - **Abrir Dired** (atajo clásico de Emacs) + +### **Navegación de Archivos del Proyecto:** +- `SPC SPC` - **Buscar archivo** en el proyecto +- `SPC f f` - **Buscar archivo** en cualquier lugar +- `SPC f r` - **Archivos recientes** +- `SPC p f` - **Buscar archivo** en el proyecto + +### **Exploradores en Estilo de Árbol:** +- `SPC o p` - **Alternar barra lateral del proyecto** (Treemacs) +- `SPC f t` - **Buscar archivo** en el árbol + +## 🧭 **Navegación en Dired** + +### **Movimiento Básico:** +- `j/k` o `n/p` - **Moverse arriba/abajo** entre archivos +- `h` - **Subir** un directorio (padre) +- `l` o `RET` - **Entrar en el directorio** o abrir archivo +- `^` - **Ir al directorio padre** +- `g` - **Refrescar** el listado del directorio + +### **Saltando:** +- `gg` - **Ir al principio** del listado +- `G` - **Ir al final** del listado +- `/` - **Buscar** por nombre de archivo/directorio +- `SPC s s` - **Buscar dentro** del directorio + +### **Información del Archivo:** +- `(` - **Alternar detalles** (mostrar/ocultar información del archivo) +- `s` - **Ordenar** archivos (por nombre, fecha, tamaño) +- `C-h m` - **Mostrar ayuda** para el modo actual + +## 📁 **Operaciones con Archivos** + +### **Abriendo Archivos:** +- `RET` - **Abrir archivo** en la ventana actual +- `o` - **Abrir archivo** en otra ventana +- `C-o` - **Abrir archivo** en otra ventana (mantener el cursor en Dired) +- `v` - **Ver archivo** (solo lectura) +- `f` - **Buscar archivo** (igual que RET) + +### **Creando Archivos y Directorios:** +- `+` - **Crear directorio** +- `SPC f c` - **Crear archivo** (cuando estás en el búfer de Dired) +- `C-x C-f` - **Buscar/crear archivo** (desde Dired) + +## 🏷️ **Marcando Archivos** + +### **Marcado Básico:** +- `m` - **Marcar archivo** para operaciones +- `u` - **Desmarcar archivo** +- `U` - **Desmarcar todos** los archivos +- `t` - **Alternar marcas** (marcar los no marcados, desmarcar los marcados) +- `* %` - **Marcar por patrón** de expresión regular + +### **Marcado Rápido:** +- `* .` - **Marcar por extensión** (ej., *.txt) +- `* /` - **Marcar directorios** +- `* @` - **Marcar enlaces simbólicos** +- `* *` - **Marcar ejecutables** + +### **Marcado Avanzado:** +- `% m` - **Marcar archivos** que coincidan con una expresión regular +- `% d` - **Marcar para eliminar** archivos que coincidan con una expresión regular +- `* c` - **Cambiar marcas** (cambiar una marca por otra) + +## ✂️ **Operaciones de Gestión de Archivos** + +### **Copiar, Mover, Eliminar:** +- `C` - **Copiar** archivos marcados (o el archivo bajo el cursor) +- `R` - **Renombrar/Mover** archivos marcados +- `D` - **Eliminar** archivos marcados inmediatamente +- `d` - **Marcar para eliminar** (usa `x` para ejecutar) +- `x` - **Ejecutar eliminaciones** (eliminar archivos marcados con `d`) + +### **Opciones de Eliminación:** +- `d` y luego `x` - **Eliminación segura** (marcar primero, luego ejecutar) +- `D` - **Eliminación inmediata** (omite el paso de marcar) +- **Integración con la papelera**: Si `trash-cli` está instalado, los archivos van a la papelera en lugar de ser eliminados permanentemente + +### **Operaciones Avanzadas:** +- `Z` - **Comprimir/descomprimir** archivos (usa `gzip`, `zip`, `tar` automáticamente) +- `A` - **Buscar** en archivos marcados (usa `grep` o `rg` si está disponible) +- `Q` - **Consultar y reemplazar** en archivos marcados +- `!` - **Ejecutar comando de shell** en archivos marcados +- `&` - **Ejecutar comando de shell asíncrono** en archivos marcados + +## 📋 **Copiando y Moviendo** + +### **Operaciones de Copia:** +- `C` - **Copiar archivos** (solicita el destino) +- Funciona con archivos marcados o un solo archivo bajo el cursor +- Usa `rsync` si está disponible para una copia más rápida y reanudable +- Admite la copia a diferentes unidades/particiones + +### **Operaciones de Mover/Renombrar:** +- `R` - **Renombrar/Mover** archivos +- Puede renombrar archivos individuales o mover múltiples archivos marcados +- Admite el movimiento entre directorios + +### **Consejos para Copiar/Mover:** +- Marca múltiples archivos primero, luego usa `C` o `R` +- El autocompletado con Tab funciona para las rutas de destino +- Usa rutas relativas (`.`, `..`) para una navegación rápida + +## 🔍 **Búsqueda y Filtro** + +### **Encontrando Archivos:** +- `/` - **Buscar** nombres de archivo en el listado actual +- `n/N` - **Siguiente/anterior** coincidencia de búsqueda + +### **Búsqueda Mejorada (con herramientas externas):** +- `A` - **Buscar dentro de los archivos** (usa `rg` > `ag` > `grep` en orden de prioridad) +- Mucho más rápido con `ripgrep` o `the_silver_searcher` +- Admite patrones de expresiones regulares y filtrado por tipo de archivo + +### **Filtrando la Visualización:** +- `(` - **Alternar** vista detallada +- `s` - **Ordenar** por diferentes criterios +- `C-u s` - **Ordenar** con opciones personalizadas + +### **Búsqueda de Contenido:** +- `A` - **Buscar dentro** de los archivos marcados +- `Q` - **Consultar y reemplazar** en los archivos marcados + +## 🔧 **Características Avanzadas** + +### **Wdired (Dired Editable):** +- `C-x C-q` - **Editar nombres de archivo** directamente (como renombrar) +- Edita los nombres de archivo como texto, luego `C-c C-c` para aplicar los cambios +- `C-c C-k` para cancelar las ediciones + +### **Múltiples Ventanas:** +- `o` - **Abrir en otra ventana** +- `C-o` - **Mostrar en otra ventana** (permanecer en Dired) +- `2` - **Dividir la ventana** verticalmente para dos vistas de Dired + +### **Subdirectorios:** +- `i` - **Insertar subdirectorio** en el mismo búfer +- `$` - **Ocultar/mostrar** el contenido del subdirectorio +- `M-$` - **Ocultar todos** los subdirectorios + +## 📊 **Comparación de Archivos** + +### **Operaciones de Diferencias:** +- `=` - **Comparar archivo** con otro +- `M-=` - **Comparar** archivos marcados entre sí +- Funciona con herramientas de diferencias externas + +## 🗜️ **Operaciones con Archivos Comprimidos** + +### **Compresión y Archivos:** +- `Z` - **Comprimir/descomprimir** detecta automáticamente el formato +- Admite: `.gz`, `.zip`, `.tar`, `.tar.gz`, `.tar.xz`, `.7z` +- Usa las herramientas apropiadas: `gzip`, `zip`, `tar`, `7z` + +### **Visualización de Archivos Comprimidos:** +- Abre archivos `.zip`, `.tar`, etc. directamente para navegar por su contenido +- Extrae archivos específicos de los archivos comprimidos + +## 🎛️ **Personalización y Ajustes** + +### **Opciones de Vista:** +- `(` - **Alternar** entre vista simple y detallada +- `s` - **Ciclar** entre los órdenes de clasificación (nombre, fecha, tamaño) +- Listados mejorados con `exa` o `lsd` si están disponibles + +### **Ajustes Útiles:** +- Dired reutiliza los búferes por defecto en Doom +- Actualización automática al cambiar los archivos +- Integración con los atajos de teclado del modo Evil + +## ⚡ **Treemacs (Explorador en Árbol)** + +### **Treemacs Básico:** +- `SPC o p` - **Alternar** la barra lateral de Treemacs +- `j/k` - **Navegar** arriba/abajo en el árbol +- `RET` - **Abrir archivo** o expandir/contraer directorio +- `TAB` - **Expandir/contraer** directorio + +### **Operaciones de Archivo en Treemacs:** +- `cf` - **Crear archivo** +- `cd` - **Crear directorio** +- `R` - **Renombrar** +- `d` - **Eliminar** +- `yy` - **Copiar** la ruta al portapapeles + +## 🚀 **Flujo de Trabajo de Inicio Rápido** + +### **Gestión Básica de Archivos:** +1. **Presiona `SPC .`** - Abre Dired en el directorio actual +2. **Navega con `j/k`** - Muévete entre los archivos +3. **Marca archivos con `m`** - Selecciona múltiples archivos +4. **Usa `C` para copiar** o `R` para mover/renombrar +5. **Presiona `g`** para refrescar cuando termines + +### **Operaciones de Archivo Eficientes:** +1. **Marca múltiples archivos** con `m` +2. **Ejecuta operaciones por lotes** (`C` para copiar, `R` para mover) +3. **Usa `!`** para ejecutar comandos de shell en los archivos marcados +4. **Alterna los detalles con `(`** para más/menos información + +## 📚 **Resumen de Atajos Esenciales** + +| Acción | Tecla | Descripción | +|--------|-----|-------------| +| Abrir Dired | `SPC .` | Abrir explorador de archivos | +| Navegar | `j/k` | Moverse arriba/abajo | +| Entrar/Abrir | `RET` o `l` | Abrir archivo/directorio | +| Directorio Padre | `h` o `^` | Subir un directorio | +| Marcar | `m` | Marcar archivo para operaciones | +| Copiar | `C` | Copiar archivos marcados | +| Mover/Renombrar | `R` | Mover o renombrar archivos | +| Eliminar | `d` y luego `x` | Marcar para eliminar, ejecutar | +| Crear Directorio | `+` | Crear nuevo directorio | +| Comprimir | `Z` | Comprimir/descomprimir | +| Buscar en Archivos | `A` | Buscar dentro de los archivos | +| Refrescar | `g` | Refrescar el listado del directorio | +| Ayuda | `?` | Mostrar comandos disponibles | + +## 🔧 **Solución de Problemas** + +### **Problemas Comunes:** +- **¿El búfer de Dired no se actualiza?** Presiona `g` para refrescar +- **¿No puedes ver los detalles del archivo?** Presiona `(` para alternar la vista detallada +- **¿Las operaciones son lentas?** Usa el marcado (`m`) para operaciones por lotes +- **¿Orden de clasificación incorrecto?** Presiona `s` para ciclar entre las opciones de clasificación + +### **Consejos de Rendimiento:** +- Instala `fd` para una búsqueda de archivos más rápida +- Instala `rg` (ripgrep) para una búsqueda de texto más rápida +- Usa `rsync` para una copia de archivos eficiente +- Considera `exa` o `lsd` para listados de directorios mejorados + +### **Obteniendo Ayuda:** +- `?` - **Ayuda contextual** en cualquier búfer de Dired +- `C-h m` - **Ayuda específica del modo** +- `SPC h d f dired` - **Documentación completa de Dired** + +## 📋 **Comparación: Dired vs Treemacs** + +### **Usa Dired cuando:** +- Gestionas múltiples archivos a la vez +- Necesitas información detallada de los archivos +- Realizas operaciones por lotes +- Trabajas con permisos/propiedad de archivos + +### **Usa Treemacs cuando:** +- Necesitas una vista rápida del proyecto +- Navegación de archivos simple +- Prefieres una estructura de árbol visual +- Necesitas una barra lateral persistente + +## 🛠️ **Integración con Herramientas Externas** + +### **Herramientas Recomendadas:** +- **`rsync`** - Copia de archivos rápida y fiable con capacidad de reanudación +- **`ripgrep` (rg)** - Búsqueda de texto extremadamente rápida, mucho más rápida que grep +- **`fd`** - Alternativa rápida a find con mejores valores predeterminados +- **`exa`** - Reemplazo moderno de ls con colores e integración con git +- **`trash-cli`** - Eliminación segura a la papelera en lugar de eliminación permanente +- **`7z`** - Maneja archivos 7zip y otros formatos de compresión + +### **Instalación (Debian/Ubuntu):** +```bash +sudo apt install rsync ripgrep fd-find exa trash-cli p7zip-full +``` + +## 🎯 **Consejos Profesionales** + +- **Operaciones por lotes**: Marca los archivos primero (`m`), luego ejecuta las operaciones +- **Navegación rápida**: Usa `/` para buscar archivos por nombre +- **Editar nombres de archivo**: Usa `C-x C-q` para el modo Wdired para renombrar múltiples archivos +- **Integración con la shell**: Usa `!` para ejecutar comandos de shell en los archivos +- **Múltiples directorios**: Usa `i` para mostrar subdirectorios en el mismo búfer +- **Eliminación segura**: Instala `trash-cli` para enviar archivos a la papelera en lugar de eliminarlos permanentemente +- **Búsqueda rápida**: Instala `ripgrep` para una búsqueda de texto ultrarrápida en los archivos + +Dired proporciona una experiencia completa de gestión de archivos que se integra bien con herramientas externas de Linux, haciendo que las operaciones con archivos sean eficientes y potentes. diff --git a/cheatsheets/emacs/emacs.file-explorer.cheatsheet.md b/cheatsheets/emacs/emacs.file-explorer.cheatsheet.md new file mode 100644 index 0000000..01e8da2 --- /dev/null +++ b/cheatsheets/emacs/emacs.file-explorer.cheatsheet.md @@ -0,0 +1,306 @@ +English | [Español](./emacs.file-explorer.cheatsheet.es.md) + +# Doom Emacs File Explorer Cheatsheet +## 🗂️ **What is Dired?** + +Dired (Directory Editor) is Emacs' built-in file manager that allows you to navigate, manage, and manipulate files and directories efficiently. +- Browse directories with keyboard navigation +- Mark, copy, move, and delete files +- Execute commands on multiple files at once +- Integrate with other Emacs tools and buffers + +## 📋 **Requirements** +- Doom Emacs (Dired is built-in) +- **Treemacs**: Must be enabled in `~/.doom.d/init.el` (uncomment `treemacs` line) +- Optional tools for enhanced functionality: + - `rsync` - Fast file synchronization and copying + - `fd` or `find` - Enhanced file finding + - `rg` (ripgrep) or `ag` (the_silver_searcher) - Fast text search + - `exa` or `lsd` - Enhanced directory listings + - `trash-cli` - Safe file deletion to trash + - `zip`/`unzip`, `tar`, `gzip` - Archive handling + +## ⌨️ **Opening File Explorers** + +### **Dired (Built-in File Manager):** +- `SPC .` - **Open Dired** in current directory +- `SPC f d` - **Find directory** (open Dired in specific path) +- `C-x d` - **Open Dired** (classic Emacs binding) + +### **Project File Navigation:** +- `SPC SPC` - **Find file** in project +- `SPC f f` - **Find file** anywhere +- `SPC f r` - **Recent files** +- `SPC p f` - **Find file** in project + +### **Tree-style Explorers:** +- `SPC o p` - **Toggle project sidebar** (Treemacs) +- `SPC f t` - **Find file** in tree + +## 🧭 **Navigation in Dired** + +### **Basic Movement:** +- `j/k` or `n/p` - **Move up/down** between files +- `h` - **Go up** one directory (parent) +- `l` or `RET` - **Enter directory** or open file +- `^` - **Go to parent directory** +- `g` - **Refresh** directory listing + +### **Jumping Around:** +- `gg` - **Go to top** of listing +- `G` - **Go to bottom** of listing +- `/` - **Search** for file/directory name +- `SPC s s` - **Search within** directory + +### **File Information:** +- `(` - **Toggle details** (show/hide file info) +- `s` - **Sort** files (by name, date, size) +- `C-h m` - **Show help** for current mode + +## 📁 **File Operations** + +### **Opening Files:** +- `RET` - **Open file** in current window +- `o` - **Open file** in other window +- `C-o` - **Open file** in other window (keep cursor in Dired) +- `v` - **View file** (read-only) +- `f` - **Find file** (same as RET) + +### **Creating Files & Directories:** +- `+` - **Create directory** +- `SPC f c` - **Create file** (when in Dired buffer) +- `C-x C-f` - **Find/create file** (from Dired) + +## 🏷️ **Marking Files** + +### **Basic Marking:** +- `m` - **Mark file** for operations +- `u` - **Unmark file** +- `U` - **Unmark all** files +- `t` - **Toggle marks** (mark unmarked, unmark marked) +- `* %` - **Mark by regex** pattern + +### **Quick Marking:** +- `* .` - **Mark by extension** (e.g., *.txt) +- `* /` - **Mark directories** +- `* @` - **Mark symlinks** +- `* *` - **Mark executables** + +### **Advanced Marking:** +- `% m` - **Mark files** matching regex +- `% d` - **Mark for deletion** files matching regex +- `* c` - **Change marks** (change one mark to another) + +## ✂️ **File Management Operations** + +### **Copy, Move, Delete:** +- `C` - **Copy** marked files (or file under cursor) +- `R` - **Rename/Move** marked files +- `D` - **Delete** marked files immediately +- `d` - **Mark for deletion** (use `x` to execute) +- `x` - **Execute deletions** (delete files marked with `d`) + +### **Deletion Options:** +- `d` then `x` - **Safe deletion** (mark first, then execute) +- `D` - **Immediate deletion** (bypass mark step) +- **Trash integration**: If `trash-cli` is installed, files go to trash instead of permanent deletion + +### **Advanced Operations:** +- `Z` - **Compress/uncompress** files (uses `gzip`, `zip`, `tar` automatically) +- `A` - **Search** in marked files (uses `grep` or `rg` if available) +- `Q` - **Query replace** in marked files +- `!` - **Run shell command** on marked files +- `&` - **Run async shell command** on marked files + +## 📋 **Copying & Moving** + +### **Copy Operations:** +- `C` - **Copy files** (prompts for destination) +- Works with marked files or single file under cursor +- Uses `rsync` if available for faster, resumable copying +- Supports copying to different drives/partitions + +### **Move/Rename Operations:** +- `R` - **Rename/Move** files +- Can rename single files or move multiple marked files +- Supports moving across directories + +### **Tips for Copy/Move:** +- Mark multiple files first, then use `C` or `R` +- Tab completion works for destination paths +- Use relative paths (`.`, `..`) for quick navigation + +## 🔍 **Search & Filter** + +### **Finding Files:** +- `/` - **Search** file names in current listing +- `n/N` - **Next/previous** search match + +### **Enhanced Search (with external tools):** +- `A` - **Search inside files** (uses `rg` > `ag` > `grep` in priority order) +- Much faster with `ripgrep` or `the_silver_searcher` +- Supports regex patterns and file type filtering + +### **Filtering Display:** +- `(` - **Toggle** detailed view +- `s` - **Sort** by different criteria +- `C-u s` - **Sort** with custom options + +### **Content Search:** +- `A` - **Search inside** marked files +- `Q` - **Query replace** across marked files + +## 🔧 **Advanced Features** + +### **Wdired (Writable Dired):** +- `C-x C-q` - **Edit filenames** directly (like renaming) +- Edit filenames as text, then `C-c C-c` to apply changes +- `C-c C-k` to cancel edits + +### **Multiple Windows:** +- `o` - **Open in other window** +- `C-o` - **Display in other window** (stay in Dired) +- `2` - **Split window** vertically for two Dired views + +### **Subdirectories:** +- `i` - **Insert subdirectory** in same buffer +- `$` - **Hide/show** subdirectory contents +- `M-$` - **Hide all** subdirectories + +## 📊 **File Comparison** + +### **Diff Operations:** +- `=` - **Diff file** with another +- `M-=` - **Diff** marked files against each other +- Works with external diff tools + +## 🗜️ **Archive Operations** + +### **Compression & Archives:** +- `Z` - **Compress/decompress** automatically detects format +- Supports: `.gz`, `.zip`, `.tar`, `.tar.gz`, `.tar.xz`, `.7z` +- Uses appropriate tools: `gzip`, `zip`, `tar`, `7z` + +### **Archive Viewing:** +- Open `.zip`, `.tar`, etc. files directly to browse contents +- Extract specific files from archives + +## 🎛️ **Customization & Settings** + +### **View Options:** +- `(` - **Toggle** between simple and detailed view +- `s` - **Cycle** through sort orders (name, date, size) +- Enhanced listings with `exa` or `lsd` if available + +### **Useful Settings:** +- Dired reuses buffers by default in Doom +- Auto-refresh on file changes +- Integration with Evil mode keybindings + +## ⚡ **Treemacs (Tree Explorer)** + +### **Basic Treemacs:** +- `SPC o p` - **Toggle** Treemacs sidebar +- `j/k` - **Navigate** up/down in tree +- `RET` - **Open file** or expand/collapse directory +- `TAB` - **Expand/collapse** directory + +### **Treemacs File Operations:** +- `cf` - **Create file** +- `cd` - **Create directory** +- `R` - **Rename** +- `d` - **Delete** +- `yy` - **Copy** path to clipboard + +## 🚀 **Quick Start Workflow** + +### **Basic File Management:** +1. **Press `SPC .`** - Open Dired in current directory +2. **Navigate with `j/k`** - Move between files +3. **Mark files with `m`** - Select multiple files +4. **Use `C` to copy** or `R` to move/rename +5. **Press `g`** to refresh when done + +### **Efficient File Operations:** +1. **Mark multiple files** with `m` +2. **Execute batch operations** (`C` for copy, `R` for move) +3. **Use `!`** to run shell commands on marked files +4. **Toggle details with `(`** for more/less information + +## 📚 **Essential Keybind Summary** + +| Action | Key | Description | +|--------|-----|-------------| +| Open Dired | `SPC .` | Open file explorer | +| Navigate | `j/k` | Move up/down | +| Enter/Open | `RET` or `l` | Open file/directory | +| Parent Dir | `h` or `^` | Go up one directory | +| Mark | `m` | Mark file for operations | +| Copy | `C` | Copy marked files | +| Move/Rename | `R` | Move or rename files | +| Delete | `d` then `x` | Mark for deletion, execute | +| Create Dir | `+` | Create new directory | +| Compress | `Z` | Compress/decompress | +| Search Files | `A` | Search inside files | +| Refresh | `g` | Refresh directory listing | +| Help | `?` | Show available commands | + +## 🔧 **Troubleshooting** + +### **Common Issues:** +- **Dired buffer not updating?** Press `g` to refresh +- **Can't see file details?** Press `(` to toggle detailed view +- **Operations feel slow?** Use marking (`m`) for batch operations +- **Wrong sort order?** Press `s` to cycle through sort options + +### **Performance Tips:** +- Install `fd` for faster file finding +- Install `rg` (ripgrep) for faster text search +- Use `rsync` for efficient file copying +- Consider `exa` or `lsd` for enhanced directory listings + +### **Getting Help:** +- `?` - **Context help** in any Dired buffer +- `C-h m` - **Mode-specific help** +- `SPC h d f dired` - **Full Dired documentation** + +## 📋 **Comparison: Dired vs Treemacs** + +### **Use Dired when:** +- Managing multiple files at once +- Need detailed file information +- Performing batch operations +- Working with file permissions/ownership + +### **Use Treemacs when:** +- Quick project overview +- Simple file navigation +- Prefer visual tree structure +- Need persistent sidebar + +## 🛠️ **External Tool Integration** + +### **Recommended Tools:** +- **`rsync`** - Fast, reliable file copying with resume capability +- **`ripgrep` (rg)** - Extremely fast text search, much faster than grep +- **`fd`** - Fast alternative to find with better defaults +- **`exa`** - Modern replacement for ls with colors and git integration +- **`trash-cli`** - Safe deletion to trash instead of permanent removal +- **`7z`** - Handle 7zip archives and other compression formats + +### **Installation (Debian/Ubuntu):** +```bash +sudo apt install rsync ripgrep fd-find exa trash-cli p7zip-full +``` + +## 🎯 **Pro Tips** + +- **Batch operations**: Mark files first (`m`), then execute operations +- **Quick navigation**: Use `/` to search for files by name +- **Edit filenames**: Use `C-x C-q` for Wdired mode to rename multiple files +- **Shell integration**: Use `!` to run shell commands on files +- **Multiple directories**: Use `i` to show subdirectories in same buffer +- **Safe deletion**: Install `trash-cli` to send files to trash instead of permanent deletion +- **Fast search**: Install `ripgrep` for lightning-fast text search in files + +Dired provides a comprehensive file management experience that integrates well with external Linux tools, making file operations both efficient and powerful. diff --git a/cheatsheets/emacs/emacs.getting-started.top10.es.md b/cheatsheets/emacs/emacs.getting-started.top10.es.md new file mode 100644 index 0000000..bc952a9 --- /dev/null +++ b/cheatsheets/emacs/emacs.getting-started.top10.es.md @@ -0,0 +1,276 @@ +[English](./emacs.getting-started.top10.md) | Español + +# Las 10 Cosas Principales que los Nuevos Usuarios de Doom Emacs Deberían Saber +## 🚀 **Primeros Pasos con Doom Emacs** + +¡Bienvenido a Doom Emacs! Aquí están las 10 cosas más esenciales que todo nuevo usuario debería dominar para ser productivo rápidamente. + +--- + +## 1. 🗝️ **Domina la Tecla Líder: `SPC`** + +**La tecla Espacio es tu puerta de entrada a todo en Doom Emacs.** + +- `SPC` se llama la "tecla líder" - abre menús para casi todas las acciones +- Después de presionar `SPC`, verás sugerencias útiles que muestran los comandos disponibles +- Los comandos están organizados lógicamente: `SPC f` para archivos, `SPC g` para git, `SPC p` para proyectos + +**Comandos esenciales para empezar:** + +- `SPC f f` - Buscar/abrir archivos +- `SPC f s` - Guardar archivo actual +- `SPC q q` - Salir de Emacs +- `SPC h` - Menú de ayuda (¡muy importante!) + +**Consejo Profesional:** Si olvidas lo que sigue, simplemente presiona `SPC` y espera - ¡Doom te mostrará las opciones! + +--- + +## 2. 📁 **Navega por los Archivos como un Profesional** + +**La navegación de archivos es fundamental para la productividad.** + +- `SPC .` - **Abrir explorador de archivos** (Dired) en el directorio actual +- `SPC f f` - **Buscar archivo** en cualquier parte de tu sistema +- `SPC f r` - **Archivos recientes** en los que has trabajado +- `SPC SPC` - **Buscar archivo en el proyecto actual** (¡súper útil!) + +📋 _Consulta la guía completa: `emacs.file-explorer.cheatsheet.md`_ + +**Flujo de trabajo rápido:** + +1. Abre el directorio de tu proyecto en la terminal +2. Inicia Emacs: `emacs` (o `emacsclient -c` para GUI, `et` para TTY) +3. Usa `SPC .` para explorar archivos o `SPC SPC` para encontrar archivos rápidamente + +--- + +## 3. ⌨️ **Entiende el Modo Evil (Atajos de Teclado de Vim)** + +**Doom Emacs usa atajos de teclado al estilo de Vim por defecto.** + +**Movimiento básico (en modo Normal):** + +- `h j k l` - Izquierda, abajo, arriba, derecha +- `w` - Saltar a la siguiente palabra +- `b` - Saltar una palabra hacia atrás +- `gg` - Ir al principio del archivo +- `G` - Ir al final del archivo + +**Cambio de modo:** + +- `i` - Entrar en modo de Inserción (para escribir texto) +- `ESC` - Volver al modo Normal +- `v` - Modo Visual (para seleccionar texto) + +**Si no estás familiarizado con Vim:** ¡No te asustes! Puedes aprender gradualmente. Lo básico anterior te ayudará a empezar. + +--- + +## 4. 🔍 **Busca y Reemplaza Eficientemente** + +**Encontrar y cambiar texto es una tarea diaria.** + +- `/` - Buscar hacia adelante en el búfer actual +- `?` - Buscar hacia atrás en el búfer actual +- `n/N` - Resultado de búsqueda siguiente/anterior +- `SPC s s` - Buscar en el búfer actual (interactivo) +- `SPC s p` - Buscar en todo el proyecto +- `SPC s r` - Buscar y reemplazar en el búfer actual + +**Para búsquedas en todo el proyecto:** `SPC s p` es increíblemente poderoso para encontrar código en todo tu proyecto. + +--- + +## 5. 🗂️ **Trabaja con Búferes y Ventanas** + +**Los búferes son archivos abiertos, las ventanas son cómo los ves.** + +**Gestión de búferes:** + +- `SPC b b` - Cambiar entre búferes abiertos +- `SPC b k` - Matar (cerrar) el búfer actual +- `SPC b s` - Guardar el búfer actual + +**Gestión de ventanas:** + +- `SPC w v` - Dividir la ventana verticalmente +- `SPC w s` - Dividir la ventana horizontalmente +- `SPC w c` - Cerrar la ventana actual +- `SPC w w` - Cambiar entre ventanas +- `C-h j/k/h/l` - Navegar entre ventanas (estilo Vim) + +**Piénsalo de esta manera:** Puedes tener muchos archivos abiertos (búferes) pero solo ver algunos de ellos a la vez (ventanas). + +--- + +## 6. 🛠️ **Configura y Personaliza Doom** + +**Doom es altamente configurable, pero empieza de forma sencilla.** + +**Archivos clave que debes conocer:** + +- `~/.doom.d/config.el` - Tu configuración personal +- `~/.doom.d/init.el` - Habilitar/deshabilitar módulos de Doom +- `~/.doom.d/packages.el` - Añadir paquetes adicionales + +**Comandos esenciales:** + +- `SPC h r r` - Recargar la configuración de Doom +- `SPC h d h` - Ayuda y documentación de Doom +- `doom doctor` - Comprobar si hay problemas de configuración (ejecutar en la terminal) +- `doom upgrade` - Actualizar Doom (ejecutar en la terminal) + +**Empieza poco a poco:** No intentes personalizar todo de una vez. Usa primero los valores predeterminados de Doom y luego ajusta las cosas gradualmente. + +--- + +## 7. 📝 **Domina los Conceptos Básicos de Edición de Texto** + +**Comandos de edición esenciales que funcionan en cualquier modo.** + +**En modo Normal (Evil):** + +- `x` - Eliminar el carácter bajo el cursor +- `dd` - Eliminar la línea entera +- `yy` - Copiar (yank) la línea entera +- `p` - Pegar después del cursor +- `u` - Deshacer +- `C-r` - Rehacer + +**En modo de Inserción:** + +- `C-w` - Eliminar palabra hacia atrás +- `C-u` - Eliminar hasta el principio de la línea + +**Selección y manipulación:** + +- `v` - Iniciar selección visual +- `V` - Seleccionar la línea entera +- `d` - Eliminar el texto seleccionado +- `y` - Copiar el texto seleccionado + +--- + +## 8. 💻 **Usa la Autocompletación de Código y las Funciones del Lenguaje** + +**Doom viene con un excelente soporte de código de fábrica.** + +**Autocompletación:** + +- Simplemente empieza a escribir - las terminaciones aparecen automáticamente +- `TAB` - Aceptar la terminación +- `C-n/C-p` o `j/k` - Navegar por las opciones de terminación + +**Navegación de código:** + +- `gd` - Ir a la definición +- `gr` - Encontrar referencias +- `K` - Mostrar documentación +- `SPC c a` - Acciones de código (refactorizar, arreglar, etc.) + +📋 _Consulta la guía completa: `emacs.code-completion.cheatsheet.md`_ + +**Lenguajes soportados:** La mayoría de los lenguajes populares funcionan de fábrica (Python, JavaScript, C/C++, Rust, Go, etc.) + +--- + +## 9. 📚 **Usa el Sistema de Ayuda Incorporado** + +**Doom tiene una excelente documentación incorporada.** + +- `SPC h` - **Menú principal de ayuda** +- `SPC h d h` - **Ayuda específica de Doom** +- `SPC h k` - **Describir tecla** (¿qué hace esta tecla?) +- `SPC h f` - **Describir función** +- `SPC h v` - **Describir variable** +- `C-h m` - **Mostrar ayuda para el modo actual** + +**Cuando estés perdido:** Presiona `SPC h` y explora. El sistema de ayuda es completo y siempre está disponible. + +**Consejo Profesional:** Si presionas una combinación de teclas y no sabes qué pasó, usa `SPC h l` para ver los comandos recientes. + +--- + +## 10. 🔧 **Aprende la Integración con Git (Magit)** + +**Magit es una de las mejores interfaces de Git disponibles en cualquier lugar.** + +- `SPC g g` - Abrir el estado de Magit (¡tu comando principal de Git!) +- `s` - Preparar archivos o fragmentos +- `c c` - Confirmar cambios +- `P P` - Empujar al remoto +- `F F` - Traer del remoto + +📋 _Consulta la guía completa: `emacs.magit.cheatsheet.md`_ + +**Flujo de trabajo básico:** + +1. `SPC g g` - Ver qué ha cambiado +2. `s` en los archivos para prepararlos +3. `c c` para confirmar (escribe el mensaje, luego `C-c C-c`) +4. `P P` para empujar + +**Por qué es esencial:** Si trabajas con Git, Magit transformará tu flujo de trabajo. Es visual, rápido e increíblemente poderoso. + +--- + +## 🎯 **Lista de Verificación de Inicio Rápido** + +Una vez que hayas leído lo anterior, prueba este flujo de trabajo de 5 minutos: + +1. ✅ **Abre Doom:** `emacs` en la terminal +2. ✅ **Encuentra un archivo:** `SPC f f` y abre cualquier archivo de texto +3. ✅ **Edita algo:** Presiona `i`, escribe texto, presiona `ESC` +4. ✅ **Guarda:** `SPC f s` +5. ✅ **Abre el explorador de archivos:** `SPC .` +6. ✅ **Obtén ayuda:** `SPC h` +7. ✅ **Divide la ventana:** `SPC w v` +8. ✅ **Cambia de búfer:** `SPC b b` +9. ✅ **Busca en el proyecto:** `SPC s p` (si estás en un proyecto) +10. ✅ **Sal:** `SPC q q` + +--- + +## 📖 **Próximos Pasos: Profundiza** + +Una vez que te sientas cómodo con lo básico anterior: + +1. **Lee las hojas de trucos específicas:** + - `emacs.file-explorer.cheatsheet.md` - Gestión de archivos + - `emacs.code-completion.cheatsheet.md` - Funciones de codificación + - `emacs.magit.cheatsheet.md` - Integración con Git + - `emacs.markdown.cheatsheet.md` - Edición de Markdown + +2. **Personaliza gradualmente:** Empieza a ajustar tu `config.el` +3. **Aprende tu lenguaje:** Explora las funciones específicas del lenguaje +4. **Únete a la comunidad:** Discord de Doom, Reddit, discusiones de GitHub + +--- + +## 🆘 **Cuando Estés Atascado** + +**Comandos de emergencia:** + +- `C-g` - Cancelar el comando actual (como presionar ESC) +- `SPC q q` - Salir de Emacs +- `SPC h d h` - Ayuda de Doom +- `:q` - Salir del búfer actual (comando de Vim) + +**Recuerda:** Todo experto fue una vez un principiante. No intentes aprender todo de una vez. Domina estas 10 cosas primero, luego explora gradualmente funciones más avanzadas. + +**El consejo más importante:** Usa `SPC` y explora los menús. ¡Doom está diseñado para ser descubrible - deja que te guíe! + +--- + +## 🎓 **Filosofía de Aprendizaje** + +**Empieza con flujos de trabajo, no con funciones:** En lugar de memorizar cada atajo de teclado, aprende flujos de trabajo completos para las tareas que haces a diario (editar archivos, confirmar código, buscar en proyectos). + +**Usa primero los valores predeterminados:** Los valores predeterminados de Doom son excelentes. Resiste la tentación de personalizar todo de inmediato. + +**Una cosa a la vez:** Domina la navegación de archivos antes de sumergirte en funciones de código avanzadas. Construye tus habilidades de forma incremental. + +**Practica a diario:** Usa Doom para el trabajo real, incluso si al principio eres más lento. La memoria muscular se desarrolla con la práctica. + +¡Bienvenido a Doom Emacs! 🚀 diff --git a/cheatsheets/emacs/emacs.getting-started.top10.md b/cheatsheets/emacs/emacs.getting-started.top10.md new file mode 100644 index 0000000..8ae5f12 --- /dev/null +++ b/cheatsheets/emacs/emacs.getting-started.top10.md @@ -0,0 +1,295 @@ +English | [Español](./emacs.getting-started.top10.es.md) + +# Top 10 Things New Doom Emacs Users Should Know +## 🚀 **Getting Started with Doom Emacs** + +Welcome to Doom Emacs! Here are the 10 most essential things every new user +should master to get productive quickly. + +--- + +## 1. 🗝️ **Master the Leader Key: `SPC`** + +**The Space key is your gateway to everything in Doom Emacs.** + +- `SPC` is called the "leader key" - it opens menus for almost every action +- After pressing `SPC`, you'll see helpful hints showing available commands +- Commands are organized logically: `SPC f` for files, `SPC g` for git, `SPC p` + for projects + +**Essential starter commands:** + +- `SPC f f` - Find/open files +- `SPC f s` - Save current file +- `SPC q q` - Quit Emacs +- `SPC h` - Help menu (very important!) + +**Pro Tip:** If you forget what comes next, just press `SPC` and wait - Doom +will show you the options! + +--- + +## 2. 📁 **Navigate Files Like a Pro** + +**File navigation is fundamental to productivity.** + +- `SPC .` - **Open file explorer** (Dired) in current directory +- `SPC f f` - **Find file** anywhere on your system +- `SPC f r` - **Recent files** you've worked on +- `SPC SPC` - **Find file in current project** (super useful!) + +📋 _See the complete guide: `emacs.file-explorer.cheatsheet.md`_ + +**Quick workflow:** + +1. Open your project directory in terminal +2. Start Emacs: `emacs` (or `emacsclient -c` for GUI, `et` for TTY) +3. Use `SPC .` to browse files or `SPC SPC` to quickly find files + +--- + +## 3. ⌨️ **Understand Evil Mode (Vim Keybindings)** + +**Doom Emacs uses Vim-style keybindings by default.** + +**Basic movement (in Normal mode):** + +- `h j k l` - Left, down, up, right +- `w` - Jump to next word +- `b` - Jump back one word +- `gg` - Go to top of file +- `G` - Go to bottom of file + +**Mode switching:** + +- `i` - Enter Insert mode (to type text) +- `ESC` - Return to Normal mode +- `v` - Visual mode (to select text) + +**If you're not familiar with Vim:** Don't panic! You can learn gradually. The +basics above will get you started. + +--- + +## 4. 🔍 **Search and Replace Efficiently** + +**Finding and changing text is a daily task.** + +- `/` - Search forward in current buffer +- `?` - Search backward in current buffer +- `n/N` - Next/previous search result +- `SPC s s` - Search in current buffer (interactive) +- `SPC s p` - Search in entire project +- `SPC s r` - Search and replace in current buffer + +**For project-wide search:** `SPC s p` is incredibly powerful for finding code +across your entire project. + +--- + +## 5. 🗂️ **Work with Buffers and Windows** + +**Buffers are open files, windows are how you view them.** + +**Buffer management:** + +- `SPC b b` - Switch between open buffers +- `SPC b k` - Kill (close) current buffer +- `SPC b s` - Save current buffer + +**Window management:** + +- `SPC w v` - Split window vertically +- `SPC w s` - Split window horizontally +- `SPC w c` - Close current window +- `SPC w w` - Switch between windows +- `C-h j/k/h/l` - Navigate between windows (Vim-style) + +**Think of it this way:** You can have many files open (buffers) but only see +some of them at once (windows). + +--- + +## 6. 🛠️ **Configure and Customize Doom** + +**Doom is highly configurable, but start simple.** + +**Key files to know about:** + +- `~/.doom.d/config.el` - Your personal configuration +- `~/.doom.d/init.el` - Enable/disable Doom modules +- `~/.doom.d/packages.el` - Add extra packages + +**Essential commands:** + +- `SPC h r r` - Reload Doom configuration +- `SPC h d h` - Doom help and documentation +- `doom doctor` - Check for configuration issues (run in terminal) +- `doom upgrade` - Update Doom (run in terminal) + +**Start small:** Don't try to customize everything at once. Use Doom's defaults +first, then gradually tweak things. + +--- + +## 7. 📝 **Master Text Editing Basics** + +**Essential editing commands that work in any mode.** + +**In Normal mode (Evil):** + +- `x` - Delete character under cursor +- `dd` - Delete entire line +- `yy` - Copy (yank) entire line +- `p` - Paste after cursor +- `u` - Undo +- `C-r` - Redo + +**In Insert mode:** + +- `C-w` - Delete word backward +- `C-u` - Delete to beginning of line + +**Selection and manipulation:** + +- `v` - Start visual selection +- `V` - Select entire line +- `d` - Delete selected text +- `y` - Copy selected text + +--- + +## 8. 💻 **Use Code Completion and Language Features** + +**Doom comes with excellent code support out of the box.** + +**Auto-completion:** + +- Just start typing - completions appear automatically +- `TAB` - Accept completion +- `C-n/C-p` or `j/k` - Navigate completion options + +**Code navigation:** + +- `gd` - Go to definition +- `gr` - Find references +- `K` - Show documentation +- `SPC c a` - Code actions (refactor, fix, etc.) + +📋 _See the complete guide: `emacs.code-completion.cheatsheet.md`_ + +**Languages supported:** Most popular languages work out of the box (Python, +JavaScript, C/C++, Rust, Go, etc.) + +--- + +## 9. 📚 **Use Built-in Help System** + +**Doom has excellent built-in documentation.** + +- `SPC h` - **Main help menu** +- `SPC h d h` - **Doom-specific help** +- `SPC h k` - **Describe key** (what does this key do?) +- `SPC h f` - **Describe function** +- `SPC h v` - **Describe variable** +- `C-h m` - **Show help for current mode** + +**When you're lost:** Press `SPC h` and explore. The help system is +comprehensive and always available. + +**Pro Tip:** If you press a key combination and don't know what happened, use +`SPC h l` to see recent commands. + +--- + +## 10. 🔧 **Learn Git Integration (Magit)** + +**Magit is one of the best Git interfaces available anywhere.** + +- `SPC g g` - Open Magit status (your main Git command!) +- `s` - Stage files or hunks +- `c c` - Commit changes +- `P P` - Push to remote +- `F F` - Pull from remote + +📋 _See the complete guide: `emacs.magit.cheatsheet.md`_ + +**Basic workflow:** + +1. `SPC g g` - See what's changed +2. `s` on files to stage them +3. `c c` to commit (write message, then `C-c C-c`) +4. `P P` to push + +**Why it's essential:** If you work with Git, Magit will transform your +workflow. It's visual, fast, and incredibly powerful. + +--- + +## 🎯 **Quick Start Checklist** + +Once you've read through the above, try this 5-minute workflow: + +1. ✅ **Open Doom:** `emacs` in terminal +2. ✅ **Find a file:** `SPC f f` and open any text file +3. ✅ **Edit something:** Press `i`, type text, press `ESC` +4. ✅ **Save:** `SPC f s` +5. ✅ **Open file explorer:** `SPC .` +6. ✅ **Get help:** `SPC h` +7. ✅ **Split window:** `SPC w v` +8. ✅ **Switch buffers:** `SPC b b` +9. ✅ **Search project:** `SPC s p` (if in a project) +10. ✅ **Quit:** `SPC q q` + +--- + +## 📖 **Next Steps: Dive Deeper** + +Once you're comfortable with the basics above: + +1. **Read the specific cheatsheets:** + - `emacs.file-explorer.cheatsheet.md` - File management + - `emacs.code-completion.cheatsheet.md` - Coding features + - `emacs.magit.cheatsheet.md` - Git integration + - `emacs.markdown.cheatsheet.md` - Markdown editing + +2. **Customize gradually:** Start tweaking your `config.el` +3. **Learn your language:** Explore language-specific features +4. **Join the community:** Doom Discord, Reddit, GitHub discussions + +--- + +## 🆘 **When You're Stuck** + +**Emergency commands:** + +- `C-g` - Cancel current command (like pressing ESC) +- `SPC q q` - Quit Emacs +- `SPC h d h` - Doom help +- `:q` - Quit current buffer (Vim command) + +**Remember:** Every expert was once a beginner. Don't try to learn everything at +once. Master these 10 things first, then gradually explore more advanced +features. + +**Most important tip:** Use `SPC` and explore the menus. Doom is designed to be +discoverable - let it guide you! + +--- + +## 🎓 **Learning Philosophy** + +**Start with workflows, not features:** Instead of memorizing every keybinding, +learn complete workflows for tasks you do daily (editing files, committing code, +searching projects). + +**Use the defaults first:** Doom's defaults are excellent. Resist the urge to +customize everything immediately. + +**One thing at a time:** Master file navigation before diving into advanced code +features. Build your skills incrementally. + +**Practice daily:** Use Doom for real work, even if you're slower at first. +Muscle memory develops with practice. + +Welcome to Doom Emacs! 🚀 diff --git a/cheatsheets/emacs/emacs.magit.cheatsheet.es.md b/cheatsheets/emacs/emacs.magit.cheatsheet.es.md new file mode 100644 index 0000000..15e23e1 --- /dev/null +++ b/cheatsheets/emacs/emacs.magit.cheatsheet.es.md @@ -0,0 +1,276 @@ +[English](./emacs.magit.cheatsheet.md) | Español + +# Cheatsheet de Magit para Doom Emacs +## 🚀 **¿Qué es Magit?** + +Magit es una herramienta extremadamente poderosa para gestionar tu proyecto de Git. + +- Flujos de trabajo de Git visuales e interactivos +- Prepara para confirmación (stage) fragmentos (hunks), líneas o archivos completos con facilidad +- Confirma (commit), empuja (push), trae (pull), fusiona (merge), reorganiza (rebase) - todo desde menús intuitivos +- Ve el estado de tu repositorio de un vistazo + +## 📋 **Requisitos** + +- Git instalado en tu sistema +- Doom Emacs con Magit habilitado (incluido por defecto) +- Estar trabajando dentro de un repositorio de Git + +## ⌨️ **Abriendo Magit** + +### **Interfaz Principal de Magit:** + +- `SPC g g` - **Estado de Magit** (¡tu comando principal!) +- `SPC g d` - **Despacho de archivos de Magit** +- `SPC g f` - **Comandos de archivo de Magit** +- `SPC g l` - **Registro (log) de Magit** +- `SPC g b` - **Culpar (blame) de Magit** + +## 🎯 **El Búfer de Estado de Magit** (Tu Centro de Mando) + +### **Navegación:** + +- `j/k` o `n/p` - **Moverse arriba/abajo** entre secciones +- `TAB` - **Expandir/contraer** la sección bajo el cursor +- `M-TAB` - **Expandir/contraer** todas las secciones +- `g` - **Refrescar** el búfer de estado + +### **Resumen de Secciones:** + +``` +Archivos sin seguimiento - Archivos que no están en Git +Cambios sin preparar - Archivos modificados no preparados para confirmación +Cambios preparados - Archivos listos para confirmar +Confirmaciones recientes - Tu historial de confirmaciones +Aliijos (Stashes) - Tu trabajo en progreso guardado +``` + +## 📝 **Preparando y Despreparando (Staging & Unstaging)** + +### **Preparar Archivos:** + +- `s` - **Preparar** archivo/fragmento bajo el cursor +- `S` - **Preparar todos** los cambios sin preparar +- `i` - **Ignorar** archivo (añadir a .gitignore) + +### **Despreparar Archivos:** + +- `u` - **Despreparar** archivo/fragmento bajo el cursor +- `U` - **Despreparar todos** los cambios preparados + +### **Descartar Cambios:** + +- `k` - **Descartar** cambios en el archivo/fragmento bajo el cursor +- `K` - **Descartar todos** los cambios en el directorio de trabajo + +### **Preparando Fragmentos y Líneas:** + +- `RET` o `SPC` - **Mostrar diferencias (diff)** del archivo bajo el cursor +- En la vista de diferencias: + - `s` - **Preparar fragmento** bajo el cursor + - `u` - **Despreparar fragmento** bajo el cursor + - `k` - **Descartar fragmento** bajo el cursor + - `+/-` - **Mostrar más/menos** líneas de contexto + +## 💾 **Confirmando (Committing)** + +### **Crear Confirmaciones:** + +- `c c` - **Confirmar** (abre el búfer de mensaje de confirmación) +- `c a` - **Enmendar** la última confirmación +- `c e` - **Extender** la última confirmación (sin cambio de mensaje) +- `c w` - **Reescribir** el mensaje de la última confirmación +- `c f` - **Arreglar (fixup)** una confirmación +- `c s` - **Aplastar (squash)** una confirmación + +### **En el Búfer de Mensaje de Confirmación:** + +- `C-c C-c` - **Finalizar confirmación** +- `C-c C-k` - **Cancelar confirmación** +- `M-p/M-n` - **Mensaje de confirmación anterior/siguiente** del historial + +## 🌿 **Ramas y Cambio (Branching & Switching)** + +### **Operaciones con Ramas:** + +- `b b` - **Cambiar de rama** (checkout) +- `b c` - **Crear nueva rama** +- `b n` - **Crear rama** desde el HEAD actual +- `b s` - **Crear rama** y cambiar a ella +- `b r` - **Renombrar rama** +- `b k` - **Eliminar rama** + +### **Ramas Remotas:** + +- `b a` - **Establecer rama de seguimiento (upstream)** para la rama actual +- `b u` - **Establecer rama de seguimiento** y empujar + +## 🔄 **Operaciones Remotas** + +### **Traer y Actualizar (Fetch & Pull):** + +- `f f` - **Traer** desde el remoto predeterminado +- `f a` - **Traer desde todos** los remotos +- `F F` - **Actualizar** desde la rama de seguimiento +- `F u` - **Actualizar desde la rama de seguimiento** (rebase) + +### **Empujar (Push):** + +- `P P` - **Empujar** a la rama de seguimiento +- `P u` - **Empujar y establecer rama de seguimiento** +- `P f` - **Forzar empuje** (¡úsalo con cuidado!) +- `P t` - **Empujar etiquetas** + +## 📚 **Viendo Historial y Registros** + +### **Vistas de Registro:** + +- `l l` - **Mostrar registro** para la rama actual +- `l o` - **Mostrar registro** para otras ramas +- `l h` - **Mostrar registro** para HEAD +- `l a` - **Mostrar registro** para todas las ramas +- `l f` - **Mostrar registro** para el archivo bajo el cursor + +### **En la Vista de Registro:** + +- `RET` - **Mostrar detalles** de la confirmación +- `d d` - **Mostrar diferencias** para la confirmación +- `c c` - **Crear nueva confirmación** +- `r r` - **Revertir confirmación** + +## 🔍 **Diferencias y Comparaciones** + +### **Comandos de Diferencias:** + +- `d d` - **Diferencias del directorio de trabajo** vs preparado +- `d s` - **Diferencias de lo preparado** vs HEAD +- `d u` - **Diferencias de los cambios sin preparar** +- `d r` - **Diferencias de un rango** entre confirmaciones + +### **En las Vistas de Diferencias:** + +- `j/k` - **Navegar** entre fragmentos +- `n/p` - **Archivo siguiente/anterior** +- `TAB` - **Alternar** visibilidad de la sección de diferencias +- `+/-` - **Aumentar/disminuir** líneas de contexto + +## 🔧 **Reorganizando y Fusionando (Rebasing & Merging)** + +### **Fusionar:** + +- `m m` - **Fusionar** rama +- `m a` - **Abortar fusión** +- `m c` - **Continuar fusión** + +### **Reorganizar:** + +- `r i` - **Reorganización interactiva** +- `r r` - **Reorganizar** rama +- `r a` - **Abortar reorganización** +- `r c` - **Continuar reorganización** + +### **Durante la Reorganización Interactiva:** + +- `j/k` - **Moverse** entre confirmaciones +- `p` - **Elegir (pick)** confirmación (predeterminado) +- `r` - **Reescribir (reword)** mensaje de confirmación +- `e` - **Editar (edit)** confirmación +- `s` - **Aplastar (squash)** confirmación +- `f` - **Arreglar (fixup)** confirmación +- `d` - **Descartar (drop)** confirmación + +## 📦 **Aliijos (Stashing)** + +### **Operaciones con Aliijos:** + +- `z z` - **Alijar** los cambios actuales +- `z i` - **Alijar** con mensaje +- `z a` - **Aplicar alijo** +- `z p` - **Sacar alijo** (aplicar y eliminar) +- `z k` - **Descartar alijo** +- `z l` - **Listar alijos** + +## 🏷️ **Etiquetas (Tags)** + +### **Operaciones con Etiquetas:** + +- `t t` - **Crear etiqueta** +- `t a` - **Crear etiqueta anotada** +- `t k` - **Eliminar etiqueta** +- `t p` - **Empujar etiqueta** + +## ⚡ **Consejos Profesionales y Flujos de Trabajo** + +### **Flujo de Trabajo Diario de Git:** + +1. `SPC g g` - **Abrir estado de Magit** +2. Revisar cambios, preparar con `s` +3. `c c` - **Confirmar cambios** +4. `P P` - **Empujar al remoto** + +### **Trucos de Usuario Avanzado:** + +- Usa `M-x magit-find-file` para abrir rápidamente archivos del historial de Git +- `SPC g f s` - **Preparar archivo actual** sin abrir Magit +- `SPC g f u` - **Despreparar archivo actual** +- `SPC g f d` - **Mostrar diferencias del archivo** + +### **Granularidad de la Preparación:** + +- Prepara archivos completos con `s` en el búfer de estado +- Prepara fragmentos individuales entrando en la vista de diferencias (`RET`) y luego `s` +- Prepara líneas individuales seleccionando una región en la diferencia y luego `s` + +### **Buenas Prácticas de Confirmación:** + +- Usa `c c` para confirmaciones normales +- Usa `c a` para arreglar tu última confirmación +- Usa `c f` para crear confirmaciones de arreglo para una reorganización interactiva posterior + +## 🔧 **Solución de Problemas** + +### **Problemas Comunes:** + +- **¿Magit no se abre?** Asegúrate de estar en un repositorio de Git +- **¿Rendimiento lento?** Prueba `M-x magit-refresh` o reinicia Emacs +- **¿Conflictos de fusión?** Magit resalta los conflictos - resuélvelos y usa `m c` + +### **Obteniendo Ayuda:** + +- `?` - **Mostrar ayuda** en cualquier búfer de Magit +- `C-h m` - **Mostrar ayuda del modo** +- `SPC h d m magit` - **Documentación completa de Magit** + +## 🚀 **Flujo de Trabajo de Inicio Rápido** + +1. **Navega a tu repositorio de Git** en Doom Emacs +2. **Presiona `SPC g g`** - Abre el estado de Magit +3. **Prepara archivos** con `s`, revisa las diferencias con `RET` +4. **Confirma** con `c c`, escribe el mensaje, finaliza con `C-c C-c` +5. **Empuja** con `P P` + +## 📚 **Resumen de Atajos Esenciales** + +| Acción | Tecla | Descripción | +| --------- | --------- | -------------------- | +| Estado | `SPC g g` | Abrir estado de Magit| +| Preparar | `s` | Preparar archivo/fragmento | +| Despreparar| `u` | Despreparar archivo/fragmento | +| Confirmar | `c c` | Crear confirmación | +| Empujar | `P P` | Empujar a la rama de seguimiento | +| Actualizar| `F F` | Actualizar desde la rama de seguimiento | +| Rama | `b b` | Cambiar de rama | +| Registro | `l l` | Mostrar registro | +| Diferencias| `d d` | Mostrar diferencias | +| Alijar | `z z` | Alijar cambios | +| Ayuda | `?` | Mostrar ayuda contextual | + +## 🎉 **Por Qué Magit es Increíble** + +- **Visual**: Ve todo el estado de tu repositorio de un vistazo +- **Interactivo**: Prepara fragmentos, líneas o archivos con simples pulsaciones de teclas +- **Rápido**: Navega por las operaciones de Git más rápido que cualquier CLI +- **Potente**: Accede a todas las funciones de Git a través de menús intuitivos +- **Integrado**: Funciona perfectamente con Doom Emacs y el modo Evil + +**Consejo Profesional**: Una vez que aprendas Magit, ¡nunca más querrás usar Git desde la línea de comandos! 🚀 diff --git a/cheatsheets/emacs/emacs.magit.cheatsheet.md b/cheatsheets/emacs/emacs.magit.cheatsheet.md new file mode 100644 index 0000000..96d2a2f --- /dev/null +++ b/cheatsheets/emacs/emacs.magit.cheatsheet.md @@ -0,0 +1,277 @@ +English | [Español](./emacs.magit.cheatsheet.es.md) + +# Doom Emacs Magit Cheatsheet +## 🚀 **What is Magit?** + +Magit is an extremely powerful tool for managing your Git project + +- Visual, interactive Git workflows +- Stage hunks, lines, or entire files with ease +- Commit, push, pull, merge, rebase - all from intuitive menus +- See your repo status at a glance + +## 📋 **Requirements** + +- Git installed on your system +- Doom Emacs with Magit enabled (included by default) +- Working inside a Git repository + +## ⌨️ **Opening Magit** + +### **Main Magit Interface:** + +- `SPC g g` - **Magit status** (your main command!) +- `SPC g d` - **Magit file dispatch** +- `SPC g f` - **Magit file commands** +- `SPC g l` - **Magit log** +- `SPC g b` - **Magit blame** + +## 🎯 **The Magit Status Buffer** (Your Command Center) + +### **Navigation:** + +- `j/k` or `n/p` - **Move up/down** between sections +- `TAB` - **Expand/collapse** section under cursor +- `M-TAB` - **Expand/collapse** all sections +- `g` - **Refresh** status buffer + +### **Section Overview:** + +``` +Untracked files - Files not in Git +Unstaged changes - Modified files not staged +Staged changes - Files ready to commit +Recent commits - Your commit history +Stashes - Your saved work-in-progress +``` + +## 📝 **Staging & Unstaging** + +### **Stage Files:** + +- `s` - **Stage** file/hunk under cursor +- `S` - **Stage all** unstaged changes +- `i` - **Ignore** file (add to .gitignore) + +### **Unstage Files:** + +- `u` - **Unstage** file/hunk under cursor +- `U` - **Unstage all** staged changes + +### **Discard Changes:** + +- `k` - **Discard** changes in file/hunk under cursor +- `K` - **Discard all** changes in working directory + +### **Staging Hunks & Lines:** + +- `RET` or `SPC` - **Show diff** of file under cursor +- In diff view: + - `s` - **Stage hunk** under cursor + - `u` - **Unstage hunk** under cursor + - `k` - **Discard hunk** under cursor + - `+/-` - **Show more/less context** lines + +## 💾 **Committing** + +### **Create Commits:** + +- `c c` - **Commit** (opens commit message buffer) +- `c a` - **Amend** last commit +- `c e` - **Extend** last commit (no message change) +- `c w` - **Reword** last commit message +- `c f` - **Fixup** commit +- `c s` - **Squash** commit + +### **In Commit Message Buffer:** + +- `C-c C-c` - **Finish commit** +- `C-c C-k` - **Cancel commit** +- `M-p/M-n` - **Previous/next** commit message from history + +## 🌿 **Branching & Switching** + +### **Branch Operations:** + +- `b b` - **Switch branch** (checkout) +- `b c` - **Create new branch** +- `b n` - **Create branch** from current HEAD +- `b s` - **Create branch** and switch to it +- `b r` - **Rename branch** +- `b k` - **Delete branch** + +### **Remote Branches:** + +- `b a` - **Set upstream** for current branch +- `b u` - **Set upstream** and push + +## 🔄 **Remote Operations** + +### **Fetch & Pull:** + +- `f f` - **Fetch** from default remote +- `f a` - **Fetch from all** remotes +- `F F` - **Pull** from upstream +- `F u` - **Pull from upstream** (rebase) + +### **Push:** + +- `P P` - **Push** to upstream +- `P u` - **Push and set upstream** +- `P f` - **Force push** (use carefully!) +- `P t` - **Push tags** + +## 📚 **Viewing History & Logs** + +### **Log Views:** + +- `l l` - **Show log** for current branch +- `l o` - **Show log** for other branches +- `l h` - **Show log** for HEAD +- `l a` - **Show log** for all branches +- `l f` - **Show log** for file under cursor + +### **In Log View:** + +- `RET` - **Show commit** details +- `d d` - **Show diff** for commit +- `c c` - **Create new commit** +- `r r` - **Revert commit** + +## 🔍 **Diffs & Comparisons** + +### **Diff Commands:** + +- `d d` - **Diff working directory** vs staged +- `d s` - **Diff staged** vs HEAD +- `d u` - **Diff unstaged** changes +- `d r` - **Diff range** between commits + +### **In Diff Views:** + +- `j/k` - **Navigate** between hunks +- `n/p` - **Next/previous** file +- `TAB` - **Toggle** visibility of diff section +- `+/-` - **Increase/decrease** context lines + +## 🔧 **Rebasing & Merging** + +### **Merge:** + +- `m m` - **Merge** branch +- `m a` - **Abort merge** +- `m c` - **Continue merge** + +### **Rebase:** + +- `r i` - **Interactive rebase** +- `r r` - **Rebase** branch +- `r a` - **Abort rebase** +- `r c` - **Continue rebase** + +### **During Interactive Rebase:** + +- `j/k` - **Move** between commits +- `p` - **Pick** commit (default) +- `r` - **Reword** commit message +- `e` - **Edit** commit +- `s` - **Squash** commit +- `f` - **Fixup** commit +- `d` - **Drop** commit + +## 📦 **Stashing** + +### **Stash Operations:** + +- `z z` - **Stash** current changes +- `z i` - **Stash** with message +- `z a` - **Apply stash** +- `z p` - **Pop stash** (apply and delete) +- `z k` - **Drop stash** +- `z l` - **List stashes** + +## 🏷️ **Tags** + +### **Tag Operations:** + +- `t t` - **Create tag** +- `t a` - **Create annotated tag** +- `t k` - **Delete tag** +- `t p` - **Push tag** + +## ⚡ **Pro Tips & Workflows** + +### **Daily Git Workflow:** + +1. `SPC g g` - **Open Magit status** +2. Review changes, stage with `s` +3. `c c` - **Commit changes** +4. `P P` - **Push to remote** + +### **Power User Tricks:** + +- Use `M-x magit-find-file` to quickly open files from Git history +- `SPC g f s` - **Stage current file** without opening Magit +- `SPC g f u` - **Unstage current file** +- `SPC g f d` - **Show file diff** + +### **Staging Granularity:** + +- Stage entire files with `s` in status buffer +- Stage individual hunks by entering diff view (`RET`) then `s` +- Stage individual lines by selecting region in diff then `s` + +### **Commit Best Practices:** + +- Use `c c` for normal commits +- Use `c a` to fix up your last commit +- Use `c f` to create fixup commits for interactive rebase later + +## 🔧 **Troubleshooting** + +### **Common Issues:** + +- **Magit won't open?** Make sure you're in a Git repository +- **Performance slow?** Try `M-x magit-refresh` or restart Emacs +- **Merge conflicts?** Magit highlights conflicts - resolve them and use `m c` + +### **Getting Help:** + +- `?` - **Show help** in any Magit buffer +- `C-h m` - **Show mode help** +- `SPC h d m magit` - **Full Magit documentation** + +## 🚀 **Quick Start Workflow** + +1. **Navigate to your Git repo** in Doom Emacs +2. **Press `SPC g g`** - Opens Magit status +3. **Stage files** with `s`, review diffs with `RET` +4. **Commit** with `c c`, write message, finish with `C-c C-c` +5. **Push** with `P P` + +## 📚 **Essential Keybind Summary** + +| Action | Key | Description | +| ------- | --------- | ------------------ | +| Status | `SPC g g` | Open Magit status | +| Stage | `s` | Stage file/hunk | +| Unstage | `u` | Unstage file/hunk | +| Commit | `c c` | Create commit | +| Push | `P P` | Push to upstream | +| Pull | `F F` | Pull from upstream | +| Branch | `b b` | Switch branch | +| Log | `l l` | Show log | +| Diff | `d d` | Show diff | +| Stash | `z z` | Stash changes | +| Help | `?` | Show context help | + +## 🎉 **Why Magit is Amazing** + +- **Visual**: See your entire repo state at a glance +- **Interactive**: Stage hunks, lines, or files with simple keystrokes +- **Fast**: Navigate Git operations faster than any CLI +- **Powerful**: Access every Git feature through intuitive menus +- **Integrated**: Works seamlessly with Doom Emacs and Evil mode + +**Pro Tip**: Once you learn Magit, you'll never want to use Git from the command +line again! 🚀 diff --git a/cheatsheets/emacs/emacs.markdown.cheatsheet.es.md b/cheatsheets/emacs/emacs.markdown.cheatsheet.es.md new file mode 100644 index 0000000..2e3c315 --- /dev/null +++ b/cheatsheets/emacs/emacs.markdown.cheatsheet.es.md @@ -0,0 +1,86 @@ +[English](./emacs.markdown.cheatsheet.md) | Español + +# Cheatsheet de Markdown para Doom Emacs +## 📝 **Primeros Pasos** +- Abre cualquier archivo `.md` - Doom habilita automáticamente `markdown-mode` +- Obtendrás resaltado de sintaxis, sangría adecuada y características específicas de markdown + +## ⌨️ **Comandos Clave de Markdown** (con atajos de Evil/Vim) + +### **Formato de Texto:** +- `SPC m b` - Texto en **negrita** +- `SPC m i` - Texto en *cursiva* +- `SPC m c` - `Código en línea` +- `SPC m C` - Bloque de código +- `SPC m s` - ~~Tachado~~ + +### **Encabezados:** +- `SPC m h` - Insertar encabezado (solicita el nivel 1-6) +- `SPC m H` - Insertar encabezado con estilo de subrayado + +### **Listas:** +- `SPC m l` - Insertar elemento de lista no ordenada +- `SPC m L` - Insertar elemento de lista ordenada + +### **Enlaces e Imágenes:** +- `SPC m l l` - Insertar enlace +- `SPC m l i` - Insertar imagen +- `SPC m l u` - Insertar URL + +### **Navegación:** +- `]]` - Siguiente encabezado +- `[[` - Encabezado anterior +- `SPC m o` - Abrir esquema/tabla de contenidos + +## 👁️ **Vista Previa en Vivo** +- `SPC m p` - Vista previa en el navegador +- `SPC m P` - Exportar a HTML + +## 📊 **Tablas** +- `SPC m t` - Comandos de tabla +- `SPC m t t` - Insertar tabla +- `TAB` - Navegar entre celdas +- `S-TAB` - Navegar hacia atrás entre celdas + +## 🎯 **Atajos Útiles de Evil en Markdown** +- `TAB` - Ciclar el plegado de encabezados +- `S-TAB` - Ciclar el plegado globalmente +- `RET` - Seguir enlaces +- `M-RET` - Insertar nuevo elemento de lista + +## 🧪 **Ejemplos de Prueba** + +### Formato de Muestra +Este es **texto en negrita** y este es *texto en cursiva*. + +Aquí hay algo de `código en línea` y un bloque de código: + +```bash +# Ejemplo de bloque de código +echo "¡Hola desde markdown!" +``` + +### Lista de Muestra +- [ ] Elemento de casilla de verificación 1 +- [x] Casilla de verificación completada +- Punto de viñeta normal + +### Tabla de Muestra +| Característica | Atajo | Descripción | +|----------------|---------|--------------------------| +| Negrita | SPC m b | Poner texto en negrita | +| Cursiva | SPC m i | Poner texto en cursiva | +| Vista Previa | SPC m p | Vista previa en el navegador | + +## 🚀 **Consejos Profesionales** +1. Usa `SPC m o` para obtener una vista de esquema para la navegación +2. `TAB` en los encabezados para plegar/desplegar secciones +3. `RET` en los enlaces para seguirlos +4. Usa `SPC m p` para previsualizar tu markdown en un navegador +5. Crea listas de verificación con la sintaxis `- [ ]` + +## 📚 **Referencia Rápida** +- Todos los comandos de markdown comienzan con `SPC m` +- Usa `SPC m ?` o `C-h m` para ver todos los comandos disponibles +- Navegación entre encabezados: `]]` (siguiente) y `[[` (anterior) +- Alternar plegado: `TAB` (local) y `S-TAB` (global) diff --git a/cheatsheets/emacs/emacs.markdown.cheatsheet.md b/cheatsheets/emacs/emacs.markdown.cheatsheet.md new file mode 100644 index 0000000..43b8017 --- /dev/null +++ b/cheatsheets/emacs/emacs.markdown.cheatsheet.md @@ -0,0 +1,86 @@ +English | [Español](./emacs.markdown.cheatsheet.es.md) + +# Doom Emacs Markdown Cheatsheet +## 📝 **Getting Started** +- Open any `.md` file - Doom automatically enables `markdown-mode` +- You'll get syntax highlighting, proper indentation, and markdown-specific features + +## ⌨️ **Key Markdown Commands** (with Evil/Vim bindings) + +### **Formatting Text:** +- `SPC m b` - **Bold** text +- `SPC m i` - *Italic* text +- `SPC m c` - `Inline code` +- `SPC m C` - Code block +- `SPC m s` - ~~Strikethrough~~ + +### **Headers:** +- `SPC m h` - Insert header (prompts for level 1-6) +- `SPC m H` - Insert header with underline style + +### **Lists:** +- `SPC m l` - Insert unordered list item +- `SPC m L` - Insert ordered list item + +### **Links & Images:** +- `SPC m l l` - Insert link +- `SPC m l i` - Insert image +- `SPC m l u` - Insert URL + +### **Navigation:** +- `]]` - Next header +- `[[` - Previous header +- `SPC m o` - Open outline/table of contents + +## 👁️ **Live Preview** +- `SPC m p` - Preview in browser +- `SPC m P` - Export to HTML + +## 📊 **Tables** +- `SPC m t` - Table commands +- `SPC m t t` - Insert table +- `TAB` - Navigate between cells +- `S-TAB` - Navigate backward between cells + +## 🎯 **Useful Evil Bindings in Markdown** +- `TAB` - Cycle folding of headers +- `S-TAB` - Cycle folding globally +- `RET` - Follow links +- `M-RET` - Insert new list item + +## 🧪 **Test Examples** + +### Sample Formatting +This is **bold text** and this is *italic text*. + +Here's some `inline code` and a code block: + +```bash +# Code block example +echo "Hello from markdown!" +``` + +### Sample List +- [ ] Checkbox item 1 +- [x] Completed checkbox +- Regular bullet point + +### Sample Table +| Feature | Shortcut | Description | +|---------|----------|-------------| +| Bold | SPC m b | Make text bold | +| Italic | SPC m i | Make text italic | +| Preview | SPC m p | Preview in browser | + +## 🚀 **Pro Tips** +1. Use `SPC m o` to get an outline view for navigation +2. `TAB` on headers to fold/unfold sections +3. `RET` on links to follow them +4. Use `SPC m p` to preview your markdown in a browser +5. Create checklists with `- [ ]` syntax + +## 📚 **Quick Reference** +- All markdown commands start with `SPC m` +- Use `SPC m ?` or `C-h m` to see all available commands +- Navigation between headers: `]]` (next) and `[[` (previous) +- Toggle folding: `TAB` (local) and `S-TAB` (global) diff --git a/cheatsheets/emacs/emacs.nix.cheatsheet.es.md b/cheatsheets/emacs/emacs.nix.cheatsheet.es.md new file mode 100644 index 0000000..f92b0cc --- /dev/null +++ b/cheatsheets/emacs/emacs.nix.cheatsheet.es.md @@ -0,0 +1,45 @@ +Español | [English](./emacs.nix.cheatsheet.md) + +# Guía Rápida: Doom Emacs + Nix + +Esta guía enumera los comandos de Nix y los atajos configurados en tu Doom Emacs. + +## Requisitos +- Módulo de Doom habilitado: `(nix +tree-sitter +lsp)` en `~/.doom.d/init.el` +- Paquetes instalados (en `~/.doom.d/packages.el`): `nix`, `nix-update`, `nixos-options` +- Herramientas Nix disponibles en el sistema: `nix`, `nixfmt` (o tu formateador preferido) +- Opcional pero recomendado: `nil` (LSP de Nix) + +## Convenciones de teclas (Leader) +- `SPC` = tecla líder de Doom +- `SPC m` = menú del modo mayor (contextual al buffer actual, p. ej., buffers Nix) + +## Atajos para Nix +- `SPC m f` → `nix-format-buffer` — Formatea el buffer Nix actual (usa `nixfmt` por defecto) +- `SPC m b` → `nix-build` — Construye la derivación/expresión actual +- `SPC m s` → `nix-shell` — Abre un `nix-shell` +- `SPC m u` → `nix-unpack` — Desempaqueta una fuente de Nix +- `SPC m r` → `nix-repl-show` — Muestra información de símbolo en el REPL de Nix +- `SPC m U` → `nix-update-fetch` — Actualiza fetchers/hashes en expresiones Nix +- `SPC m o` → `+nix/lookup-option` — Busca una opción de NixOS (requiere `:tools lookup` y `nixos-options`) + +## Referencia de comandos +- `nix-format-buffer`: Formatea el buffer usando `nixfmt`. + - Configuración: `(setq nix-nixfmt-bin "nixfmt")`. + - Consejo: ¿Prefieres otro formateador? Instálalo y ajusta `nix-nixfmt-bin` (p. ej., `"alejandra"` o `"nixpkgs-fmt"`). +- `nix-build`: Inicia una construcción para el archivo/contexto actual. +- `nix-shell`: Abre un shell de desarrollo derivado de la expresión Nix actual. +- `nix-unpack`: Desempaqueta la fuente de una derivación (útil para inspeccionar fuentes). +- `nix-repl-show`: Muestra información de símbolo desde una sesión del REPL de Nix. +- `nix-update-fetch`: Actualiza atributos de fetcher (rev, sha256, etc.). +- `+nix/lookup-option`: Salta a la documentación de una opción de NixOS usando la integración con `nixos-options`. + +## Consejos +- Asegúrate de estar editando un archivo `.nix` para que `SPC m` (modo mayor) esté disponible. +- Para funciones LSP (documentación, autocompletado, diagnósticos), verifica que el servidor `nil` esté instalado y activo. + +## Solución de problemas +- ¿Comandos no disponibles en Emacs? Ejecuta `~/.emacs.d/bin/doom sync` y reinicia Emacs. +- ¿El formateador no funciona? Verifica que `nixfmt` (u otro) esté en tu PATH y que `nix-nixfmt-bin` coincida con su nombre. +- ¿La búsqueda de opciones no funciona? Asegúrate de tener `nixos-options` instalado y que `:tools lookup` esté habilitado en Doom. + diff --git a/cheatsheets/emacs/emacs.nix.cheatsheet.md b/cheatsheets/emacs/emacs.nix.cheatsheet.md new file mode 100644 index 0000000..fa59dce --- /dev/null +++ b/cheatsheets/emacs/emacs.nix.cheatsheet.md @@ -0,0 +1,45 @@ +English | [Español](./emacs.nix.cheatsheet.es.md) + +# Doom Emacs + Nix Cheatsheet + +This guide lists the Nix commands and keybindings configured in your Doom Emacs. + +## Requirements +- Doom module enabled: `(nix +tree-sitter +lsp)` in `~/.doom.d/init.el` +- Packages installed (via `~/.doom.d/packages.el`): `nix`, `nix-update`, `nixos-options` +- Nix tooling available on system: `nix`, `nixfmt` (or your preferred formatter) +- Optional but recommended: `nil` (Nix LSP) + +## Leader key conventions +- `SPC` = Doom leader +- `SPC m` = Major mode menu (contextual to current buffer, e.g., Nix buffers) + +## Nix keybindings +- `SPC m f` → `nix-format-buffer` — Format current Nix buffer (uses `nixfmt` by default) +- `SPC m b` → `nix-build` — Build the current derivation / expression +- `SPC m s` → `nix-shell` — Open a `nix-shell` +- `SPC m u` → `nix-unpack` — Unpack a Nix source +- `SPC m r` → `nix-repl-show` — Show symbol info in Nix REPL +- `SPC m U` → `nix-update-fetch` — Update fetchers/hashes in Nix expressions +- `SPC m o` → `+nix/lookup-option` — Lookup NixOS option (requires `:tools lookup` and `nixos-options`) + +## Command reference +- `nix-format-buffer`: Formats the current buffer using `nixfmt`. + - Configured via `(setq nix-nixfmt-bin "nixfmt")`. + - Tip: Prefer a different formatter? Install it and set `nix-nixfmt-bin` accordingly (e.g., `"alejandra"` or `"nixpkgs-fmt"`). +- `nix-build`: Triggers a build for the current file/context. +- `nix-shell`: Opens a development shell derived from the current Nix expression. +- `nix-unpack`: Unpacks the source for a derivation (useful to inspect sources). +- `nix-repl-show`: Displays symbol info from a Nix REPL session. +- `nix-update-fetch`: Updates fetcher attributes (rev, sha256, etc.). +- `+nix/lookup-option`: Jumps to documentation for a NixOS option using `nixos-options` integration. + +## Tips +- Ensure you are editing a `.nix` file so the `SPC m` (major mode) bindings are available. +- For LSP features (hover docs, completion, diagnostics), make sure the `nil` language server is installed and running. + +## Troubleshooting +- Commands not found in Emacs? Run `~/.emacs.d/bin/doom sync`, then restart Emacs. +- Formatter not working? Verify `nixfmt` (or chosen formatter) is on your PATH and `nix-nixfmt-bin` matches its name. +- Option lookup not working? Ensure `nixos-options` is installed and Doom’s `:tools lookup` is enabled. + diff --git a/cheatsheets/ghostty/ghostty.cheatsheet.es.md b/cheatsheets/ghostty/ghostty.cheatsheet.es.md new file mode 100644 index 0000000..01e8cd9 --- /dev/null +++ b/cheatsheets/ghostty/ghostty.cheatsheet.es.md @@ -0,0 +1,123 @@ +[English](./ghostty.cheatsheet.md) | Español + +# Ghostty en ZaneyOS — Resumen y Cheatsheet +## 🚀 Resumen de modules/home/terminals/ghostty.nix + +- Programa + - Ghostty habilitado con el paquete de Nix: pkgs.ghostty + - Integraciones de shell: Fish, Zsh, Bash + - clearDefaultKeybinds = true (todos los atajos se definen explícitamente a continuación) + +- Apariencia + - Título: ZaneyOS-GhosTTY + - TERM: xterm-256color + - Tema: oscuro: catppuccin-mocha; claro: catppuccin-mocha + - Tema de la ventana: oscuro + - Fuente: Maple Mono NF, tamaño 12 + - Ajuste de altura de celda: +10% + - Opacidad del fondo: 1.00 (opaco) + - Radio de desenfoque del fondo: 60 + - Estilo del cursor: barra + - Colores de selección: fondo #2d3f76, frente #c8d3f5 + - Opacidad de división sin foco: 0.5 + - Posición de terminal rápida: centro + +- Ventana y Comportamiento + - Tamaño de ventana predeterminado: 110x32 (columnas x filas) + - Confirmar cierre de superficie: false + - Esperar después del comando: false + - Integración de shell: detectar; características: cursor, sudo + - Estado de guardado de ventana: siempre + - Instancia única de GTK: true + - Ratón: ocultar al escribir: true + +- Atajos de Teclado (esquema de prefijo Super/Alt) + - El acorde personalizado tipo líder usa Alt+s y luego la tecla, ej. alt+s>c + - Portapapeles estándar y tamaño de fuente con acordes Ctrl+Shift + - Pestañas, divisiones, navegación, zoom, ecualizar definidos a continuación + +--- + +## 🗝️ Cheatsheet de Atajos de Teclado + +Portapapeles +- Ctrl+Shift+C — copy_to_clipboard +- Ctrl+Shift+V — paste_from_clipboard + +Tamaño de fuente +- Ctrl+Shift+= (más) — increase_font_size:1 +- Ctrl+Shift+- (menos) — decrease_font_size:1 +- Ctrl+Shift+0 — reset_font_size + +Sesión +- Alt+s r — reload_config +- Alt+s x — close_surface +- Alt+s n — new_window + +Pestañas +- Alt+s c — new_tab +- Alt+s Shift+L — next_tab +- Alt+s Shift+H — previous_tab +- Alt+s , — move_tab:-1 +- Alt+s . — move_tab:+1 +- Alt+s 1..9 — goto_tab:N + +Divisiones +- Alt+s \ — new_split:right +- Alt+s - — new_split:down +- Alt+s j — goto_split:bottom +- Alt+s k — goto_split:top +- Alt+s h — goto_split:left +- Alt+s l — goto_split:right +- Alt+s z — toggle_split_zoom +- Alt+s e — equalize_splits + +Notas +- clearDefaultKeybinds = true significa que solo los anteriores están activos. +- La notación Alt+s> denota un acorde de dos teclas: mantén presionado Alt, presiona s, luego la siguiente tecla. + +--- + +## ⚙️ Referencia de Opciones Predeterminadas (según configuración) + +Terminal y ventana +- term: xterm-256color +- window-width: 110 +- window-height: 32 +- window-theme: dark +- window-save-state: always +- gtk-single-instance: true +- quick-terminal-position: center + +Apariencia +- theme: catppuccin-mocha (oscuro y claro mapeados a mocha) +- font-family: Maple Mono NF +- font-size: 12 +- adjust-cell-height: 10% +- background-opacity: 1.00 +- background-blur-radius: 60 +- selection-background: #2d3f76 +- selection-foreground: #c8d3f5 +- cursor-style: bar +- unfocused-split-opacity: 0.5 + +Comportamiento +- confirm-close-surface: false +- mouse-hide-while-typing: true +- wait-after-command: false +- shell-integration: detect +- shell-integration-features: cursor,sudo + +Integraciones +- Integraciones de Fish, Zsh, Bash habilitadas + +--- + +## 📝 Notas de Estilo/Formato + +Este cheatsheet refleja el estilo de tus cheatsheets de Emacs: +- Encabezados de sección claros con emoji +- Listas con viñetas con descripciones concisas +- Bloques cortos de "Notas" para comportamientos especiales + +Si lo deseas, puedo enlazar esto desde un índice central o agregar más consejos de Ghostty (temas, indicadores de rendimiento, solución de problemas). diff --git a/cheatsheets/ghostty/ghostty.cheatsheet.md b/cheatsheets/ghostty/ghostty.cheatsheet.md new file mode 100644 index 0000000..ad1634b --- /dev/null +++ b/cheatsheets/ghostty/ghostty.cheatsheet.md @@ -0,0 +1,123 @@ +English | [Español](./ghostty.cheatsheet.es.md) + +# Ghostty on ZaneyOS — Summary & Cheatsheet +## 🚀 Summary of modules/home/terminals/ghostty.nix + +- Program + - Ghostty enabled with Nix package: pkgs.ghostty + - Shell integrations: Fish, Zsh, Bash + - clearDefaultKeybinds = true (all bindings are explicitly defined below) + +- Appearance + - Title: ZaneyOS-GhosTTY + - TERM: xterm-256color + - Theme: dark: catppuccin-mocha; light: catppuccin-mocha + - Window theme: dark + - Font: Maple Mono NF, size 12 + - Cell height adjustment: +10% + - Background opacity: 1.00 (opaque) + - Background blur radius: 60 + - Cursor style: bar + - Selection colors: bg #2d3f76, fg #c8d3f5 + - Unfocused split opacity: 0.5 + - Quick terminal position: center + +- Window and Behavior + - Default window size: 110x32 (cols x rows) + - Confirm close surface: false + - Wait after command: false + - Shell integration: detect; features: cursor, sudo + - Window save state: always + - GTK single instance: true + - Mouse: hide while typing: true + +- Keybindings (Super/Alt prefix scheme) + - Custom leader-like chord uses Alt+s then key, e.g. alt+s>c + - Standard clipboard and font size with Ctrl+Shift chords + - Tabs, splits, navigation, zoom, equalize defined below + +--- + +## 🗝️ Keybindings Cheatsheet + +Clipboard +- Ctrl+Shift+C — copy_to_clipboard +- Ctrl+Shift+V — paste_from_clipboard + +Font size +- Ctrl+Shift+= (plus) — increase_font_size:1 +- Ctrl+Shift+- (minus) — decrease_font_size:1 +- Ctrl+Shift+0 — reset_font_size + +Session +- Alt+s r — reload_config +- Alt+s x — close_surface +- Alt+s n — new_window + +Tabs +- Alt+s c — new_tab +- Alt+s Shift+L — next_tab +- Alt+s Shift+H — previous_tab +- Alt+s , — move_tab:-1 +- Alt+s . — move_tab:+1 +- Alt+s 1..9 — goto_tab:N + +Splits +- Alt+s \ — new_split:right +- Alt+s - — new_split:down +- Alt+s j — goto_split:bottom +- Alt+s k — goto_split:top +- Alt+s h — goto_split:left +- Alt+s l — goto_split:right +- Alt+s z — toggle_split_zoom +- Alt+s e — equalize_splits + +Notes +- clearDefaultKeybinds = true means only the above are active. +- The Alt+s> notation denotes a two-key chord: hold Alt, press s, then the next key. + +--- + +## ⚙️ Default Options Reference (as configured) + +Terminal and window +- term: xterm-256color +- window-width: 110 +- window-height: 32 +- window-theme: dark +- window-save-state: always +- gtk-single-instance: true +- quick-terminal-position: center + +Appearance +- theme: catppuccin-mocha (dark and light mapped to mocha) +- font-family: Maple Mono NF +- font-size: 12 +- adjust-cell-height: 10% +- background-opacity: 1.00 +- background-blur-radius: 60 +- selection-background: #2d3f76 +- selection-foreground: #c8d3f5 +- cursor-style: bar +- unfocused-split-opacity: 0.5 + +Behavior +- confirm-close-surface: false +- mouse-hide-while-typing: true +- wait-after-command: false +- shell-integration: detect +- shell-integration-features: cursor,sudo + +Integrations +- Fish, Zsh, Bash integrations enabled + +--- + +## 📝 Style/Formatting Notes + +This cheatsheet mirrors your Emacs cheatsheets style: +- Clear section headers with emoji +- Bulleted lists with concise descriptions +- Short “Notes” blocks for special behaviors + +If you’d like, I can link this from a central index or add more Ghostty tips (themes, performance flags, troubleshooting). diff --git a/cheatsheets/hyprland-customization-guide.es.md b/cheatsheets/hyprland-customization-guide.es.md new file mode 100644 index 0000000..74c7605 --- /dev/null +++ b/cheatsheets/hyprland-customization-guide.es.md @@ -0,0 +1,164 @@ +# Guía de Personalización de Hyprland en ZaneyOS + +Esta guía ofrece una visión práctica para personalizar tu experiencia con Hyprland en ZaneyOS. Veremos los archivos más relevantes, qué hacen y pequeños cambios seguros que puedes aplicar. + +Nota: Estos archivos están escritos en Nix. Un pequeño error de sintaxis puede romper las compilaciones. Realiza un cambio a la vez y mantén tus ediciones bajo control de versiones. + +## Aplicar tus cambios + +Preferido (específico de ZaneyOS): +- `zcli rebuild` + - Nota: el alias `fr` está obsoleto. + +Método manual de respaldo (funciona en cualquier instalación): +- Desde la raíz del repo, reemplaza PROFILE por tu perfil (intel, nvidia, nvidia-laptop, amd-hybrid, vm): + - `sudo nixos-rebuild switch --flake .#PROFILE` + +--- + +### `binds.nix` — Atajos de teclado + +Controla atajos de teclado y ratón. + +Ubicación: `modules/home/hyprland/binds.nix` + +Formato: `MODIFICADOR, TECLA, DISPATCHER, VALOR` + +Ejemplo: Cambiar la terminal de Super+Return a Super+T + +```nix +# ... + bind = [ + # ... + "$modifier,T,exec, ${terminal}" + # ... + ]; +# ... +``` + +--- + +### `exec-once.nix` — Aplicaciones al iniciar + +Comandos que se ejecutan automáticamente con Hyprland. + +Ubicación: `modules/home/hyprland/exec-once.nix` + +Ejemplo: Añadir copyq al inicio + +```nix +# ... + exec-once = [ + # ... + "pypr &" + "copyq" + ]; +# ... +``` + +--- + +### `decoration.nix` — Bordes, sombras, desenfoque + +Ubicación: `modules/home/hyprland/decoration.nix` + +Ejemplo: Esquinas redondeadas + +```nix +# ... + decoration = { + rounding = 10; + }; +# ... +``` + +--- + +### `env.nix` — Variables de entorno + +Ubicación: `modules/home/hyprland/env.nix` + +Ejemplo: Habilitar Wayland para Firefox + +```nix +# ... + env = [ + "SDL_VIDEODRIVER, wayland" + "MOZ_ENABLE_WAYLAND, 1" + ]; +# ... +``` + +--- + +### `gestures.nix` — Gestos del touchpad + +Ubicación: `modules/home/hyprland/gestures.nix` + +Ejemplo: Desactivar deslizamiento entre espacios + +```nix +# ... + gestures = { + workspace_swipe = 0; + }; +# ... +``` + +--- + +### `misc.nix` — Ajustes varios + +Ubicación: `modules/home/hyprland/misc.nix` + +Ejemplo: Activar Frecuencia de Actualización Variable (VRR) + +```nix +# ... + misc = { + vrr = 1; + }; +# ... +``` + +--- + +### `hyprland.nix` — Configuración principal + +Ubicación: `modules/home/hyprland/hyprland.nix` + +Ejemplo: Distribución del teclado + +```nix +# ... + input = { + kb_layout = "us"; + }; +# ... +``` + +--- + +### `windowrules.nix` — Reglas de ventanas + +Ubicación: `modules/home/hyprland/windowrules.nix` + +Ejemplo: Hacer que Thunar flote siempre + +```nix +# ... + windowrule = [ + "float, class:^(foot-floating)$" + "float, class:^(Thunar)$" + ]; +# ... +``` + +--- + +## Consejos útiles + +- Realiza un cambio a la vez y recompila para validar. +- Mantén una terminal abierta mientras experimentas por si cambias el atajo del lanzador. +- Si algo se rompe, reinicia y elige una generación anterior en el menú de arranque. + diff --git a/cheatsheets/hyprland-customization-guide.md b/cheatsheets/hyprland-customization-guide.md new file mode 100644 index 0000000..481b8f9 --- /dev/null +++ b/cheatsheets/hyprland-customization-guide.md @@ -0,0 +1,164 @@ +# A Guide to Customizing Hyprland in ZaneyOS + +This guide provides a practical overview for customizing your Hyprland experience in ZaneyOS. We’ll cover the most relevant files, what they do, and small, safe edits you can make. + +Note: These files are written in Nix. A small syntax error can break builds. Make one change at a time and keep your edits under version control. + +## Applying your changes + +Preferred (ZaneyOS-specific): +- `zcli rebuild` + - Note: The `fr` alias is deprecated. + +Manual backup method (works anywhere): +- From the repo root, replace PROFILE with your profile (intel, nvidia, nvidia-laptop, amd-hybrid, vm): + - `sudo nixos-rebuild switch --flake .#PROFILE` + +--- + +### `binds.nix` — Keybindings + +Controls keyboard and mouse shortcuts. + +Location: `modules/home/hyprland/binds.nix` + +Format: `MODIFIER, KEY, DISPATCHER, VALUE` + +Example: Change terminal from Super+Return to Super+T + +```nix +# ... + bind = [ + # ... + "$modifier,T,exec, ${terminal}" + # ... + ]; +# ... +``` + +--- + +### `exec-once.nix` — Startup applications + +Commands that start automatically with Hyprland. + +Location: `modules/home/hyprland/exec-once.nix` + +Example: Add copyq to autostart + +```nix +# ... + exec-once = [ + # ... + "pypr &" + "copyq" + ]; +# ... +``` + +--- + +### `decoration.nix` — Borders, shadows, blur + +Location: `modules/home/hyprland/decoration.nix` + +Example: Rounded corners + +```nix +# ... + decoration = { + rounding = 10; + }; +# ... +``` + +--- + +### `env.nix` — Environment variables + +Location: `modules/home/hyprland/env.nix` + +Example: Enable Wayland for Firefox + +```nix +# ... + env = [ + "SDL_VIDEODRIVER, wayland" + "MOZ_ENABLE_WAYLAND, 1" + ]; +# ... +``` + +--- + +### `gestures.nix` — Touchpad gestures + +Location: `modules/home/hyprland/gestures.nix` + +Example: Disable workspace swipe + +```nix +# ... + gestures = { + workspace_swipe = 0; + }; +# ... +``` + +--- + +### `misc.nix` — Misc settings + +Location: `modules/home/hyprland/misc.nix` + +Example: Enable Variable Refresh Rate + +```nix +# ... + misc = { + vrr = 1; + }; +# ... +``` + +--- + +### `hyprland.nix` — Main configuration + +Location: `modules/home/hyprland/hyprland.nix` + +Example: Keyboard layout + +```nix +# ... + input = { + kb_layout = "us"; + }; +# ... +``` + +--- + +### `windowrules.nix` — Window rules + +Location: `modules/home/hyprland/windowrules.nix` + +Example: Float Thunar always + +```nix +# ... + windowrule = [ + "float, class:^(foot-floating)$" + "float, class:^(Thunar)$" + ]; +# ... +``` + +--- + +## Helpful tips + +- Make one change at a time and rebuild to validate. +- Keep a terminal open during experiments in case your launcher keybind changes. +- If something breaks, reboot and choose a previous generation in the boot menu. + diff --git a/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.es.md b/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.es.md new file mode 100644 index 0000000..95b2bae --- /dev/null +++ b/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.es.md @@ -0,0 +1,213 @@ +# Cómo tematizar o añadir Waybars en ZaneyOS + +Esta guía muestra cómo ZaneyOS selecciona y configura Waybar, cómo añadir tu propio módulo de Waybar y cómo personalizar fuentes, tamaños, colores, iconos, widgets y layout. También indica dónde colocar scripts y una nota crítica sobre git add para evitar fallos de rebuild. + +## Módulos Waybar disponibles +Guardados en modules/home/waybar/: +- waybar-tony.nix +- waybar-ddubs.nix +- waybar-ddubsos-v1.nix +- waybar-dwm.nix +- waybar-curved.nix +- waybar-simple.nix +- waybar-ddubs-2.nix +- waybar-mecha.nix +- waybar-dwm2.nix +- waybar-nekodyke.nix +- Jerry-waybar.nix + +## Dónde seleccionas tu Waybar +Selecciona el módulo en hosts/default/variables.nix vía waybarChoice. Ejemplo (extracto real): +```nix path=/home/dwilliams/ZaneyOS/hosts/default/variables.nix start=73 + # Set Waybar + # Includes alternates such as: + # Comment out the current choice and uncomment the one you want + #waybarChoice = ../../modules/home/waybar/waybar-curved.nix; + #waybarChoice = ../../modules/home/waybar/Jerry-waybars.nix; + #waybarChoice = ../../modules/home/waybar/waybar-simple.nix; + #waybarChoice = ../../modules/home/waybar/waybar-mecha.nix; + #waybarChoice = ../../modules/home/waybar/waybar-nekodyke.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; + waybarChoice = ../../modules/home/waybar/waybar-tony.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs-2.nix; +``` +Notas: +- Asegúrate de que la ruta coincide con un archivo real bajo modules/home/waybar/. Por ejemplo, la lista incluye Jerry-waybar.nix (singular) pero el comentario muestra Jerry-waybars.nix (plural). Usa el nombre correcto para evitar errores de build. + +## CRÍTICO: usa git add o fallará el rebuild +Cuando añadas un archivo Waybar o scripts que use, debes prepararlos con git antes de reconstruir, o Nix no verá esas rutas y fallará la build. +- Ejemplo: +```bash path=null start=null +# Añade tu módulo y scripts +git add modules/home/waybar/my-waybar.nix modules/home/waybar/scripts/my-widget.sh +# Commit (opcional pero recomendado) +git commit -m "Add my Waybar module and widget script" +``` + +## Cómo están estructurados los módulos Waybar aquí +- Exponen un módulo de Home Manager que define programs.waybar.settings (config estilo JSON) y programs.waybar.style (CSS). +- Copian scripts auxiliares a ~/.config/waybar/scripts desde un directorio compartido scripts. + +Ejemplo: waybar-tony.nix copia scripts y define config y CSS de Waybar: +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=15 + # Configure & Theme Waybar (Tony) + home.file = builtins.listToAttrs (map + (name: { + name = ".config/waybar/scripts/" + name; + value = { + source = "${scriptsDir}/${name}"; + executable = true; + }; + }) + scripts); + + programs.waybar = { + enable = true; + package = pkgs.waybar; + settings = [ + { + layer = "top"; + position = "top"; + height = 30; + spacing = 4; + modules-left = [ + "custom/startmenu" "hyprland/workspaces" "custom/sep" "tray" "custom/sep" "hyprland/window" "custom/sep" + ]; + modules-center = [ "custom/sep" "idle_inhibitor" "custom/notification" "custom/sep" ]; + modules-right = [ "custom/sep" "pulseaudio" "network" "cpu" "memory" "clock" "custom/sep" "custom/power" ]; + # ... component configs ... + } + ]; + style = concatStrings [ + '' + @define-color bg #1a1b26; + @define-color fg #a9b1d6; + * { font-family: "JetBrainsMono Nerd Font", monospace; font-size: 16px; font-weight: bold; } + window#waybar { background-color: @bg; color: @fg; } + #workspaces button { padding: 0 6px; color: @cyn; } + #clock { color: @cyn; border-bottom: 4px solid @cyn; } + #pulseaudio { color: @blu; border-bottom: 4px solid @blu; } + #idle_inhibitor.activated { color: @grn; border-bottom: 4px solid @grn; } + '' + ]; + }; +``` +Puntos clave: +- El layout se controla con modules-left, modules-center y modules-right. +- La configuración de cada módulo (p. ej., hyprland/workspaces, pulseaudio) va en el mismo objeto. +- El CSS controla tipografías, tamaños, colores, bordes y espaciado. +- scriptsDir = ./scripts relativo al archivo; se instalan en ~/.config/waybar/scripts y se marcan como ejecutables. + +## Añadir tu propio Waybar (paso a paso) +1) Copia un módulo como base: +```bash path=null start=null +cp modules/home/waybar/waybar-simple.nix modules/home/waybar/my-waybar.nix +``` +2) (Opcional) Añade scripts auxiliares en modules/home/waybar/scripts/. +3) Apunta variables.nix a tu módulo: +```nix path=/home/dwilliams/ZaneyOS/hosts/default/variables.nix start=81 + #waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; + waybarChoice = ../../modules/home/waybar/waybar-tony.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs-2.nix; +``` +Cámbialo a: +```nix path=null start=null +waybarChoice = ../../modules/home/waybar/my-waybar.nix; +``` +4) Prepara los archivos antes de reconstruir (crítico): +```bash path=null start=null +git add modules/home/waybar/my-waybar.nix modules/home/waybar/scripts/* +``` +5) Reconstruye como siempre. + +## Ejemplos de personalización +1) Cambiar tipografía y tamaño (CSS) +```css path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=207 +* { + font-family: "JetBrainsMono Nerd Font", monospace; + font-size: 16px; + font-weight: bold; +} +``` +2) Mover widgets izquierda/centro/derecha +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-simple.nix start=28 +modules-center = [ "hyprland/workspaces" ]; +modules-left = [ "custom/startmenu" "custom/arrow6" "pulseaudio" "cpu" "memory" "idle_inhibitor" "custom/arrow7" "hyprland/window" ]; +modules-right = [ "custom/arrow4" "custom/hyprbindings" "custom/arrow3" "custom/notification" "custom/arrow3" "custom/power" "battery" "custom/arrow2" "tray" "custom/arrow1" "clock" ]; +``` +3) Cambiar colores y estilos de botones +```css path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=218 +#workspaces button { + padding: 0 6px; + color: @cyn; + background: transparent; + border-bottom: 3px solid @bg; +} +#workspaces button.active { + color: @cyn; + border-bottom: 3px solid @mag; +} +``` +4) Añadir iconos o cambiar etiquetas +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-ddubs.nix start=104 +"pulseaudio" = { + format = "{icon} {volume}% {format_source}"; + format-icons = { + headphone = ""; + default = [ "" "" "" ]; + }; +}; +``` +5) Añadir un widget que ejecute un script +```nix path=null start=null +"custom/mywidget" = { + exec = "~/.config/waybar/scripts/my-widget.sh"; + return-type = "json"; + interval = 5; + format = "{}"; + on-click = "kitty -e my-tool"; +}; +``` +6) Hacer la barra flotante o acoplada +```nix path=null start=null +settings = [ + { + layer = "top"; + position = "top"; + mode = "overlay"; + # ... + } +]; +``` +```css path=null start=null +window#waybar { + background: rgba(0, 0, 0, 0.6); + margin: 6px 10px; + border-radius: 12px; +} +``` + +## Dónde guardar scripts usados por widgets +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-ddubs.nix start=14 +home.file = builtins.listToAttrs (map (name: { + name = ".config/waybar/scripts/" + name; + value = { source = "${scriptsDir}/${name}"; executable = true; }; +}) scripts); +``` +Copia todo desde ./scripts a ~/.config/waybar/scripts y marca ejecutable. + +## Solución de problemas +- Fallo de ruta: asegúrate de hacer git add de los archivos nuevos. +- Nombre incorrecto en variables.nix: usa exactamente el nombre real. +- Iconos faltan: instala una Nerd Font (p. ej., JetBrainsMono Nerd Font) y selecciónala en CSS. +- Widgets faltan: confírmalos en modules-left/center/right y su bloque de config. + +## Receta rápida +1) Crea modules/home/waybar/my-waybar.nix (copia uno y edítalo) +2) Añade scripts en modules/home/waybar/scripts/ +3) En variables.nix: +```nix path=null start=null +waybarChoice = ../../modules/home/waybar/my-waybar.nix; +``` +4) git add de los archivos +5) Reconstruye. diff --git a/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.md b/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.md new file mode 100644 index 0000000..154b680 --- /dev/null +++ b/cheatsheets/hyprland/How-to-theme-or-add-waybars-in-ddubsos.md @@ -0,0 +1,254 @@ +# How to theme or add Waybars in ZaneyOS + +This guide shows how ZaneyOS selects and configures Waybar, how to add your own Waybar module, and how to customize fonts, sizes, colors, icons, widgets, and layout. It also calls out where to put scripts and a critical note about git add to avoid rebuild failures. + + +## Current Waybar modules available +Saved in modules/home/waybar/: +- waybar-tony.nix +- waybar-ddubs.nix +- waybar-ddubsos-v1.nix +- waybar-dwm.nix +- waybar-curved.nix +- waybar-simple.nix +- waybar-ddubs-2.nix +- waybar-mecha.nix +- waybar-dwm2.nix +- waybar-nekodyke.nix +- Jerry-waybar.nix +- waybar-TheBlackDon.nix + + +## Where you select your Waybar +Select the Waybar module in hosts/default/variables.nix via waybarChoice. Example (actual excerpt): +```nix path=/home/dwilliams/ZaneyOS/hosts/default/variables.nix start=73 + # Set Waybar + # Includes alternates such as: + # Comment out the current choice and uncomment the one you want + #waybarChoice = ../../modules/home/waybar/waybar-curved.nix; + #waybarChoice = ../../modules/home/waybar/Jerry-waybars.nix; + #waybarChoice = ../../modules/home/waybar/waybar-simple.nix; + #waybarChoice = ../../modules/home/waybar/waybar-mecha.nix; + #waybarChoice = ../../modules/home/waybar/waybar-nekodyke.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; + waybarChoice = ../../modules/home/waybar/waybar-tony.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs-2.nix; +``` +Notes: +- Ensure the file path matches an actual file name under modules/home/waybar/. For example, the list includes Jerry-waybar.nix (singular), but the commented example shows Jerry-waybars.nix (plural). Use the actual filename to avoid build errors. + + +## CRITICAL: git add or rebuild will fail +When you add a new Waybar file or any scripts it uses, you must stage them in git before rebuilding, or Nix will not see those paths and the build will fail. +- Example: +```bash path=null start=null +# Add your new module and scripts +git add modules/home/waybar/my-waybar.nix modules/home/waybar/scripts/my-widget.sh +# Commit (optional but recommended) +git commit -m "Add my Waybar module and widget script" +``` + + +## How Waybar modules are structured here +Most Waybar modules follow this pattern: +- They expose a Home Manager module that sets programs.waybar.settings (JSON-like config) and programs.waybar.style (CSS). +- They also copy any helper scripts to ~/.config/waybar/scripts via a shared scripts directory. + +Example: waybar-tony.nix copies scripts and sets Waybar config and CSS: +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=15 + # Configure & Theme Waybar (Tony) + home.file = builtins.listToAttrs (map + (name: { + name = ".config/waybar/scripts/" + name; + value = { + source = "${scriptsDir}/${name}"; + executable = true; + }; + }) + scripts); + + programs.waybar = { + enable = true; + package = pkgs.waybar; + settings = [ + { + layer = "top"; + position = "top"; + height = 30; + spacing = 4; + modules-left = [ + "custom/startmenu" "hyprland/workspaces" "custom/sep" "tray" "custom/sep" "hyprland/window" "custom/sep" + ]; + modules-center = [ "custom/sep" "idle_inhibitor" "custom/notification" "custom/sep" ]; + modules-right = [ "custom/sep" "pulseaudio" "network" "cpu" "memory" "clock" "custom/sep" "custom/power" ]; + # ... component configs ... + } + ]; + style = concatStrings [ + '' + @define-color bg #1a1b26; + @define-color fg #a9b1d6; + * { font-family: "JetBrainsMono Nerd Font", monospace; font-size: 16px; font-weight: bold; } + window#waybar { background-color: @bg; color: @fg; } + #workspaces button { padding: 0 6px; color: @cyn; } + #clock { color: @cyn; border-bottom: 4px solid @cyn; } + #pulseaudio { color: @blu; border-bottom: 4px solid @blu; } + #idle_inhibitor.activated { color: @grn; border-bottom: 4px solid @grn; } + '' + ]; + }; +``` + +Key takeaways: +- Layout is controlled by modules-left, modules-center, and modules-right arrays. +- Individual module settings (e.g., hyprland/workspaces, pulseaudio) are configured under the same top-level object. +- CSS controls fonts, sizes, colors, borders, and spacing. +- scriptsDir = ./scripts relative to the module file; any files inside that directory are installed into ~/.config/waybar/scripts and made executable. + + +## Add your own Waybar module (step-by-step) +1) Copy an existing module as a starting point, e.g.: +```bash path=null start=null +cp modules/home/waybar/waybar-simple.nix modules/home/waybar/my-waybar.nix +``` +2) (Optional) Add any helper scripts your widgets will use into modules/home/waybar/scripts/ (they will be installed to ~/.config/waybar/scripts automatically by modules using scriptsDir = ./scripts). +3) Point variables.nix to your new module: +```nix path=/home/dwilliams/ZaneyOS/hosts/default/variables.nix start=81 + #waybarChoice = ../../modules/home/waybar/waybar-ddubs.nix; + waybarChoice = ../../modules/home/waybar/waybar-tony.nix; + #waybarChoice = ../../modules/home/waybar/waybar-ddubs-2.nix; +``` +Change the active line to: +```nix path=null start=null +waybarChoice = ../../modules/home/waybar/my-waybar.nix; +``` +4) Stage your files before rebuilding (critical): +```bash path=null start=null +git add modules/home/waybar/my-waybar.nix modules/home/waybar/scripts/* +``` +5) Rebuild as you normally do for ZaneyOS. + + +## Customization examples +Below are quick edits you can make, demonstrated using existing modules. + +1) Change font family and size (CSS) +- In waybar-tony.nix: +```css path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=207 +* { + font-family: "JetBrainsMono Nerd Font", monospace; + font-size: 16px; + font-weight: bold; +} +``` +Change font-family and font-size to your preference. + +2) Move widgets left/center/right +- In any module, edit modules-left, modules-center, modules-right arrays. For example in waybar-simple.nix: +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-simple.nix start=28 +modules-center = [ "hyprland/workspaces" ]; +modules-left = [ "custom/startmenu" "custom/arrow6" "pulseaudio" "cpu" "memory" "idle_inhibitor" "custom/arrow7" "hyprland/window" ]; +modules-right = [ "custom/arrow4" "custom/hyprbindings" "custom/arrow3" "custom/notification" "custom/arrow3" "custom/power" "battery" "custom/arrow2" "tray" "custom/arrow1" "clock" ]; +``` +Just reorder or move entries between arrays to place widgets where you want. + +3) Change colors and button styles +- In waybar-tony.nix, CSS color variables and workspace button styling: +```css path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-tony.nix start=218 +#workspaces button { + padding: 0 6px; + color: @cyn; + background: transparent; + border-bottom: 3px solid @bg; +} +#workspaces button.active { + color: @cyn; + border-bottom: 3px solid @mag; +} +``` +Adjust colors (e.g., @cyn, @mag) or borders as desired. You can also define your own @define-color variables at the top of the CSS block. + +4) Add icons or change labels +- Many modules set format and format-icons. Example (pulseaudio) in waybar-ddubs.nix: +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-ddubs.nix start=104 +"pulseaudio" = { + format = "{icon} {volume}% {format_source}"; + format-icons = { + headphone = ""; + default = [ "" "" "" ]; + }; +}; +``` +Replace icons with Nerd Font glyphs you prefer. + +5) Add a new widget that runs a script +- Waybar custom modules can execute scripts and display the output. Put your script in modules/home/waybar/scripts/ and configure a custom module: +```nix path=null start=null +"custom/mywidget" = { + exec = "~/.config/waybar/scripts/my-widget.sh"; + return-type = "json"; # or "text" depending on your script + interval = 5; # seconds + format = "{}"; # how to render the output + on-click = "kitty -e my-tool"; +}; +``` +- Scripts placed in modules/home/waybar/scripts/ are installed to ~/.config/waybar/scripts and marked executable by modules that include the home.file mapping. + +6) Make the bar floating or docked +- Waybar supports a mode field; CSS margins/transparency give a floating look: +```nix path=null start=null +settings = [ + { + layer = "top"; + position = "top"; + mode = "overlay"; # overlay (floats), or "dock" (reserves space), or "invisible" + # ... + } +]; +``` +- CSS for floating effect: +```css path=null start=null +window#waybar { + background: rgba(0, 0, 0, 0.6); + margin: 6px 10px; /* space from screen edges */ + border-radius: 12px; +} +``` + +7) Known Waybar modules you’ll see in ZaneyOS configs +- Hyprland modules: hyprland/workspaces, hyprland/window, wlr/taskbar (wlroots taskbar) +- System modules: clock, tray, cpu, memory, network, disk, battery, bluetooth, backlight, idle_inhibitor, mpris, temperature, pulseaudio +- Custom modules: custom/* (e.g., custom/power, custom/notification, custom/startmenu, etc.) + + +## Where to store scripts that widgets call +- Place scripts under modules/home/waybar/scripts/. +- Many Waybar modules here include: +```nix path=/home/dwilliams/ZaneyOS/modules/home/waybar/waybar-ddubs.nix start=14 +home.file = builtins.listToAttrs (map (name: { + name = ".config/waybar/scripts/" + name; + value = { source = "${scriptsDir}/${name}"; executable = true; }; +}) scripts); +``` +This copies all files from ./scripts (next to the module file) to ~/.config/waybar/scripts and makes them executable, so your Waybar configuration can reference them as ~/.config/waybar/scripts/