From da191e5ae48740c72f407c915e09114c31b9aabf Mon Sep 17 00:00:00 2001 From: pagedmov Date: Thu, 7 Nov 2024 15:07:08 -0500 Subject: [PATCH] replaced tabs with 2 spaces in script docs --- docs/scripts/commands.md | 72 ++++++++++++++++++------------------ docs/scripts/nixshortcuts.md | 58 +++++++++++++++-------------- 2 files changed, 67 insertions(+), 63 deletions(-) diff --git a/docs/scripts/commands.md b/docs/scripts/commands.md index 56f8c6e..69808b1 100644 --- a/docs/scripts/commands.md +++ b/docs/scripts/commands.md @@ -1,49 +1,49 @@ # pagedMov's Custom Command Scripts ## icanhazip - - Leverages ip and icanhazip.com to return relevant ip info for the current machine. - - Usage: - - `icanhazip` - returns public ip, local ip, and default gateway - - `icanhazip -p` - returns only public ip - - `icanhazip -l` - returns only local ip - - `icanhazip -d` - returns only default gateway - - Defined in 'modules/home/scripts/commands/icanhazip.nix' + - Leverages ip and icanhazip.com to return relevant ip info for the current machine. + - Usage: + - `icanhazip` - returns public ip, local ip, and default gateway + - `icanhazip -p` - returns only public ip + - `icanhazip -l` - returns only local ip + - `icanhazip -d` - returns only default gateway + - Defined in 'modules/home/scripts/commands/icanhazip.nix' ## invoke - - Leverages `nix run` to run any command once. Works with arguments. - - Usage: - - `invoke ` - - Example: - - `invoke hello` - - Defined in 'modules/home/scripts/commands/invoke.nix' + - Leverages `nix run` to run any command once. Works with arguments. + - Usage: + - `invoke ` + - Example: + - `invoke hello` + - Defined in 'modules/home/scripts/commands/invoke.nix' ## runbg - - Runs a command and detaches the process from the shell silently. Works with arguments. Credit to [Frost-Phoenix](https://github.com/Frost-Phoenix) for writing this script. - - Usage: - - `runbg ` - - Example: - - `runbg waybar` - - Defined in 'modules/home/scripts/commands/runbg.nix' + - Runs a command and detaches the process from the shell silently. Works with arguments. Credit to [Frost-Phoenix](https://github.com/Frost-Phoenix) for writing this script. + - Usage: + - `runbg ` + - Example: + - `runbg waybar` + - Defined in 'modules/home/scripts/commands/runbg.nix' ## toolbelt - - Opens a fuzzyfinder window with some useful utilities. Meant to be used with the Super + P bind defined in hyprland.nix, and not invoked directly from the shell. - - Defined in 'modules/home/scripts/commands/toolbelt.nix' + - Opens a fuzzyfinder window with some useful utilities. Meant to be used with the Super + P bind defined in hyprland.nix, and not invoked directly from the shell. + - Defined in 'modules/home/scripts/commands/toolbelt.nix' ## viconf - - Searches the directory held in the $FLAKEPATH environment variable for a given nix file or directory name. Opens the file found in neovim, or if there are multiple matches, opens a fuzzyfinder window to allow you to choose one. - - Usage: - - `viconf ` - - Examples: - - `viconf hyprland` - Opens $FLAKEPATH/modules/home/environment/hyprland.nix - - `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 scripts/def` - Opens $FLAKEPATH/modules/home/scripts/default.nix - - Defined in 'modules/home/scripts/commands/viconf.nix' + - Searches the directory held in the $FLAKEPATH environment variable for a given nix file or directory name. Opens the file found in neovim, or if there are multiple matches, opens a fuzzyfinder window to allow you to choose one. + - Usage: + - `viconf ` + - Examples: + - `viconf hyprland` - Opens $FLAKEPATH/modules/home/environment/hyprland.nix + - `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 scripts/def` - Opens $FLAKEPATH/modules/home/scripts/default.nix + - Defined in 'modules/home/scripts/commands/viconf.nix' ## vipkg - - Searches the pkgs directory from the nixpkgs github repository. Works almost identically to viconf with a few tweaks to accomodate the different directory structure. Useful for when you want to override a package's build attributes. Can also just be used to search for a package name. - - Usage: - - `vipkg ` - - Example: - - `vipkg neofetch` - Opens nixpkgs/pkgs/tools/misc/neofetch/default.nix - - Defined in 'modules/home/scripts/commands/vipkg.nix' + - Searches the pkgs directory from the nixpkgs github repository. Works almost identically to viconf with a few tweaks to accomodate the different directory structure. Useful for when you want to override a package's build attributes. Can also just be used to search for a package name. + - Usage: + - `vipkg ` + - Example: + - `vipkg neofetch` - Opens nixpkgs/pkgs/tools/misc/neofetch/default.nix + - Defined in 'modules/home/scripts/commands/vipkg.nix' diff --git a/docs/scripts/nixshortcuts.md b/docs/scripts/nixshortcuts.md index a1b0975..3b0025e 100644 --- a/docs/scripts/nixshortcuts.md +++ b/docs/scripts/nixshortcuts.md @@ -1,36 +1,40 @@ # 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' + - 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' + - 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 ` - - Example: - - `nsp hello` - - Defined in 'modules/home/scripts/nix/nsp.nix' + - Simple alias for `nix-shell -p` + - Usage: + - `nsp ` + - 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 $FLAKEPATH` - - `rebuild -s` - Runs `nh os switch -H $FLAKEPATH` - - Defined in 'modules/home/scripts/nix/rebuild.nix' + - nh os switch and nh home switch packaged into one command + - Usage: + - `rebuild -h` - Runs `nh home switch -c $FLAKEPATH` + - `rebuild -s` - Runs `nh os switch -H $FLAKEPATH` + - Defined in 'modules/home/scripts/nix/rebuild.nix'