dotfiles for my personal use.
Consult the following for more details.
Drop into a nix-shell with the following command. This would
download some commands required for setup, open a new temporary shell, and make
the commands available through PATH.
$ system="$(nix-instantiate --eval -E 'builtins.currentSystem' | tr -d '"')"
$ nix-shell -A "devShells.$system.setup" 'https://github.com/midchildan/dotfiles/archive/main.tar.gz'
$Fork this repository and clone it to your location of choice. Then edit
nix/config.nix and commit the changes.
$ git clone https://github.com/${USER}/dotfiles.git ~/Documents/src/repos/github.com/${USER}/dotfiles
$ cd ~/Documents/src/repos/github.com/${USER}/dotfiles
$ nvim nix/config.nix
$ git commit -am 'chore: adjust config.nix for my own use'Using the table in the Supported Platforms section,
checkout the most relevant branch for your platform. Note that instead of
checking out your chosen branch directly, it is recommended that you create a
local branch based on your chosen branch that is tied to your local machine
and check it out to a separate path for deployment. This way, you can make edits
on any branch without affecting your current configuration.
$ git branch --track local # create local branch
$ git worktree add ~/.config/dotfiles local # checkout local branchRun the setup script. This script would symlink files in files to your
home directory. It should be run each time changes are made to your dotfiles
even after bootstrapping is complete. The --init flag indicates that this is
the first time you've run this script.
$ ./setup.sh --initFor details about each, read the docs linked below. Pick the ones you need and configure them as needed before proceeding.
| Software | File | Required? |
|---|---|---|
| Home Manager | nix/home/README.md | yes |
| NixOS | nix/nixos/README.md | no |
| Nix-Darwin | nix/darwin/README.md | no |
Bootstrapping instructions for each are listed below. Home Manager can optionally be integrated into NixOS or Nix-Darwin. If you do this, NixOS or Nix-Darwin would take care of bootstrapping Home Manager for you.
- Home Manager:
$ nix run '.#home' -- switch --flake .- NixOS:
$ sudo nix --experimental-features 'nix-command flakes' run '.#os' -- switch --flake '.#'- nix-darwin:
$ nix --experimental-features 'nix-command flakes' run '.#os' -- switch --flake '.#'
$ sudo -H nix-env -e '*' # remove existing packages not managed by nix-darwin| branch | platform |
|---|---|
| main | Linux |
| osx | macOS |
In addition to the platforms listed above, support for one-off remote Linux
sessions is included in the gh-pages branch. This is useful in cases where
it's cumbersome to maintain a full-blown dotfiles, e.g. docker sessions, servers
you rarely login to directly, etc. Notably, this branch doesn't require Nix. See
here for details.
Changes common to all platforms should first be made in main, and then merged
into the remaining branches. Make sure you never go the other way and merge
non-main branches into main or you'll end up with non-common
platform-specific stuff in main.