mdy/nix-config
1
0
Fork 0
Code Pull Requests Activity

chore: update AGENTS.md to match current codebase, remove stale TODO.md

Browse Source
This commit is contained in:
imbytecat
2026-04-12 00:38:04 +08:00
parent 47802ac519
commit 0fad4558f0
2 changed files with 19 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+16 -14
View File
@@ -13,7 +13,7 @@ flake.nix
└── nixosConfigurations.wsl (x86_64-linux) └── nixosConfigurations.wsl (x86_64-linux)
``` ```
- `lib/default.nix` — builders: `mkDarwin`, `mkNixos`. All hosts get shared modules + home-manager + catppuccin. - `lib/default.nix` — builders: `mkDarwin`, `mkNixos`. All hosts get shared modules + home-manager + catppuccin + lazyvim-nix + sops-nix.
- `modules/shared/` — both platforms: nixpkgs config, overlays, nix settings, Lix - `modules/shared/` — both platforms: nixpkgs config, overlays, nix settings, Lix
- `modules/darwin/` — macOS: system preferences, homebrew (casks/brews/masApps), fonts, fish shell, user - `modules/darwin/` — macOS: system preferences, homebrew (casks/brews/masApps), fonts, fish shell, user
- `modules/nixos/` — NixOS: base packages, docker, locale, user - `modules/nixos/` — NixOS: base packages, docker, locale, user
@@ -32,14 +32,17 @@ All platforms use **Lix** (`nix.package = pkgs.lix` in `modules/shared/nix.nix`)
```bash ```bash
# Justfile shortcuts (preferred) # Justfile shortcuts (preferred)
just darwin mac-mini # rebuild macOS host just rebuild mac-mini # rebuild macOS host (on macOS)
just darwin macbook-air just rebuild macbook-air
just nixos # rebuild WSL (linux only) just rebuild # rebuild WSL (linux only, default: "wsl")
just check # eval configs without building (platform-aware) just check # eval configs without building (platform-aware)
just update # nix flake update just update # nix flake update
just secrets # sops secrets/secrets.yaml just up nixpkgs # update a single flake input
just gc # nix-collect-garbage -d
just show # nix flake show just show # nix flake show
just secrets # sops secrets/secrets.yaml
just clean # nix-collect-garbage -d
just history # list system profile generations
just lsp mac-mini # generate .vscode/settings.json for nixd option completion
# Direct (when just isn't available) # Direct (when just isn't available)
sudo darwin-rebuild switch --flake .#mac-mini sudo darwin-rebuild switch --flake .#mac-mini
@@ -51,29 +54,27 @@ nix build .#darwinConfigurations.mac-mini.system # validate (full bu
sudo nix run nix-darwin -- switch --flake .#mac-mini sudo nix run nix-darwin -- switch --flake .#mac-mini
``` ```
Fish abbreviations `rebuild` and `update` are also available in the shell (defined in `home/shell/fish.nix`). `rebuild` auto-detects the platform and derives the flake attr from hostname.
## Critical gotchas ## Critical gotchas
- **catppuccin.nvim workaround active**: `catppuccin.enable = true` works, but `home/dev/neovim.nix` overrides `catppuccin.sources.nvim` to add `catppuccin.lib.detect_integrations` to `nvimSkipModule`. Upstream fix pending in catppuccin/nix. Cleanup condition: after `nix flake update`, if removing the override still builds, delete it. See `TODO.md`. - **Neovim uses lazyvim-nix**: `programs.lazyvim` in `home/dev/neovim.nix` manages neovim via the `lazyvim-nix` flake input. Catppuccin nvim integration is explicitly disabled (`catppuccin.nvim.enable = false`) because LazyVim manages its own colorscheme. Don't try to use `catppuccin.enable` for nvim or the old `programs.neovim.plugins` approach.
- **catppuccin module name**: Uses `catppuccin.homeModules.catppuccin` (not the old `homeManagerModules`). NixOS uses `catppuccin.nixosModules.catppuccin`. - **catppuccin module name**: Home-manager uses `catppuccin.homeModules.catppuccin` (imported in `home/default.nix`). NixOS uses `catppuccin.nixosModules.catppuccin` (in `lib/default.nix`). Don't use the old `homeManagerModules` name.
- **Homebrew tap casks**: Casks from taps need full path (e.g. `"goooler/repo/fl-clash"`), not just the short name. - **Homebrew tap casks**: Casks from taps need full path (e.g. `"goooler/repo/fl-clash"`), not just the short name.
- **`onActivation.cleanup = "zap"`**: Any brew formula/cask NOT declared in `modules/darwin/default.nix` WILL be removed on rebuild. Be comprehensive. - **`onActivation.cleanup = "zap"`**: Any brew formula/cask NOT declared in `modules/darwin/default.nix` WILL be removed on rebuild. Be comprehensive.
- **Repo location**: Default `~/nix-config`. Configurable via `nix_config_dir` fish variable in `home/shell/fish.nix`.
- **First-time bootstrap requires sudo**: `sudo nix run nix-darwin -- switch --flake .#mac-mini` (not `darwin-rebuild` which doesn't exist yet). - **First-time bootstrap requires sudo**: `sudo nix run nix-darwin -- switch --flake .#mac-mini` (not `darwin-rebuild` which doesn't exist yet).
- **mise for version management**: Activated in `home/shell/fish.nix` via `mise activate fish | source`. Config in `home/dev/languages.nix` trusts all config paths.
## Secrets (sops-nix) ## Secrets (sops-nix)
- Encrypted with age, key derived from `~/.ssh/id_ed25519` (see `.sops.yaml`) - Encrypted with age, key derived from `~/.ssh/id_ed25519` (see `.sops.yaml`)
- Secrets file: `secrets/secrets.yaml` — edit with `just secrets` (runs `sops`) - Secrets file: `secrets/secrets.yaml` — edit with `just secrets` (runs `sops`)
- Decrypted at runtime via `home/secrets.nix`, exposed as env vars in fish (`AI_GATEWAY_BASE_URL`, `AI_GATEWAY_API_KEY`) - Decrypted at runtime via `home/secrets.nix`, exposed as env vars in fish: `AI_GATEWAY_BASE_URL`, `AI_GATEWAY_API_KEY`, `EXA_API_KEY`, `CONTEXT7_API_KEY`
- sops-nix integrated via `home-manager` shared module in `lib/default.nix` - sops-nix integrated via `home-manager` sharedModules in `lib/default.nix`
- Never commit `*.dec.yaml`, `*.dec.json`, `*.plaintext` (in `.gitignore`) - Never commit `*.dec.yaml`, `*.dec.json`, `*.plaintext` (in `.gitignore`)
## Shell ## Shell
Fish (not zsh). All tool integrations use `enableFishIntegration`. Key files: Fish (not zsh). All tool integrations use `enableFishIntegration`. Key files:
- `home/shell/fish.nix` — abbreviations, interactiveShellInit, dynamic `rebuild` abbr - `home/shell/fish.nix` — abbreviations, interactiveShellInit, mise activation
- `home/shell/tools.nix` — fzf, atuin, zoxide (`--cmd cd`), direnv, bat, eza, yazi, btop, zellij - `home/shell/tools.nix` — fzf, atuin, zoxide (`--cmd cd`), direnv, bat, eza, yazi, btop, zellij
- `home/shell/starship.nix` — prompt - `home/shell/starship.nix` — prompt
@@ -92,6 +93,7 @@ These options were renamed in recent home-manager; use the new names:
- LSP: `nixd` (not `nil`). Provides nixpkgs/option completion. - LSP: `nixd` (not `nil`). Provides nixpkgs/option completion.
- Formatter: `nixfmt`. Run: `nixfmt <file.nix>` - Formatter: `nixfmt`. Run: `nixfmt <file.nix>`
- Both installed via `home/dev/languages.nix`. - Both installed via `home/dev/languages.nix`.
- VSCode settings for nixd option completion: `just lsp <host>` (generates `.vscode/settings.json` from `.vscode/settings.base.json`)
## Tool usage ## Tool usage
TODO.md
-9
View File
@@ -1,9 +0,0 @@
# TODO
## catppuccin-nvim require check workaround
- **文件**: `home/dev/neovim.nix`
- **内容**: 覆盖 `catppuccin.sources.nvim` 补上 `nvimSkipModule`
- **原因**: catppuccin/nix 的 `pkgs/nvim/package.nix` 漏了 `catppuccin.lib.detect_integrations`，该模块依赖 lazy.nvim 运行时，nix 构建沙箱里 require check 必定失败
- **上游**: https://github.com/catppuccin/nix — 需要在 `nvimSkipModule` 列表中添加 `catppuccin.lib.detect_integrations`
- **清理条件**: `nix flake update` 后若 `catppuccin.enable = true` + 删除 neovim.nix 中的 override 仍能 `nix build` 通过，即可移除