feat(dotfiles): adding some documentation

lib/aliases/archives/README.md

@@ -0,0 +1,39 @@
+# 🅰🆁🅲🅷🅸🆅🅴🆂 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to help users compress and extract files and directories in various formats on a Unix-based system.
+
+The following compression formats are supported:
+
+- 7z
+- bzip2
+- gzip
+- jar
+- lz4
+- lzma
+- lzo
+- pigz
+- tar
+- xz
+- zstd
+- zip
+
+These aliases enable users to compress or extract files and directories quickly by using simple commands.
+
+For example:
+
+- `c7z` can be used to compress a whole directory (including subdirectories) to a 7z file.
+- `e7z` can be used to extract a whole directory (including subdirectories) from a 7z file.
+
+Similarly, there are aliases for compressing and extracting files and directories in all supported formats.
+
+The aliases are designed to be easy to remember and use, and they should make the compression and extraction process much simpler for users.
+
+Please note that some of the compression formats may require additional software to be installed on your system.
+
+Enjoy the convenience of quickly compressing and extracting files and directories with these command aliases!

lib/aliases/clear/README.md

@@ -0,0 +1,23 @@
+# 🅲🅻🅴🅰🆁 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to make working with the
+terminal easier and more efficient. The following aliases are included:
+
+- `c` clears the terminal screen.
+- `cdw` changes the current directory to the workspace directory.
+- `cl` is an alias for `c`, which clears the terminal screen.
+- `clc` clears the terminal screen and lists the contents of the current directory.
+- `clh` clears the terminal screen and prints the command history.
+- `clp` clears the terminal screen and prints the current working
+  directory.
+- `clt` clears the terminal screen and prints the directory tree.
+- `cpl` clears the terminal screen and prints the current working
+  directory and the contents of the current directory.
+- `cplt` clears the terminal screen and prints the current working
+  directory and the directory tree.

lib/aliases/configuration/README.md

@@ -0,0 +1,26 @@
+# 🅲🅾🅽🅵🅸🅶🆄🆁🅰🆃🅸🅾🅽 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to open important
+configuration files in default text editors quickly and easily. The
+following aliases are included:
+
+- `apconf` opens the Apache configuration file in the default text
+  editor.
+- `bshrc` opens the Bash configuration file in the default text editor.
+- `bshp` opens the Bash profile in the default text editor.
+- `dockcomp` opens the Docker Compose file in the default text editor.
+- `eddir` opens the current directory in the default text editor.
+- `gcfg` opens the Git configuration file in the default text editor.
+- `gign` opens the Git ignore file in the default text editor.
+- `hosts` opens the hosts file in the default text editor.
+- `ngconf` opens the Nginx configuration file in the default text
+  editor.
+- `sshconf` opens the SSH configuration file in the default text editor.
+- `zshrc` opens the Zsh configuration file in the default text editor.
+- `zshp` opens the Zsh profile in the default text editor.

lib/aliases/configuration/configuration.aliases.sh

@@ -38,3 +38,6 @@ alias sshconf='${=EDITOR} $HOME/.ssh/config'
 
 # Alias to open the Zsh configuration file in the default text editor
 alias zshrc='${=EDITOR} $HOME/.zshrc'
+
+# Alias to open the Zsh profile in the default text editor
+alias zshp='${=EDITOR} $HOME/.zsh_profile'

lib/aliases/default/README.md

@@ -0,0 +1,26 @@
+# 🅳🅴🅵🅰🆄🅻🆃 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to make common tasks and
+commands more convenient and faster to execute. These aliases range from
+general purpose to system monitoring and file system navigation.
+
+Some of the most useful aliases include:
+
+- `c`: shortcut for the `clear` command to clear the terminal screen.
+- `p`: shortcut for the `pwd` command to display the current working
+  directory.
+- `h`: lists all recently used commands.
+- `path`: displays the `$PATH` variable on new lines.
+- `quit`: shortcut for the `exit` command to exit the shell.
+- `halt`, `poweroff`, `reboot`: system shutdown and reboot commands.
+- `srv`: starts a simple HTTP server.
+- `top`: allows the user to interactively monitor the system's vital
+  resources or server's processes in real-time.
+- `qfind`: quickly search for files.
+- `clc`: clear the terminal screen and print the contents of the current directory.

lib/aliases/dig/README.md

@@ -0,0 +1,24 @@
+# 🅳🅸🅶 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to simplify working with DNS
+(Domain Name System) lookup using the dig command on a Unix-based system
+.
+
+The following aliases are included:
+
+- `d`: runs the dig command with default options.
+- `d4`: performs a DNS lookup for an IPv4 address.
+- `d6`: performs a DNS lookup for an IPv6 address.
+- `dga`: performs a DNS lookup for all records.
+- `dgs`: performs a DNS lookup for a short answer.
+- `digg`: performs a dig with Google's DNS.
+- `ip4`: retrieves your public IPv4 address.
+- `ip6`: retrieves your public IPv6 address.
+- `ips`: retrieves your public IPv4 and IPv6 addresses.
+- `wip`: retrieves your public IP address.

lib/aliases/diskusage/README.md

@@ -0,0 +1,23 @@
+# 🅳🅸🆂🅺 🆄🆂🅰🅶🅴 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases to help users manage disk
+usage on a Unix-based system.
+
+The following aliases are provided:
+
+- `du`: Display the disk usage of the current directory.
+- `du1`: Show the file size of files and directories in the current
+  directory.
+- `duh`: Show the file size of files and directories.
+- `ducks`: Display the top 10 largest files and directories in the
+  current directory.
+- `dus`: Show the file size in human-readable format, sorted by size.
+- `dusym`: Show the file size of files and directories in the current
+  directory, including symlinks.
+- `dut`: Show the total file size of the current directory.

lib/aliases/editor/README.md

@@ -0,0 +1,31 @@
+# 🅴🅳🅸🆃🅾🆁 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides command aliases for editing files on a Unix-based system using various text editors. The following editors are supported:
+
+- nano
+- vim
+- vi
+- code
+- gedi
+- notepad++
+
+The aliases are designed to make it easy for users to quickly open and edit files with their preferred text editor. The aliases are:
+
+- `e`: Edit a file
+- `edit`: Edit a file
+- `editor`: Edit a file
+- `mate`: Edit a file
+- `n`: Edit a file
+- `v`: Edit a file
+
+The code checks if any of the supported editors are installed on the system and sets the corresponding alias to open the file in the available editor.
+
+This makes it easy for users to switch between editors or use their preferred editor without having to remember the specific command for each editor.
+
+Enjoy the convenience of quickly editing files with these command aliases!

lib/aliases/find/README.md

@@ -0,0 +1,33 @@
+# 🅵🅸🅽🅳 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases for the `fd` utility that is
+an alternative to the `find` command on Unix-based systems.
+
+`fd` is a simple, fast, and user-friendly tool that can be used to
+search for files and directories in a given path. These aliases make it
+easier to use `fd` by providing simple and memorable commands for common
+use cases.
+
+Here are some of the available aliases:
+
+- `fd` is the default alias for `fd --color always` that lists all files
+  with colorized output.
+- `fda` lists all files with absolute paths.
+- `fdc` lists all files with case-insensitive search.
+- `fdd` lists all files with details.
+- `fde` lists all files with a specified extension.
+- `fdf` lists all files while following symbolic links.
+- `fdh` shows help for `fd`.
+- `fdh` lists all files, including hidden files.
+- `fdn` lists all files that match a specified glob.
+- `fdo` lists all files with owner information.
+- `fds` lists all files with size.
+- `fdu` lists all files with exclusion rules.
+- `fdv` shows the version of `fd`.
+- `fdx` executes a command for each search result.

lib/aliases/gcloud/README.md

@@ -0,0 +1,52 @@
+# 🅶🅾🅾🅶🅻🅴 🅲🅻🅾🆄🅳 🅰🅻🅸🅰🆂🅴🆂
+
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" alt="dotfiles logo" width="261" align="right" />
+
+<!-- markdownlint-enable MD033 MD041 -->
+
+This code provides a set of command aliases for managing various Google
+Cloud services, such as Compute Engine, Identity and Access Management,
+and Cloud SQL. These aliases help streamline the process of managing
+Google Cloud resources by providing simple and memorable commands for
+common use cases.
+
+## Available Aliases
+
+- `gca` authenticates with Google Cloud.
+- `gcb` accesses beta commands.
+- `gcb` manages Google Cloud Build.
+- `gcca` manages Compute Engine IP addresses.
+- `gccc` creates a new virtual machine instance.
+- `gcco` connects to a virtual machine instance by using SSH.
+- `gcd` sets the default project to the current directory name.
+- `gcdb` manages Google Cloud Datastore.
+- `gcdp` manages Google Cloud Dataproc.
+- `gce` manages Google Cloud Endpoints.
+- `gcem` manages Google Cloud Eventarc.
+- `gcf` manages Google Cloud Functions.
+- `gci` manages Google Cloud Compute Engine instances.
+- `gcic` manages Google Cloud Identity and Access Management.
+- `gcir` manages Google Cloud IoT Core.
+- `gck` lists all configurations.
+- `gcki` manages Google Cloud KMS.
+- `gcla` manages Google Cloud Logging.
+- `gcma` manages Google Cloud Monitoring.
+- `gcn` manages Google Cloud Networks.
+- `gcp` manages Google Cloud projects.
+- `gcpd` deletes a Google Cloud project.
+- `gcpha` displays details for a Compute Engine IP address.
+- `gcps` manages Google Cloud Pub/Sub.
+- `gcr` deletes a container image from Google Container Registry.
+- `gcrm` manages Google Cloud resources.
+- `gcro` manages Google Cloud Run.
+- `gcs` manages Google Cloud Kubernetes Engine clusters.
+- `gcsa` sets the account for the current configuration.
+- `gcsc` manages Google Cloud Source Repositories.
+- `gcso` opens the Google Cloud Console for the current project.
+- `gcsq` manages Google Cloud SQL.
+- `gcss` manages Google Cloud Storage.
+- `gcst` enables or disables Google Cloud services.
+- `gct` manages Google Cloud Tasks.
+- `gcu` manages Google Cloud App Engine.