OrgとNixによる文芸的設定集
1. 概要
このリポジトリはNixとOrg modeを使って複数マシンのシステム設定を管理しています。すべての設定は文芸的プログラムとして書かれており、Org文書の中で各決定の理由を説明する文章がNixコードブロックを囲み、そこからタングルによって実際の設定ファイルが生成されます。
1.1. ドキュメント
設定ドキュメントの全文は以下で公開しています:
1.2. Nix
Nixは純粋関数型のパッケージマネージャー兼ビルドシステムです。このリポジトリでは以下のNixエコシステムツールを使用しています:
- Flakesによる再現可能な依存関係管理
- NixOSによる宣言的なLinuxシステム設定
- nix-darwinによる宣言的なmacOSシステム設定
- home-managerによるユーザー環境管理
- nix-on-droidによるAndroid (Termux) 環境
1.3. マシン
| 名前 | プラットフォーム | デバイス | 用途 |
|---|---|---|---|
| kilimanjaro | NixOS (x86_64) | i5-12400F / RTX 3080 | メインデスクトップ |
| tarangire | NixOS (x86_64) | Ryzen 9 9950X | ビルドサーバー |
| manyara | NixOS (x86_64) | Beelink Mini S12 | ホームサーバー |
| arusha | NixOS (x86_64) | WSL2 | WSL環境 |
| serengeti | NixOS (aarch64) | OCI A1 Flex | ビルドサーバー |
| katavi | macOS (aarch64) | M1 MacBook Air | メインラップトップ |
| work | macOS (aarch64) | M4 MacBook Pro | 仕事用ラップトップ |
| mikumi | macOS (aarch64) | M1 Mac mini | ビルドサーバー |
| android | nix-on-droid | Galaxy S24 FE | スマートフォン |
2. 設計思想
2.1. 文芸的設定
Nixは宣言的なシステムです。 Nixで書かれたコードを読めばシステムがどうあるべきかわかりますし、 Nix自身がその状態にするために自動的に処理してくれます。 しかしそのコードからもビルドシステムからも、なぜその設定になっているのか、 なぜ他の選択肢を取らなかったのか知ることはできません。
なぜzshやbashではなくfishを選んだのか? どうしてこのサービスはデスクトップ環境でのみ使われているのか? この古いバージョンのパッケージを使い続けてるのはなぜなのか? コードは決定事項は語りますが、その背景となる事由には口をつぐみます。 もしこの決定の理由がわからなければ将来の変更に 意図したトレードオフが失われたり既に検討し却下したアプローチを 再度採用したりしてしまう危険性が伴うことになるでしょう。
This repository uses literate programming to preserve intent. Configuration lives in Org mode documents where prose surrounds code.
For most settings, one or two sentences—what it enables and the visible effect—is enough. Reserve the full problem-and-alternatives form for non-obvious trade-offs: architectural choices, package pins, temporary workarounds.
3. 設定
3.1. Flake
このflakeはmacOS、Linux、Androidの複数プラットフォームにまたがるマシンのNixOS、nix-darwin、home-manager設定を管理しています。flake-partsによるモジュール構成を採用し、開発、コードフォーマット、pre-commitフックのためのツールも含んでいます。
{ description = "dotfiles"; # Core # Flake Infrastructure # Transitive Dependencies # System Configuration # Infrastructure # Development Tools # Desktop & Theming # Applications inputs = { <<nixpkgs>> <<nixpkgs-stable>> <<flake-parts>> <<flake-utils>> <<darwin>> <<home-manager>> <<nixos-wsl>> <<nix-on-droid>> <<disko>> <<impermanence>> <<lanzaboote>> <<nixos-facter-modules>> <<comin>> <<microvm>> <<niks3>> <<sops-nix>> <<tsnsrv>> <<git-hooks>> <<treefmt-nix>> <<nix-colors>> <<nix-wallpaper>> <<brew-nix>> <<claude-desktop>> <<edgepkgs>> <<emacs-overlay>> <<firefox-addons>> <<hermes-agent>> <<mcp-servers>> <<niri-flake>> <<org-clickup>> <<nur-packages>> <<paneru>> <<simple-wol-manager>> <<zen-browser>> }; nixConfig = { <<nix-config>> }; outputs = { self, flake-parts, ... }@inputs: flake-parts.lib.mkFlake { inherit inputs; } { <<outputs>> }; }
3.1.1. 入力
外部flake依存関係です。
依存関係グラフの肥大化による評価時間の増加を抑えるため、ほぼすべてのflakeで同一のnixpkgsや共通のinputをfollowするように設定しています。
- コア
- nixpkgs
https://github.com/NixOS/nixpkgs
Nixパッケージコレクション & NixOS
メインのパッケージセットです。チャンネル更新を高速にするため、=nixos-unstable= ではなく=nixos-unstable-small= を使用しています。=-small= バリアントは重要度の低い一部のCIテストを省略するため、コアパッケージの安定性を維持しつつ新しいパッケージバージョンをより早く取得できます。
チャンネルの選び方については https://nix.dev/concepts/faq.html#which-channel-branch-should-i-use を参照してください。
チャンネルの状態は https://status.nixos.org/ で確認できます。
nixpkgsのような大規模リポジトリでのファイル展開をわずかに高速化するため、=github:= の代わりに=git+https://= と
shallow=1を使用しています。nixpkgs.url = "git+https://github.com/nixos/nixpkgs?shallow=1&ref=nixos-unstable-small";
- nixpkgs-stable
unstableでビルド失敗やリグレッションが発生した際に安定版パッケージを提供します。主にunstableで壊れているパッケージに対して=stable= overlay(overlays/configuration.org参照)で使用されています。
nixpkgs-stable.url = "git+https://github.com/nixos/nixpkgs?shallow=1&ref=nixos-25.05";
- nixpkgs
- Flakeインフラストラクチャー
- flake-parts
https://github.com/hercules-ci/flake-parts
モジュールシステムによるNix Flakeの簡素化
flake出力を整理するためのフレームワークです。flakeにモジュールシステムを提供し、関心の分離によって複雑な設定の保守性を高めます。
flake-parts = { url = "github:hercules-ci/flake-parts"; inputs.nixpkgs-lib.follows = "nixpkgs"; };
- flake-parts
- 推移的依存関係
- flake-utils
https://github.com/numtide/flake-utils
純粋なNix flakeユーティリティ関数
一般的なflakeユーティリティです。flake-utilsに依存するinput間でバージョンを統一するため、=follows= 経由の推移的な利用のみです。
flake-utils.url = "github:numtide/flake-utils";
- flake-utils
- システム設定
- darwin
https://github.com/nix-darwin/nix-darwin
Nixを使ったmacOSの管理
nix-darwinはmacOSにNixOSスタイルのシステム設定を提供します。macOSのシステム設定、launchdサービス、Homebrewを宣言的に管理するために欠かせません。
darwin = { url = "github:nix-darwin/nix-darwin"; inputs.nixpkgs.follows = "nixpkgs"; };
- home-manager
https://github.com/nix-community/home-manager
Nixを使ったユーザー環境の管理
ユーザー環境管理ツールです。dotfiles、ユーザーサービス、ユーザーごとのパッケージを宣言的に管理します。このリポジトリにおけるユーザーレベル設定の中核です。
home-manager = { url = "github:nix-community/home-manager"; inputs.nixpkgs.follows = "nixpkgs"; };
- nixos-wsl
https://github.com/nix-community/nixos-wsl
WSL上のNixOS
Windows Subsystem for Linux上のNixOSです。WSL2内でNixOSの体験を提供し、Linux開発環境が必要なWindowsマシンで活用できます。
nixos-wsl = { url = "github:nix-community/nixos-wsl"; inputs.flake-compat.follows = ""; inputs.nixpkgs.follows = "nixpkgs"; };
- nix-on-droid
https://github.com/nix-community/nix-on-droid
AndroidデバイスのためのNix対応環境
Termuxを介したAndroid向けNix環境です。モバイルデバイスでも同じ宣言的な設定アプローチを利用できます。
nix-on-droid = { url = "github:nix-community/nix-on-droid"; inputs.home-manager.follows = "home-manager"; inputs.nix-formatter-pack.follows = ""; inputs.nixpkgs-docs.follows = "nixpkgs"; inputs.nixpkgs-for-bootstrap.follows = "nixpkgs"; inputs.nixpkgs.follows = "nixpkgs"; inputs.nmd.follows = ""; };
- disko
https://github.com/nix-community/disko
Nixを使った宣言的なディスクパーティショニングとフォーマット
再現可能なNixOSインストールのために使用します。パーティションレイアウト、ファイルシステムの作成、暗号化のセットアップを自動化します。
disko = { url = "github:nix-community/disko"; inputs.nixpkgs.follows = "nixpkgs"; };
- impermanence
https://github.com/nix-community/impermanence
一時的なルートストレージを持つシステムで永続的な状態を管理するためのモジュール
一時的なルートファイルシステムを持つシステムでステートフルなパスを管理します。btrfsスナップショットと組み合わせて、明示的に宣言された状態のみが再起動後も保持されるようにします。
impermanence.url = "github:nix-community/impermanence";
- lanzaboote
https://github.com/nix-community/lanzaboote
NixOS向けSecure Boot
カスタムキーでブートコンポーネントに署名し、NixOSマシンでSecure Bootを有効にします。
lanzaboote = { url = "github:nix-community/lanzaboote"; inputs.nixpkgs.follows = "nixpkgs"; inputs.pre-commit.follows = "git-hooks"; };
- nixos-facter-modules
https://github.com/numtide/nixos-facter-modules
nixos-facterと組み合わせて使用するNixOSモジュール群
NixOS向けのハードウェア検出ツールです。検出されたハードウェアに基づいてハードウェア設定を自動生成し、初期システムセットアップを簡素化します。
nixos-facter-modules.url = "github:numtide/nixos-facter-modules";
- darwin
- インフラストラクチャー
- comin
https://github.com/nlewo/comin
NixOSマシンのためのGitOps
リポジトリへのプッシュ時に設定変更を自動デプロイし、手動で
nixos-rebuild switchを実行せずにサーバーの継続的デプロイメントを実現します。comin = { url = "github:nlewo/comin"; inputs.nixpkgs.follows = "nixpkgs"; };
- microvm
https://github.com/astro/microvm.nix
NixOS modules for declaring & running virtual machines from within your system Flake configuration
Lightweight per-VM isolation suitable for running somewhat untrusted code. Used to sandbox third-party agent code (hermes-agent) so crashes, runaway tool invocations, or compromise of the agent runtime cannot reach the host's service stack. A microvm is preferred over a plain systemd-nspawn container because the qemu/firecracker boundary blocks kernel-level escapes that container namespacing alone does not.
microvm = { url = "github:astro/microvm.nix"; inputs.nixpkgs.follows = "nixpkgs"; };
- sops-nix
https://github.com/Mic92/sops-nix
sopsベースのNixOS向けアトミックなシークレットプロビジョニング
Mozilla SOPSを使ったシークレット管理です。リポジトリ内でシークレットを暗号化し、アクティベーション時にageキーで復号します。
sops-nix = { url = "github:Mic92/sops-nix"; inputs.nixpkgs.follows = "nixpkgs"; };
- tsnsrv
https://github.com/boinkor-net/tsnsrv
tailnet上のサービスを公開するリバースプロキシ(独立したTailscale参加者として)
Tailscaleサービスプロキシです。ローカルサービスを自動HTTPS証明書付きでTailscaleネットワークに公開します。
tsnsrv = { url = "github:boinkor-net/tsnsrv"; inputs.flake-parts.follows = "flake-parts"; inputs.nixpkgs.follows = "nixpkgs"; };
- niks3
https://github.com/Mic92/niks3
S3-backed Nix binary cache with garbage collection
niks3 is a self-hosted, S3-backed Nix binary cache that resolves the upload limits I ran into with the alternatives: it hands clients presigned S3 URLs so NARs upload straight to R2, and the cloudflared tunnel only carries small API calls. Cachix's free 5 GB was not enough for my dotfiles closures, so builds kept re-running instead of being fetched from the cache. attic worked, but behind a free cloudflared tunnel every upload was proxied through the tunnel and hit Cloudflare's 100 MiB request-body cap on large derivations.
niks3 = { url = "github:Mic92/niks3"; inputs.nixpkgs.follows = "nixpkgs"; inputs.treefmt-nix.follows = "treefmt-nix"; };
- comin
- 開発ツール
- git-hooks
https://github.com/cachix/git-hooks.nix
pre-commit.comのGitフックとNixのシームレスな統合
pre-commitフックをNix derivationとして提供します。グローバルなツールのインストールを必要とせず、すべての開発環境で一貫したコード品質チェックを実行できます。
このflakeに影響しないinputはロックファイルの肥大化を防ぐために削除しています。
git-hooks = { url = "github:cachix/git-hooks.nix"; inputs.flake-compat.follows = ""; inputs.gitignore.follows = ""; inputs.nixpkgs.follows = "nixpkgs"; };
- treefmt-nix
https://github.com/numtide/treefmt-nix
treefmt-nixの設定
統一的なコードフォーマッター設定です。複数のフォーマッター(nixfmt、shfmtなど)を単一のインターフェースで実行し、リポジトリ全体で一貫したフォーマットを保証します。
treefmt-nix = { url = "github:numtide/treefmt-nix"; inputs.nixpkgs.follows = "nixpkgs"; };
- git-hooks
- デスクトップ & テーマ
- nix-colors
https://github.com/misterio77/nix-colors
Nixでのテーマ設定を素晴らしくするモジュールとスキーム
Nix向けBase16カラースキームフレームワークです。単一のカラースキーム定義により、アプリケーション間で一貫したテーマを提供します。
nix-colors = { url = "github:misterio77/nix-colors"; inputs.nixpkgs-lib.follows = "nixpkgs"; };
- nix-wallpaper
https://github.com/natsukium/nix-wallpaper
Nixシステム向けのカスタマイズ可能な壁紙
Nixロゴの壁紙を生成します。追加のロゴバリエーションをサポートするカスタムブランチ(=custom-logo=)を使用しています。
nix-wallpaper = { url = "github:natsukium/nix-wallpaper/custom-logo"; inputs.flake-utils.follows = "flake-utils"; inputs.nixpkgs.follows = "nixpkgs"; inputs.pre-commit-hooks.follows = "git-hooks"; };
- nix-colors
- アプリケーション
- brew-nix
https://github.com/BatteredBunny/brew-nix
HomebrewのすべてのmacOS caskを自動的にパッケージ化する実験的なNix式
Homebrew caskをdarwin向けNixパッケージとして提供します。nixpkgsにないプロプライエタリなmacOSアプリケーションに便利です。
brew-apiinputはデータソース(HomebrewのAPIからのJSON APIダンプ)にすぎないため、non-flakeとしてマークされています。brew-api = { url = "github:BatteredBunny/brew-api"; flake = false; }; brew-nix = { url = "github:BatteredBunny/brew-nix"; inputs.brew-api.follows = "brew-api"; inputs.nix-darwin.follows = "darwin"; inputs.nixpkgs.follows = "nixpkgs"; };
- claude-desktop
https://github.com/k3d3/claude-desktop-linux-flake
Linux向けClaude DesktopのNix Flake
Linux向けのClaude Desktopを提供します。AnthropicがLinuxを公式にはまだサポートしていないため、コミュニティflakeを使用しています。
claude-desktop = { url = "github:k3d3/claude-desktop-linux-flake"; inputs.flake-utils.follows = "flake-utils"; inputs.nixpkgs.follows = "nixpkgs"; };
- edgepkgs
https://github.com/natsukium/edgepkgs
最新パッケージのための個人リポジトリです。nixpkgsにまだないパッケージ、修正が必要なパッケージ、アップストリームに受け入れられないパッケージ(ニッチなソフトウェアや実験的なソフトウェアなど)を含みます。
edgepkgs = { url = "github:natsukium/edgepkgs"; inputs.nixpkgs.follows = "nixpkgs"; };
- emacs-overlay
https://github.com/nix-community/emacs-overlay
最新版Emacs overlay
ネイティブコンパイルやpure GTKバリアントを含む最新のEmacsビルドを提供します。nixpkgsよりも頻繁に更新されるMELPAパッケージも含みます。主にorgファイルを解析して依存パッケージを自動設定するユーティリティのために使用しています。
emacs-overlay = { url = "github:nix-community/emacs-overlay"; inputs.nixpkgs-stable.follows = "nixpkgs-stable"; inputs.nixpkgs.follows = "nixpkgs"; };
- firefox-addons
https://gitlab.com/rycee/nur-expressions
Nix User Repositoryへの組み込みに適したNix式
Nix向けにパッケージ化されたFirefox/ブラウザ拡張機能です。home-managerを通じた宣言的なブラウザ拡張機能管理が可能になります。
firefox-addons = { url = "gitlab:rycee/nur-expressions?dir=pkgs/firefox-addons"; inputs.nixpkgs.follows = "nixpkgs"; };
- hermes-agent
https://github.com/NousResearch/hermes-agent
The self-improving AI agent built by Nous Research
Provides the upstream NixOS module (
nixosModules.default) and packaged Python build of hermes-agent.hermes-agent = { url = "github:NousResearch/hermes-agent"; inputs.flake-parts.follows = "flake-parts"; inputs.nixpkgs.follows = "nixpkgs"; };
- mcp-servers
https://github.com/natsukium/mcp-servers-nix
すぐに使えるパッケージ付きのModel Control Protocol (MCP) サーバー向けNixベース設定フレームワーク
Nix向けの設定フレームワークとパッケージ化されたMCPサーバーの両方を提供します。Claude Codeやその他のMCP互換AIアシスタントで使用します。設定の詳細はMCP Serversを参照してください。
mcp-servers = { url = "github:natsukium/mcp-servers-nix"; inputs.nixpkgs.follows = "nixpkgs"; };
- niri-flake
https://github.com/sodiboo/niri-flake
NixによるNiriの設定
niriはスクロール可能なタイリングWaylandコンポジターです。このflakeはコンポジターとNixOS/home-manager統合のための関連モジュールを提供します。
niri-flake = { url = "github:sodiboo/niri-flake"; inputs.niri-stable.follows = ""; inputs.niri-unstable.follows = ""; inputs.nixpkgs-stable.follows = "nixpkgs-stable"; inputs.nixpkgs.follows = "nixpkgs"; inputs.xwayland-satellite-stable.follows = ""; inputs.xwayland-satellite-unstable.follows = ""; };
- org-clickup
https://git.natsukium.com/natsukium/org-clickup
Emacs package for bidirectional ClickUp ↔ org-mode sync.
org-clickup = { url = "git+https://git.natsukium.com/natsukium/org-clickup"; flake = false; };
- nur-packages
https://github.com/natsukium/nur-packages
個人のNUR (Nix User Repository) です。nixpkgsにはニッチすぎるものやカスタマイズが必要な個人的にメンテナンスしているパッケージを含みます。
nur-packages = { url = "github:natsukium/nur-packages"; inputs.nixpkgs.follows = "nixpkgs"; };
- paneru
https://github.com/karinushka/paneru (fork: https://github.com/natsukium/paneru)
A sliding, tiling window manager for MacOS.
Paneru brings the Niri-style scrollable tiling workflow used on Linux machines to macOS. Among the window managers tried for this purpose, it has run the most stably in day-to-day use, which is why it was chosen.
The
natsukium/panerufork exists for a single reason: upstream tiles Emacs child frames — the floating windows used by completion UIs such as Corfu — alongside their parent, which collapses the popup. The fork keeps child frames floating. Once the patch has been confirmed stable in daily use, the plan is to send it upstream and switch this input back tokarinushka/paneru.paneru = { url = "github:natsukium/paneru/fix/emacs-child-frame"; inputs.flake-parts.follows = "flake-parts"; inputs.nixpkgs.follows = "nixpkgs"; inputs.nix-darwin.follows = "darwin"; };
- simple-wol-manager
https://git.natsukium.com/natsukium/simple-wol-manager
Wake-on-LAN (WoL) デバイスを管理するWebアプリケーション
個人的なWake-on-LAN管理ツール。WoLパケットの送信とデバイス構成の管理のためのWebインターフェースを提供します。
simple-wol-manager = { url = "git+https://git.natsukium.com/natsukium/simple-wol-manager"; inputs.nixpkgs.follows = "nixpkgs"; };
- zen-browser
https://github.com/0xc000022070/zen-browser-flake
Zen Browser向けコミュニティ主導のNix Flake
プライバシーに重点を置いたFirefoxベースのブラウザです。home-manager統合を含むNixパッケージングを提供するコミュニティflakeです。
zen-browser = { url = "github:0xc000022070/zen-browser-flake"; inputs.nixpkgs.follows = "nixpkgs"; inputs.home-manager.follows = "home-manager"; };
- brew-nix
3.1.2. Nixの設定
このflakeで使用するNixの設定です。これらの設定はすべての管理対象マシンで既に設定済みですが、ここに記述することで初期セットアップの助けになり、他の人がこのflakeを利用する際にも役立ちます。
各設定の詳細なドキュメントは https://nix.dev/manual/nix/latest/command-ref/conf-file.html を参照してください。
注意: flake.nix
はコードの再利用を妨げるNix言語の制限されたサブセットを使用しています(https://github.com/NixOS/nix/issues/4945
参照)。以下の値は現在このセクションにハードコードされています。マシン設定がOrg
modeに移行されれば、nowebリファレンスによりflakeとマシン固有の設定の両方でこれらの値を共有できるようになります。
- バイナリキャッシュ
このflakeをビルドするためのバイナリキャッシュ(substituter)設定です。必須ではありませんが、これらのキャッシュを設定するとソースからコンパイルする代わりにビルド済みバイナリをダウンロードするため、ビルド時間を大幅に短縮できます。
substitutersとtrusted-public-keysの代わりに=extra-substituters= とextra-trusted-public-keysを使うことで、このflakeのキャッシュ設定がユーザーの既存設定を置き換えるのではなく追加的になるようにしています。これによりユーザーがnix.confやシステム設定で既に設定しているキャッシュが尊重されます。extra-substituters = [ "https://nix-cache.natsukium.com" "https://natsukium.cachix.org" "https://nix-community.cachix.org" ]; extra-trusted-public-keys = [ "niks3-1:SoIFTPtiPoCW3/OzUkIBKlLG5znMZfbihlr11XAOles=" "natsukium.cachix.org-1:STD7ru7/5+KJX21m2yuDlgV6PnZP/v5VZWAJ8DZdMlI=" "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" ];
- nix-community.cachix.org
コミュニティバイナリキャッシュで、主にCUDA関連パッケージに使用されます。2024年11月以降、CUDAバイナリはnix-community名前空間で配布されています。ビルド状況は https://hydra.nix-community.org/project/nixpkgs で確認できます。
詳細は https://discourse.nixos.org/t/cuda-cache-for-nix-community/56038 を参照してください。
代替として、CUDAパッケージにFloxのバイナリキャッシュも利用できます。2025年9月時点で、FloxはNVIDIAと提携して再配布権を取得しています。https://discourse.nixos.org/t/nix-flox-nvidia-opening-up-cuda-redistribution-on-nix/69189 を参照してください。
- natsukium.cachix.org
このflakeの出力を含む個人バイナリキャッシュです。公式の
cache.nixos.orgやnix-community.cachix.orgにないパッケージはGitHub Actionsでビルドされ、ここにプッシュされます。
- nix-community.cachix.org
3.1.3. ホスト
すべての管理対象システムのマシン定義です。
hosts = { <<host-katavi>> <<host-mikumi>> <<host-work>> <<host-kilimanjaro>> <<host-arusha>> <<host-manyara>> <<host-serengeti>> <<host-tarangire>> <<host-android>> };
- katavi
メインラップトップ(M1 MacBook Air)。
katavi = { system = "aarch64-darwin"; };
- mikumi
ビルドサーバー(M1 Mac mini)。
mikumi = { system = "aarch64-darwin"; };
- work
仕事用ラップトップ(M4 MacBook Pro)。
work = { system = "aarch64-darwin"; };
- kilimanjaro
メインデスクトップ(Intel Core i5-12400F)。
Wake-on-LAN (WoL) は以下のBIOS設定で有効化されています:=Advanced > APM Configuration > Power On By PCI-E > Enabled=
kilimanjaro = { system = "x86_64-linux"; };
- arusha
WSL(kilimanjaroとデュアルブート)。
- セットアップ
arushaのセットアップにはWindows側とWSL側の両方の手順が必要です。手順はNixOS-WSLのクイックスタートガイドに従います。
- WSLのインストール
--no-distributionを指定すると、デフォルトのUbuntuディストリビューションのインストールを回避できます。NixOSをインポートした後に削除することになるためです。wsl --install --no-distribution
- NixOS-WSLのインポート
最新のNixOS-WSLリリースイメージをダウンロードしてインポートします。
| Select-Object -ExpandProperty assets ` | | Where-Object { $_.name -eq "nixos.wsl" } ` | | ForEach-Object { Invoke-WebRequest -Uri $_.browser_download_url -OutFile $_.name } | Invoke-RestMethod -Uri https://api.github.com/repos/nix-community/nixos-wsl/releases/latest `./nixos.wsl
- 設定の適用
NixOS-WSLの初回起動後、このflakeの設定をGitHubから直接適用します。初回実行時にローカルへのクローンは不要です。
wsl -d NixOS
sudo nixos-rebuild switch --flake github:natsukium/dotfiles#arusha
- Windows側のCLIツール
Windows 24H2には
sudoコマンドが組み込まれているため、別途UACプロンプトを表示せずにwingetをインラインで昇格できます。arusha = { system = "x86_64-linux"; };
- WSLのインストール
- セットアップ
- manyara
Intel N100搭載のミニPCで、軽量なホームサーバーとして使用しています。https://www.bee-link.com/products/beelink-mini-s12-pro-n100
停電後に自動的に電源が入るよう、以下のBIOS設定がされています:=Chipset > PCH-IO Configuration > State After G3 > S0 State=
manyara = { system = "x86_64-linux"; };
- serengeti
ビルドサーバー(OCI A1 Flex)。
serengeti = { system = "aarch64-linux"; };
- tarangire
ビルドサーバー(Ryzen 9 9950X)。
Wake-on-LAN (WoL) は以下のBIOS設定で有効化されています:=Advanced > APM Configuration > Power On By PCI-E > Enabled=
tarangire = { system = "x86_64-linux"; };
- android
スマートフォン(Pixel 7a)。
android = { system = "aarch64-linux"; platform = "android"; };
3.1.4. 出力
Each per-system concern lives in its own modules/flake/per-system/*.nix
file, documented in [[Per-system modules]] below. The outputs body wires
them via imports; flake-parts merges perSystem contributions across all
modules.
systems = [ "x86_64-linux" "aarch64-linux" "aarch64-darwin" ]; imports = [ ./flake-module.nix ./modules/flake/_registries.nix ./modules/flake/features/emacs ./modules/flake/features/neovim ./modules/flake/per-system/checks.nix ./modules/flake/per-system/dev-shell.nix ./modules/flake/per-system/mcp-servers.nix ./modules/flake/per-system/packages.nix ./modules/flake/per-system/pkgs.nix ./modules/flake/per-system/pre-commit.nix ./modules/flake/per-system/treefmt.nix ]; <<hosts>> flake = { overlays = import ./overlays { inherit inputs; }; };
3.1.5. Per-system modules
Per-concern flake-parts modules that each contribute to
perSystem. Splitting them keeps flake.nix small and lets each concern
carry its own documentation. flake-parts merges contributions across all
imported modules, so each file only needs to define what it owns.
The shared pattern is:
{ ... }: # or { self, inputs, ... }: when the module needs them { perSystem = { ... }: # the usual perSystem args (pkgs, self', config, system, ...) { <the-attribute-this-module-owns> = { ... }; }; }
- Nixpkgs instance
Constructs the per-system
pkgswith overlays applied, exposed to all otherperSystemconsumers via_module.args.pkgs.allowUnfreeis enabled because several desktop hosts pull in unfree packages (NVIDIA drivers onkilimanjaro,1password, etc.) and gating each call-site with an override would only add noise.{ self, inputs, ... }: { perSystem = { system, ... }: { _module.args.pkgs = import inputs.nixpkgs { inherit system; config.allowUnfree = true; overlays = [ inputs.nur-packages.overlays.default ] ++ builtins.attrValues self.overlays; }; }; }
- Checks
Re-exports the NixOS VM tests under
./testsas flake checks for the current system. Kept in its own module so the test wiring is easy to find independent of the per-systempkgsconstruction.{ inputs, ... }: { perSystem = { pkgs, ... }: { checks = import ../../../tests { inherit (inputs) nixpkgs; inherit pkgs; }; }; }
- Packages
Per-system packages exposed as flake outputs.
{ ... }: { perSystem = { pkgs, lib, ... }: { packages = { fastfetch = pkgs.callPackage ../../../pkgs/fastfetch { }; html = with pkgs; let org-html-themes = fetchurl { url = "https://raw.githubusercontent.com/fniessen/org-html-themes/b3898f4c5b09b3365fd93fd1566f46ecd0a8911f/org/theme-readtheorg.setup"; hash = "sha256-+5gy+S6NcuvlV61fudbCNoCKmSrCdA9P5CHeGKlDrSM="; }; org-to-html = ../../../scripts/org-to-html.el; in stdenvNoCC.mkDerivation { name = "dotfiles"; src = lib.cleanSource ../../..; postPatch = '' substituteInPlace configuration.org \ --replace-fail "/nix/store/3a3059l625swdwn9x129qqa6q6fvwjrb-theme-readtheorg.setup" "${org-html-themes}" ''; nativeBuildInputs = [ (emacs.pkgs.withPackages (epkgs: [ epkgs.htmlize epkgs.nix-ts-mode (epkgs.treesit-grammars.with-grammars (g: [ g.tree-sitter-nix ])) ])) gettext po4a ]; buildPhase = '' runHook preBuild po4a po4a.cfg emacs --batch -l ${org-to-html} runHook postBuild ''; installPhase = '' runHook preInstall install -Dm644 configuration.html $out/index.html install -Dm644 configuration.ja.html $out/ja/index.html runHook postInstall ''; }; }; }; }
3.2. Overlay
3.2.1. 概要
このファイルでは、壊れたパッケージの修正、特定バージョンのピン留め、ローカルな回避策の追加のためのnixpkgs overlayを定義しています。各overlayはパッケージセットを変更し、システムのビルドを妨げたり実行時の問題を引き起こす課題に対処します。
overlayの仕組み(=final: prev:= パターン、合成順序など)の詳細は nixpkgs overlayドキュメントを参照してください。
overlayは目的と想定される存続期間に基づいて4つのカテゴリに分類されています:
- stable: unstableで壊れており、修正すると大量のリビルドが発生するか、 ローカルでパッチするには複雑すぎる場合にnixpkgs-stableから取得するパッケージ。
- temporary-fix: 別のnixpkgsバージョンを必要としないローカルオーバーライド (例: テストの無効化)。アップストリームで修正されたら削除します。
- pre-release: nixpkgsに入る前にテストするためのアルファ版、ベータ版、プレリリースパッケージ。
- patches: アップストリームへの貢献に適さない回避策(例: ロケール固有の修正、 ローカルツールのshim)。恒久的に残る想定です。
{ inputs }: { <<stable>> <<temporary-fix>> <<pre-release>> <<patches>> }
- stable
unstableで壊れている場合にnixpkgs-stableからパッケージを取得します。アップストリームの修正が大量のリビルドを引き起こす場合や、ローカルでパッチするには複雑すぎる場合が該当します。
stable = final: prev: { };
- temporary-fix
ビルドはできるがテストが失敗したり軽微な問題があるパッケージのローカルオーバーライドです。=stable= overlayとは異なり、別のnixpkgsブランチからパッケージを取得する必要はありません。既存パッケージの特定の属性(=doCheck= など)をオーバーライドするだけです。アップストリームで問題が修正されたらこれらのオーバーライドを削除します。
temporary-fix = final: prev: { <<python313-package-set>> };
- Python313パッケージセット
packageOverridesを使用して問題のあるPythonパッケージをオーバーライドします。nixpkgsのPythonパッケージは相互に接続された依存関係グラフを形成しています。=packageOverrides= の仕組みにより、パッケージがオーバーライドされると、依存するすべてのパッケージが自動的に変更後のバージョンを参照します。これは一貫性のために不可欠です。直接的なoverlayオーバーライド(例: =python313Packages.foo = …=)ではトップレベルのアクセスにしか影響せず、内部の依存関係は元の壊れたバージョンを使い続けてしまいます。
詳細はnixpkgs Pythonドキュメントを参照してください。
python313 = prev.python313.override { packageOverrides = pyfinal: pyprev: { <<rapidocr-onnxruntime>> <<lxml-html-clean>> }; };
- rapidocr-onnxruntime
テストスイートの実行中にセグメンテーションフォールトが発生します。根本原因はまだ調査中です。
このパッケージは推移的な依存関係として取り込まれています。実際の使用でランタイム機能が正しく動作することは確認済みのため、テストスイートの無効化は安全な回避策です。
rapidocr-onnxruntime = pyprev.rapidocr-onnxruntime.overridePythonAttrs (_: { doCheck = false; });
- lxml-html-clean
libxml2 2.14の破壊的変更により、特定のDOM操作における空白文字やエンティティエンコーディングの処理方法が変更されたためテストが失敗します。実際のHTMLクリーニング機能は正しく動作しているにもかかわらず、テストのアサーションが失敗します。
アップストリームでは fedora-python/lxml_html_clean#24で追跡されています。テストスイートがlibxml2 2.14互換に更新されたらこのオーバーライドを削除します。
lxml-html-clean = pyprev.lxml-html-clean.overridePythonAttrs (_: { doCheck = false; });
- rapidocr-onnxruntime
- Python313パッケージセット
- pre-release
nixpkgsに入る前のアルファ版、ベータ版、プレリリース版パッケージをテストするためのoverlayです。リリース候補、ナイトリービルド、アップストリームのレビュー待ちパッケージの評価に便利です。nixpkgsで利用可能になったら、このoverlayから削除します。
pre-release = final: prev: { };
- patches
アップストリームへの貢献に適さない回避策です。
これらのパッチは、アップストリームが受け入れないであろう問題に対処します。この設定固有のもの(例: ロケール設定)、意図された動作を迂回するもの、または非標準的な方法で問題を解決するものが該当します。=temporary-fix= とは異なり、恒久的に残る想定です。
patches = final: prev: { <<gh-dash>> <<command-line-tools-shim>> };
- gh-dash
LANG=ja_JP.UTF-8が設定されているとプレビューペインが正しく描画されません。gh-dashの端末幅計算が特定のUTF-8文字(特にCJK文字や一部の絵文字)の表示幅を誤ってカウントすることが原因です。これによりテキストの折り返しと配置が崩れます。LANG=C.UTF-8を設定するとUTF-8エンコーディングのサポートを維持しつつASCI互換の幅計算が強制され、描画の問題が修正されます。=writeShellApplication= を使って、実際のバイナリを呼び出す前にこの環境変数を設定するラッパーを作成しています。アップストリームでは dlvhdr/gh-dash#316で報告済みです。
gh-dash = (final.writeShellApplication { name = "gh-dash"; text = '' LANG=C.UTF-8 ${final.lib.getExe prev.gh-dash} "$@" ''; }).overrideAttrs { pname = "gh-dash"; };
- mkShim
macOS Command Line Toolsのスタブ実装を提供するshimユーティリティです。
Xcode Command Line Toolsがインストールされていないdarwinシステムでは、=cc= や
python3などのコマンドを実行するとインストールを促す煩わしいシステムポップアップが表示されます。これらのshimはそのような呼び出しをインターセプトし、Nixが提供するツールに委譲するか適切な終了コードを返すことで、ポップアップを抑制し不要なビルド失敗を防ぎます。実装の詳細とshim化されたコマンドの一覧は pkgs/mkShimを参照してください。
inherit (final.callPackage ../pkgs/mkShim { }) mkShim commandLineToolsShim;
- gh-dash
3.3. モジュール
3.3.1. 概要
このファイルでは、標準のNixOS、nix-darwin、およびhome-managerモジュールシステムを拡張するカスタムモジュールを定義しています。各モジュールは特定のユースケースに対応するか、アップストリームにない独自のデフォルトを提供します。
モジュールはモジュールシステムのターゲットではなく、機能ドメイン(例:シェル、ネットワーク、バージョン管理)ごとに整理されています。あるドメインにシステムレベルとユーザーレベルの両方の設定が含まれる場合、サブヘッダーで明示的に区別しています。
3.3.2. Nix
Nixパッケージマネージャーとnixpkgsの設定です。これらのモジュールはNixOSとnix-darwinで共有され、すべてのマシンで一貫したNixの動作を提供します。
- コア設定
flake、ガベージコレクション、バイナリキャッシュ、サンドボックス設定を含むNixデーモンのコア設定です。
{ config, lib, pkgs, ... }: let cfg = config.my.nix; inherit (lib) mkEnableOption mkIf mkMerge mkOption optional types ; in { <<nix-options>> <<nix-config>> }
- オプション
options.my.nix = { enable = mkEnableOption "Nix configuration"; enableFlakes = mkOption { default = true; example = false; description = "Whether to enable flakes."; type = types.bool; }; };
- 設定
config = mkIf cfg.enable (mkMerge [ <<nix-flakes>> { <<nix-store-optimisation>> <<nix-warn-dirty>> <<nix-substituters>> <<nix-sandbox>> <<nix-trusted-users>> <<nix-gc>> <<nix-extra-options>> } ]);
- Flakes
FlakeはNixプロジェクト管理のデファクトスタンダードであり、このリポジトリ全体で使用されています。
チャンネルは無効化されています。チャンネルはマシン間で再現が困難な可変状態(=/nix/var/nix/profiles/per-user/*/channels=)を導入するためです。ただし、=nix-shell= などのレガシーコマンドは壊れません。NixOSとnix-darwinはデフォルトでflakeのinputから=NIX_PATH= を自動設定するため(
nixpkgs.flake.setNixPath参照)、このdotfilesリポジトリで管理されるすべてのマシンで<nixpkgs>の参照が引き続き機能します。(mkIf cfg.enableFlakes { nix = { settings.experimental-features = [ "flakes" "nix-command" ]; channel.enable = false; }; })
- ストアの最適化
2つの補完的な重複排除メカニズムが有効化されています:
nix.optimise.automaticは定期的にnix-store --optimiseを実行し、 ストア内の同一ファイルをハードリンクします。nix.settings.auto-optimise-storeは新しいパスが追加される際にビルド時に重複排除します。
auto-optimise-storeはLinux専用です。macOSで有効にするとストアが破損し、=error: cannot link 'nix/store.tmp-link' to 'nix/store.links/…': File exists= でビルドが失敗します。NixOS/nix#7273を参照してください。nix.optimise.automatic = true; nix.settings.auto-optimise-store = pkgs.stdenv.hostPlatform.isLinux;
- ガベージコレクション
定期的に
nix-collect-garbageを実行してディスク容量を回収します。7日以上前の世代は自動的に削除されます。それ以上古いビルドを保持しても価値は薄く、flakeのロックファイルからいつでも再ビルドできるためです。nix.gc = { automatic = true; options = "--delete-older-than 7d"; };
- Dirty警告
flake評価時の「Git tree is dirty」警告を抑制します。この警告はコミットされていない変更があるとビルドのたびに表示されますが、開発中はそれが通常の状態です。
nix.settings.warn-dirty = false;
- バイナリキャッシュ
I configure three binary caches.
nix-cache.natsukium.comis my self-hosted niks3 cache (on manyara, backed by Cloudflare R2); CI pushes this dotfiles repository's pre-built artifacts to it.natsukiumis my Cachix cache, which my other repositories still push to — only dotfiles has moved to niks3, so for now niks3 is dotfiles-only and Cachix covers everything else, though I may broaden niks3's scope later.nix-communityprovides caches for community projects, including NVIDIA/CUDA packages and other nix-community-maintained derivations.nix.settings = { substituters = [ "https://nix-cache.natsukium.com" "https://natsukium.cachix.org" "https://nix-community.cachix.org" ]; trusted-public-keys = [ "niks3-1:SoIFTPtiPoCW3/OzUkIBKlLG5znMZfbihlr11XAOles=" "natsukium.cachix.org-1:STD7ru7/5+KJX21m2yuDlgV6PnZP/v5VZWAJ8DZdMlI=" "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" ]; };
- サンドボックス
Darwinではサンドボックスを
"relaxed"に設定し、予期しないビルド失敗を回避しています。=sandbox = true= では、サンドボックスの制約により一部のパッケージがmacOSでビルドに失敗します。テストスイートがローカルサーバーを起動する際のlocalhost通信に関連していると考えられますが、正確なメカニズムは完全には解明されていません。nixpkgsはサンドボックス内でlocalhostアクセスを許可する__darwinAllowLocalNetworkingを提供しており、同じ種類の問題に対処できる可能性があります。="relaxed"= は通常のderivationをサンドボックス化したまま、=__noChroot = true= を持つderivationがサンドボックスを迂回できるようにし、これらの失敗を防ぎます。nix.settings.sandbox = if pkgs.stdenv.hostPlatform.isDarwin then "relaxed" else true;
- 信頼されたユーザー
macOSでは、管理者ユーザーは
wheelではなく=admin= グループに属します(=wheel= にはrootのみが含まれます)。=@admin= がないと、DarwinでプライマリユーザーがNixデーモンから信頼されません。nix.settings.trusted-users = [ "root" "@wheel" ] ++ optional pkgs.stdenv.hostPlatform.isDarwin "@admin";
- 追加オプション
3600秒(1時間)出力がないビルドを終了します。一部の重いビルド(例: Chromium、カーネルのコンパイル、CUDAベースのディープラーニングライブラリ)は長時間無出力になることがあるため、本当にハングしたビルドを検出しつつ誤検知を避けるためにタイムアウトは余裕を持って設定されています。
nix.extraOptions = '' max-silent-time = 3600 '';
- Flakes
- オプション
- Nixpkgs
Nixpkgsの設定です。=allowUnfree= はデフォルトで有効化されています。可能な限りフリーソフトウェアが望ましいですが、厳密に強制するのは非現実的です。NVIDIAハードウェアにはunfreeドライバーとCUDAライブラリが必要であり、=allowUnfreePredicate= で個別にunfreeパッケージを指定するのは、関連する推移的な依存関係の数を考えると過度に煩雑です。
{ config, lib, ... }: let cfg = config.my.nixpkgs; inherit (lib) mkEnableOption mkIf mkOption types ; in { options.my.nixpkgs = { enable = mkEnableOption "Nixpkgs configuration"; allowUnfree = mkOption { default = true; example = false; description = "Whether to allow unfree packages."; type = types.bool; }; }; config = mkIf cfg.enable { nixpkgs = { config.allowUnfree = cfg.allowUnfree; }; }; }
- 分散ビルド
Nixの組み込み
buildMachinesサポートを使用した分散ビルド設定です。フリート内の任意のマシンからビルドを他のマシンにオフロードでき、リソースを多く消費するderivationのビルド時間を大幅に短縮します。nix.distributedBuildsはここでmkDefault trueに設定されており、サーバープロファイルがfalseでオーバーライドできるようにしています。=nix.buildMachines= は分散ビルドが無効でも無害なので、条件付きのラッピングは不要です。サーバープロファイル(=profiles/nixos/server.nix= と =profiles/darwin/server.nix=)では無効化されています。ビルドサーバーにはローカルでビルドするリソースがあり、ビルドサーバー間でオフロードすると不必要なネットワークオーバーヘッドや循環依存が生じるためです。{ inputs, config, lib, ... }: let <<build-machines-let>> in { <<distributed-builds-config>> <<build-machines-known-hosts>> }
- プロトコルの選択
ssh-ngプロトコルはプレーンなsshよりも推奨されます。コンテンツアドレスドderivationとより効率的なストアパス転送をサポートするためです。ただし、Hydraはssh-ngをサポートしていません(NixOS/hydra#688参照)。そのため、現在のマシンでHydraが有効かどうかに基づいてプロトコルが動的に選択されます。protocol = if (config.services ? hydra && config.services.hydra.enable) then "ssh" else "ssh-ng"; inherit (inputs.self.outputs.nixosConfigurations) kilimanjaro serengeti tarangire; inherit (inputs.self.outputs.darwinConfigurations) mikumi;
- 設定
nix = { distributedBuilds = lib.mkDefault true; extraOptions = '' builders-use-substitutes = true ''; <<build-machines-list>> };
- ビルドマシン
各マシンは循環的なビルド委任を避けるため、自身をビルドマシンリストから除外しています(=config.networking.hostName= のチェックによる)。=mikumi= マシンも
workホストから除外されています。ワークマシンから個人のインフラにビルドをオフロードすべきではないためです。マシンの性能(=maxJobs=、=system-features=)はハードコードではなく各マシンの設定から参照されます。実際の値は
systems/以下の各マシンの定義を参照してください(例:systems/nixos/tarangire/default.nixの =max-jobs = 12=)。buildMachines = [ ] ++ lib.optional (config.networking.hostName != "tarangire") { inherit (tarangire.config.networking) hostName; systems = [ "x86_64-linux" "i686-linux" ]; sshUser = "natsukium"; inherit protocol; maxJobs = tarangire.config.nix.settings.max-jobs; speedFactor = 1; supportedFeatures = tarangire.config.nix.settings.system-features; mandatoryFeatures = [ ]; } ++ lib.optional (config.networking.hostName != "kilimanjaro") { inherit (kilimanjaro.config.networking) hostName; systems = [ "x86_64-linux" "i686-linux" ]; sshUser = "natsukium"; inherit protocol; maxJobs = kilimanjaro.config.nix.settings.max-jobs; speedFactor = 1; supportedFeatures = kilimanjaro.config.nix.settings.system-features; mandatoryFeatures = [ ]; } ++ lib.optional (config.networking.hostName != "serengeti") { inherit (serengeti.config.networking) hostName; system = "aarch64-linux"; sshUser = "natsukium"; inherit protocol; maxJobs = serengeti.config.nix.settings.max-jobs; speedFactor = 1; supportedFeatures = serengeti.config.nix.settings.system-features; mandatoryFeatures = [ ]; } ++ lib.optional (config.networking.hostName != "mikumi" && config.networking.hostName != "work") { inherit (mikumi.config.networking) hostName; systems = [ "aarch64-darwin" "x86_64-darwin" ]; sshUser = "natsukium"; inherit protocol; maxJobs = mikumi.config.nix.settings.max-jobs; speedFactor = 1; supportedFeatures = [ "apple-virt" "benchmark" "big-parallel" "nixos-test" ]; mandatoryFeatures = [ ]; };
- SSH Known Hosts
分散ビルドはSSH経由でリモートマシンに接続するため、無人ビルド中の対話的な検証プロンプトを避けるために各ビルドマシンのホスト鍵を登録する必要があります。
programs.ssh.knownHosts = { tarangire.publicKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEJJYgE/dmYLXYBrVnPicd0qsaUeqcBtXB8H9LHkJ2j4"; kilimanjaro.publicKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILhpfAalh6A5xDSE+HOdNE29ZgIjlP7tdlhHs82boSwp"; serengeti.publicKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDWwhfhDSZ+M2XDwP2MlC/zFfVpk3WjUxV/JWFgGzgNW"; mikumi.publicKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPfWOWKBFuDV08g6xP9MMY78CERI02CNG+5dy8CXQmXs"; };
- プロトコルの選択
- ユーザーレベルの設定
ユーザーレベルのNix設定です。システム設定ではなくユーザーの環境に属するため、home-managerで管理されています。
XDGベースディレクトリを有効にして、=~/.nix-defexpr= と
~/.nix-profileをそれぞれ~/.config/nix/と~/.local/state/nix/の下に配置し、=$HOME= のドットファイルの散らかりを減らします。resultシンボリックリンクはgitの無視対象に追加されています。=nix build= はデフォルトでプロジェクトルートにresultシンボリックリンクを作成し、コミットすべきではないためです。これは特定のリポジトリではなく、ユーザーのグローバルgitignoreに適用されます。{ config, ... }: { nix.settings.use-xdg-base-directories = config.xdg.enable; programs.git.ignores = [ "result" ]; }
3.3.3. ネットワーク
- Tailscale
NixOSシステム向けの独自のTailscale VPN設定です。このモジュールはMagicDNS、SSHアクセス、適切なファイアウォール設定とともにTailscaleを実行するための合理的なデフォルトを提供します。
{ config, lib, ... }: let cfg = config.my.services.tailscale; in { <<tailscale-options>> <<tailscale-config>> }
- オプション
Tailscaleの動作を制御するモジュールオプションです。
options.my.services.tailscale = { enable = lib.mkEnableOption "Tailscale VPN"; <<configureResolver-option>> };
- configureResolver
デスクトップシステムではサスペンド/レジューム後にDNS解決の失敗が発生することがあります。システムがレジュームすると、外部ドメインの解決(例: github.com)が失敗する一方、Tailnetのホスト名は引き続き動作します。これはネットワーク遷移時のTailscaleのDNS状態管理に関する既知の問題です。
configureResolverを有効にするとsystemd-resolvedがアクティベートされ、サスペンド/レジューム後のDNS解決の問題が軽減されます。これで問題が完全に解消されるわけではありませんが(アップストリームのバグは未解決)、最も信頼性の高いMagicDNS体験を提供します。ヘッドレスサーバーでは、このオプションは通常不要です。サーバーはサスペンドしないため、レジュームに関連するこのDNSバグに遭遇することがないためです。
アップストリームの議論は tailscale/tailscale#4254を参照してください。
configureResolver = lib.mkOption { type = lib.types.bool; default = false; description = '' Enable systemd-resolved for Tailscale DNS. Recommended for desktop systems to mitigate DNS failures after suspend/resume. https://github.com/tailscale/tailscale/issues/4254 ''; };
- configureResolver
- 設定
config = lib.mkIf cfg.enable ( lib.mkMerge [ { <<tailscale-service>> <<tailscale-networking>> <<tailscale-secrets>> } <<tailscale-resolver>> ] );
- サービス設定
Tailscaleサービスのコア設定
useRoutingFeatures = "server"はこのマシンをサブネットルーターまたはイグジットノードとして機能させます。この設定のすべてのマシンは他のデバイスのイグジットノードとして機能でき、旅行中や制限されたネットワーク上での柔軟性を提供します。authKeyFileはTailscale認証キーを含むSOPS管理のシークレットを指します。認証キーを使用することで無人認証が可能になり、cominなどのツールを使った自動デプロイやGitOpsワークフローに不可欠です。--sshはTailscale SSHを有効にし、SSHキーの管理やポート22のパブリックインターネットへの公開なしにTailscaleネットワーク経由でSSHアクセスを可能にします。services.tailscale = { enable = true; useRoutingFeatures = "server"; authKeyFile = config.sops.secrets.tailscale-authkey.path; extraUpFlags = [ "--ssh" ]; };
- ネットワーク
Tailscale統合のためのファイアウォールとDNS設定です。
tailscale0インターフェースは信頼されています。このインターフェース上のすべてのトラフィックはTailscaleによって認証されるためです。これにより、追加のファイアウォールルールなしにサービスをtailnetのみに公開できます。100.100.100.100はTailscaleのMagicDNSリゾルバーで、tailnetホスト名(例:hostname.tail4108.ts.net=)の解決を可能にします。=8.8.8.8はtailnet以外のクエリのフォールバックを提供しますが、実際にはMagicDNSがアップストリームリゾルバーへの転送を処理します。検索ドメインはtailnetドメインに設定されており、短いホスト名(例:
ssh manyara.tail4108.ts.netの代わりに =ssh manyara=)が使えます。networking = { firewall = { trustedInterfaces = [ "tailscale0" ]; allowedUDPPorts = [ config.services.tailscale.port ]; }; nameservers = [ "100.100.100.100" "8.8.8.8" ]; search = [ "tail4108.ts.net" ]; };
- シークレット
Tailscale認証キーのSOPSシークレット宣言です。実際のキーはリポジトリのシークレットファイルに暗号化されて保存され、アクティベーション時に復号されます。
sops.secrets.tailscale-authkey = { };
- リゾルバー
条件付きのsystemd-resolved設定です。=configureResolver= がtrueの場合にのみ有効になり、通常はサスペンド/レジュームするデスクトップシステムで使用されます。
(lib.mkIf cfg.configureResolver { services.resolved.enable = cfg.configureResolver; })
- サービス設定
- オプション
3.3.4. File Synchronization
- org-sync
I keep my org notes in
~/dropbox/organd have synced them across my desktop and laptops through Dropbox. I added Syncthing so the hermes-agent VM can read the same notes, and I plan to drop Dropbox and rely on Syncthing alone once it has proven itself.This is a user-level
services.syncthinginstance, separate from the system-level daemon kilimanjaro already runs; its ports are shifted off the defaults so the two do not collide.{ config, lib, ... }: let cfg = config.my.services.org-sync; in { options.my.services.org-sync = { enable = lib.mkEnableOption "syncing the org folder across the user's devices"; devices = lib.mkOption { type = lib.types.attrsOf ( lib.types.submodule { options.id = lib.mkOption { type = lib.types.str; description = "Syncthing device ID."; }; } ); default = { }; description = "Peer devices that participate in the org folder."; }; }; config = lib.mkIf cfg.enable { services.syncthing = { enable = true; guiAddress = "127.0.0.1:8385"; overrideDevices = true; overrideFolders = true; settings = { options.listenAddresses = [ "tcp://0.0.0.0:22001" "quic://0.0.0.0:22001" ]; devices = cfg.devices; folders.org = { path = "${config.home.homeDirectory}/dropbox/org"; devices = lib.attrNames cfg.devices; }; }; }; }; }
3.3.5. シェル
対話的シェルとスクリプト用シェルは異なる目的を持ちます。対話的シェルはPOSIX互換である必要はなく、重要なのは使いやすさ、幅広い環境サポート、拡張性です。
- Fish
fishはプライマリの対話的シェルです。すぐに使えるエクスペリエンス(シンタックスハイライト、オートサジェスト、タブ補完が設定やプラグインなしで動作する)が選定理由です。幅広い環境とソフトウェアのサポートを持つシェルの中で、fishは最小限のセットアップで最も便利で拡張可能な対話的エクスペリエンスを提供します。
{ pkgs, ... }: { programs.fish = { enable = true; <<fish-interactive-shell-init>> <<fish-abbreviations>> <<fish-functions>> <<fish-plugins>> }; }
- 対話シェルの初期化
fishが対話セッションを開始する際に適用される設定です。キーバインド、プラグイン設定、環境変数、シェル統合が含まれます。
interactiveShellInit = '' <<fish-keybindings>> <<fish-done-config>> <<fish-pinentry>> <<fish-extra-abbrs>> <<fish-any-nix-shell>> '';
- キーバインド
Ctrl+Sに =zi=(zoxideのインタラクティブモード)をバインドし、ファジーなディレクトリジャンプに使用します。bind \cs zi
- Pinentry
SSH経由で接続している場合、GPGのpinentryをcurses(ターミナル)バリアントに切り替えます。デフォルトのグラフィカルなpinentryはX11/Waylandフォワーディングなしではリモートセッションで表示できないため、SSH経由でのコミット署名やシークレット復号にTUIのフォールバックが必要です。Gentoo Wiki: GnuPG - Changing pinentry for SSH loginsを参照してください。
# set environment variable for pinentry if test "$SSH_CONNECTION" != "" set -x PINENTRY_USER_DATA "USE_CURSES" end
- 追加の略語
位置認識型の略語で、fishの高度な機能(=–position anywhere=、=–regex=、=–function=)を使用しています。これらはhome-managerの
shellAbbrsオプションでは利用できません。# extra abbrs abbr -a L --position anywhere --set-cursor "% | less" abbr -a !! --position anywhere --function _abbr_last_history_item abbr -a extract_tar_gz --position command --regex ".+\.tar\.gz" --function _abbr_extract_tar_gz abbr -a dotdot --regex '^\.\.+$' --function _abbr_multicd
- any-nix-shell
any-nix-shellは=nix shell= や
nix develop環境内でfishを対話的シェルとして維持します。これがないと、Nixシェルに入る際にbash(デフォルトのビルダーシェル)に落ち、fishの対話機能が失われます。他のすべての設定が適用された後にシェルのエントリーポイントをラップできるよう、=interactiveShellInit= の末尾でソースされます。${pkgs.any-nix-shell}/bin/any-nix-shell fish | source
- キーバインド
- 略語
shellAbbrs = { <<fish-abbr-general>> <<fish-abbr-nix>> };
- 一般
# spellchecker:off l = "ls";
- Nixリモートビルド
Nixのビルドターゲットシステムを指定する略語で、主にnixpkgsで作業する際に使用されます。各略語は
--system <triple>に展開され、ターゲットシステムが現在のホストと異なる場合は条件付きで-j0が追加されます。=-j0= はローカルジョブ数の上限をゼロに設定し、すべてのビルドをリモートビルダーに委任させます(分散ビルド参照)。これにより、Nixがホスト上でビルドを試みてアーキテクチャの不一致で失敗することを防ぎます。# spellchecker:on "--sxl" = { position = "anywhere"; expansion = "--system x86_64-linux" + pkgs.lib.optionalString ( pkgs.stdenv.hostPlatform.isDarwin || pkgs.stdenv.hostPlatform.isAarch64 ) " -j0"; }; "--sal" = { position = "anywhere"; expansion = "--system aarch64-linux" + pkgs.lib.optionalString ( pkgs.stdenv.hostPlatform.isDarwin || pkgs.stdenv.hostPlatform.isx86_64 ) " -j0"; }; "--sxd" = { position = "anywhere"; expansion = "--system x86_64-darwin" + pkgs.lib.optionalString pkgs.stdenv.hostPlatform.isLinux " -j0"; }; "--sad" = { position = "anywhere"; expansion = "--system aarch64-darwin" + pkgs.lib.optionalString pkgs.stdenv.hostPlatform.isLinux " -j0"; };
- 一般
- 関数
略語システムで使用されるヘルパー関数です。fishでは
--function略語が参照する前に関数を定義する必要があるため、略語の定義とは分離されています。functions = { _abbr_last_history_item = "echo $history[1]"; _abbr_extract_tar_gz = "echo tar avfx $argv"; _abbr_multicd = "echo cd (string repeat -n (math (string length -- $argv[1]) - 1) ../)"; };
- プラグイン
plugins = [ { name = "done"; src = pkgs.fishPlugins.done.src; } { name = "fzf-fish"; src = pkgs.fishPlugins.fzf-fish.src; } ];
doneプラグインは長時間実行されるコマンドのデスクトップ通知を提供します。閾値は15秒に設定されています。これより短いコマンドは通常対話的で通知の恩恵がなく、長いコマンド(ビルド、テストスイート、大きなファイル操作)はバックグラウンドで実行されることが多く、通知が有用です。
# set done's variable set -U __done_min_cmd_duration 15000
fzf-fishはfzfをfishのタブ補完、履歴検索、ファイル/ディレクトリナビゲーションと統合します。fishの組み込み履歴検索(=Ctrl+R=)をfzfのファジーファインダーに置き換え、大きな履歴をより効果的に処理します。
- 対話シェルの初期化
- Bash
Bashは完全な対話環境ではなく、最小限のフォールバックシェルとして設定されています。主な用途はfishが利用できない場合に使えるシェルを確保すること、およびbashを前提とするスクリプトやツールにPOSIX互換シェルを提供することです。また、fishが予期しない動作を示す際のテスト環境としても機能します。クリーンなbashがあれば、問題がfish固有かどうかの切り分けに役立ちます。
{ pkgs, lib, config, ... }: { home.packages = with pkgs; [ bashInteractive ]; programs.bash = { enable = true; <<bash-history>> <<bash-completion>> <<bash-aliases>> <<bash-init>> }; }
- 履歴
履歴は
XDG_CONFIG_HOME配下に保存し、=$HOME= をクリーンに保ちます。リポジトリのXDGベースディレクトリの方針と一貫しています(ユーザーレベルの設定参照)。historyFile = "$XDG_CONFIG_HOME/bash/history";
- 補完
Bashの補完はプライマリの対話的シェルとして使用されていないため無効化されています。補完スクリプトの読み込みは起動時間を追加(約100ms以上)しますが、フォールバックやスクリプト実行にのみ使用するシェルではメリットがありません。
enableCompletion = false;
- エイリアス
bashを対話的に使用する場合の最小限の利便性向上のための基本的なエイリアスです。意図的にシンプルにしています。リッチな対話エクスペリエンスはfishが担当します。
shellAliases = { l = "ls -CF"; grep = "grep --color=auto"; fgrep = "fgrep --color=auto"; egrep = "egrep --color=auto"; };
- 初期化
この設定はfishがデフォルトのログインシェルに設定される前の名残です。以前はbashがログインシェルで
.bashrcからfishを起動していたため、これらの設定はすべての対話セッションに必要でした。bashがフォールバックとして使用されるため保持されています。+ lib.optionalString (!config.programs.kitty.enable) '' <<bash-tmux-autostart>> initExtra = '' <<bash-terminal-settings>> '' '';
- ターミナル設定
stty stop undef:Ctrl+SがXOFF=(ターミナル一時停止)を送信するのを無効にし、 fishや他のTUIアプリケーションでキーバインドとして利用できるようにします。これがないと、 =Ctrl+Sを押すとCtrl+Qを押すまでターミナルがフリーズします。 これは現代のターミナルではほとんど役に立たないレガシーなフロー制御機構です。stty werase undef+bind "\C-w":unix-filename-rubout:Ctrl+Wを単語全体ではなく 前のパスコンポーネント(=/= で停止)を削除するように再バインドします。 シェルでの一般的なケースであるファイルパスの編集時に、より便利です。
stty stop undef # Ctrl-s stty werase undef bind "\C-w":unix-filename-rubout # Ctrl-w
- TMUXの自動アタッチ
bashが対話的シェルの場合にtmuxセッションを自動的に開始またはアタッチしますが、kittyがターミナルエミュレーターの場合のみ除外されます。kittyには独自のタブ/ウィンドウ管理(分割、レイアウト、タブ)があり、tmuxの多重化と競合します。kitty内でtmuxを実行すると冗長なネストが生じます。よりシンプルなターミナル(例: =xterm=、=alacritty=、またはLinuxコンソール)を使用する場合、tmuxはそれ以外では欠けるセッション永続性とウィンドウ管理を提供します。
# TMUX (from ArchWiki) # if no session is started, start a new session if type tmux > /dev/null 2>&1; then test -z $TMUX && tmux # when quitting tmux, try to attach while test -z $TMUX; do tmux attach || break done fi
- ターミナル設定
- 履歴
- Nushell
Nushellは構造化データをネイティブに扱える能力のために有効化されており、PowerShellに似ています。従来のシェルがコマンド間でテキストをパイプするのに対し、Nushellはシリアライズされたデータ形式(JSON、YAML、CSVなど)をファーストクラスのテーブルやレコードとして操作し、=jq= のような外部ツールなしで簡単なデータ操作を可能にします。fishと同様に非POSIXですが、対話的シェルにはPOSIX互換性は要件ではありません。
カスタム設定はまだ追加されていません。デフォルトで探索的な使用には十分であり、Nushell固有のワークフローにコミットするのは時期尚早です。
{ config, ... }: { programs.nushell = { enable = true; }; }
- Starship
StarshipはRustで書かれたクロスシェルプロンプトで、ここで設定されているすべてのシェルで一貫したプロンプト体験を提供するために使用されています。前身のspacefishの頃から使用されており、簡単なTOMLベースの設定が使い続けている主な理由です。
Starshipはネイティブで非同期プロンプトレンダリングをサポートしていないため、このセクションにはfish用のカスタム非同期プロンプトモジュールも含まれています。
{ pkgs, ... }: { programs.starship = { enable = true; settings = builtins.fromTOML (builtins.readFile ./starship.toml); }; my.programs.starship.enableFishAsyncPrompt = true; }
- プロンプトフォーマット
プロンプトフォーマットはデフォルトのモジュールの前にシェルインジケーターを追加します。これにより、どのシェルがアクティブかが即座に分かり、テストやデバッグでfishとbashを切り替える際に便利です。
"$schema" = "https://starship.rs/config-schema.json" format = "$shell$all$line_break$character"
- シェルインジケーター
各シェルには固有のアイコンがあります。fishには ==(fishアイコン)。Bashとnushellはデフォルトのインジケーターを使用します。
[shell] fish_indicator = "" powershell_indicator = "" disabled = false
- リモートコンテナの検出
VS Code Remote Container(Dev Container)内で実行されているかを
REMOTE_CONTAINERS環境変数のチェックにより検出するカスタムモジュールで、視覚的なリマインダーとしてクジラの絵文字(🐋)を表示します。数年間使用されておらず、もう関連性がないかもしれません。[custom.remote-container] when = """ test "$REMOTE_CONTAINERS" """ symbol = "🐋" format = " in $symbol "
- 無効化されたモジュール
gcloudはホームディレクトリ(=~/.config/gcloud/=)からアクティブなGCP設定を読み込むため無効化されています。プロジェクトがGCPを使用しているかどうかに関係なく、すべてのリポジトリで表示されてしまいます。[gcloud] disabled = true
- 非同期プロンプトモジュール
Starshipのデフォルトのfish統合を非同期バリアントに置き換えるカスタムhome-managerモジュールです。非同期プロンプトスクリプトはduamentのgistから取得したもので、fish-async-promptに基づいています。非同期プロンプトサポートに関するアップストリームの議論は fish-shell#8223も参照してください。
# use my own script to ensure the execution order { config, lib, ... }: let inherit (lib) mkForce mkIf mkOption types ; cfg = config.my.programs.starship; in { options = { my.programs.starship = { enableFishAsyncPrompt = mkOption { type = types.bool; default = false; }; }; }; config = mkIf cfg.enableFishAsyncPrompt { programs.starship.enableFishIntegration = mkForce false; programs.fish.interactiveShellInit = '' if test "$TERM" != dumb ${lib.getExe config.programs.starship.package} init fish | source source ${./async_prompt.fish} end ''; }; }
- 非同期プロンプトスクリプト
# cherry picked from https://gist.github.com/duament/bac0181935953b97ca71640727c9c029 status is-interactive or exit 0 if test -n "$XDG_RUNTIME_DIR" set -g __starship_async_tmpdir "$XDG_RUNTIME_DIR"/fish-async-prompt else set -g __starship_async_tmpdir /tmp/fish-async-prompt end mkdir -p "$__starship_async_tmpdir" set -g __starship_async_signal SIGUSR1 # Starship set -g VIRTUAL_ENV_DISABLE_PROMPT 1 builtin functions -e fish_mode_prompt set -gx STARSHIP_SHELL fish set -gx STARSHIP_SESSION_KEY (random 10000000000000 9999999999999999) # Prompt function fish_prompt printf '\e[0J' # Clear from cursor to end of screen if test -e "$__starship_async_tmpdir"/"$fish_pid"_fish_prompt cat "$__starship_async_tmpdir"/"$fish_pid"_fish_prompt else __starship_async_simple_prompt end end # Async task function __starship_async_fire --on-event fish_prompt switch "$fish_key_bindings" case fish_hybrid_key_bindings fish_vi_key_bindings set STARSHIP_KEYMAP "$fish_bind_mode" case '*' set STARSHIP_KEYMAP insert end set STARSHIP_CMD_PIPESTATUS $pipestatus set STARSHIP_CMD_STATUS $status set STARSHIP_DURATION "$CMD_DURATION" set STARSHIP_JOBS (count (jobs -p)) set -l tmpfile "$__starship_async_tmpdir"/"$fish_pid"_fish_prompt fish -c ' starship prompt --terminal-width="'$COLUMNS'" --status='$STARSHIP_CMD_STATUS' --pipestatus="'$STARSHIP_CMD_PIPESTATUS'" --keymap='$STARSHIP_KEYMAP' --cmd-duration='$STARSHIP_DURATION' --jobs='$STARSHIP_JOBS' > '$tmpfile' kill -s "'$__starship_async_signal'" '$fish_pid & disown end function __starship_async_simple_prompt set_color brgreen echo -n '❯' set_color normal echo ' ' end function __starship_async_repaint_prompt --on-signal "$__starship_async_signal" commandline -f repaint end function __starship_async_cleanup --on-event fish_exit rm -f "$__starship_async_tmpdir"/"$fish_pid"_fish_prompt end # https://github.com/acomagu/fish-async-prompt # https://github.com/fish-shell/fish-shell/issues/8223
- 非同期プロンプトスクリプト
- プロンプトフォーマット
3.3.6. バージョン管理
- Git
Gitバージョン管理の設定です。Gitはhome-managerの=programs.git= モジュールを通じて直接設定され、=~/.config/git/config= を宣言的に生成します。
{ pkgs, config, ... }: { programs.git = { enable = true; <<git-settings>> <<git-signing>> <<git-ignores>> <<git-scalar>> }; <<git-gh>> <<git-delta>> <<git-difftastic>> <<git-lazygit>> <<git-fish-abbreviations>> }
- コア設定
基本的なgitの動作設定です。
settings = { <<git-user-identity>> <<git-editor>> <<git-color>> <<git-default-branch>> <<git-push-safety>> <<git-url-rewrite>> };
- ユーザーID
user = { name = "natsukium"; email = "[email protected]"; };
- エディター
core.editor = "vim"はgit操作のフォールバックエディターとして設定されています。=EDITOR= 環境変数はホーム設定でnvimに設定されていますが、一部のコンテキスト(最小限の環境での=git commit= など)ではセッションの環境変数を引き継がない場合があります。gitconfigで明示的に設定することで一貫した動作を保証します。core.editor = "vim";
- カラー
すべてのgitサブコマンドでターミナルのカラーサポートを自動検出します。
color = { status = "auto"; diff = "auto"; branch = "auto"; interactive = "auto"; grep = "auto"; };
- デフォルトブランチ
init.defaultBranch = "main";
- 強制プッシュの安全対策
push.useForceIfIncludesは強制プッシュの安全チェックを有効にします。gitはローカルブランチがリモートの現在のtipを含んでいるか確認してから強制プッシュを許可します。これにより、最後のfetch以降に他の人がプッシュしたコミットを誤って上書きすることを防ぎます。=–force-with-lease= だけでは、リモートrefがバックグラウンドで更新された場合(例: lazygitの定期的なfetchやバックグラウンドの=git fetch=)に検出できません。push.useForceIfIncludes = true;
- URLの書き換え
url."[email protected]:".pushInsteadOfはプッシュURLをHTTPSからSSHに書き換えます。これにより=git clone https://github.com/…= がSSHなしで動作し(CIや一時的な環境で有用)、プッシュは常にSSH認証を使用するため、パーソナルアクセストークンが不要になります。実際には、
ghが独自の認証ヘルパーを提供し、HTTPS認証を透過的に処理するため、この書き換えルールはGitHubリポジトリでは実行されないかもしれません。=gh= が利用できない環境のための意図的なフォールバックとして保持されています。url."[email protected]:".pushInsteadOf = "https://github.com/";
- ユーザーID
- コミット署名
SSHベースのコミット署名です。SSHキーはプッシュ認証にすでに必要なため、別途GPGキーチェーンを管理する必要がなくなることからGPGよりSSHキーが選ばれました。GitのSSH署名サポート(Git 2.34で追加)は、よりシンプルな鍵管理でGPG署名と同じ整合性保証を提供します。認証と署名の両方に1つの鍵ペアで対応できます。
GitHubは2022年8月からSSHコミット検証をサポートしており、2024年11月から検証結果がサーバー側に永続化されるようになりました。この永続的検証により、SSH署名の主な懸念点であった鍵のローテーションによる過去の署名の無効化が解消され、長期的なIDの保証におけるGPGの主な利点がなくなりました。
将来的には、gitsign(Sigstoreベースの署名)のようなキーレスソリューションに移行することで、鍵管理を完全に不要にしワークフローをさらに簡素化できます。GitHubがSigstore検証をネイティブサポートするのを待っている状態です。
signByDefault = trueはすべてのコミットを=git commit -S= なしで署名し、未署名のコミットが紛れ込むのを防ぎます。signing = { format = "ssh"; key = "~/.ssh/id_ed25519.pub"; signByDefault = true; };
- グローバルIgnore
すべてのリポジトリでコミットすべきでないパターンです。リポジトリごとの
.gitignoreエントリではなくグローバルignoreとしているのは、個人的なツール選択を反映しており、共同作業者に押し付けるべきではないためです。ignores = [ <<git-ignores-os>> <<git-ignores-dev>> <<git-ignores-workflow>> <<git-ignores-private>> ];
- OSアーティファクト
macOS Finderのメタデータファイルです。LinuxとmacOSの両方で使用されるクロスプラットフォームなdotfilesリポジトリのため、グローバルignoreに含めています。
".DS_Store" - 開発環境
ローカルに留めるべき開発ツールが生成するアーティファクトです:
.aider*はaiderの会話履歴と設定ファイルにマッチします。 セッション固有のコンテキストを含むため、リポジトリに漏れるべきではありません。.direnv=、.envrc=: direnvの状態と設定。各プロジェクトが独自の.envrcを定義できますが、このリポジトリではflakeベースのdevshellを使用するため、.envrcファイルは自動生成されコミットすべきではありません。.ipynb_checkpoints: Jupyter Notebookの自動保存ファイル。.pre-commit-config.yaml: コミットではなくdevshell環境でプロジェクトごとに管理し、 ツールバージョンの異なるコントリビューター間のバージョン競合を避けます。.vscode/: 開発者ごとに異なるエディター固有の設定。__pycache__/: Pythonバイトコードキャッシュ。実行ごとに再生成されます。
".aider*" ".direnv" ".envrc" ".ipynb_checkpoints" ".pre-commit-config.yaml" ".vscode/" "__pycache__/"
- ワークフロー
.worktree: git worktreeワークフローで使用されるマーカーファイル。
".worktree" - プライベートノート
.private/は個人的なメモ、LLMコンテキストファイル、その他の共有すべきでないローカル専用のドキュメントのためのディレクトリです。".private/"
- OSアーティファクト
- Scalar
Scalarは大規模リポジトリのgitパフォーマンスを最適化します。600,000件以上のコミットを持つnixpkgsリポジトリ向けに特に有効化されており、Scalarのバックグラウンドメンテナンス(prefetch、commit-graph、loose-objects)とファイルシステムモニターの統合から大きな恩恵を受けます。
Scalarモジュール(=programs.git.scalar=)はhome-manager/git-scalar.nixで定義されたカスタムhome-managerモジュールで、gitの組み込みパフォーマンス最適化(multipack index、preload index、untracked cache、fsmonitor)を設定します。
scalar = { enable = true; repo = [ "${config.programs.git.settings.ghq.root}/github.com/natsukium/nixpkgs" ]; };
- GitHub CLI
gh(GitHub CLI)はgitとともに有効化されています。認証ヘルパー(
programs.gh.gitCredentialHelper.enable、デフォルトで有効)を提供し、GitHubリポジトリのHTTPS認証を透過的に処理するためです。これがpushInsteadOf設定が実際には実行されないかもしれない理由です。=gh= の認証コンテキストはHTTPS経由のfetchとpushの両方をカバーします。programs.gh.enable = true;
- Delta
deltaはターミナルでシンタックスハイライト付きのdiffを提供し、行番号やサイドバイサイド表示をサポートします。クリーンな視覚的表現が選定理由です。
programs.delta = { enable = true; enableGitIntegration = true; };
- Difftastic
Difftasticは、行単位の比較ではなくAST(抽象構文木)レベルで動作する構造的差分ツールです。関数の移動や変数のリネームを、削除と挿入のブロックではなく、単一の意味的変更として認識します。これはJSXのリファクタリング、インデントの変更、ネストされたタグの再構成において特に有用で、行ベースの差分ではノイズが多く読みにくい出力になる場面で力を発揮します。
difftasticとdeltaの両方を併用しているのは、それぞれ補完的な役割を持つためです。deltaは日常的な操作(=git diff=、=git log=)でGitの組み込み行差分にシンタックスハイライトを追加し、difftasticは構造的な理解が重要な場面でlazygit経由で使用します。
programs.difftastic = { enable = true; };
- Lazygit
LazygitはGitのターミナルUIです。個別のhunkのステージング、インタラクティブリベース、コンフリクト解決といった対話的操作では、視覚的なフィードバックループがエラーを大幅に減らすため、生のGitコマンドではなくTUIを選択しました。以前はgituiを使用していましたが、より広い機能セットを持つlazygitに移行しました。gituiのパフォーマンス上の優位性は実際には現れず、ワークフローに不可欠な操作がいくつか欠けていました。
nixpkgsのような大規模リポジトリではパフォーマンスが顕著に低下しますが、操作性と活発な開発により、このトレードオフにもかかわらずワークフローの信頼できる一部となっています。
programs.lazygit = { enable = true; settings = { <<lazygit-gui>> <<lazygit-git>> }; };
- GUI
視認性向上のため、lazygitのインターフェースでNerd Fontアイコンを有効にします。
gui = { showIcons = true; };
- Git連携
overrideGpg = trueは、lazygitにGPG/SSH署名用のサブプロセスを生成する代わりにGitコマンドをインラインで実行するよう指示します。デフォルトでは、lazygitはユーザーが対話的にパスフレーズを入力できるようサブプロセスに委譲します。しかし、このサブプロセスモードではlazygitが内部でインタラクティブリベースを制御できなくなります。リベース中に複数の署名プロンプトが発生し、lazygitがそれを処理できないため、HEAD以外のコミットのリワード、並べ替え、編集が完全に無効化されます。=overrideGpg = true= を設定すると、lazygitは署名エージェント(ssh-agent、macOS Keychain)がパスフレーズをキャッシュしていると想定するため、対話的プロンプトが不要になり、すべてのリベース操作が正常に動作します。ページャー設定により、deltaとdifftasticの両方がlazygitの差分ビューに統合されます。Deltaはシンタックスハイライト付きの行差分を提供し(lazygitが独自にページングを行うため
--dark --paging=neverを指定)、difftasticは構造的比較のための外部diffコマンドとして利用できます。git = { overrideGpg = true; pagers = [ { colorArg = "always"; pager = "delta --dark --paging=never"; } { externalDiffCommand = "difft --color=always"; } ]; };
- GUI
- Fishの略語
頻繁に使うgit操作のシェル略語です。エイリアスではなく略語を使用しているのは、fishが実行前にインラインで展開するため、履歴に実際のコマンドが表示され、実行前の修正も可能になるためです。
programs.fish.shellAbbrs = { <<git-abbr-push>> <<git-abbr-pull>> <<git-abbr-commit>> <<git-abbr-status>> <<git-abbr-stash>> <<git-abbr-switch>> };
- Push
lease付きの強制プッシュです。まだfetchされていないリモートの変更の上書きを防ぐため、=–force= よりも安全です。
gpf = "git push --force-with-lease";
- Pull
gpmはリモートのデフォルトブランチからpullします。=main= やmasterをハードコードするのではなく、=git remote show= で動的に検出します。これにより=master= や他のブランチ命名規約を使用するリポジトリにも対応できます。gpuはupstreamからpullします。フォークワークフローでオリジナルのリポジトリと同期するために使用されます。gpm = "git pull (git remote show origin | sed -n '/HEAD branch/s/.*: //p')"; gpu = "git pull upstream";
- Commit
gciはコミットを作成します。末尾のスペースにより-m "message"を直接追加できます。gcaは直前のコミットを修正します。インタラクティブrebaseのワークフローで頻繁に使用されます。gci = "git commit "; gca = "git commit --amend";
- Status
gs = "git status";
- Stash
gst = "git stash"; gstp = "git stash pop";
- Switch
gsw = "git switch"; gswc = "git switch -c";
- Push
- コア設定
3.3.7. ブラウザー
- Zen Browser
Zen Browserはプライバシーとカスタマイズに焦点を当てたFirefoxベースのブラウザです。Firefoxの拡張機能エコシステムと
about:configがブラウザの動作をより深く制御でき、NixエコシステムにはFirefoxのプロファイルをhome-managerで宣言的に管理する成熟したツールがあるため、ChromiumベースのブラウザよりFirefox派生が選ばれました。Zen Browserは、Firefoxの完全な互換性を保ちつつUI/UXが改善されているため、素のFirefoxより選ばれました。拡張機能、検索エンジン、プロファイル設定は同じように動作します。
{ inputs, config, lib, pkgs, ... }: let cfg = config.my.programs.zen-browser; in { imports = [ inputs.zen-browser.homeModules.beta ]; options.my.programs.zen-browser = { enable = lib.mkEnableOption "Zen Browser"; }; config = lib.mkIf cfg.enable { programs.zen-browser = { enable = true; profiles.natsukium = { <<zen-browser-settings>> <<zen-browser-search>> <<zen-browser-extensions>> }; }; }; }
- 設定
ユーザープロンプトなしで拡張機能を自動インストールします。デフォルトでは、Firefoxはプロファイル経由でインストールされる各拡張機能に確認ダイアログを表示します。=extensions.autoDisableScopes= を0に設定するとこの動作が無効になり、完全に宣言的な拡張機能管理に必要です。そうしないと、プロファイル再ビルド後の初回起動時にすべての拡張機能について手動承認が必要になります。
settings = { "extensions.autoDisableScopes" = 0; };
- 検索エンジン
開発関連のパッケージレジストリやドキュメントに素早くアクセスするためのカスタム検索エンジンです。各エンジンには短いエイリアス(例: =@np=)が割り当てられており、アドレスバーで使用でき、各サイトに手動で移動する必要がなくなります。
search = { force = true; engines = { <<zen-browser-search-engine-nix-packages>> <<zen-browser-search-engine-nixos-wiki>> <<zen-browser-search-engine-noogle>> <<zen-browser-search-engine-crates-io>> <<zen-browser-search-engine-npm>> <<zen-browser-search-engine-pypi>> }; };
- Nixパッケージ
公式のNixOS/nixpkgsリポジトリを検索します。変更や利用不能になる可能性のある外部URLに依存しないよう、アイコンにはnixpkgsの=nixos-icons= を使用しています。
nix-packages = { name = "Nix Packages"; urls = [ { template = "https://search.nixos.org/packages"; params = [ { name = "type"; value = "packages"; } { name = "query"; value = "{searchTerms}"; } ]; } ]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@np" ]; };
- NixOS Wiki
NixOSコミュニティwikiで設定例やトラブルシューティングガイドを検索します。
nixos-wiki = { name = "NixOS Wiki"; urls = [ { template = "https://wiki.nixos.org/w/index.php?search={searchTerms}"; } ]; icon = "https://wiki.nixos.org/favicon.ico"; definedAliases = [ "@nw" ]; };
- noogle
noogleはNix関数の検索エンジンで、HaskellにおけるHoogleに相当します。Nix式を書く際に型シグネチャや名前でライブラリ関数を見つけるのに便利です。
noogle = { name = "noogle"; urls = [ { template = "https://noogle.dev/q?term={searchTerms}"; } ]; icon = "https://noogle.dev/favicon.png"; definedAliases = [ "@noogle" ]; };
- crates.io
Rustパッケージレジストリでcrateの検索とバージョン情報を調べます。
crates-io = { name = "crates.io"; urls = [ { template = "https://crates.io/search?q={searchTerms}"; } ]; icon = "https://crates.io/favicon.ico"; definedAliases = [ "@crates" ]; };
- npm
npmレジストリでJavaScript/TypeScriptパッケージを検索します。
npm = { name = "npm"; urls = [ { template = "https://www.npmjs.com/search?q={searchTerms}"; } ]; icon = "https://www.google.com/s2/favicons?domain=npmjs.com&sz=64"; definedAliases = [ "@npm" ]; };
- PyPI
Python Package IndexでPythonパッケージを検索します。
pypi = { name = "PyPI"; urls = [ { template = "https://pypi.org/search/?q={searchTerms}"; } ]; icon = "https://pypi.org/favicon.ico"; definedAliases = [ "@pypi" ]; };
- Nixパッケージ
- 拡張機能
宣言的に管理されるブラウザ拡張機能です。拡張機能は2つのoverlayで提供されるセットから取得されます。=firefox-addons=(NUR firefox-addonsリポジトリから)と =my-firefox-addons=(アップストリームにないカスタムの追加)です。
extensions = { packages = (with pkgs.firefox-addons; [ bitwarden instapaper-official keepa onepassword-password-manager refined-github vimium violentmonkey wayback-machine zotero-connector ]) ++ (with pkgs.my-firefox-addons; [ adguard-adblocker calilay kiseppe-price-chart-kindle ]); };
- 設定
3.3.8. エディター
- Neovim
Neovim is the editor I spend the most time in, primarily for coding — though the gravitational pull of
org-modeis slowly dragging me over to Emacs.Everything Neovim-related lives under
flake/features/neovim/: the wrapped derivation (package.nix) and the lua configuration. The flake-parts module pulls double duty from a single file:perSystem.packages.neovimmakesnix run .#neovimwork on every supported system.flake.homeManagerModules.neovimlets a home-manager config opt in withmy.programs.neovim.enable, which installs the wrapped Neovim plusneovim-remoteand exportsEDITOR=nvim.
{ ... }: { flake.homeManagerModules.neovim = { config, lib, pkgs, ... }: { options.my.programs.neovim.enable = lib.mkEnableOption "neovim"; config = lib.mkIf config.my.programs.neovim.enable { home.packages = [ (pkgs.callPackage ./package.nix { }) pkgs.neovim-remote ]; home.sessionVariables.EDITOR = "nvim"; }; }; perSystem = { pkgs, ... }: { packages.neovim = pkgs.callPackage ./package.nix { }; }; }
- Emacs
Emacs has been my second-most-used editor since early 2026. The draw is
org-mode— the workflows built aroundorg-captureandorg-agendaare slowly winning me over, and a widening set of daily inputs (email, RSS feeds, and more) now lives inside emacs, where the ongoing experiment is wiring each of them back into org.The feature lives alongside Neovim under
flake/features/emacs/and pulls the same double duty:perSystem.packages.emacsexposes a wrapped emacs as a flake output.init.orgis pre-tangled intodefault.eland passed toemacsWithPackagesFromUsePackagesonix run .#emacsloads the full config without home-manager.flake.homeManagerModules.emacsaddsmy.programs.emacs.enablefor home-manager hosts, wiring upservices.emacs(daemon), the tangled~/.config/emacs/{init,early-init}.el, and the encrypted~/.authinfo.age.
# Requires: inputs.emacs-overlay { lib, inputs, ... }: let withEmacsOverlay = pkgs: pkgs.extend inputs.emacs-overlay.overlays.default; emacsUnwrapped = pkgs: let epkgs = withEmacsOverlay pkgs; in if pkgs.stdenv.hostPlatform.isDarwin then epkgs.emacs-plus else epkgs.emacs-pgtk; # Pass target-file to org-babel-tangle-file so blocks without an explicit # :tangle header still get tangled; emacs-overlay's defaultInitFile path # calls plain org-babel-tangle, which would tangle 0 blocks here. tangle = pkgs: { name, org, }: pkgs.runCommand name { nativeBuildInputs = [ (emacsUnwrapped pkgs) ]; } '' cp ${org} tmp.org emacs -Q --batch --eval \ "(progn (require 'ob-tangle) (org-babel-tangle-file \"tmp.org\" \"emacs-lisp\"))" install emacs-lisp $out ''; tangleEl = pkgs: org: let stem = name: lib.head (lib.splitString "." name); in tangle pkgs { name = "${stem (baseNameOf (toString org))}.el"; inherit org; }; mkEmacs = pkgs: (withEmacsOverlay pkgs).callPackage ./package.nix { defaultInitFile = tangle pkgs { name = "default.el"; org = ./init.org; }; org-clickup-src = inputs.org-clickup; }; in { flake.homeManagerModules.emacs = { config, lib, pkgs, ... }: { options.my.programs.emacs.enable = lib.mkEnableOption "emacs"; config = lib.mkIf config.my.programs.emacs.enable { programs.emacs = { enable = true; package = mkEmacs pkgs; }; services.emacs = { enable = true; client.enable = true; }; xdg.configFile."emacs/init.el".source = tangleEl pkgs ./init.org; xdg.configFile."emacs/early-init.el".source = tangleEl pkgs ./early-init.org; home.file.".authinfo.age".source = ./authinfo.age; home.shellAliases = lib.optionalAttrs pkgs.stdenv.hostPlatform.isDarwin { emacs = "${config.programs.emacs.package}/Applications/Emacs.app/Contents/MacOS/Emacs"; }; }; }; perSystem = { pkgs, ... }: { packages.emacs = mkEmacs pkgs; }; }
# Bundle the tangled init.org as default.el so the package is usable # standalone (e.g. `nix run .#emacs`); a home-manager-managed # ~/.config/emacs/init.el still takes precedence when present. { stdenv, age, beancount, beancount-language-server, emacs-pgtk, emacs-plus, emacsWithPackagesFromUsePackage, gettext, nixd, nixfmt, notmuch, terraform-ls, yaml-language-server, defaultInitFile, org-clickup-src, }: let emacs-unwrapped = if stdenv.hostPlatform.isDarwin then emacs-plus else emacs-pgtk; in emacsWithPackagesFromUsePackage { package = emacs-unwrapped; config = ./init.org; alwaysTangle = true; inherit defaultInitFile; override = epkgs: epkgs // { org-clickup = epkgs.melpaBuild { pname = "org-clickup"; ename = "org-clickup"; version = builtins.substring 0 8 (org-clickup-src.lastModifiedDate or "00000000"); commit = org-clickup-src.shortRev or "unknown"; files = ''("lisp/*.el")''; src = org-clickup-src; }; }; extraEmacsPackages = epkgs: [ epkgs.treesit-grammars.with-all-grammars notmuch.emacs age beancount beancount-language-server gettext nixd nixfmt yaml-language-server terraform-ls ]; }
- early-init.org
- disable some bars
The tool bar duplicates functionality already accessible via keybindings and the menu bar, while the vertical scroll bar wastes horizontal space without providing useful navigation—line numbers and modeline indicators are more precise. Setting these in
default-frame-alistrather than callingtool-bar-mode/scroll-bar-modeavoids a brief flash of the bars during startup before the modes disable them.(push '(tool-bar-lines . 0) default-frame-alist) (push '(vertical-scroll-bars) default-frame-alist)
- turn off the annoying bell
The default audible bell is distracting and provides no actionable information. Replacing it with
ignoresilences it entirely; a visual bell (visible-bell) was not chosen because the screen flash is equally disruptive.(setq ring-bell-function 'ignore) - disable backup files
Emacs already skips backup files for version-controlled files by default (
vc-make-backup-filesisnil), but files outside of a repository still produce backups. Since virtually all editing happens in Git-managed trees, the remaining cases are rare enough that the clutter outweighs the safety net. Auto-save files are likewise redundant when unsaved work can be recovered through Git stashes or reflog.(setq make-backup-files nil) (setq auto-save-default nil)
- disable lock files
Lock files (
.#filename) prevent concurrent editing across multiple Emacs instances, but in a single-instance workflow they only clutter the working directory and interfere with file watchers and build tools.(setq create-lockfiles nil)
- disable some bars
- init.org
- basic
(add-to-list 'default-frame-alist '(undecorated-round . t)) (use-package doom-themes :ensure t :config (load-theme 'doom-nord :no-confirm))
Enable visual-line-mode globally instead of using auto-fill-mode here to preserve logical line structure while still wrapping long lines visually for better readability without modifying the actual file.
(visual-line-mode 1)
Highlight the cursor line.
(global-hl-line-mode 1)
Accept single-character
y/nresponses instead of requiring the full wordyes/no.(setq use-short-answers t)- Customize file
Emacs defaults
custom-filetoinit.el, but hereinit.elis a read-only symlink into the Nix store, so anything Customize tries to persist would fail to write. Stateful files like this must live outside Nix management to stay mutable: pointcustom-fileat a writable path underuser-emacs-directory(the directory itself is writable; only the symlinked files are not) and load it so the saved values take effect.(setq custom-file (locate-user-emacs-file "custom.el")) (when (file-exists-p custom-file) (load custom-file nil t))
- Font
Moralerspace is a monaspace-based composite font family that pairs a Latin programming typeface with Japanese glyphs. Each variant—Argon, Krypton, Radon, Xenon—has its own typographic character, so assigning a different variant to each face produces visually distinct bold, italic, and bold-italic rendering without relying on Emacs's synthetic transformations.
:weight 'normaland:slant 'normalprevent Emacs from further synthesizing bold or italic on top of the variant's own design.font-lock-comment-faceuses Radon (the italic variant) to give code comments a softer, visually distinct appearance.(set-face-attribute 'default nil :family "Moralerspace Argon HW" :height 140) (set-face-attribute 'bold nil :family "Moralerspace Krypton HW" :weight 'normal) (set-face-attribute 'italic nil :family "Moralerspace Radon HW" :slant 'normal) (set-face-attribute 'bold-italic nil :family "Moralerspace Xenon HW" :weight 'normal :slant 'normal) (set-face-attribute 'font-lock-comment-face nil :family "Moralerspace Radon HW" :slant 'normal)
Without an explicit
set-language-environment, Emacs may select a Chinese font for CJK characters based on locale order, causing Japanese text to render with Chinese glyphs.(set-language-environment "Japanese") - Nix wrapper paths
The Nix Emacs wrapper (
extraEmacsPackages) adds binaries toexec-paththat are absent from the shell'sPATH. Both exec-path-from-shell and envrc replaceexec-pathduring operation, losing these entries. Capturing them once at init allows both packages to merge them back.(setq my/nix-exec-path exec-path) - Darwin
On macOS, Emacs cannot inherit environment variables (such as
$PATH) from the shell, so exec-path-from-shell is needed as a workaround. emacs-plus injects PATH into Emacs's Info.plist, so applying that patch might eliminate the need for this package.exec-path-from-shell-initializereplacesexec-pathwith the login shell'sPATH. Mergingmy/nix-exec-pathback after initialization preserves wrapper-provided paths.When launched from an application launcher (Dock, Spotlight), Emacs inherits only the minimal launchd environment, which lacks Nix-related variables. Without these,
direnv exportmay produce incomplete results. (envrc#92)Separately, fish sources
conf.d/*.fisheven for non-interactive invocations (fish -c "..."). nix-darwin places environment setup scripts there that re-initialize PATH from system profiles when guard variables (__fish_nixos_env_preinit_sourced,__NIX_DARWIN_SET_ENVIRONMENT_DONE,__HM_SESS_VARS_SOURCED) are absent. Without propagating these guards, subprocesses spawned bycompileorshell-commandlose the buffer-local PATH that envrc constructed—even though envrc itself applied the correct environment.(use-package exec-path-from-shell :ensure t :config (when (memq window-system '(mac ns x)) (dolist (var '("SSH_AUTH_SOCK" "SSH_AGENT_PID" "GPG_AGENT_INFO" "LANG" "LC_CTYPE" "NIX_SSL_CERT_FILE" "NIX_PATH" "__fish_nixos_env_preinit_sourced" "__NIX_DARWIN_SET_ENVIRONMENT_DONE" "__HM_SESS_VARS_SOURCED")) (add-to-list 'exec-path-from-shell-variables var)) (exec-path-from-shell-initialize) (setq exec-path (delete-dups (append exec-path my/nix-exec-path)))))
- envrc
envrc.el provides buffer-local environment variables based on direnv. This enables Emacs to recognize project-specific development environments managed by direnv.
Unlike direnv.el which sets environment variables globally, envrc.el keeps them buffer-local. This is essential when working on multiple projects simultaneously, each with its own .envrc.
The mode must be enabled early (via after-init hook) so that other packages can inherit the correct environment.
When envrc updates a buffer's environment, it replaces
exec-pathwith values fromdirenv export, losing the Nix wrapper paths. (envrc#9) Mergingmy/nix-exec-pathback after each update preserves access to wrapper-provided executables (e.g. yaml-language-server) inside direnv-managed buffers.(use-package envrc :ensure t :hook (after-init . envrc-global-mode) :config (advice-add 'envrc--update :after (defun my/envrc-preserve-nix-path (&rest _) (when (local-variable-p 'exec-path) (setq-local exec-path (delete-dups (append exec-path my/nix-exec-path)))))))
- Customize file
- UI
- mode-line
(use-package moody :ensure t :config (moody-replace-mode-line-front-space) (moody-replace-mode-line-buffer-identification) (moody-replace-vc-mode))
- headerline
(use-package breadcrumb :ensure t :config (breadcrumb-mode))
- indent-bars
indent-bars displays configurable vertical guide bars at each indentation level. Tree-sitter integration is available for scope-aware highlighting, where bars outside the current scope are de-emphasized.
(use-package indent-bars :ensure t :hook (prog-mode . indent-bars-mode))
- mode-line
- minibuffer
Referring to https://protesilaos.com/codelog/2024-11-28-basic-emacs-configuration/
(use-package vertico :ensure t :hook (after-init . vertico-mode))
(use-package marginalia :ensure t :hook (after-init . marginalia-mode))
(use-package orderless :ensure t :config (setq completion-styles '(orderless basic)) (setq completion-category-defaults nil) (setq completion-category-overrides nil))
The built-in savehist package keeps a record of user inputs and stores them across sessions. Thus, the user will always see their latest choices closer to the top (such as with M-x).
(use-package savehist :ensure nil ; it is built-in :hook (after-init . savehist-mode))
(use-package corfu :ensure t :hook (after-init . global-corfu-mode) :bind (:map corfu-map ("<tab>" . corfu-complete)) :config (setq tab-always-indent 'complete) (setq corfu-auto t) (setq corfu-auto-prefix 1) (setq corfu-preview-current nil) (setq corfu-min-width 20) (setq corfu-popupinfo-delay '(1.25 . 0.5)) (corfu-popupinfo-mode 1) ; shows documentation after `corfu-popupinfo-delay' ;; Sort by input history (no need to modify `corfu-sort-function'). (with-eval-after-load 'savehist (corfu-history-mode 1) (add-to-list 'savehist-additional-variables 'corfu-history)))
- embark
(use-package embark :ensure t :bind (("C-." . embark-act) ;; pick some comfortable binding ("C-;" . embark-dwim) ;; good alternative: M-. ("C-h B" . embark-bindings)) ;; alternative for `describe-bindings' :init ;; Optionally replace the key help with a completing-read interface (setq prefix-help-command #'embark-prefix-help-command) ;; Show the Embark target at point via Eldoc. You may adjust the ;; Eldoc strategy, if you want to see the documentation from ;; multiple providers. Beware that using this can be a little ;; jarring since the message shown in the minibuffer can be more ;; than one line, causing the modeline to move up and down: ;; (add-hook 'eldoc-documentation-functions #'embark-eldoc-first-target) ;; (setq eldoc-documentation-strategy #'eldoc-documentation-compose-eagerly) ;; Add Embark to the mouse context menu. Also enable `context-menu-mode'. ;; (context-menu-mode 1) ;; (add-hook 'context-menu-functions #'embark-context-menu 100) :config ;; Hide the mode line of the Embark live/completions buffers (add-to-list 'display-buffer-alist '("\\`\\*Embark Collect \\(Live\\|Completions\\)\\*" nil (window-parameters (mode-line-format . none)))))
- embark
- version control system
- git
(use-package magit :ensure t :bind (("C-x g" . magit-status))) (use-package diff-hl :ensure t :init (global-diff-hl-mode) (diff-hl-flydiff-mode) (add-hook 'dired-mode-hook 'diff-hl-dired-mode) (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh))
- forge
Forge extends Magit to work with GitHub, GitLab, and other forges directly from Emacs—browsing issues, reviewing pull requests, and managing notifications without leaving the editor.
Forge authenticates via
ghub, which reads credentials fromauth-sources. Theauthinfo.agefile should contain a GitHub API token entry:machine api.github.com login <username>^forge password <token>
The token must be a classic personal access token, not a fine-grained one, because the
/notificationsREST endpoints only accept classic tokens. A 6-month expiration is set so the token must be regenerated periodically.Required scopes:
repo— issues and pull requestsnotifications—forge-list-notificationsand notification markinguser— resolve the authenticated user's profileread:org— enumerate organization repositories and teams
(use-package forge :ensure t :after magit)
- consult-gh
consult-gh drives the
ghCLI through a consult interface, so searching repositories, issues, pull requests, and code across GitHub happens from the minibuffer with live preview.Forge already covers issues and pull requests for repositories tracked locally in magit. consult-gh extends that reach to arbitrary repositories: scanning an upstream's recent issues, opening another project's README, or finding a snippet by code search—without first cloning or visiting the repo in magit.
(use-package consult-gh :ensure t :after consult :config (consult-gh-enable-default-keybindings))
consult-gh-embark-modeadds embark actions on results (clone, browse, copy URL, …).(use-package consult-gh-embark :ensure t :after (consult-gh embark) :config (consult-gh-embark-mode +1))
consult-gh-forge-moderoutes issue and PR viewing through forge buffers, keeping the editing surface consistent with the existing magit/forge workflow.(use-package consult-gh-forge :ensure t :after (consult-gh forge) :config (consult-gh-forge-mode +1))
- forge
- git
- LSP
lsp-mode is a Language Server Protocol client for Emacs. It provides IDE-like features (completion, diagnostics, navigation) by communicating with external language servers.
Eglot is built into Emacs 29+ as a lighter alternative, but it assumes one server per major mode, making it cumbersome to run multiple servers simultaneously on the same buffer (e.g. a language server alongside a linter or formatter). lsp-mode handles multiple concurrent servers natively and provides more granular control over LSP behavior.
Using
lsp-deferredinstead oflspto delay server startup until the buffer is visible, avoiding unnecessary processes for buffers opened in the background.Disabling
lsp-headerline-breadcrumb-modeto avoid conflict with the existingbreadcrumbpackage in the header line.(use-package lsp-mode :ensure t :commands (lsp lsp-deferred) :init (setq lsp-keymap-prefix "C-c l") :config (setq lsp-headerline-breadcrumb-enable nil))
- language support
- tree-sitter
Use maximum font-lock level for tree-sitter modes.
(setq treesit-font-lock-level 4) - treesit-fold
treesit-fold provides code folding driven by the tree-sitter syntax tree, so foldable regions follow real syntactic nodes (functions, blocks, comments) rather than indentation heuristics.
global-treesit-fold-modeactivates it automatically in every supported tree-sitter mode.TAB is rebound to a wrapper that mimics
org-cycle: when point sits on a foldable node, the fold is toggled; otherwise the originalindent-for-tab-commandruns, so ordinary indentation in code keeps working.Language-specific fold rules (e.g. Nix
let ... inblocks) live with their respective language sections rather than here, so the catalogue of foldable nodes per language stays next to the rest of that mode's setup.(use-package treesit-fold :ensure t :hook (after-init . global-treesit-fold-mode) :preface (defun my/treesit-fold-toggle-or-indent () "Toggle the fold at point when on a foldable node; otherwise indent." (interactive) (if (treesit-fold--foldable-node-at-pos) (treesit-fold-toggle) (indent-for-tab-command))) :bind (:map treesit-fold-mode-map ("TAB" . my/treesit-fold-toggle-or-indent)))
- Beancount
beancount-mode is the major mode bundled with Beancount. LSP integration uses beancount-language-server via lsp-mode's bundled
lsp-beancountclient.Upstream only auto-registers
.beancount, so.beanis added explicitly here for the common short extension.(use-package beancount :ensure t :mode ("\\.bean\\(count\\)?\\'" . beancount-mode) :hook (beancount-mode . lsp-deferred))
- CSV
csv-mode provides a major mode for editing csv and tsv files.
(use-package csv-mode :ensure t)
- Markdown
https://github.com/jrblevin/markdown-mode
markdown-mode is a major mode for editing Markdown-formatted text.
First, enable
markdown-fontify-code-blocks-nativelyso fenced code blocks are highlighted by each language's major mode. A```nixblock then reads like a real Nix buffer rather than a flat monochrome region.Also enable
markdown-marginalize-headersto push leading#characters into the left margin. Header text then starts at the same column across all depths, keeping the outline aligned with body paragraphs.Finally, set
markdown-indent-on-enterto'indent-and-new-itemsoRETinside a list inserts the next bullet or number at the correct indent level.(use-package markdown-mode :ensure t :mode ("README\\.md\\'" . gfm-mode) :init (setq markdown-command "multimarkdown") :bind (:map markdown-mode-map ("C-c C-e" . markdown-do)) :config (setq markdown-header-scaling t) (setq markdown-fontify-code-blocks-natively t) (setq markdown-marginalize-headers t) (setq markdown-indent-on-enter 'indent-and-new-item))
- Nix
https://github.com/nix-community/nix-ts-mode
Tree-sitter based major mode for Nix expressions.
nixd (configured via lsp-mode) provides IDE features for Nix expressions by interoperating with the C++ Nix evaluator. Unlike nil which relies on static analysis, nixd performs actual Nix evaluation, enabling accurate completion for attribute paths (e.g.
pkgs.), NixOS options, and flake inputs.The bundled
treesit-fold-parsers-nixonly knows about attrsets, interpolations, lists, and comments. Two extra rules are registered here solet ... inblocks and indented (''...'') multi-line strings fold as well.(use-package nix-ts-mode :ensure t :mode "\\.nix\\'" :hook (nix-ts-mode . lsp-deferred) :init ;; org-src-lang-modes is defined in org-src, which may not be loaded yet at init time (with-eval-after-load 'org-src (add-to-list 'org-src-lang-modes '("nix" . nix-ts))) :config (setq lsp-nix-nixd-formatting-command ["nixfmt"]) (with-eval-after-load 'treesit-fold (setf (alist-get 'nix-ts-mode treesit-fold-range-alist) (append (alist-get 'nix-ts-mode treesit-fold-range-alist) `((let_expression . ,(lambda (node offset) (treesit-fold-range-markers node offset "let" "in"))) (indented_string_expression . ,(lambda (node offset) (treesit-fold-range-markers node offset "''" "''"))))))))
- Terraform
terraform-mode provides syntax highlighting and indentation for Terraform (HCL) files.
No tree-sitter variant is available in MELPA, so using the traditional major mode.
terraform-ls (configured via lsp-mode) provides IDE features such as completion, diagnostics via
terraform validate, and go-to-definition for Terraform configurations.(use-package terraform-mode :ensure t :hook (terraform-mode . lsp-deferred))
- PO
po-mode is Emacs's major mode for editing GNU gettext PO (Portable Object) files. PO files store translations for software internationalization.
Editing PO files as plain text is error-prone because the format has strict requirements for escaping and structure. po-mode provides structured navigation between entries, automatic validation, and prevents common formatting errors.
- Common Operations
PO mode is not derived from text mode. The buffer is read-only and has its own keymap, so standard text editing commands do not work directly. Translations must be edited through the subedit buffer (
RET).- Main Commands
Commands for file operations, validation, and general PO mode management.
Key Function Description _po-undoUndo last modification qpo-confirm-and-quitQuit with confirmation ?hpo-helpShow help about PO mode Use or
qto quit instead ofC-x k(kill-buffer), as they properly handle unsaved changes and warn about untranslated entries.See Main PO mode Commands for more details.
- Entry Positioning
Commands for navigating between entries in the PO file.
Key Function Description npo-next-entryMove to next entry ppo-previous-entryMove to previous entry <po-first-entryMove to first entry >po-last-entryMove to last entry See Entry Positioning for more details.
- Modifying Translations
Commands for editing translation strings. Press
RETto open a subedit buffer where standard Emacs editing works normally.Key Function Description RETpo-edit-msgstrOpen subedit buffer for editing C-c C-cpo-subedit-exitFinish editing and apply changes C-c C-kpo-subedit-abortAbort editing and discard changes DELpo-fade-out-entryDelete the translation See Modifying Translations for more details.
- Main Commands
- Configuration
(use-package po-mode :ensure t)
- Common Operations
- Protocol Buffers
protobuf-ts-mode is a tree-sitter-based major mode for editing proto3 files.
The mode auto-registers
.protofiles when theprotogrammar is available.(use-package protobuf-ts-mode :ensure t)
- Justfile
just-ts-mode is a tree-sitter-based major mode for editing just command runner files.
C-c 'opens a dedicated editing buffer for the recipe body at point, with automatic shebang-based language detection.(use-package just-ts-mode :ensure t)
- YAML
yaml-ts-modeis a built-in tree-sitter-based major mode for YAML files. The tree-sitter grammar is already available viatreesit-grammars.with-all-grammars, so the mode activates automatically when the grammar is present.yaml-language-server (configured via lsp-mode) provides schema validation using SchemaStore. For example, files under
.github/workflows/are automatically matched to the GitHub Actions workflow schema, enabling completion and diagnostics for workflow definitions.(use-package yaml-ts-mode :ensure nil :mode ("\\.ya?ml\\'") :hook (yaml-ts-mode . lsp-deferred))
- tree-sitter
- org
- Semantic Line Breaks
Semantic Line Breaks (SemBr) is a writing convention where line breaks are placed at logical boundaries in sentences, such as after punctuation marks or between phrases. This makes diffs more meaningful in version control and improves readability without affecting the rendered output.
The recommended line length is around 80 characters. I set this as an upper limit in the editor to prevent lines from becoming unnecessarily long.
(add-hook 'text-mode-hook (lambda () (auto-fill-mode 1) (setq fill-column 80))) - org-capture
(global-set-key (kbd "C-c c") 'org-capture) (global-set-key (kbd "C-c l") 'org-store-link) (setq org-root "~/dropbox/org/") (setq org-capture-templates `(("t" "Todo" entry (file+headline ,(concat org-root "todo.org") "Tasks") "* TODO %?\n %i\n %a") ("j" "Journal" entry (file+olp+datetree ,(concat org-root "journal.org")) "* %U\n%?\n %i\n %a") ("f" "Fleeting" entry (file ,(concat org-root "fleeting.org")) "* %?\n %U\n %i\n %a")))
- org-agenda
(global-set-key (kbd "C-c a") 'org-agenda) (setq org-agenda-files '("~/dropbox/org"))
- org-gcal
org-gcal provides bidirectional sync between Google Calendar and Org files via the native Google Calendar API.
(use-package org-gcal :ensure t :defer t)
Prerequisites for this configuration to function:
- On the personal Cloud Project, the Google Calendar API is enabled
and
https://www.googleapis.com/auth/calendaris added to the OAuth consent screen scopes. ~/.authinfo.agecontains entries:machine org-gcal login client-id password <client-id> machine org-gcal login client-secret password <client-secret>
org-gcal registers an
oauth2-autoprovider entry at package load time only when bothorg-gcal-client-idandorg-gcal-client-secretare already set; otherwise it skips registration and warns. Since these variables are populated after the package loads,org-gcal-reload-client-id-secretmust be called explicitly to perform the registration with the populated values.(with-eval-after-load 'org-gcal (setq org-gcal-client-id (auth-source-pick-first-password :host "org-gcal" :user "client-id")) (setq org-gcal-client-secret (auth-source-pick-first-password :host "org-gcal" :user "client-secret")) (org-gcal-reload-client-id-secret))
org-gcal supports only one global OAuth client. To sync calendars from multiple accounts, share the secondary calendars to the authorized account via Google Calendar's sharing UI with "Make changes to events" permission.
(with-eval-after-load 'org-gcal (setq org-gcal-fetch-file-alist `(("[email protected]" . ,(concat org-root "gcal-personal.org")) ("[email protected]" . ,(concat org-root "gcal-work.org")))))
The empty-file pre-creation works around emacs-oauth2-auto issue #6: when
~/.config/emacs/contains symlinks (here from home-manager managing other emacs config files), oauth2-auto's first write to the plstore fails an internal file/buffer identity check. Pre-creating the file before the first sync lets that check succeed.(with-eval-after-load 'oauth2-auto (unless (file-exists-p oauth2-auto-plstore) (write-region "" nil oauth2-auto-plstore)))
org-gcal stores one plstore entry per calendar ID and each one is read on every sync to retrieve the access token, so without passphrase caching the user is prompted by pinentry multiple times per sync.
plstore-cache-passphrase-for-symmetric-encryptioncaches the passphrase within the Emacs session to reduce this to a single prompt after Emacs restart.(setq plstore-cache-passphrase-for-symmetric-encryption t) - On the personal Cloud Project, the Google Calendar API is enabled
and
- org-clickup
org-clickup is a personal package that bidirectionally syncs ClickUp tasks with org-mode TODO entries. Work tasks live in ClickUp, but the authoritative planning surface is org-mode (agenda, capture, refile) so daily triage stays in Emacs instead of switching to a browser tab.
The API token must live in
~/.authinfo.ageas:machine api.clickup.com login <workspace-id> password <token>
(use-package org-clickup :ensure t :defer t)
- org-roam
(use-package org-roam :ensure t :custom (org-roam-directory "~/dropbox/org-roam") (org-roam-db-location "~/.local/share/org-roam.db") :bind (("C-c n l" . org-roam-buffer-toggle) ("C-c n f" . org-roam-node-find) ("C-c n g" . org-roam-graph) ("C-c n i" . org-roam-node-insert) ("C-c n c" . org-roam-capture) ("C-c n j" . org-roam-dailies-capture-today)) :config (setq org-roam-capture-templates '(("p" "permanent" plain "%?" :target (file+head "permanent/${slug}.org" "#+title: ${title}\n") :unnarrowed t) ("l" "literature" plain "%?" :target (file+head "literature/${title}.org" "#+title: ${title}\n") :unnarrowed t))) (setq org-roam-node-display-template (concat "${title:*} " (propertize "${tags:10}" 'face 'org-tag))) (org-roam-db-autosync-mode) (require 'org-roam-protocol) )
- htmlize
Used when converting Org files to HTML with syntax highlighting for code blocks.
C-c C-e h hexports the current Org buffer to HTML.(use-package htmlize :ensure t)
- Semantic Line Breaks
- document
- pdf-tools
Emacs's built-in DocView mode renders PDFs as rasterized images page-by-page, resulting in blurry text at most zoom levels and lacking interactive features like text selection, incremental search, and annotation.
pdf-tools replaces DocView with a viewer powered by
poppler, providing sharp rendering, isearch integration, annotation support, and SyncTeX for LaTeX workflows.Using
pdf-loader-installinstead ofpdf-tools-installto defer initialization until a PDF is actually opened. With Nix's pre-builtepdfinfobinary, both functions behave identically, but the loader variant avoids unnecessary work at startup.(use-package pdf-tools :ensure t :mode ("\\.pdf\\'" . pdf-view-mode) :config (pdf-loader-install))
- pdf-tools
- RSS
elfeed is a web feed reader for Emacs. Using it with elfeed-protocol to read feeds from Miniflux via the Fever API. This keeps feed management centralized in Miniflux and avoids duplicating the subscription list across devices.
The Fever API must be enabled in Miniflux (Settings -> Integrations -> Fever API) before this configuration will work.
Credentials are stored in
~/.authinfo.age.machine rss.home.natsukium.com login natsukium password <fever-password>"
(use-package elfeed :ensure t :bind ("C-x w" . elfeed)) (use-package elfeed-protocol :ensure t :after elfeed :config (setq elfeed-use-curl t) (setq elfeed-feeds '(("fever+http://[email protected]" :api-url "http://rss.home.natsukium.com/fever/" :use-authinfo t))) (setq elfeed-protocol-enabled-protocols '(fever)) (elfeed-protocol-enable))
- mail
notmuch is a tag-based email indexer and searcher. notmuch.el provides an Emacs interface for reading and organizing email. It reads mail from a local maildir synced by mbsync.
notmuch was chosen over mu4e because the notmuch indexer is already configured for all email accounts. Adding notmuch.el only requires the Emacs frontend, avoiding a second indexer for the same maildir.
notmuch has no built-in delete operation; it manages metadata (tags) rather than maildir folder placement. Pressing
dtags the message with+deletedand removesinbox. The actual deletion happens on the nextnotmuch new: a post-new hook moves tagged files to Gmail's Trash maildir folder after indexing, so the move is synced to the server on the next mbsync run.Dreverses the operation, restoringinboxand removingdeleted. This only works before the nextnotmuch newmoves the file; once mbsync has synced the move, the message is in Gmail's Trash.shr-use-colorsis disabled so sender HTML colors don't clash with the dark theme. Inline CID images ship with the mail and are enabled, butshr-blocked-imagesis set to.(matches every URL) to block remote images, which marketing platforms use as tracking pixels — Gmail's web UI proxies them, but notmuch fetches directly.Irefreshes the current message with blocking disabled when a sender is trusted.notmuch-show-part-button-default-actiondefaults to saving an attachment to disk; I switch it tonotmuch-show-view-partso the part opens with its mailcap viewer instead, letting me press the button on a PDF to open it directly.(use-package notmuch :ensure nil :bind ("C-c M" . notmuch) :custom (notmuch-fcc-dirs nil) (notmuch-search-oldest-first nil) (notmuch-show-part-button-default-action 'notmuch-show-view-part) (notmuch-saved-searches '((:name "inbox" :query "tag:inbox" :key "i") (:name "unread" :query "tag:unread" :key "u") (:name "action" :query "tag:github::action-required" :key "a") (:name "attmcojp" :query "tag:github::attmcojp" :key "w") (:name "github" :query "tag:github and not tag:github::action-required" :key "g") (:name "all" :query "*" :key "A"))) (shr-use-colors nil) (mm-inline-text-html-with-images t) (shr-blocked-images ".") :config (keymap-set notmuch-search-mode-map "d" (lambda () (interactive) (notmuch-search-tag '("+deleted" "-inbox")) (notmuch-search-next-thread))) (keymap-set notmuch-show-mode-map "d" (lambda () (interactive) (notmuch-show-tag '("+deleted" "-inbox")))) (keymap-set notmuch-search-mode-map "D" (lambda () (interactive) (notmuch-search-tag '("-deleted" "+inbox")) (notmuch-search-next-thread))) (keymap-set notmuch-show-mode-map "D" (lambda () (interactive) (notmuch-show-tag '("-deleted" "+inbox")))) (keymap-set notmuch-show-mode-map "I" (lambda () (interactive) (let ((shr-blocked-images nil)) (notmuch-show-refresh-view t)))))
ol-notmuch integrates notmuch with Org mode's link system. Calling
org-store-link(C-c l) in a notmuch buffer stores a link to the current message or thread, which can then be inserted into org-capture templates via%a.(use-package ol-notmuch :ensure t :after (notmuch org))
- terminal
- vterm
emacs-libvterm is a fully-fledged terminal emulator based on libvterm. It provides better performance and compatibility than pure Emacs Lisp alternatives, making it suitable for running interactive CLI tools like Claude Code.
(use-package vterm :ensure t)
- vterm
- encryption
age.el provides transparent encryption and decryption of
.agefiles in Emacs using the age encryption tool.Using SSH keys as identity/recipient so that no separate age keypair is needed.
(use-package age :ensure t :custom (age-default-identity "~/.ssh/id_ed25519") (age-default-recipient "~/.ssh/id_ed25519.pub") :config (age-file-enable) (setq auth-sources '("~/.authinfo.age")))
- AI
- gptel
gptel turns any buffer into a chat with an LLM backend.
Authenticate once with
gptel-openai-oauth-login(ChatGPT device flow); the token is cached under.cache/gptel-openai/inuser-emacs-directory.(use-package gptel :ensure t :config (setq gptel-model 'gpt-5.4-mini gptel-backend (gptel-make-openai-oauth "ChatGPT")))
- gptel
- misc
- vundo
(use-package vundo :ensure t :bind (("C-x u" . vundo)) :config (setq vundo-glyph-alist vundo-unicode-symbols))
- consult
;; Example configuration for Consult (use-package consult :ensure t ;; Replace bindings. Lazily loaded by `use-package'. :bind (;; C-c bindings in `mode-specific-map' ("C-c M-x" . consult-mode-command) ("C-c h" . consult-history) ("C-c k" . consult-kmacro) ("C-c m" . consult-man) ("C-c i" . consult-info) ([remap Info-search] . consult-info) ;; C-x bindings in `ctl-x-map' ("C-x M-:" . consult-complex-command) ;; orig. repeat-complex-command ("C-x b" . consult-buffer) ;; orig. switch-to-buffer ("C-x 4 b" . consult-buffer-other-window) ;; orig. switch-to-buffer-other-window ("C-x 5 b" . consult-buffer-other-frame) ;; orig. switch-to-buffer-other-frame ("C-x t b" . consult-buffer-other-tab) ;; orig. switch-to-buffer-other-tab ("C-x r b" . consult-bookmark) ;; orig. bookmark-jump ("C-x p b" . consult-project-buffer) ;; orig. project-switch-to-buffer ;; Custom M-# bindings for fast register access ("M-#" . consult-register-load) ("M-'" . consult-register-store) ;; orig. abbrev-prefix-mark (unrelated) ("C-M-#" . consult-register) ;; Other custom bindings ("M-y" . consult-yank-pop) ;; orig. yank-pop ;; M-g bindings in `goto-map' ("M-g e" . consult-compile-error) ("M-g f" . consult-flymake) ;; Alternative: consult-flycheck ("M-g g" . consult-goto-line) ;; orig. goto-line ("M-g M-g" . consult-goto-line) ;; orig. goto-line ("M-g o" . consult-outline) ;; Alternative: consult-org-heading ("M-g m" . consult-mark) ("M-g k" . consult-global-mark) ("M-g i" . consult-imenu) ("M-g I" . consult-imenu-multi) ;; M-s bindings in `search-map' ("M-s d" . consult-find) ;; Alternative: consult-fd ("M-s c" . consult-locate) ("M-s g" . consult-grep) ("M-s G" . consult-git-grep) ("M-s r" . consult-ripgrep) ("M-s l" . consult-line) ("M-s L" . consult-line-multi) ("M-s k" . consult-keep-lines) ("M-s u" . consult-focus-lines) ;; Isearch integration ("M-s e" . consult-isearch-history) :map isearch-mode-map ("M-e" . consult-isearch-history) ;; orig. isearch-edit-string ("M-s e" . consult-isearch-history) ;; orig. isearch-edit-string ("M-s l" . consult-line) ;; needed by consult-line to detect isearch ("M-s L" . consult-line-multi) ;; needed by consult-line to detect isearch ;; Minibuffer history :map minibuffer-local-map ("M-s" . consult-history) ;; orig. next-matching-history-element ("M-r" . consult-history)) ;; orig. previous-matching-history-element ;; The :init configuration is always executed (Not lazy) :init ;; Tweak the register preview for `consult-register-load', ;; `consult-register-store' and the built-in commands. This improves the ;; register formatting, adds thin separator lines, register sorting and hides ;; the window mode line. (advice-add #'register-preview :override #'consult-register-window) (setq register-preview-delay 0.5) ;; Use Consult to select xref locations with preview (setq xref-show-xrefs-function #'consult-xref xref-show-definitions-function #'consult-xref) ;; Configure other variables and modes in the :config section, ;; after lazily loading the package. :config ;; Optionally configure preview. The default value ;; is 'any, such that any key triggers the preview. ;; (setq consult-preview-key 'any) ;; (setq consult-preview-key "M-.") ;; (setq consult-preview-key '("S-<down>" "S-<up>")) ;; For some commands and buffer sources it is useful to configure the ;; :preview-key on a per-command basis using the `consult-customize' macro. (consult-customize consult-theme :preview-key '(:debounce 0.2 any) consult-ripgrep consult-git-grep consult-grep consult-man consult-bookmark consult-recent-file consult-xref consult-source-bookmark consult-source-file-register consult-source-recent-file consult-source-project-recent-file ;; :preview-key "M-." :preview-key '(:debounce 0.4 any)) ;; Optionally configure the narrowing key. ;; Both < and C-+ work reasonably well. (setq consult-narrow-key "<") ;; "C-+" ;; Optionally make narrowing help available in the minibuffer. ;; You may want to use `embark-prefix-help-command' or which-key instead. ;; (keymap-set consult-narrow-map (concat consult-narrow-key " ?") #'consult-narrow-help) )
;; Consult users will also want the embark-consult package. (use-package embark-consult :ensure t)
- compilation
The compilation buffer does not inherit from comint-mode, so ANSI escape sequences are displayed as raw text by default. Adding
ansi-color-compilation-filterto the compilation filter hook interprets these sequences and renders them as colors.(add-hook 'compilation-filter-hook 'ansi-color-compilation-filter)
- copy-region-reference
Copy the absolute path and line range of the selected region in
file:start-endformat (e.g./path/to/file.el:10-20). Pasting the result into a coding agent's prompt gives it an unambiguous file reference to work with.(defun my/copy-region-reference (start end) "Copy the file path and line range of the current region to the clipboard. The format is \"/path/to/file:START-END\"." (interactive "r") (let* ((file (buffer-file-name)) (line-start (line-number-at-pos start)) (line-end (line-number-at-pos (1- end))) (ref (format "%s:%d-%d" file line-start line-end))) (kill-new ref) (message "%s" ref))) (global-set-key (kbd "C-c r") #'my/copy-region-reference)
- Others
(which-key-mode) (setq-default indent-tabs-mode nil) (require 'org-tempo) (org-babel-do-load-languages 'org-babel-load-languages '((shell . t))) (setq org-src-preserve-indentation t)
- project.el
Register all repositories cloned by ghq (https://github.com/x-motemen/ghq) as projects.
Specifically, directories under
~/src/$ACCOUNT/$VCS_HOST/$OWNER/$REPO.(defun my/sync-project-list () "Find all projects under ~/src and synchronize the project-list-file." (interactive) (let* (;; 1. Retrieve directory list as a string using find command (command (format "find %s -mindepth 4 -maxdepth 4 -type d" (expand-file-name "~/src"))) (dir-list-string (shell-command-to-string command)) ;; 2. Split string by newlines and exclude empty lines to create a list (dirs (split-string dir-list-string "\n" t))) ;; 3. Build file contents in a temporary buffer (with-temp-buffer (insert ";;; -*- lisp-data -*-\n") (insert "(\n") (dolist (dir dirs) (insert (format " (\"%s/\")\n" dir))) (insert ")\n") ;; 4. Write the built contents to file (write-file project-list-file)))) (my/sync-project-list)
Sort the project list by modification time, placing recently updated projects first.
Using advice instead of sorting in
my/sync-project-listensures that projects are sorted by their current mtime at selection time, not at file generation time. This keeps the order fresh even during long Emacs sessions.(defun my/sort-projects-by-mtime (projects) "Sort PROJECTS by modification time, most recent first." (sort projects (lambda (a b) (let ((time-a (file-attribute-modification-time (file-attributes a))) (time-b (file-attribute-modification-time (file-attributes b)))) (time-less-p time-b time-a))))) (advice-add 'project-known-project-roots :filter-return #'my/sort-projects-by-mtime)
- project.el
- vundo
- basic
3.3.9. Darwin
- Spotlight
I don't use Spotlight search, yet its indexer (
mdworker) keeps consuming CPU, disk I/O, and disk space in the background, so I turn indexing off by default. Hosts that want it back can setenableIndex = true. nix-darwin has no option for this, so the module drivesmdutilfrom an activation script.{ config, lib, ... }: let cfg = config.my.services.spotlight; in { <<spotlight-options>> <<spotlight-config>> }
- オプション
options.my.services.spotlight = { enableIndex = lib.mkOption { type = lib.types.bool; default = false; description = "Whether Spotlight indexes the volumes on this machine."; }; };
- 設定
mdutiltargets all volumes with-arather than just/: modern macOS splits the boot disk into a read-only System volume (/) and a writable Data volume, somdutil -i off /silently leaves the Data volume indexing. When disabling,mdutil -Ealso erases the orphaned index stores to reclaim disk space.config = { system.activationScripts.extraActivation.text = if cfg.enableIndex then '' echo "enabling spotlight indexing..." mdutil -i on -a &> /dev/null '' else '' echo "disabling spotlight indexing..." mdutil -i off -d -a &> /dev/null mdutil -E -a &> /dev/null ''; };
- オプション
3.4. スクリプト
flake derivation、pre-commitフック、Makefileレシピで使用されるスクリプトです。適切なシンタックスハイライトと単独実行を可能にするため、別ファイルに分離しています。
(require 'org) (require 'htmlize) (require 'nix-ts-mode) (add-to-list 'org-src-lang-modes '("nix" . nix-ts)) (setq treesit-font-lock-level 4) ;; In batch mode, faces lack color attributes. Explicitly set ;; foreground colors so htmlize emits colored inline CSS. (set-face-attribute 'font-lock-keyword-face nil :foreground "#5317ac") (set-face-attribute 'font-lock-string-face nil :foreground "#2544bb") (set-face-attribute 'font-lock-comment-face nil :foreground "#505050") (set-face-attribute 'font-lock-function-name-face nil :foreground "#721045") (set-face-attribute 'font-lock-function-call-face nil :foreground "#721045") (set-face-attribute 'font-lock-variable-name-face nil :foreground "#00538b") (set-face-attribute 'font-lock-variable-use-face nil :foreground "#005077") (set-face-attribute 'font-lock-type-face nil :foreground "#005a5f") (set-face-attribute 'font-lock-constant-face nil :foreground "#0000c0") (set-face-attribute 'font-lock-builtin-face nil :foreground "#8f0075") (set-face-attribute 'font-lock-property-name-face nil :foreground "#00538b") (set-face-attribute 'font-lock-property-use-face nil :foreground "#005077") (set-face-attribute 'font-lock-number-face nil :foreground "#0000c0") (set-face-attribute 'font-lock-operator-face nil :foreground "#813e00") (set-face-attribute 'font-lock-bracket-face nil :foreground "#5f5f5f") (set-face-attribute 'font-lock-delimiter-face nil :foreground "#5f5f5f") (set-face-attribute 'font-lock-punctuation-face nil :foreground "#5f5f5f") (set-face-attribute 'font-lock-escape-face nil :foreground "#a0132f") (find-file "configuration.org") (org-html-export-to-html) (find-file "configuration.ja.org") (org-html-export-to-html)
2つのpre-commitフックスクリプトは共通のパターンを持っています。コマンドを実行し、=git diff=
で変更を確認し、変更があればエラーとともに手順を表示します。この共通ロジックは check-git-changes.sh にあります。
# Usage: check-git-changes <message> [git-diff-args...] # Exits 1 if git diff finds changes, with instructions to stage them. set -euo pipefail message="$1" shift changed=$(git diff --name-only "$@") if [ -n "$changed" ]; then echo "$message" echo "Changed files:" echo "$changed" echo "" echo "Please stage the changes and commit again:" echo " git add $changed" exit 1 fi
set -euo pipefail po4a po4a.cfg check-git-changes "po4a updated translation files." -- po/ '*.ja.org'
set -euo pipefail make -B tangle -j check-git-changes "Org files were out of sync and have been auto-tangled."
(require 'ox-md) (re-search-forward "^\\* Philosophy") (org-md-export-to-markdown nil t)
org-export-with-author 設定は明示的に無効にしています。=configuration.org= には #+AUTHOR:
キーワードがないため、Org modeはEmacsの変数 user-full-name
にフォールバックします。macOSではこの変数がシステムディレクトリサービス(=dscl= / getpwuid=)から設定され、不要な
=#+author:
行が出力されます。Linuxでは、特にCI環境では値が通常空のため、この行は省略されます。この設定を無効にすることで、プラットフォーム間で一貫した出力を保証します。
(require 'ox-org) (let ((org-export-select-tags (list "readme")) (org-export-with-author nil) (org-export-with-tags nil) (org-export-time-stamp-file nil)) (org-export-to-file 'org export-readme-dest))
4. 開発
このリポジトリは設定作業に必要なすべてのツールを備えたNix開発シェルを提供します。以下のコマンドでシェルに入れます:
nix develop
このシェルにはインフラツール(Terraform、sops、ssh-to-age)、翻訳ツール(po4a、gettext)、ビルドユーティリティ(nix-fast-build)が含まれています。シェルに入ると自動的にpre-commitフックのセットアップ、MCPサーバーの設定、文芸的ソースからの
CLAUDE.md 同期が行われます。
{ ... }: { perSystem = { config, pkgs, ... }: let terraform' = pkgs.terraform.withPlugins (p: [ p.carlpett_sops p.cloudflare_cloudflare p.determinatesystems_hydra p.hashicorp_aws p.hashicorp_external p.hashicorp_null p.integrations_github p.oracle_oci ]); in { devShells = { default = pkgs.mkShell { packages = with pkgs; [ aws-vault nix-fast-build sops ssh-to-age terraform' <<translation-packages>> ]; shellHook = config.pre-commit.installationScript + config.mcp-servers.shellHook + '' echo "Syncing CLAUDE.md..." make CLAUDE.md >/dev/null 2>&1 || echo "Warning: Failed to generate CLAUDE.md" ''; }; terraform = pkgs.mkShell { packages = [ terraform' ]; }; }; }; }
4.1. Pre-commit hooks
Hooks run by git-hooks.nix on
every commit. prek is used as the runner because it is the
actively-maintained Rust port of pre-commit, with a faster cold start and
parallel hook execution out of the box.
check-org-tangle is the only hook with priority = 0 because it must run
before everything else: if Org files are out of sync, formatters and linters
downstream would otherwise fail against stale tangle output. Every other
hook keeps the default priority and runs in parallel under prek.
{ inputs, ... }: { imports = [ inputs.git-hooks.flakeModule ]; # Ensure this hook runs before all other hooks perSystem = { pkgs, ... }: { pre-commit = { check.enable = true; settings = { package = pkgs.prek; src = ../../..; hooks = let check-git-changes = pkgs.writeShellApplication { name = "check-git-changes"; runtimeInputs = [ pkgs.git ]; text = builtins.readFile ../../../scripts/check-git-changes.sh; }; emacs-with-org = (pkgs.emacsPackagesFor pkgs.emacs).emacsWithPackages (epkgs: [ epkgs.org ]); in { actionlint = { enable = true; priority = 10; }; biome = { enable = true; priority = 10; }; lua-ls = { enable = false; priority = 10; }; nil = { enable = true; priority = 10; }; shellcheck = { enable = true; priority = 10; }; treefmt = { enable = true; priority = 10; }; typos = { enable = true; priority = 10; excludes = [ ".sops.yaml" "homes/shared/gpg/keys.txt" "secrets.yaml" "secrets/default.yaml" "systems/nixos/tarangire/facter.json" "systems/shared/hercules-ci/binary-caches.json" ]; settings.configPath = "typos.toml"; }; yamllint = { enable = true; priority = 10; excludes = [ "secrets/default.yaml" "secrets.yaml" ]; settings.configData = "{rules: {document-start: {present: false}}}"; }; po4a = { enable = true; name = "po4a"; description = "Update translations with po4a"; priority = 10; entry = pkgs.lib.getExe ( pkgs.writeShellApplication { name = "check-po4a"; runtimeInputs = [ pkgs.po4a pkgs.gettext check-git-changes ]; text = builtins.readFile ../../../scripts/check-po4a.sh; } ); files = "(\\.org|po/.*\\.po)$"; pass_filenames = false; }; "check-org-tangle" = { enable = true; name = "check-org-tangle"; description = "Verify org files are tangled and synchronized"; priority = 0; entry = pkgs.lib.getExe ( pkgs.writeShellApplication { name = "check-org-tangle"; runtimeInputs = [ emacs-with-org pkgs.gnumake check-git-changes ]; text = builtins.readFile ../../../scripts/check-org-tangle.sh; } ); files = "\\.org$"; pass_filenames = false; }; }; }; }; }; }
4.2. Formatting
Formatters are aggregated via
treefmt-nix and invoked from the
treefmt pre-commit hook, so a single declaration covers both editor
integrations and the commit-time check.
{ inputs, ... }: { imports = [ inputs.treefmt-nix.flakeModule ]; perSystem = _: { treefmt = { projectRootFile = "flake.nix"; programs = { biome.enable = true; nixfmt.enable = true; shfmt.enable = true; stylua.enable = true; taplo.enable = true; terraform.enable = true; yamlfmt.enable = true; }; }; }; }
4.3. MCPサーバー
開発シェルで有効化されるmcp-servers-nixの設定です。=flavors.claude-code=
プリセットにより、Claude Codeの期待するフォーマットと互換性のある .mcp.json ファイルが生成されます。
nixos: NixOSパッケージ/オプション検索とHome Managerのドキュメントterraform: Terraformレジストリのプロバイダー、モジュール、ポリシー検索grafana: ホームサーバーのGrafanaインスタンスからダッシュボード、データソース、メトリクスを照会
有効なサーバー:
passwordCommand オプションは rbw (Bitwarden CLI)
を使って実行時にシークレットを取得し、リポジトリに平文の認証情報を含めることを避けています。
{ inputs, ... }: { imports = [ inputs.mcp-servers.flakeModule ]; perSystem = _: { mcp-servers = { flavors.claude-code.enable = true; programs = { nixos.enable = true; terraform.enable = true; grafana = { enable = true; env = { GRAFANA_URL = "http://manyara:3001"; GRAFANA_USERNAME = "admin"; }; passwordCommand = { GRAFANA_PASSWORD = [ "rbw" "get" "grafana" ]; }; }; }; }; }; }
4.4. 翻訳
このプロジェクトでは翻訳にpo4aを使っています。
4.4.1. 必要なソフトウェア
必要なパッケージは開発シェルに含まれています。
gettext po4a
gettext: msgfmtやその他の国際化ユーティリティを提供po4a: Org modeサポートにはpo4a >= 0.74が必要です。
4.4.2. 翻訳作業
- po4aを設定する
対象となる言語、生成するpoファイルを置くディレクトリ、それから翻訳対象のドキュメントを以下のように設定します。=-k 0=というオプションは翻訳が不完全な場合でも翻訳されたファイルを出力するものです。(デフォルトでは80%以上翻訳されているときのみ出力されます。)
[po4a_langs] ja [po4a_paths] po/dotfiles.pot $lang:po/$lang.po [type: org] configuration.org $lang:configuration.$lang.org opt:"-k 0" [type: org] .github/README.org $lang:.github/README.$lang.org opt:"-k 0" [type: org] modules/flake/features/emacs/init.org $lang:modules/flake/features/emacs/init.$lang.org opt:"-k 0" [type: org] modules/flake/features/emacs/early-init.org $lang:modules/flake/features/emacs/early-init.$lang.org opt:"-k 0" [type: org] overlays/configuration.org $lang:overlays/configuration.$lang.org opt:"-k 0" [type: org] modules/configuration.org $lang:modules/configuration.$lang.org opt:"-k 0"
=po4a.cfg=について、詳しくは=man po4a=を参照してください。
- poを生成/更新する
ドキュメントを更新したら、次のコマンドでpoファイルを更新する必要があります。このコマンドはテンプレート(pot)と各言語に対応したpoを=po4a.cfg=で設定したパスに生成します。
po4a --no-translations po4a.cfg
- 翻訳する
対象となる言語のpoをpoエディタで編集します。Emacsのpo-modeやpoedit、GNOMEのGtranslator、KDEのLokalizeが有名です。
- 翻訳ファイルを生成/更新する
翻訳が終わったら次のコマンドでファイルを生成します。このときpoも更新されるため、実運用上はこのコマンドを実行するだけで良いでしょう。
po4a po4a.cfg