Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hlissner/dotfiles

And I say hey, what's going on?
https://github.com/hlissner/dotfiles

dotfiles nix-flake nixos nixos-configuration

Last synced: 2 days ago
JSON representation

And I say hey, what's going on?

Host: GitHub
URL: https://github.com/hlissner/dotfiles
Owner: hlissner
License: mit
Created: 2013-03-01T08:33:14.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-12-07T00:02:43.000Z (15 days ago)
Last Synced: 2024-12-12T08:04:32.815Z (9 days ago)
Topics: dotfiles, nix-flake, nixos, nixos-configuration
Language: Nix
Homepage: https://youtu.be/ZZ5LpwO-An4
Size: 23.7 MB
Stars: 1,689
Watchers: 44
Forks: 99
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred-test - hlissner/dotfiles - And I say hey, what's going on? (Nix)

README

[![Made with Doom Emacs](https://img.shields.io/badge/Made_with-Doom_Emacs-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white)](https://github.com/doomemacs)
[![NixOS Unstable](https://img.shields.io/badge/NixOS-24.05-blue.svg?style=flat-square&logo=NixOS&logoColor=white)](https://nixos.org)

**Hey,** you. You're finally awake. You were trying to configure your OS
declaratively, right? Walked right into that NixOS ambush, same as us, and those
dotfiles over there.

> [!IMPORTANT]
> **Disclaimer:** _This is not a "community framework" or "NixOS distribution"._
> Please do not use it like one. It is an ongoing and haphazard experiment to
> feel out NixOS for my own purposes, and is home to all manner of unspeakable,
> overly-opinionated hackery that make the other 9 circles of hell look like
> tropical beach resorts.
>
> Until I can bend spoons with my Nix-fu, please divert your general Nix(OS)
> questions [to the NixOS discourse][nixos-discourse] instead of my issue
> tracker. That said, I'm more than happy [to hear input and discuss
> ideas](/discussions), but be warned: I struggle to stay on top of Github
> notifications most of the time.

(screenshots coming soon)

------

| | Wayland | X11 |
|---------------|-------------------------|--------------------------------------------------|
| **Shell:** | zsh + zgenom | " |
| **WM:** | hyprland + waybar | lightdm + lightdm-mini-greeter + bspwm + polybar |
| **Editor:** | [Doom Emacs][doomemacs] | " |
| **Terminal:** | foot | st |
| **Launcher:** | rofi | " |
| **Browser:** | firefox | " |

-----

## Quick start

1. Acquire or build a NixOS 24.05+ image:
```sh
# Yoink nixos-unstable from upstream
$ wget -O nixos.iso https://channels.nixos.org/nixos-unstable/latest-nixos-minimal-x86_64-linux.iso
```

2. Write it to a USB drive:
```sh
# Replace /dev/sdX with the correct partition!
$ cp nixos.iso /dev/sdX
```

3. Restart and boot into the installer.

4. Do your partitions and mount your root to `/mnt` ([for
example](hosts/udon/README.org)).

5. Clone these dotfiles somewhere:
```sh
$ git clone --recursive https://github.com/hlissner/dotfiles
```

6. Create a host config in `hosts/` (see [existing ones](hosts/) for examples).

7. Run the installer:
```sh
# The options are optional, but these are their default values, if you omit them.
$ dotfiles/install.zsh \
--root /mnt \
--flake /mnt/etc/dotfiles \
--user "$USER" \
--host "$HOST" \
--dest /mnt/home/$USER/.config/dotfiles
```

8. Then reboot and you're good to go!

> [!WARNING]
> Don't forget to change your `root` and `$USER` passwords! They are set to
> `nixos` by default.

## Management

And I say, `bin/hey`, [what's going on?](https://youtu.be/ZZ5LpwO-An4).

```
SYNOPSIS:
hey [-?|-??|-???|-!] [-h|--help] COMMAND [ARGS...]

OPTIONS:
-! -- Do a dry run. WARNING: It's up to called scripts to obey!
-?,-??,-??? -- Enable debug (verbose) mode.
-h,--help -- Display the documentation embedded in a target script's
header.

COMMANDS:
- build|b -- Build nix images or recompile bin/hey
- exec -- Dispatch to $DOTFILES_HOME/{,hosts/$HOST,config/$WM}/bin/shim.d $PATH
- get|set -- Alias for hey vars {get,set} ...
- gc -- Run garbage collection on the user's/system's profile
- help|h -- Display documentation for the command
- hook -- Trigger scripts associated with an event
- host -- Dispatch to $DOTFILES_HOME/hosts/$HOST/bin
- info -- Display information about current system (JSON)
- path -- Display path to area of my dotfiles
- profile -- Manage or analyze a system or user nix profile
- pull -- Update flake inputs
- reload -- Run reload hooks
- repl -- Open a Janet, Nix, or nix-develop REPL
- swap -- Swap nix-store symlinks with copies (and back)
- sync|s -- Rebuild this flake (using nixos-rebuild)
- test -- Run Hey and/or Nix test suites
- which -- Print out the script's path (with arguments) w/o executing it
- wm -- Dispatch to $DOTFILES_HOME/config/$WM/bin
- vars -- Get or set session or persistent state in userspace.
- @* -- Dispatch to $DOTFILES_HOME/config/${1#@}/bin
- .* -- Tries to be smart. Looks for any executable under host, wm,
then $DOTFILES_HOME/bin.
```

## Frequently asked questions

+ **Why NixOS?**

Because managing a fleet of servers, a hundred strong, is the tenth circle of
hell without a declarative, generational, and immutable single-source-of-truth
configuration framework like NixOS.

Sure beats the nightmare of brittle capistrano/chef/puppet/ansible/shell
scripts I left behind.

+ **Should I use NixOS?**

**Short answer:** no.

**Long answer:** no really. Don't.

**Long long answer:** I'm not kidding. Don't.

**Unsigned long long answer:** Alright alright. Here's why not:

- Its learning curve is steep.
- You _will_ trial and error your way to enlightenment, if you survive the
frustration long enough.
- NixOS is unlike other Linux distros. Your issues will be unique and
difficult to google. A decent grasp of Linux and your chosen services is a
must, if only to distinguish Nix(OS) issues from Linux (or upstream) issues
-- as well as to debug them or report them to the correct authority (and
coherently).
- If words like "declarative", "generational", and "immutable" don't put your
sexuality in jeopardy, you're considering NixOS for the wrong reasons.
- The overhead of managing a NixOS config will rarely pay for itself with 3
systems or fewer (perhaps another distro with nix on top would suit you
better?).
- Official documentation for Nix(OS) is vast, but shallow. Unofficial
resources and example configs are sparse and tend toward too simple or too
complex (and most are outdated). Case in point: this repo.
- The Nix language is obtuse and its toolchain is not intuitive. Your
experience will be infinitely worse if functional languages are alien to
you, however, learning Nix is a must to do even a fraction of what makes
NixOS worth the trouble.
- If you need somebody else to tell you whether or not you need NixOS, you
don't need NixOS.

If you're not discouraged by this, then you didn't need my advice in the first
place. Stop procrastinating and try NixOS!

+ **How do you manage secrets?**

With [agenix].

+ **Why did you write bin/hey?**

I envy Guix's CLI and want similar for NixOS, whose toolchain is spread across
many commands, none of which are as intuitive: `nix`, `nix-collect-garbage`,
`nixos-rebuild`, `nix-env`, `nix-shell`, etc.

I don't claim `hey` is the answer, but who doesn't like their own brew?

+ **How 2 flakes?**

Would it be the NixOS experience if I gave you all the answers in one,
convenient place?

No. Suffer my pain:

- [A three-part tweag article that everyone's read.](https://www.tweag.io/blog/2020-05-25-flakes/)
- [An overengineered config to scare off beginners.](https://github.com/divnix/devos)
- [A minimalistic config for scared beginners.](https://github.com/colemickens/nixos-flake-example)
- [A nixos wiki page that spells out the format of flake.nix.](https://wiki.nixos.org/wiki/Flakes)
- [Official documentation that nobody reads.](https://nixos.org/learn.html)
- [Some great videos on general nixOS tooling and hackery.](https://www.youtube.com/channel/UC-cY3DcYladGdFQWIKL90SQ)
- A couple flake configs that I
[may](https://github.com/LEXUGE/nixos)
[have](https://github.com/bqv/nixrc)
[shamelessly](https://git.sr.ht/~dunklecat/nixos-config/tree)
[rummaged](https://github.com/utdemir/dotfiles)
[through](https://github.com/purcell/dotfiles).
- [Some notes about using Nix](https://github.com/justinwoo/nix-shorts)
- [What helped me figure out generators (for npm, yarn, python and haskell)](https://myme.no/posts/2020-01-26-nixos-for-development.html)
- [Learn from someone else's descent into madness; this journals his
experience digging into the NixOS
ecosystem](https://www.ianthehenry.com/posts/how-to-learn-nix/introduction/)
- [What y'all will need when Nix drives you to drink.](https://www.youtube.com/watch?v=Eni9PPPPBpg)

And if all else fails, ask for help on [the NixOS Discourse][nixos-discourse].

[nixos-discourse]: https://discourse.nixos.org
[doomemacs]: https://github.com/doomemacs/doomemacs
[agenix]: https://github.com/ryantm/agenix