Below:

* Added user-friendly GUI along with respective install, uninstall, update scripts
* Added uninstall-undervolt.sh to distributables
* Improved the README docs
* Updated go.yml GitHub Actions Workflow to build both CLI and GUI binaries and distribute them

Author: SanmayJoshi

.github/workflows/go.yml

@@ -41,23 +41,32 @@ jobs:
         echo "All required dependencies are installed"
     - name: Build undervolt-go
       run: |
-        echo "Building undervolt-go..."
-        go build -ldflags="-X 'main.version=$(git describe --tags)'" -o undervolt-go main.go # When building your application, pass the version from git tags using ldflags.
+        echo "Building Undervolt Go..."
+        go build -ldflags="-X 'main.version=$(git describe --tags)'" -o undervolt-go . # When building your application, pass the version from git tags using ldflags.
+        echo "Build complete!"
+    - name: Build Undervolt Go Pro
+      run: |
+        echo "Building Undervolt Go Pro..."
+        go build -tags gui -ldflags="-X main.version=$(git describe --tags)" -o undervolt-go-pro .
         echo "Build complete!"
     - name: Make compiled binary available
       run: |
         echo "Working on making the compiled binary available..."
-        mkdir latest-build public
+        mkdir latest-build latest-pro-build public
         cp -r ./undervolt-go ./latest-build/ # Copy the binary to the latest-build directory
-        cp -r ./dist/script/* ./latest-build/ # Copy the install scripts to the latest-build directory
+        cp -r ./undervolt-go-pro ./latest-pro-build/ # Copy the binary to the latest-pro-build directory
+        cp -r ./dist/script/cli/* ./latest-build/ # Copy the install scripts to the latest-build directory
+        cp -r ./dist/script/gui/* ./latest-pro-build/ # Copy the install scripts to the latest-pro-build directory
         echo "Ready to deploy!"
     - name: Compress the 'latest-build' and make it available in 'public'
       run: |
         zip -r undervolt-go.zip ./latest-build/ # Make a zip file of the latest build
+        zip -r undervolt-go-pro.zip ./latest-pro-build/ # Make a zip file of the latest build
         cp -r undervolt-go.zip ./public/
+        cp -r undervolt-go-pro.zip ./public/
         echo "Compress complete and available in public directory!"
-        echo "Removing the now unused latest-build directory and undervolt-go.zip..."
-        rm -r undervolt-go.zip latest-build
+        echo "Removing the now unused directory and archives..."
+        rm -r undervolt-go.zip undervolt-go-pro.zip latest-build latest-pro-build
         echo "Removing complete!"
     - name: Output the files structure into a JSON file
       run: |

README.md

@@ -1,6 +1,6 @@
-# undervolt-go
+# Undervolt Go
 
-**undervolt-go** is a Go port of the original [undervolt](https://github.com/georgewhewell/undervolt) utility, designed to allow users to undervolt Intel CPUs on Linux systems. Undervolting can help reduce CPU temperatures, decrease power consumption, and potentially increase system stability and longevity. **undervolt-go** gives the advantage of running the application without the need for any dependencies.
+**Undervolt Go** is a power-utility, designed to allow users to undervolt Intel CPUs on Linux systems. Undervolting can help reduce CPU temperatures, decrease power consumption, and potentially increase system stability and longevity. **Undervolt Go** gives the advantage of running the application without the need for any dependencies, and also features a user-friendly graphical version.
 
 Get it [here](https://softorage.github.io/undervolt-go/).
 
@@ -24,11 +24,11 @@ _**Note:**_
 
 ## Introduction
 
-**undervolt-go** enables users to apply voltage offsets to various components of Intel CPUs, such as the core, cache, GPU, and more. By adjusting these voltage offsets, users can achieve lower power consumption and reduced heat output, which is particularly beneficial for laptops and compact systems where thermal management is crucial.
+**Undervolt Go** enables users to apply voltage offsets to various components of Intel CPUs, such as the core, cache, GPU, and more. By adjusting these voltage offsets, users can achieve lower power consumption and reduced heat output, which is particularly beneficial for laptops and compact systems where thermal management is crucial.
 
 ## Building
 
-To build **undervolt-go**, follow these steps:
+To build **Undervolt Go**, follow these steps:
 
 1. **Clone the repository:**
 
@@ -62,13 +62,16 @@ To build **undervolt-go**, follow these steps:
 
 ## Installation
 
-To install **undervolt-go** on your system, follow these steps:
-1. Download latest release from [offical nightly builds](https://softorage.github.io/undervolt-go/)
+To install **Undervolt Go** on your system, follow these steps:
+1. Download latest release from [offical nightly builds](https://softorage.github.io/undervolt-go/).
+   - You can download the GUI version (slightly more in size) or the CLI version.
+   - The GUI version can also run the CLI commands. The commands need to be passed to `undervolt-go-pro`
 2. Extract the archive. You should now have the following files:
-   1. undervolt-go
+   1. undervolt-go or undervolt-go-pro
    2. install-undervolt.sh
-   3. update-undervolt.sh
-3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have it):
+   3. uninstall-undervolt.sh
+   4. update-undervolt.sh
+3. Simply make install-undervolt.sh executable (or update-undervolt.sh if you already have Undervolt Go installed on your system):
    - `chmod +x install-undervolt.sh`
    - or you can right click install-undervolt.sh, go to Properties, and in the Permissions tab, tick 'Make executable'
 4. If you have built the binary by yourselves, replace the downloaded undervolt-go with your undervolt-go
@@ -77,7 +80,7 @@ To install **undervolt-go** on your system, follow these steps:
 
 ## Usage
 
-**undervolt-go** requires root privileges to interact with the CPU's model-specific registers (MSRs). Ensure you have the necessary permissions before proceeding.
+**Undervolt Go** requires root privileges to interact with the CPU's model-specific registers (MSRs). Ensure you have the necessary permissions before proceeding.
 
 1. To apply a voltage offset, use the following syntax:
 
@@ -132,9 +135,13 @@ To install **undervolt-go** on your system, follow these steps:
 
 ## Features
 
+- **GUI:** Interact with 'Undervolt Go' from a user-friendly graphical user interface.
 - **Voltage Offset Adjustment:** Apply custom voltage offsets to CPU components to optimize performance and thermal characteristics.
-- **Temperature Target Override:** Set a custom temperature target for CPU throttling.
+- **Temperature Target Override:** Set a custom temperature target for CPU throttling, on AC or battery power.
 - **Power Limit Configuration:** Adjust the CPU's power limits to control performance and power consumption.
+- **Intel Turbo Adjustment:** Enable or disable Intel Turbo for optimal performance.
+- **Temperature Monitoring:** Monitor and display the current temperature of the CPU.
+- **Fan Monitoring:** Monitor and display the current fan speed of the CPU.
 
 ## Dependencies
 
@@ -151,14 +158,15 @@ To install **undervolt-go** on your system, follow these steps:
 
 ## Configuration
 
-**undervolt-go** does not use a configuration file. All settings are applied via command-line arguments. To maintain settings across reboots, you can either consider creating a startup script that runs your preferred `undervolt-go` command, or add the preferred `undervolt-go` command in `.profile` file. You may need to edit the `sudoers` file to allow running `undervolt-go` as sudo without requiring password.
+**Undervolt Go** does not use a configuration file. All settings are applied via command-line arguments. To maintain settings across reboots, you can either consider creating a startup script that runs your preferred `undervolt-go` command, or add the preferred `undervolt-go` command in `.profile` file. You may need to edit the `sudoers` file to allow running `undervolt-go` as sudo without requiring password.
 
 To edit `sudoers` file,
 1. Type in terminal `sudo visudo`.
-2. Add the below line at last of the sudoers file to allow running `undervolt-go` as sudo without requiring password
-   `username ALL=(ALL) NOPASSWD: /usr/local/bin/undervolt-go` 
+2. Add the below line at last of the sudoers file to allow running **Undervolt Go** as sudo without requiring password
+    - `username ALL=(ALL) NOPASSWD: /usr/local/bin/undervolt-go`
+    - `username ALL=(ALL) NOPASSWD: /usr/local/bin/undervolt-go-pro` # in case you are using the graphical version
 3. `Ctrl`+`X` to exit, `y` and `enter` to save.
-4. Make sure that you are absolutely sure that the computer won't crash with the commands that you are putting in `.profile`. Otherwise, your computer will always crash upon login. In such a case, you may try to shift to tty4 (`Ctrl`+`Alt`+`F4`) before login (or any other tty), and remove the commands causing issues from `.profile` file. This would usually work if X Server is causing issues.
+4. Make sure that you are absolutely sure that the computer won't crash with the commands that you are putting in `.profile`. Otherwise, your computer will always crash upon login. In such a case, you may try to shift to `tty4` (`Ctrl`+`Alt`+`F4`) before login (or any other `tty`), and remove the commands causing issues from `.profile` file. This would usually work if X Server is causing issues.
 
 
 ## Examples
@@ -197,43 +205,45 @@ To edit `sudoers` file,
 
 1. Is undervolting safe?
 
-Undervolting can be safe if done correctly, but it carries inherent risks. Applying incorrect voltage settings can lead to system instability, crashes, or hardware damage. Start with small negative voltage offsets, and choose the offset just before the system starts crashing. You may have to manually cut the power when the system crashes due to undervolt.
+   Undervolting can be safe if done correctly, but it carries inherent risks. Applying incorrect voltage settings can lead to system instability, crashes, or hardware damage. Start with small negative voltage offsets, and choose the offset just before the system starts crashing. You may have to manually cut the power when the system crashes due to undervolt.
 
-2. Do I need to install any dependencies to use undervolt-go?
+2. Do I need to install any dependencies to use Undervolt Go?
 
-No, undervolt-go is built using Go and does not require any external dependencies. However, to interact with CPU settings, the application needs to run with elevated privileges.
+   No, Undervolt Go is built using Go and does not require any external dependencies. However, to interact with CPU settings, the application needs to run with elevated privileges.
 
-3. How do I use undervolt-go to undervolt my CPU?
+3. How do I use Undervolt Go to undervolt my CPU?
 
-To use undervolt-go:
+   To use Undervolt Go:
 
-   Mehtod 1: Without installation:
+      Mehtod 1: Without installation:
 
-   - Open Terminal: Launch your terminal application.​
-   - Navigate to the Executable Location: Ensure you're in the directory containing the undervolt-go executable (`cd` into the directory where 'undervolt-go' is located) or provide the full path to it.​
-   - Run the Executable: Execute the program with appropriate permissions:​
-      `sudo ./undervolt-go`
+      - Open Terminal: Launch your terminal application.​
+      - Navigate to the Executable Location: Ensure you're in the directory containing the undervolt-go executable (`cd` into the directory where 'undervolt-go' is located) or provide the full path to it.​
+      - Run the Executable: Execute the program with appropriate permissions:​
+         `sudo ./undervolt-go`
 
-   Mehtod 2: With installation:
+      Mehtod 2: With installation:
 
-   - Open Terminal: Launch your terminal application.
-   - Navigate to the undervolt-go directory: Change to the directory containing the undervolt-go executable, along with the install-undervolt.sh and update-undervolt.sh scripts. Make sure that all the files are in the same directory.
-   - Install undervolt-go: Run the install-undervolt.sh script: 
-      `sudo ./install-undervolt.sh`
-   - Run undervolt-go: You can now use 'undervolt-go' from any directory.Run the undervolt-go executable with root privileges:
-      `sudo undervolt-go`
+      - Navigate to the undervolt-go or undervolt-go-pro directory: Change to the directory containing the undervolt-go executable or undervolt-go-pro executable for graphical version, along with the install-undervolt.sh, uninstall-undervolt.sh and update-undervolt.sh scripts. Make sure that all the files are in the same directory.
+      - Open Terminal: Launch your terminal application in the undervolt-go or undervolt-go-pro directory.
+      - Install Undervolt Go: Run the install-undervolt.sh script: 
+         `sudo ./install-undervolt.sh`
+      - Run Undervolt Go:
+         - For `undervolt-go`, you can now use 'Undervolt Go' from any directory. Run the `undervolt-go` command with root privileges:
+            - `sudo undervolt-go --help`
+         - For `undervolt-go-pro`, you can now launch 'Undervolt Go' from your desktop. Just click or double-click on the 'Undervolt Go' icon to run the graphical version. You will be prompted root password and then the program will run.
 
 4. Do you use AI to develop this project?
 
-We may use AI when developing this project. If you find any issues, please report them to us. We will try to fix them as soon as possible.
+   We may use AI when developing this project. If you find any issues, please report them to us. We will try to fix them as soon as possible.
 
-5. Which Intel CPUs are supported by undervolt-go?
+5. Which Intel CPUs are supported by Undervolt Go?
 
-undervolt-go supports a range of Intel CPUs, particularly those from the Haswell generation and newer. However, compatibility can vary based on your specific system configuration. 
+   Undervolt Go supports a range of Intel CPUs, particularly those from the Haswell generation and newer. However, compatibility can vary based on your specific system configuration. 
 
 ## Contributors
 
-We welcome contributions from the community. If you'd like to contribute to **undervolt-go**, please fork the repository and submit a pull request with your changes.
+We welcome contributions from the community. If you'd like to contribute to **Undervolt Go**, please fork the repository and submit a pull request with your changes.
 
 ## Credits
 

dist/script/install-undervolt.sh dist/script/cli/install-undervolt.shdist/script/install-undervolt.sh renamed to dist/script/cli/install-undervolt.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# uninstall-undervolt.sh
+# This script removes the undervolt Go binary from /usr/local/bin.
+#
+# Usage:
+#   sudo ./uninstall-undervolt.sh
+
+set -e
+
+# Ensure script is run as root.
+if [[ $EUID -ne 0 ]]; then
+  echo "This script must be run as root. Try using sudo."
+  exit 1
+fi
+
+INSTALL_PATH="/usr/local/bin/undervolt-go"
+
+# Check if the file exists before attempting to remove it
+if [[ -f "${INSTALL_PATH}" ]]; then
+  echo "Removing ${INSTALL_PATH}..."
+  rm -f "${INSTALL_PATH}"
+  echo "Uninstallation complete. 'undervolt-go' has been removed."
+else
+  echo "No installation found at ${INSTALL_PATH}."
+fi

dist/script/cli/uninstall-undervolt.sh

@@ -0,0 +1,82 @@
+#!/bin/bash
+# install-undervolt.sh
+# Installs undervolt-go and sets up desktop launcher with pkexec
+
+set -e
+
+# Ensure script is run as root
+if [[ $EUID -ne 0 ]]; then
+  echo "This script must be run as root. Try using sudo."
+  exit 1
+fi
+
+echo "Installing Undervolt Go..."
+
+# Install binary
+INSTALL_PATH="/usr/local/bin/undervolt-go-pro"
+cp undervolt-go-pro "${INSTALL_PATH}"
+chmod +x "${INSTALL_PATH}"
+
+# Install wrapper
+WRAPPER_PATH="/usr/bin/undervolt-go-wrapper"
+echo "Creating pkexec wrapper at ${WRAPPER_PATH}..."
+cat <<EOF > "${WRAPPER_PATH}"
+#!/bin/bash
+export DISPLAY=:0
+export XAUTHORITY=/home/\${SUDO_USER}/.Xauthority
+exec ${INSTALL_PATH}
+EOF
+chmod +x "${WRAPPER_PATH}"
+
+# Install icon (optional: replace with your own icon)
+ICON_PATH="/usr/share/icons/undervolt-go.png"
+if [[ -f "icon.png" ]]; then
+  cp icon.png "${ICON_PATH}"
+else
+  echo "No icon.png found. You can place your own icon at ${ICON_PATH} later."
+fi
+
+# Install PolicyKit file
+POLKIT_FILE="/usr/share/polkit-1/actions/com.softorage.undervolt-go.policy"
+echo "Creating PolicyKit policy at ${POLKIT_FILE}..."
+cat <<EOF > "${POLKIT_FILE}"
+<?xml version="1.0" encoding="UTF-8"?>
+<policyconfig>
+  <action id="com.softorage.undervolt-go">
+    <description>Run 'Undervolt Go' as root</description>
+    <message>Authentication is required to run 'Undervolt Go'</message>
+    <icon_name>utilities-system-monitor</icon_name>
+    <defaults>
+      <allow_any>auth_admin</allow_any>
+      <allow_inactive>auth_admin</allow_inactive>
+      <allow_active>auth_admin</allow_active>
+    </defaults>
+  </action>
+</policyconfig>
+EOF
+
+# Install desktop file
+DESKTOP_FILE="/usr/share/applications/undervolt-go.desktop"
+echo "Creating desktop shortcut at ${DESKTOP_FILE}..."
+cat <<EOF > "${DESKTOP_FILE}"
+[Desktop Entry]
+Name=Undervolt Go
+Comment=Undervolt and tweak CPU power settings to reduce temperatures and improve performance
+Exec=pkexec ${WRAPPER_PATH}
+Icon=${ICON_PATH}
+Terminal=false
+Type=Application
+Categories=Utility;
+EOF
+
+chmod +x "${DESKTOP_FILE}"
+
+# Copy to user's desktop
+USER_DESKTOP="${SUDO_USER:-$USER}"
+USER_HOME=$(eval echo "~${USER_DESKTOP}")
+cp "${DESKTOP_FILE}" "${USER_HOME}/Desktop/"
+chmod +x "${USER_HOME}/Desktop/undervolt-go.desktop"
+chown "${USER_DESKTOP}:${USER_DESKTOP}" "${USER_HOME}/Desktop/undervolt-go.desktop"
+
+echo "Installation complete!"
+echo "You can now launch 'Undervolt Go' from the applications menu or desktop."

dist/script/update-undervolt.sh dist/script/cli/update-undervolt.shdist/script/update-undervolt.sh renamed to dist/script/cli/update-undervolt.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+# uninstall-undervolt.sh
+# Uninstalls undervolt-go-pro and removes all associated files.
+
+set -e
+
+# Ensure script is run as root
+if [[ $EUID -ne 0 ]]; then
+  echo "This script must be run as root. Try using sudo."
+  exit 1
+fi
+
+echo "Uninstalling Undervolt Go..."
+
+# Define paths
+INSTALL_PATH="/usr/local/bin/undervolt-go-pro"
+WRAPPER_PATH="/usr/bin/undervolt-go-wrapper"
+ICON_PATH="/usr/share/icons/undervolt-go.png"
+POLKIT_FILE="/usr/share/polkit-1/actions/com.softorage.undervolt-go.policy"
+DESKTOP_FILE="/usr/share/applications/undervolt-go.desktop"
+
+# Remove binary
+if [[ -f "${INSTALL_PATH}" ]]; then
+  echo "Removing binary at ${INSTALL_PATH}..."
+  rm -f "${INSTALL_PATH}"
+fi
+
+# Remove wrapper
+if [[ -f "${WRAPPER_PATH}" ]]; then
+  echo "Removing wrapper at ${WRAPPER_PATH}..."
+  rm -f "${WRAPPER_PATH}"
+fi
+
+# Remove icon
+if [[ -f "${ICON_PATH}" ]]; then
+  echo "Removing icon at ${ICON_PATH}..."
+  rm -f "${ICON_PATH}"
+fi
+
+# Remove PolicyKit file
+if [[ -f "${POLKIT_FILE}" ]]; then
+  echo "Removing PolicyKit file at ${POLKIT_FILE}..."
+  rm -f "${POLKIT_FILE}"
+fi
+
+# Remove desktop entry
+if [[ -f "${DESKTOP_FILE}" ]]; then
+  echo "Removing desktop entry at ${DESKTOP_FILE}..."
+  rm -f "${DESKTOP_FILE}"
+fi
+
+# Remove desktop shortcut from user's Desktop
+USER_DESKTOP="${SUDO_USER:-$USER}"
+USER_HOME=$(eval echo "~${USER_DESKTOP}")
+USER_DESKTOP_FILE="${USER_HOME}/Desktop/undervolt-go.desktop"
+if [[ -f "${USER_DESKTOP_FILE}" ]]; then
+  echo "Removing desktop shortcut at ${USER_DESKTOP_FILE}..."
+  rm -f "${USER_DESKTOP_FILE}"
+fi
+
+echo "Uninstallation complete. All files have been removed."

dist/script/gui/icon.png

@@ -0,0 +1,30 @@
+#!/bin/bash
+# update-undervolt.sh
+# This script updates the undervolt Go binary in /usr/local/bin, to a new provided version
+# making it available from anywhere in the terminal.
+#
+# Usage:
+#   sudo ./update-undervolt.sh
+
+set -e
+
+# Ensure script is run as root.
+if [[ $EUID -ne 0 ]]; then
+  echo "This script must be run as root. Try using sudo."
+  exit 1
+fi
+
+# Install binary to /usr/local/bin.
+INSTALL_PATH="/usr/local/bin/undervolt-go-pro"
+
+# Delete the existing binary if it exists.
+if [ -f "$INSTALL_PATH" ]; then
+  echo "Deleting existing binary at $INSTALL_PATH..."
+  rm -f "$INSTALL_PATH"
+fi
+
+echo "Installing undervolt-go to ${INSTALL_PATH}..."
+cp undervolt-go-pro "${INSTALL_PATH}"
+chmod +x "${INSTALL_PATH}"
+
+echo "Update complete! You can now use updated 'undervolt-go' from terminal. Try 'undervolt-go -h'."