A modern, cross-platform Nix setup for both macOS (nix-darwin) and Linux (NixOS), with shared Home Manager and development environments.

📚 Full Documentation: docs/ - Comprehensive guides, references, and examples

curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

git clone <your-repo-url> ~/.config/nix
cd ~/.config/nix

Replace <hostname> with your machine name (e.g., jupiter for Linux or Lewiss-MacBook-Pro for macOS):

• macOS: sudo darwin-rebuild switch --flake ~/.config/nix#<hostname>
• Linux: sudo nixos-rebuild switch --flake ~/.config/nix#<hostname>

.
├── 📄 README.md              # This file - quick start
├── 📄 flake.nix              # Main flake configuration
├── 📁 docs/                  # 📚 Complete documentation
├── 📁 hosts/                 # 🖥️  Host-specific configs
├── 📁 modules/               # ⚙️  System-level modules
│   ├── shared/               #     Cross-platform modules
│   ├── darwin/               #     macOS-specific modules
│   └── nixos/                #     Linux-specific modules
├── 📁 home/                  # 🏠 Home Manager configs
│   ├── common/               #     Cross-platform user configs
│   ├── darwin/               #     macOS user configs
│   └── nixos/                #     Linux user configs
├── 📁 shells/                # 💻 Development environments
├── 📁 scripts/               # 🔧 Utility scripts
├── 📁 secrets/               # 🔐 SOPS secrets management
└── 📁 lib/                   # 🛠️  Helper functions

• Add a package: See DX Guide or Features Guide for configuration patterns
• Set up dev environment: nix develop - includes pre-commit hooks, formatters, and linters
• Update dependencies: See Updating Guide or run nix run .#update-all
• Format code: nix fmt or treefmt for all files, automatic via pre-commit hooks
• Write good commits: See DX Guide → Conventional Commits
• Troubleshoot issues: See Build Profiling or Performance Tuning

# Update all dependencies (automated)
nix run .#update-all

# Or manually update inputs
nix flake update
sudo nixos-rebuild switch --flake ~/.config/nix#<hostname>  # Linux
sudo darwin-rebuild switch --flake ~/.config/nix#<hostname> # macOS

# Cleanup
nix-collect-garbage -d && nix store optimise

This repository includes comprehensive DX tooling:

• ✅ Pre-commit Hooks: Automatic formatting, linting, and validation
• 📝 Conventional Commits: Standardized commit messages with enforcement
• 💬 Conventional Comments: Structured code review feedback
• ⚙️ EditorConfig: Consistent code style across editors
• 🔧 Development Shells: Language-specific environments with all tools

Get started: nix develop (auto-configures everything!)

Learn more: See DX Guide and Contributing Guide

Speed up your builds by using pre-built packages:

# Use the personal cache (setup required)
cachix use lewisflude-nix

Rebuilds will be 10-30 seconds instead of 10-20 minutes!

Setup guide: docs/CACHIX_FLAKEHUB_SETUP.md

This configuration can be published to FlakeHub for easy discovery and versioned releases.

Use this config:

{
  inputs.lewisflude-nix.url = "https://flakehub.com/f/lewisflude/nix/*";
}

Setup guide: docs/CACHIX_FLAKEHUB_SETUP.md

Need more help? Check out the docs/ directory for comprehensive guides and references.