docs: move explanations into short module headers

Non-obvious context sits in a brief header at the top of a module, everything else uses single-line comments. niri binds use spawn-sh strings, so neon only overrides the command.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-10-02 09:25:40 +02:00
co-authored by Claude Opus 5.5
parent 8d19be9527
commit 06b656477b
10 changed files with 88 additions and 207 deletions
+6 -11
View File
@@ -1,3 +1,7 @@
# Commits are signed with each machine's ~/.ssh/id_ed25519 through the ssh
# agent. gitea verifies them against the account keys; allowed_signers gives
# the local git the same trust, so `git log --show-signature` resolves too.
{
config,
lib,
@@ -7,18 +11,12 @@
let
email = "aaron@0x29a.ch";
# public half of every machine's ~/.ssh/id_ed25519, each one verified as a
# signing key in gitea. the key a host signs with is picked up from the key
# file itself, this list only tells the local git which machines to trust
signingKeys = [
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHRhwzo1oxaT3fEySSmILKNnu9v30cfjx5G7FKpmfqeX aaron@argon"
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGDkhvvTUcBSQdtXjX+Mw2Bp8HHhtiBm8aJi4ZxiBgZR aaron@neon"
];
in
{
# gitea verifies signatures against the account keys, this teaches the local
# git the same trust so `git log --show-signature` resolves as well
xdg.configFile."git/allowed_signers".text = lib.concatMapStrings (
key: "${email} ${key}\n"
) signingKeys;
@@ -26,9 +24,7 @@ in
programs.git = {
enable = true;
settings = {
push = {
autoSetupRemote = true;
};
push.autoSetupRemote = true;
user = {
name = "aaron";
inherit email;
@@ -37,8 +33,7 @@ in
};
signing = {
format = "ssh";
# point at the *public* key so ssh-keygen signs through the ssh agent
# instead of reading the passphrase protected private key from disk
# the public key makes ssh-keygen sign through the agent
key = "${config.home.homeDirectory}/.ssh/id_ed25519.pub";
signer = "${pkgs.openssh}/bin/ssh-keygen";
signByDefault = true;
+12 -40
View File
@@ -1,7 +1,11 @@
# Only renders ~/.config/niri/config.kdl; niri itself, its session and portals
# come from modules/nixos/niri.nix. Outputs and input devices that differ
# per machine live in hosts/<host>/niri.nix.
{ lib, osConfig, ... }:
let
# Mod+1..9 focus a workspace, Mod+Ctrl+1..9 move the column there.
# Mod+1..9 focus a workspace, Mod+Ctrl+1..9 move the column there
workspaceBinds = lib.mergeAttrsList (
map (n: {
"Mod+${toString n}".focus-workspace = n;
@@ -9,24 +13,18 @@ let
}) (lib.range 1 9)
);
# Shorthand for binds that only run spawn-sh while allowed on the lock screen.
# shell command that also works on the lock screen
lockedSh = cmd: {
_props.allow-when-locked = true;
spawn-sh = cmd;
};
in
{
# Niri config, rendered to ~/.config/niri/config.kdl by home-manager's built-in
# wayland.windowManager.niri module. The compositor itself, its session, systemd
# units and portals are provided by the NixOS module (modules/nixos/niri.nix), so
# this module only writes the config. Host-specific outputs and input devices
# live in hosts/<host>/niri.nix.
wayland.windowManager.niri = {
# only on hosts that run niri (see modules/nixos/niri.nix)
# only on hosts that run niri
enable = osConfig.programs.niri.enable;
# Use the system's niri so the config is validated against the running version.
# validate the config against the installed niri
package = osConfig.programs.niri.package;
systemd.enable = false;
portalPackage = null;
@@ -125,21 +123,11 @@ in
};
"Mod+D" = {
_props.hotkey-overlay-title = "Run an Application";
spawn = [
"noctalia"
"msg"
"panel-toggle"
"launcher"
];
spawn-sh = "noctalia msg panel-toggle launcher";
};
"Super+Alt+L" = {
_props.hotkey-overlay-title = "Lock the Screen";
spawn = [
"noctalia"
"msg"
"session"
"lock"
];
spawn-sh = "noctalia msg session lock";
};
# media keys (PipeWire / WirePlumber)
@@ -151,24 +139,8 @@ in
"XF86AudioStop" = lockedSh "playerctl stop";
"XF86AudioPrev" = lockedSh "playerctl previous";
"XF86AudioNext" = lockedSh "playerctl next";
"XF86MonBrightnessUp" = {
_props.allow-when-locked = true;
spawn = [
"brightnessctl"
"--class=backlight"
"set"
"+10%"
];
};
"XF86MonBrightnessDown" = {
_props.allow-when-locked = true;
spawn = [
"brightnessctl"
"--class=backlight"
"set"
"10%-"
];
};
"XF86MonBrightnessUp" = lockedSh "brightnessctl --class=backlight set +10%";
"XF86MonBrightnessDown" = lockedSh "brightnessctl --class=backlight set 10%-";
"Mod+O" = {
_props.repeat = false;
+9 -25
View File
@@ -1,25 +1,26 @@
# zsh with oh-my-zsh: agnoster where glyphs render, gentoo on the console.
# Deep paths are shortened to `…/last/two` so the prompt stays on one line:
# `%(4~|…/%2~|%~)` shows the last two components from four levels down.
{ lib, ... }:
{
# configure z-shell to use omz with some plugins
programs.zsh = {
enable = true;
autosuggestion.enable = true;
syntaxHighlighting.enable = true;
oh-my-zsh = {
enable = true;
# add git and agents as plugins
plugins = [
"git"
"ssh-agent"
"gpg-agent"
];
# everything here lands before `source $ZSH/oh-my-zsh.sh`
# runs before oh-my-zsh is sourced
extraConfig = ''
# make omz faster on large repositories
# faster git status on large repositories
DISABLE_UNTRACKED_FILES_DIRTY=true
# only display a fancy theme when glyphs are rendered
if [[ "$TERM" == "linux" || "$TERM" == "screen" ]]; then
ZSH_THEME="gentoo"
else
@@ -28,37 +29,20 @@
'';
};
# Unlike oh-my-zsh.extraConfig above, this lands *after*
# `source $ZSH/oh-my-zsh.sh`, which is where the theme's prompt functions
# come into existence.
# runs after oh-my-zsh, once the theme's prompt exists
initContent = lib.mkAfter ''
# Keep the prompt on one line in deeply nested trees.
#
# Both themes render the working directory as `%~`, the full path with
# $HOME collapsed to `~`. Somewhere like
# ~/git/bfh/cas-pml-sem/documents/bericht that is 39 columns on its own,
# and together with user@host and a long branch name the line wraps.
#
# `%(4~|…/%2~|%~)` is a prompt ternary: at four or more components show
# an ellipsis and the last two, otherwise show the path whole. Short
# paths like ~/git/nixconfig are left alone.
if [[ "$ZSH_THEME" == "agnoster" ]]; then
# agnoster calls prompt_dir on every render, so redefining it is
# enough. AGNOSTER_DIR_* keep the segment's own colours.
# agnoster renders prompt_dir on every prompt, so override it
prompt_dir() {
prompt_segment "$AGNOSTER_DIR_BG" "$AGNOSTER_DIR_FG" '%(4~|…/%2~|%~)'
}
else
# gentoo builds PROMPT once at load time, so patch the string. Its
# `%~` is the non-root branch of `%(!.%1~.%~)`, and it is the first
# literal `%~` in there, so the root branch is untouched. ASCII `...`
# because this branch is the Linux console, whose font may lack U+2026.
# gentoo builds PROMPT once; ascii dots, the console font lacks …
PROMPT="''${PROMPT/\%~/%(4~|.../%2~|%~)}"
fi
'';
};
# set important env vars
home.sessionVariables = {
EDITOR = "vim";
NH_FLAKE = "/home/aaron/git/nixconfig";
+16 -42
View File
@@ -1,54 +1,37 @@
# Nord-style status line built natively, no theme plugin.
# The powerline separators (U+E0B0..U+E0B3) are written as escapes via
# fromJSON: literal private-use glyphs get stripped silently on copy/paste.
# Commas inside #{?...} separate arguments, hence the escaped `#,` below.
let
# Powerline separators, U+E0B0..U+E0B3.
#
# Written as escapes rather than literal glyphs. These are Private Use Area
# codepoints: they render only with a patched font, they survive copy/paste
# badly, and when they get stripped the loss is invisible, the config still
# parses, the status bar just quietly loses its separators. Nix has no \u
# escape of its own, but fromJSON does.
sep = builtins.fromJSON ''
{
"right": "\ue0b0",
"rightThin": "\ue0b1",
"left": "\ue0b2",
"leftThin": "\ue0b3"
"right": "",
"rightThin": "",
"left": "",
"leftThin": ""
}
'';
in
{
programs.tmux = {
# defaults
enable = true;
prefix = "C-a";
keyMode = "vi";
mouse = true;
# tmux-256color gives truecolor, italics and undercurl in nvim.
terminal = "tmux-256color";
# Default is 500ms. Causes lag you feel when leaving insert mode in nvim,
# because tmux is waiting to see whether Esc starts an escape sequence.
escapeTime = 10;
# nvim autoread / :checktime react to focus.
focusEvents = true;
# History limit.
terminal = "tmux-256color"; # truecolor, italics and undercurl in nvim
escapeTime = 10; # the 500ms default lags leaving insert mode in nvim
focusEvents = true; # nvim autoread
historyLimit = 50000;
# Window numbers matching the number row.
baseIndex = 1;
baseIndex = 1; # window numbers match the number row
extraConfig = ''
# Status keys
set -g status-keys vi
# Tell tmux the outer terminal can do 24-bit colour (tmux >= 3.2).
# outer terminal does 24-bit colour
set -sa terminal-features ",*:RGB"
# Shift+Enter / extended keys
# These make tmux forward CSI-u sequences unconditionally.
# Needs tmux >= 3.5 for the format option,
# forward Shift+Enter and other extended keys as CSI-u (tmux >= 3.5)
set -s extended-keys always
set -s extended-keys-format csi-u
set -as terminal-features '*:extkeys'
@@ -88,27 +71,18 @@ in
bind -r K resize-pane -U 5
bind -r L resize-pane -R 5
# Wayland clipboard integration
# Copy selection to both clipboard (Ctrl+V / Shift+Insert) and primary (middle-click)
# copy to both the clipboard and primary selection
bind -T copy-mode-vi v send-keys -X begin-selection
bind -T copy-mode-vi C-v send-keys -X rectangle-toggle
bind -T copy-mode-vi y send-keys -X copy-pipe-and-cancel "wl-copy && wl-copy --primary"
bind -T copy-mode-vi Enter send-keys -X copy-pipe-and-cancel "wl-copy && wl-copy --primary"
bind -T copy-mode-vi MouseDragEnd1Pane send-keys -X copy-pipe-and-cancel "wl-copy && wl-copy --primary"
# Uncomment if you want yanks to also travel over SSH via OSC52.
# Locally redundant with wl-copy above.
#set -g set-clipboard on
# Kill commands
bind q confirm-before -p "kill window #W? (y/n)" kill-window
bind Q confirm-before -p "kill session #S? (y/n)" kill-session
# Bars
# This is the nord-tmux status line. #{prefix_highlight} came from that
# theme's tmux-prefix-highlight integration -- a plugin you never loaded,
# so the token expanded to nothing. tmux can do it natively. Commas inside
# #{?...} are argument separators and have to be escaped as #, hence the
# look of the style spec.
set -g status-left-length 24
set -g status-left "#[fg=black,bg=blue,bold] #{=20:session_name} #[fg=blue,bg=black,nobold,noitalics,nounderscore]${sep.right}"
set -g status-right "#{?client_prefix,#[fg=black#,bg=yellow#,bold] ^A ,}#[fg=brightblack,bg=black,nobold,noitalics,nounderscore]${sep.left}#[fg=white,bg=brightblack] %Y-%m-%d #[fg=white,bg=brightblack,nobold,noitalics,nounderscore]${sep.leftThin}#[fg=white,bg=brightblack] %H:%M #[fg=cyan,bg=brightblack,nobold,noitalics,nounderscore]${sep.left}#[fg=black,bg=cyan,bold] #H "