This configuration is currently set up for the username oratakashi.

If you want to use this configuration, you MUST customize it for your own username BEFORE applying it to your system. Applying it as-is may cause issues or unexpected behavior.

👉 Please read the Adjusting Configuration for Your Username section carefully before proceeding with the installation.

• First-Time User Notice
• Features
• Prerequisites
• Supported Platforms
• Installation
• Project Structure
• Configuration Overview
• Usage
• Customization
  • Adjusting Configuration for Your Username
  • Adding New Packages
  • Adding Shell Aliases
• Troubleshooting
• Contributing
• License

• 🔄 Cross-Platform Support - Works seamlessly on macOS (Intel & Apple Silicon), Linux, and Windows (WSL)
• 📦 Declarative Configuration - Define your entire development environment in code
• 🔁 Reproducible Builds - Same configuration yields identical results across machines
• ⚡ Nix Flakes - Modern Nix with lockfile support for reproducibility
• 🍎 nix-darwin Integration - Full macOS system configuration support
• 🍺 Homebrew Management - Automated Homebrew package management on macOS
• 🐚 Shell Configuration - Pre-configured Fish and Zsh with aliases and plugins
• 🛠️ Development Tools - Ready-to-use development environment with common tools

Before you begin, ensure you have the following:

• A supported operating system (macOS, Linux, or Windows with WSL)
• Administrator/sudo access on your machine
• Internet connection for downloading packages

Note: <username> should be replaced with your actual username after customization. See Adjusting Configuration for Your Username.

⚠️ IMPORTANT: This configuration is set up for the user oratakashi. Before following the installation steps, you MUST customize it for your username. See the Adjusting Configuration for Your Username section in Customization for detailed instructions.

Install the Nix package manager using the Determinate Systems installer:

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

Note: After installation, restart your terminal or source your shell configuration.

Clone this repository to ~/.config/home-manager:

Using SSH (recommended):

nix-shell -p git --command "git clone [email protected]:oratakashi/nix-home-manager.git $HOME/.config/home-manager"

Using HTTPS:

nix-shell -p git --command "git clone https://github.com/oratakashi/nix-home-manager.git $HOME/.config/home-manager"

Note: You can also fork this repository to your own GitHub account and clone from your fork if you want to maintain your own customizations.

⚠️ Remember: Before running these commands, make sure you've customized the configuration with your username. The commands below assume you've already updated the configuration files. Replace <username> with the username you configured in the customization step.

Choose the appropriate commands for your platform:

~/.config/home-manager/
├── flake.nix                 # Main flake configuration (entry point)
├── flake.lock                # Locked dependencies for reproducibility
├── darwin-configuration.nix  # macOS-specific system configuration
├── home-shared.nix           # Shared configuration across all platforms
├── home-darwin.nix           # macOS-specific home configuration
├── home-linux.nix            # Linux-specific home configuration
├── home-windows.nix          # Windows/WSL-specific home configuration
├── emulator-fix-hackintosh/  # Android emulator fix for Hackintosh
│   └── emulatorfix.plist
├── README.md                 # Main documentation
└── CUSTOMIZATION_GUIDE.md    # Detailed guide for username customization

The following packages are installed across all platforms:

The configuration includes helpful aliases:

To update all flake inputs to their latest versions:

cd ~/.config/home-manager
nix flake update
home-update

1. For all platforms: Edit home-shared.nix and add packages to home.packages:

   home.packages = with pkgs; [
     # Add your packages here
     ripgrep
     fd
   ];

2. For platform-specific packages: Edit the corresponding file:

   • macOS: home-darwin.nix
   • Linux: home-linux.nix
   • Windows/WSL: home-windows.nix

Edit the shellAliases section in home-shared.nix:

programs.fish.shellAliases = {
  # Add your aliases here
  myalias = "my-command --with-flags";
};

⚠️ Important: This configuration is currently set up for the user oratakashi. Before using it for your own system, you must customize it with your username.

📖 For a detailed standalone guide, see CUSTOMIZATION_GUIDE.md

The following table shows all files that need to be updated and what to change:

Follow these steps carefully to customize the configuration for your username:

Replace all instances of oratakashi with your username:

Darwin Configurations (macOS):

# For Intel Macs - Change the configuration name and user settings
darwinConfigurations."yourusername" = darwin.lib.darwinSystem {
  system = "x86_64-darwin";
  modules = [
    ./darwin-configuration.nix
    home-manager.darwinModules.home-manager
    {
      home-manager = {
        useGlobalPkgs = true;
        useUserPackages = true;
        users.yourusername = { pkgs, ... }: {  # Change here
          home = {
            username = "yourusername";        # Change here
            homeDirectory = "/Users/yourusername";  # Change here
            stateVersion = "23.11";
          };
          imports = [ 
            ./home-shared.nix
            ./home-darwin.nix 
          ];
        };
      };
    }
  ];
};

# For Apple Silicon Macs - Same changes as above
darwinConfigurations."yourusername-arm64" = darwin.lib.darwinSystem {
  system = "aarch64-darwin";
  # ... make the same username changes ...
};

Change the username and PATH variables:

home.username = "yourusername";  # Change this line

# In programs.fish.interactiveShellInit, update the PATH:
set -l nix_paths \
  /Users/yourusername/.nix-profile/bin \           # Change here
  /etc/profiles/per-user/yourusername/bin          # Change here

Also update the session path if needed (note: adjust the path format for your platform):

home.sessionPath = [
  "/home/yourusername/Documents/Tools/kobweb/bin"  # For Linux/WSL
  # Or for macOS: "/Users/yourusername/Documents/Tools/kobweb/bin"
];

Change the primary user and user definition:

system.primaryUser = "yourusername";  # Change here

users.users.yourusername = {          # Change here
  name = "yourusername";              # Change here
  home = "/Users/yourusername";       # Change here
};

Change the home directory and shell aliases:

home.homeDirectory = "/Users/yourusername";  # Change here

# Update the home-update alias:
programs.zsh.shellAliases = {
  home-update = "sudo darwin-rebuild switch --flake ~/.config/home-manager#yourusername";  # Change here
};

programs.fish.shellAliases = {
  home-update = "sudo darwin-rebuild switch --flake ~/.config/home-manager#yourusername";  # Change here
};

Change the home directory:

home.homeDirectory = "/home/yourusername";  # Change here

Change the Windows home directory:

home.homeDirectory = "/mnt/c/Users/yourusername";  # Change here

After making all the changes, verify your configuration before applying:

1. Check syntax:

   cd ~/.config/home-manager
   nix flake check

2. Verify your changes:

   # Search for any remaining references to the old username in Nix files only
   grep -r "oratakashi" ~/.config/home-manager --include="*.nix"

   This should return no results if all changes were made correctly (documentation files may still contain "oratakashi" as examples, which is fine).

3. Show available configurations:

   nix flake show ~/.config/home-manager

   You should see your new username in the configuration names.

Once you've customized all files, apply the configuration for your platform:

macOS (Intel):

nix build ~/.config/home-manager#darwinConfigurations.yourusername.system
./result/sw/bin/darwin-rebuild switch --flake ~/.config/home-manager#yourusername

macOS (Apple Silicon):

nix build ~/.config/home-manager#darwinConfigurations.yourusername-arm64.system
./result/sw/bin/darwin-rebuild switch --flake ~/.config/home-manager#yourusername-arm64

Linux:

nix run github:nix-community/home-manager -- switch --flake ~/.config/home-manager#linux

Windows (WSL):

nix run github:nix-community/home-manager -- switch --flake ~/.config/home-manager#windows

echo $HOME

grep -r "oratakashi" ~/.config/home-manager --include="*.nix"

source /nix/var/nix/profiles/default/etc/profile.d/nix-daemon.sh

sudo darwin-rebuild switch --flake ~/.config/home-manager#<username>

cp ~/.config/home-manager/emulator-fix-hackintosh/emulatorfix.plist ~/Library/LaunchAgents/
launchctl load ~/Library/LaunchAgents/emulatorfix.plist

# Check Nix version
nix --version

# Verify flake configuration
nix flake check ~/.config/home-manager

# Show flake outputs
nix flake show ~/.config/home-manager

# Dry-run to see what would change
home-manager switch --flake ~/.config/home-manager#linux --dry-run

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

This project is licensed under the MIT License - see the LICENSE file for details.