dotfile-nix

KO | EN

gitlite — search

#javascript #ai #golang #go #docker #macos #java #cli #kubernetes #pytorch #ios #mcp #openai #open-source

(★ 11)

Nix setup for all dotfiles and required applications for mac

dotfile-nix 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Nix Darwin Dotfiles

A modular macOS configuration using Nix, nix-darwin, Home Manager, and
Homebrew. The repo is organized around clear ownership boundaries: Nix manages
system/user configuration, Home Manager owns user-level CLI tools and program
settings, and Homebrew owns GUI apps, fonts, vendor apps, and selected global
toolchains.

## 🚀 Quick Start

**New to this system?** → [**📖 Complete Documentation Guide**](docs/README.md)

**Just want it working?** → [⚡ Installation Guide](docs/getting-started/installation.md)

**Already installed?** → [📋 Quick Reference](docs/getting-started/quick-reference.md)

## What is Nix?

Nix is a powerful package manager and system configuration tool that takes a unique approach to package management and system configuration. It ensures that installing or upgrading one package cannot break other packages, enables multiple versions of a package to coexist, and makes it easy to roll back to previous versions.

### Key Features

- **Declarative Configuration**
  - Your entire system defined as code
  - Reproducible environments
  - Safe, atomic updates

### Why Use Nix?

- **For Developers**
  - Consistent development environments
  - Project-specific package versions
  - Easy sharing of development setups

- **For System Configuration**
  - Version control your entire system
  - Test changes safely
  - Roll back when needed

### Learn More

- 📘 [Nix Package Manager Guide](https://nixos.org/manual/nix/stable/)
- 🎓 [Nix Pills Tutorial](https://nixos.org/guides/nix-pills/)
- 💡 [Home Manager Manual](https://nix-community.github.io/home-manager/)
- 🔧 [Nix Darwin Documentation](https://github.com/LnL7/nix-darwin)

## Core Components

Each component serves a specific purpose in creating a reproducible system:

- **nix-darwin**: System-level macOS configuration
  - Manages macOS settings and preferences
  - Handles system-level packages
  - Controls system defaults and security

- **Home Manager**: User environment management
  - Manages user-specific configurations
  - Handles dotfiles and program settings
  - Ensures consistent user environment

- **Homebrew**: macOS app and toolchain management
  - Owns GUI apps, fonts, and vendor-managed desktop software
  - Owns selected global runtimes/build chains shared with IDEs
  - Avoids duplicating user-level CLI tools managed by Home Manager

## Design Decisions

### Why Nix?

1. **Reproducibility**
    - Exact same setup across machines
    - Version-controlled configuration
    - Declarative system definition

2. **Modularity**
    - Separate system and user config
    - Easy to enable/disable features
    - Reusable configuration modules

3. **Reliability**
    - Atomic updates
    - Rollback capability
    - Consistent state management

4. **Performance Optimized**
    - Lazy loading for heavy functions
    - Streamlined configuration files
    - Fast shell startup times

### Current Shape

The repository is organized into logical, optimized components:

- `darwin/` - System configuration
  - Separates macOS-specific settings
  - Composes Homebrew package lists from `darwin/homebrew-packages/`
  - Applies profile-specific Homebrew overrides from `darwin/profiles/`
  - Controls security policies

- `home-manager/` - User environment
  - Modular program configurations with helper functions
  - Lazy-loaded AWS SSO functions for fast startup
  - Package-only CLI groups under `home-manager/modules/packages/`
  - Profile-aware behavior through `home-manager/config/profile.nix`
  - Personal preferences and tools
  - Shell and terminal setup

- `lib/` - Shared Nix helpers
  - Host config validation and enrichment

- `nix/` - Core Nix setup
  - Basic Nix configuration
  - Shell integration
  - Dynamic configurations

- `docs/architecture/` - Maintainer-facing structure and ownership docs
  - Repo map, ownership rules, and profile surface

- `docs/runbooks/homelab/` - External homelab operations
  - Monitoring, Paperless, and service migration procedures

## Prerequisites

- macOS (Apple Silicon - M*)
- Administrative access
- Basic terminal knowledge

## Quick Start

### Option 1: One-Command Setup

For a quick setup that proceeds automatically after 5 seconds:

```bash
curl -sSL <your-repo-raw-url>/setup.sh | DOTFILES_REPO_URL=<your-repo-raw-url> bash
```

### Option 2: Download and Run (Interactive)

For full interactive control with confirmation prompts:

```bash
curl -o setup.sh <your-repo-raw-url>/setup.sh
chmod +x setup.sh
DOTFILES_REPO_URL=<your-repo-raw-url> ./setup.sh
```

This will automatically:

- Download the full installation script
- Perform system checks
- Ask for your preferred directory name (defaults to `dotfile`)
- Guide you through the complete setup process

After setup, open a new terminal and run:

```bash
rebuild
./scripts/setup/validate-ssh.sh
```

## Manual Installation

If you prefer to do the setup manually:

1. **Install Command Line Tools**

```bash
xcode-select --install
```

1. **Clone Configuration**

```bash
mkdir -p ~/Documents
cd ~/Documents
git clone <your-repo-url> dotfile
cd dotfile
```

1. **Configure User Settings**

```bash
cp hosts.example.nix hosts.nix
```

Edit `hosts.nix` with your information:

```nix
{
  common = {
    username = "your-macos-username";
    fullName = "Your Full Name";
    githubUsername = "your-github-username";
  };
  hosts = {
    work = {
      hostname = "your-work-hostname";
      profile = "work";
    };
    personal = {
      hostname = "your-personal-hostname";
      profile = "personal";
    };
  };
}
```

Configure Git emails locally (not in `hosts.nix`):

```bash
git config -f ~/.gitconfig-work user.email "your.work@email.com"
git config -f ~/.gitconfig-personal user.email "your.personal@email.com"
git config --global --replace-all "includeIf.gitdir:$HOME/Development/Work/.path" "$HOME/.gitconfig-work"
git config --global --replace-all "includeIf.gitdir:$HOME/Development/Personal/.path" "$HOME/.gitconfig-personal"
```

1. **Run Installation**

This script automates the initial setup: installs Xcode tools (if needed), Homebrew, Nix, clones this repository if needed, sets up initial symlinks (including for a temporary shell environment from `nix/`), and performs the first system build using `nix-darwin`.

```bash
./scripts/install/pre-nix-installation.sh
```

After the script completes and the first build is successful, **open a new terminal window** for the fully configured environment managed by Home Manager to take effect.

## SSH Setup & Validation

The installation script includes intelligent SSH key management for bootstrap
and fallback use:

- **Detects existing SSH keys** and lets you choose which to use
- **Creates GitHub-specific key** at `~/.ssh/github` (via symlink or new key)
- **Automatically uploads** your public key to GitHub
- **Configures SSH properly** for seamless GitHub authentication

SSH is configured to prefer the Bitwarden Desktop SSH Agent when enabled. Nix
sets `IdentityAgent ~/.bitwarden-ssh-agent.sock`, omits per-host `IdentityFile`
entries, exports the matching shell environment, and provides `bwssh` to list
keys exposed by the agent. The only manual step is enabling **Settings → SSH
Agent → Enable SSH agent** in the Bitwarden Desktop app after signing in to
Vaultwarden.

**Validate your SSH setup anytime:**

```bash
./scripts/setup/validate-ssh.sh
bwssh
```

This will check:

- SSH key existence and type
- SSH agent configuration
- GitHub connection status
- Home-manager SSH configuration
- Provide troubleshooting guidance

## GPG Setup for GitHub (Optional but Recommended)

For enhanced security and verified commits on GitHub, you can automatically set up GPG signing:

```bash
./scripts/setup/gpg-github.sh --all
# or one scope only:
./scripts/setup/gpg-github.sh --work
./scripts/setup/gpg-github.sh --personal
```

This script will:

- ✅ Read email from `~/.gitconfig-work` / `~/.gitconfig-personal` (prompts if missing)
- ✅ Check if a GPG key already exists for each selected email
- ✅ Generate a new GPG key if needed (using secure defaults)
- ✅ Authenticate with GitHub (if not already done)
- ✅ Upload your public key to GitHub automatically
- ✅ Configure `user.signingkey` + `commit.gpgsign=true` in local `~/.gitconfig-*`
- ✅ Test GPG signing functionality

**Prerequisites:**

- Git email configured locally via `~/.gitconfig-work` / `~/.gitconfig-personal`
- GitHub CLI authentication (script will prompt if needed)

**After setup:**

- All your commits will be automatically signed
- GitHub will show "Verified" badges on your commits
- Your signing key IDs are stored only in local `~/.gitconfig-*` files (not tracked in git)

**Manual GitHub Authentication (if needed):**

```bash
gh auth login
```

**Example Output (`--work`):**

```text
=== GPG + GitHub Signing Setup (Local Profiles) ===

[INFO] Checking prerequisites...
[SUCCESS] Prerequisites check passed
[INFO] Configuring scope: work
[WARNING] No existing GPG key found for john@example.com
[INFO] Generating new GPG key for john@example.com...
[SUCCESS] GPG key generated successfully: ABC123DEF456789
[INFO] Uploading GPG key to GitHub...
[SUCCESS] GPG key uploaded to GitHub successfully
[SUCCESS] Configured /Users/<you>/.gitconfig-work
[SUCCESS] GPG signing test passed
[SUCCESS] GPG setup completed
```

## Applying Changes

After the initial setup, to apply any changes you make to the configuration files in this repository, run the following command from the `~/Documents/dotfile` directory:

```bash
sudo darwin-rebuild switch --flake .#<hostname-from-hosts.nix>
# Or use the 'rebuild' alias (which includes sudo automatically)
rebuild
```

**Note:** The `sudo` is required due to recent nix-darwin updates that require system activation to run as root for security reasons.

## Package Ownership

Use one owner for each tool:

| What you are adding | Where it belongs |
|---------------------|------------------|
| Configured Home Manager programs | `home-manager/modules/programs/` or a dedicated module |
| Plain user-level CLI binaries | `home-manager/modules/packages/*.nix` |
| GUI apps and vendor macOS apps | `darwin/homebrew-packages/casks/` |
| Fonts | `darwin/homebrew-packages/casks/fonts.nix` |
| Global IDE/shared toolchains | `darwin/homebrew-packages/brews/toolchains.nix` |
| Work/personal-only package changes | `darwin/profiles/work.nix` or `darwin/profiles/personal.nix` |
| Project-pinned dependencies | Project config, `direnv`, `uv`, or project flakes |

Useful references:

- [Package Management](docs/guides/package-management.md)
- [Toolchain Ownership](docs/guides/toolchain-ownership.md)
- [Home Manager Package Groups](home-manager/modules/packages/README.md)

## Directory Structure

```bash
dotfile/
├── flake.nix                   # Main configuration
├── flake.lock                  # Dependency lock file
├── hosts.nix                   # Machine configurations (work/personal)
├── hosts.example.nix           # Hosts template
├── lib/                         # Shared Nix helpers
├── setup.sh                    # Quick setup script
├── darwin/
│   ├── homebrew.nix            # Homebrew activation and composition
│   ├── homebrew-packages/      # Shared Homebrew package lists
│   └── profiles/               # Work/personal Homebrew overrides
├── home-manager/
│   ├── default.nix             # User environment entry point
│   ├── aliases/                # Shell aliases split by ownership
│   ├── config/                 # Shared declarative facts
│   ├── modules/package-groups.nix
│   ├── scripts/                # Home Manager-installed helper scripts
│   └── modules/packages/       # Package-only Home Manager CLI groups
├── docs/
│   ├── architecture/           # Repo map, ownership, profile surface
│   └── runbooks/homelab/       # External homelab operating procedures
├── scripts/                    # Organized scripts
│   ├── install/
│   │   ├── pre-nix-installation.sh    # Installation script
│   │   └── uninstall.sh              # Uninstallation script
│   ├── setup/                        # Setup utilities
│   ├── monitoring/                   # System monitoring
│   └── utils/                        # Utility scripts
```

**Note on `nix/` Directory:** The files `nix/zshrc` and `nix/dynamic-config.zsh` are symlinked directly into `~/` by the `pre-nix-installation.sh` script. They provide a minimal, temporary shell environment immediately after the script finishes, before you open a new terminal. The full, robust shell environment is declaratively configured by Home Manager (`home-manager/modules/zsh.nix`) and takes effect in new terminal sessions after the first build.

## Quick Reference

**⚡ Performance Optimized**: Fast shell startup with lazy-loaded functions and streamlined configurations.

### System Commands

```bash
rebuild   # Uses hostname resolved from active host in hosts.nix
          # Optional: rebuild --work | rebuild --personal
rebuild-work      # Explicit work target
rebuild-personal  # Explicit personal target
update    # Update Homebrew metadata/packages, flake inputs, and rebuild
cleanup   # Clean old Nix generations
```

### Common Tools

```bash
# Git
gs        # Status
gp        # Push
gl        # Pull
lg        # LazyGit TUI

# GitHub
ghprc     # Checkout PR
ghprl     # List PRs

# Cloud (lazy-loaded for fast startup)
awsd      # Default/dev SSO + file credentials
awsp      # Production/prod SSO + file credentials
awsrd     # Refresh default/dev SSO + file credentials
awsrp     # Refresh production/prod SSO + file credentials
```

## Documentation

Comprehensive documentation is organized into the following sections:

### Getting Started

- [Documentation Index](docs/README.md)
- [Installation Guide](docs/getting-started/installation.md)
- [First Steps](docs/getting-started/first-steps.md)
- [Quick Reference](docs/getting-started/quick-reference.md)

### Core Guides

- [System Overview](docs/guides/system-overview.md)
- [Configuration Basics](docs/guides/configuration-basics.md)
- [Package Management](docs/guides/package-management.md)
- [Toolchain Ownership](docs/guides/toolchain-ownership.md)

### Tools

- [Git & GitHub](docs/guides/git-setup.md)
- [Terminal Setup](docs/guides/terminal-setup.md)
- [AWS SSO Setup](docs/guides/aws-sso-setup.md)
- [Lazywarden Recovery](docs/guides/lazywarden-recovery.md)
- [Python Development](docs/development/python-setup.md)

### Customization And Help

- [Package Customization](docs/customization/packages.md)
- [Module System](docs/customization/modules.md)
- [Theme Configuration](docs/customization/themes.md)
- [FAQ](docs/help/faq.md)
- [Troubleshooting](docs/help/troubleshooting.md)
- [Onboarding Test Plan](docs/testing/onboarding-test-plan.md)

## Uninstallation

```bash
./scripts/install/uninstall.sh
```

## Acknowledgments

This configuration was developed with the assistance of [Cursor](https://cursor.sh), an AI-powered code editor that helped:

- Generate and structure configuration files
- Debug Nix expressions
- Create comprehensive documentation
- Maintain consistent code style

## Important Notes

- **Neovim:** Home Manager installs Neovim and deploys the
  [LazyVim](https://www.lazyvim.org/) configuration from
  `home-manager/config/nvim`. The repository is the source of truth; do not edit
  `~/.config/nvim` or run unrecorded plugin updates there. To update LazyVim,
  update the tracked `lazy-lock.json` in a controlled checkout, review its diff,
  run `bash scripts/testing/check-neovim-config.sh`, and deploy via `rebuild`.
  The managed UI uses Gruvbox in terminals configured with JetBrainsMonoNL Nerd
  Font Mono and Fira Code as the monospace fallback.

dotfile-nix

dotfile-nix 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

dotfile-nix

dotfile-nix 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README