tomatocream/bankrupt

Fork 0

Files

T

tomatocream 389e780660 temp add

2025-11-15 23:17:12 +08:00

5.9 KiB

Raw Permalink Blame History

Quick Start Guide

TL;DR

macOS Setup (3 steps)

# 1. Configure your info
export USERNAME="your-username"
export HOSTNAME="your-hostname"

# Edit these files and replace placeholders:
# - flake.nix (line 82-94)
# - darwin/configuration.nix (lines 33, 45, 48)
# - home-manager/home.nix (line 30)

# 2. Build (first time only)
nix build .#darwinConfigurations.$HOSTNAME.system --extra-experimental-features "nix-command flakes"
./result/sw/bin/darwin-rebuild switch --flake .#$HOSTNAME

# 3. Apply (after first time)
darwin-rebuild switch --flake .

Linux/NixOS Setup (2 steps)

# 1. Configure your info
# Edit flake.nix, nixos/configuration.nix, home-manager/home.nix
# Replace placeholders with your username and hostname

# 2. Apply
sudo nixos-rebuild switch --flake .#your-hostname

What You Get

✅ Cross-Platform Support

Same config works on macOS (via nix-darwin) and Linux (NixOS)
Automatic platform detection
Shared home-manager configuration

✅ Modular Home Manager

Your user environment is organized into:

common.nix - Basic tools (git, ripgrep, etc.)
development.nix - Dev tools (gh, lazygit, direnv)
shell.nix - Shell config (bash/zsh/fish + starship prompt)
terminal.nix - Terminal apps (tmux, neovim, alacritty)
linux.nix - Linux-specific GUI apps
darwin.nix - macOS-specific integrations

✅ Great Defaults

Modern CLI tools (ripgrep, fd, bat, eza, zoxide, fzf)
Starship prompt with git integration
Syntax highlighting and autosuggestion
Git aliases and better defaults
macOS system preferences (dock, finder, keyboard)
Automatic garbage collection
Nix flakes enabled

✅ Easy Maintenance

# Update everything
make update && make darwin-switch  # or make nixos-switch

# Format code
make fmt

# Clean old generations
make clean

File Structure Quick Reference

├── flake.nix              ← Define all your systems here
├── common.nix             ← Shared Nix settings
│
├── darwin/                ← macOS system config
│   └── configuration.nix  
│
├── nixos/                 ← Linux system config
│   └── configuration.nix
│
└── home-manager/          ← Your user environment (SHARED!)
    ├── home.nix           ← Main entry point
    ├── common.nix         ← Base config
    ├── development.nix    ← Dev tools
    ├── shell.nix          ← Shell setup
    ├── terminal.nix       ← Terminal apps
    ├── linux.nix          ← Linux-only
    └── darwin.nix         ← macOS-only

Common Tasks

Add a Package

User package (recommended):

# home-manager/common.nix
home.packages = with pkgs; [
  firefox
  your-package-here
];

System package:

# common.nix or darwin/configuration.nix or nixos/configuration.nix
environment.systemPackages = with pkgs; [
  your-package-here
];

Enable a Program

# In any home-manager/*.nix file
programs.firefox.enable = true;
programs.vscode = {
  enable = true;
  extensions = with pkgs.vscode-extensions; [
    bbenoist.nix
  ];
};

Platform-Specific Packages

# In home-manager/common.nix or development.nix
home.packages = with pkgs; [
  # Shared
  ripgrep
  fd
] ++ lib.optionals stdenv.isDarwin [
  # macOS only
] ++ lib.optionals stdenv.isLinux [
  # Linux only
];

Change Shell

# In home-manager/shell.nix, set enable = true for your preferred shell:
programs.fish.enable = true;    # Fish (recommended)
programs.zsh.enable = true;     # Zsh
programs.bash.enable = true;    # Bash

Then on macOS, set in darwin/configuration.nix:

programs.fish.enable = true;  # or zsh/bash

On NixOS, set in nixos/configuration.nix:

users.users.your-username.shell = pkgs.fish;  # or zsh/bash

Add SSH Keys

macOS:

# darwin/configuration.nix
users.users.your-username = {
  openssh.authorizedKeys.keys = [
    "ssh-ed25519 AAAA... your-key"
  ];
};

NixOS:

# nixos/configuration.nix
users.users.your-username = {
  openssh.authorizedKeys.keys = [
    "ssh-ed25519 AAAA... your-key"
  ];
};

Multiple Machines

Add entries in flake.nix:

darwinConfigurations = {
  macbook = darwin.lib.darwinSystem { ... };
  mac-mini = darwin.lib.darwinSystem { ... };
};

nixosConfigurations = {
  desktop = nixpkgs.lib.nixosSystem { ... };
  laptop = nixpkgs.lib.nixosSystem { ... };
};

Then build with:

darwin-rebuild switch --flake .#macbook
# or
sudo nixos-rebuild switch --flake .#desktop

Troubleshooting One-Liners

# Check flake is valid
nix flake check

# Show flake outputs
nix flake show

# Build without switching (test)
darwin-rebuild build --flake .         # macOS
sudo nixos-rebuild build --flake .     # Linux

# Rollback
darwin-rebuild --rollback              # macOS
sudo nixos-rebuild --rollback          # Linux

# Force rebuild
darwin-rebuild switch --flake . --recreate-lock-file

# View current generation
darwin-rebuild --list-generations      # macOS
sudo nix-env --list-generations --profile /nix/var/nix/profiles/system  # Linux

Next Steps

⚙️ Customize home-manager/development.nix - Add your dev tools
🎨 Tweak home-manager/shell.nix - Customize your prompt and aliases
🖥️ Adjust darwin/configuration.nix - Set macOS preferences
📦 Add packages - Browse search.nixos.org
🔧 Create modules - Extract common patterns into modules/home-manager/

Help & Resources

📖 Full README - Complete documentation
🚀 INSTALL.md - Detailed installation guide
🔍 NixOS Search - Find packages and options
💬 NixOS Discourse - Community forum
🎮 Nix Discord - Real-time chat

5.9 KiB Raw Permalink Blame History