forked from
lass.pds.lassul.us/superconfig
This repository has no description
3.6 kB
98 lines
1# CLAUDE.md
2
3This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
5## Repository Overview
6
7This is lassulus's personal NixOS/nix-darwin configuration repository, built on clan-core for managing multiple machines. It includes:
8- Multiple machine configurations in `machines/`
9- Configuration modules in `configs/` and `modules/`
10- Custom packages in `pkgs/`
11- packages which could in theory be upstreamed to nixkgs should go into the pkgs folder, in the tools folder we add tools we write ourself which are more complex or not upstreamable
12
13## Key Architecture Components
14
15### Machine Management
16- **Clan-core**: Primary framework for managing multiple machines
17- **Secrets**: Uses password-store for secrets management via clan.core.vars
18
19### Network Overlays
20The repository manages multiple overlay networks:
21- **Tor**: Anonymous network access
22
23### Module System
24- `configs/`: Main configuration modules
25- `configs/default.nix`: imported by all machines
26- `modules/`: Custom NixOS module definitions
27- Stockholm modules are also imported for krebs infrastructure
28
29## Common Development Commands
30
31```bash
32# Enter development shell
33nix develop
34
35# Deploy a NixOS machine (tools/deploy): one Secure Enclave unlock for all
36# secrets, builds on the target, shows source/closure diff, asks before
37# switching. `s` runs apps from ~/src/superconfig, so pass --flake to deploy
38# a different checkout/worktree. NEVER use `clan machines update`: it
39# decrypts each secret separately and fails on the Secure Enclave prompt.
40s deploy --flake . <MACHINE_NAME>
41
42# Format code
43nix fmt
44
45# Build NixOS configuration
46nix build .#nixosConfigurations.<machine-name>.config.system.build.toplevel
47
48# Build Darwin configuration
49nix build .#darwinConfigurations.barnacle.system
50
51# Deploy/rebuild Darwin configuration (for barnacle)
52sudo darwin-rebuild switch --flake .#barnacle
53
54# Access machines via SSH
55ssh <machine-name>.r # via retiolum
56ssh <machine-name>.s # via spora
57ssh <machine-name>.n # via nether
58torify ssh $(pass show machines/<machine-name>/tor-hostname) # via tor
59```
60
61## Important: Git Staging for Flake Evaluation
62
63**CRITICAL**: New nix files must be staged (git add) before they are available in flake evaluation. When creating new packages, modules, or any nix files, always run `git add <files>` before testing with `nix build`, `nix run`, etc.
64
65## Git Push Policy
66
67**CRITICAL**: NEVER `git push` to any remote. Local commits are fine when asked.
68A push happens only when the user runs it themselves or explicitly says
69"push" for that specific change in the current conversation. This includes
70all remotes (origin, HTTPS via gh credentials, pair) and all branches.
71
72## Machine Facts and Secrets via vars
73
74- SSH public keys
75- Network identities (retiolum, mycelium, zerotier)
76- Syncthing IDs
77- DKIM keys (for mail servers)
78
79Secrets are managed via password-store and uploaded to `/run/secrets` on deployment.
80
81## Adding New Machines
82
831. Create directory `machines/<name>/`
842. Add `config.nix`, `physical.nix`, and optionally `disk.nix`
853. Generate facts using clan-cli
864. Add to inventory in `flake.nix`
875. Deploy using `s deploy --flake . <name>`
88
89## Pre-Commit
90
91**CRITICAL**: Always run `nix fmt` before committing to ensure all files pass the treefmt formatting check in CI.
92
93## Commit Message Guidelines
94
95- Use simple, descriptive commit messages without attribution footers
96- Use flake attribute paths as prefixes (e.g., `tools.mutt:` not just `mutt:`)
97- For flake.lock updates, use: "flake.lock: update"
98- Follow existing patterns seen in git log