❄ Personal NixOS Flake Manager
nixos
home-manager
go
nix
docs: add readme
+50
+50
README.md
+50
README.md
···
1
+
# ❄ Rui
2
+
3
+
Rui is my personal NixOS flake manager. It isn't very unique to my system at the
4
+
moment, so anyone can use it.
5
+
6
+
## Some Useful Commands
7
+
8
+
- `rui edit` - Open and edit your flake directory from anywhere
9
+
- `rui home/os switch` - Rebuild and switch your home or OS flake configuration
10
+
from anywhere
11
+
- `rui home news` - Show the latest news from your Home Manager configuration
12
+
packages
13
+
14
+
Rui checks the `FLAKE` environment variable for the path to your flake
15
+
directory.
16
+
17
+
Rui looks at the `FLAKE_EDITOR` environment variable for the editor to use when
18
+
opening the flake directory, but falls back to `EDITOR` if it isn't set.
19
+
20
+
## `--help`
21
+
22
+
```text
23
+
NAME:
24
+
rui - A new cli application
25
+
26
+
USAGE:
27
+
rui [global options] command [command options]
28
+
29
+
DESCRIPTION:
30
+
Personal NixOS Flake Manager
31
+
32
+
AUTHOR:
33
+
Fuwn <contact@fuwn.me>
34
+
35
+
COMMANDS:
36
+
home
37
+
os
38
+
edit
39
+
help, h Shows a list of commands or help for one command
40
+
41
+
GLOBAL OPTIONS:
42
+
--help, -h show help
43
+
44
+
COPYRIGHT:
45
+
Copyright (c) 2024-2024 Fuwn
46
+
```
47
+
48
+
## Licence
49
+
50
+
This project is licensed with the [GNU General Public License v3.0](./LICENSE.txt).