Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r17x/universe
my development universe ❄️ ƛ
https://github.com/r17x/universe
dotfiles home-manager linux nix nix-darwin nixpkgs nixvim osx sketchybar skhd unix wm yabai
Last synced: about 16 hours ago
JSON representation
my development universe ❄️ ƛ
- Host: GitHub
- URL: https://github.com/r17x/universe
- Owner: r17x
- Created: 2022-02-09T22:35:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T19:21:44.000Z (4 months ago)
- Last Synced: 2024-06-04T20:41:23.777Z (4 months ago)
- Topics: dotfiles, home-manager, linux, nix, nix-darwin, nixpkgs, nixvim, osx, sketchybar, skhd, unix, wm, yabai
- Language: Nix
- Homepage: https://rin.rocks
- Size: 1.29 MB
- Stars: 62
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rin's Home 🏚
> This "README" is available in 🇮🇩 [**Bahasa**](./BACALAH.md).
## Motivation
(DRY) - Don't repeat yourself is a principle in software development. We should use this principle to reduce repetitive and time-consuming work. Personally, I just try to apply this principle in my professional and personal work. The most basic example is making these dotfiles, so that I don't have to provide the needs of the devices or tools used in everyday life. So, from this motivation you can see the main goal (Goal).
The work of a software developer, software engineer, or software laborer requires tools that are used on top of a running system (termed an operating system or OS). I am familiar with using operating systems such as OSX based on Darwin/Unix made by Apple and ArchLinux based on Linux. Well my goal is to become a human user agnostic (not religiously attached to a system but still loyal to the creator of the user, except for the operating system made by Mikocok). The tools are collected in one place to store everything about tools, configurations, settings, credentials, and others that support the needs of working or just operating a computer. Where is my container? In this github, then we need git or other tools, which is clear that we stay in sync between each machine we use so that we don't do repetitive things.
To keep it pure and the same between each machine, I decided to use Nix.
## Nix
Nix is a "purely functional package manager", the Nix experience is completely different than other package managers. For some people it may seem complicated to use, but it is worth it if you understood what you really need.
If you have ever used the "virtual env" tool popular in the "python" ecosystem then you can experience the same thing but across operating systems, platforms, and programming language ecosystems.
Since nix uses functional concepts like declarative then it should be utilized well. such as declaring needs and then declaring with nix language.
> Heavily inspired from ([malob/nixpkgs](https://github.com/malob/nixpkgs)) (especially [in v1](https://github.com/r17x/universe/tree/v1))
This is my personal configuration with [nix](https://nixos.org/) using [**flakes**](https://nixos.wiki/wiki/Flakes), [**flake.part**](https://flake.parts/), [**home-manager**](https://github.com/nix-community/home-manager), & [**nix-darwin**](https://github.com/LnL7/nix-darwin) for Darwin or MacOS System.
## Structure
```console
.
├── app/* (Applications, Packages, etc.)
├── nix/* (All nix related files)
├── nix/home (All home-manager related files)
├── nix/hosts (All hosts or machines related files)
├── nix/devShells.nix (All development shells - development environment)
├── nix/nix.nix (Nix CLI configuration)
├── nvim.nix/* (All nix related files for nvim - using [**Nixvim**](https://github.com/nix-community/nixvim))
├── notes/* (All notes with [**Neorg**](https://github.com/nvim-neorg/neorg) format)
├── flake.lock (Flake lock file)
├── flake.nix (Flake file for manage inputs)
```
## Usage
### Prerequisite
#### **Nix**
##### using Nix Flake
If you are not familiar with Nix, it is recommended to read [this onboard by zero-to-nix](https://zero-to-nix.com/start/install) to get started.
But if you want to use Nix, go jump to command below:
```console
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
```
##### using Legacy Nix
Click to expand
| System | Single User | Multiple User | Command |
| ---------------------------------------------- | ----------- | ------------- | ------------------------------------------------------------------- |
| **Linux** | ✅ | ✅ | [Single User](#linux-single-user) • [Multi User](#linux-multi-user) |
| **Darwin** (MacOS) | ❌ | ✅ | [Multi User](#darwin-multi-user) |
| [**More...**](https://nixos.org/download.html) | | | |
##### Linux Single User
```console
sh <(curl -L https://nixos.org/nix/install) --daemon
```
##### Linux Multi User
```console
sh <(curl -L https://nixos.org/nix/install) --no-daemon
```
##### Darwin Multi User
```console
sh <(curl -L https://nixos.org/nix/install)
```
#### Enable `experimental-features`
In general installation of nix, the nix configuration is located in `~/.config/nix/nix.conf`.
You **MUST** be set the `experimental-features` before use [this configuration](https://github.com/r17x/universe).
```cfg
experimental-features = nix-command flakes
// (optional) for distribution cache (DON'T COPY THIS COMMENT LINE)
substituters = https://cache.nixos.org https://cache.nixos.org/ https://r17.cachix.org
```
### Setup
After you have installed Nix, you can use the following command to clone this repository:
You can use the following nix options on this repository:
#### Using development environment
```console
nix develop github:r17x/universe#
```
> [!NOTE]
> `DEVELOPMENT_ENVIRONMENT_NAME` is only available by [devShells definitions](./nix/devShells.nix#L37:L175)
nix build github:r17x/universe#darwinConfigurations.$HOSTNAME.system
##### with `direnv`
```console
echo "use flake github:r17x/universe#" > .envrc
direnv allow
# example:
echo "use flake github:r17x/universe#node20" > .envrc
direnv allow
> node -v
< v20.10.0
```
#### Activation `nix-darwin` for MacOS Environment
##### Build
```console
# output `result` to `/tmp/result`
nix build github:r17x/universe#darwinConfigurations.$HOSTNAME.system -o /tmp/result
# example: nix build github:r17x/universe#darwinConfigurations.eR17x.system -o /tmp/result
```
##### Switch - `Activate`
```console
# run `darwin-rebuild switch` to switch to latest build
# and wait until `darwin-rebuild` finish
/tmp/result/sw/bin/darwin-rebuild switch --flake github:r17x/universe#$HOSTNAME
# example: /tmp/result/sw/bin/darwin-rebuild switch --flake github:r17x/universe#eR17x
```
> [!NOTE]
> `$HOSTNAME` is only available by [hosts definitions](./nix/hosts/default.nix#L82:L83)
## `Alias` Command List
* `drb` - darwin rebuild aliases - rebuild this nixpkgs.
* `drs` - darwin rebuild and switch the build version (make current build to current version of environment).
* `lenv` - list of build version ``, that's usefull for switch aka rollback environment.
* `senv ` - switch spesific version (number).
## Resources
### Options
* [home-manager-options](https://home-manager-options.extranix.com/?query=&release=master)
## Acknowledgement
* [**malob/nixpkgs**](https://github.com/malob/nixpkgs) ~ [malob](https://github.com/malob) Nix System configs!.
* [**srid/nixos-flake**](https://github.com/srid/nixos-flake) ~ for flake-parts inspiration.