added documentation for nix scripts

This commit is contained in:
pagedmov
2024-11-07 15:02:47 -05:00
parent fcf19c6597
commit 46b8eb6a93
2 changed files with 37 additions and 1 deletions

View File

@@ -35,7 +35,7 @@
- `viconf <part of path or filename>` - `viconf <part of path or filename>`
- Examples: - Examples:
- `viconf hyprland` - Opens $FLAKEPATH/modules/home/environment/hyprland.nix - `viconf hyprland` - Opens $FLAKEPATH/modules/home/environment/hyprland.nix
- `viconf sys` - Opens fuzzyfinder window containing all nix files in modules/sys - `viconf sys` - Opens fuzzyfinder window containing all nix files in modules/sys and its subdirectories
- `viconf config` - Opens fuzzyfinder window containing all nix files called 'config.nix' - `viconf config` - Opens fuzzyfinder window containing all nix files called 'config.nix'
- `viconf scripts/def` - Opens $FLAKEPATH/modules/home/scripts/default.nix - `viconf scripts/def` - Opens $FLAKEPATH/modules/home/scripts/default.nix
- Defined in 'modules/home/scripts/commands/viconf.nix' - Defined in 'modules/home/scripts/commands/viconf.nix'

View File

@@ -0,0 +1,36 @@
# pagedMov's Nix Aliases
## fetchfromgh
- Given a username and repo name like someuser/somerepo, generates a full pkgs.fetchFromGitHub call.
- Usage:
- `fetchfromgh someuser/somerepo`
- Example:
- `fetchfromgh pagedMov/nixos-config` - returns this:
src = pkgs.fetchFromGitHub {
owner = "pagedMov";
repo = "nixos-config";
rev = "fcf19c65971c667f67abf57bcaf88be410fb0759";
hash = "sha256-z+3E+ueSd2QNqtrbBKt8bwIfboPCXSUrGn690Hc/kl0=";
};
- Defined in 'modules/home/scripts/nix/fetchfromgh.nix'
## garbage-collect
- Runs the Nix garbage collector and also deletes all files in .local/share/Trash
- Usage:
- `garbage-collect` - Does not take any arguments
- Defined in 'modules/home/scripts/nix/garbage-collect.nix'
## nsp
- Simple alias for `nix-shell -p`
- Usage:
- `nsp <package name>`
- Example:
- `nsp hello`
- Defined in 'modules/home/scripts/nix/nsp.nix'
## rebuild
- nh os switch and nh home switch packaged into one command
- Usage:
- `rebuild -h` - Runs `nh home switch -c <currenthostname> $FLAKEPATH`
- `rebuild -s` - Runs `nh os switch -H <currenthostname> $FLAKEPATH`
- Defined in 'modules/home/scripts/nix/rebuild.nix'