This repository has no description
2.9 kB
86 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 `2configs/` and `3modules/`
10- Custom packages in `5pkgs/`
11- Various network overlays (retiolum, spora, nether, zerotier, mycelium)
12
13## Key Architecture Components
14
15### Machine Management
16- **Clan-core**: Primary framework for managing multiple machines
17- **Inventory**: Machines are tagged in `flake.nix` (laptop/server tags)
18- **Secrets**: Uses password-store for secrets management via clan.core.facts
19
20### Network Overlays
21The repository manages multiple overlay networks:
22- **Retiolum**: VPN network (access via `.r` suffix)
23- **Spora**: Mycelium-based P2P network (access via `.s` suffix)
24- **Nether**: ZeroTier-based network overlay (access via `.n` suffix)
25- **Tor**: Anonymous network access
26
27### Module System
28- `2configs/`: Main configuration modules
29- `2configs/default.nix`: imported by all machines
30- `3modules/`: Custom NixOS module definitions
31- Stockholm modules are also imported for krebs infrastructure
32
33## Common Development Commands
34
35```bash
36# Enter development shell
37nix develop
38
39# Deploy to a specific machine
40clan machines update <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## Machine Facts and Secrets via vars
66
67- SSH public keys
68- Network identities (retiolum, mycelium, zerotier)
69- Syncthing IDs
70- DKIM keys (for mail servers)
71
72Secrets are managed via password-store and uploaded to `/run/secrets` on deployment.
73
74## Adding New Machines
75
761. Create directory `machines/<name>/`
772. Add `config.nix`, `physical.nix`, and optionally `disk.nix`
783. Generate facts using clan-cli
794. Add to inventory in `flake.nix`
805. Deploy using `nix run .#deploy -- <name>`
81
82## Commit Message Guidelines
83
84- Use simple, descriptive commit messages without attribution footers
85- For flake.lock updates, use: "flake.lock: update"
86- Follow existing patterns seen in git log