chore: implement self update mechanism & update README

Author: hacktivist123

.github/workflows/go.yaml

@@ -22,7 +22,7 @@ jobs:
         go-version: '1.24'
 
     - name: Build
-      run: go build -o kpeek .
+      run: go build -ldflags "-X github.com/hacktivist123/kpeek/cmd.version=${{ env.VERSION }}" -o kpeek .
 
     - name: Upload Archives
       uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -50,12 +50,19 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_PASSWORD }}
 
+      - name: Build kpeek with version
+        run: |
+          echo "Building kpeek with version: ${{ steps.bump_version.outputs.new_tag }}"
+          go build -ldflags "-X github.com/hacktivist123/kpeek/cmd.version=$${{ steps.bump_version.outputs.new_tag }}" -o kpeek .
+
       - name: Build and push Docker image
         uses: docker/build-push-action@v5
         with:
           push: true
           platforms: linux/amd64,linux/arm64
-          tags: coderblvck/kpeek:latest
+          tags: |
+            coderblvck/kpeek:latest
+            coderblvck/kpeek:${{ steps.bump_version.outputs.new_tag }}
           cache-from: type=registry,ref=coderblvck/kpeek:buildcache
           cache-to: type=registry,ref=coderblvck/kpeek:buildcache,mode=max
           secrets: |

Dockerfile

@@ -1,12 +1,4 @@
 # Dockerfile
-FROM golang:1.24-alpine AS builder
-WORKDIR /app
-COPY go.mod go.sum ./
-RUN go mod download
-COPY . .
-RUN go build -o kpeek .
-
-FROM alpine:latest
-WORKDIR /app
-COPY --from=builder /app/kpeek /usr/local/bin/kpeek
+FROM alpine:3.18
+COPY kpeek /usr/local/bin/kpeek
 ENTRYPOINT ["kpeek"]

README.md

@@ -16,24 +16,32 @@
 
 ## Installation
 
-- Go Install  
+### Using Go Install  
 
 ```bash
 go install github.com/hacktivist123/kpeek@latest
 ```
 
-> [!NOTE]
-> You might need to add `$HOME/go/bin` to Your `$PATH` after installation
+> [!INFO]
+> - The above command does not embed an official release version in the binary. If you run `kpeek update` and your local version is unrecognized, kpeek may always see itself as outdated. You can still successfully update to the latest release, but your local binary won’t display an exact version string.
+> - You might need to add `$HOME/go/bin` to Your `$PATH` after installation
 
-- Build From Source
+## Pre-Compiled Binaries
+
+For an officially versioned kpeek build, download a pre-built release binary. Place it in your PATH, and you’ll have the correct version string for self-updates.
+
+### Build From Source (with Version Injection)
 
 ```bash
 git clone https://github.com/hacktivist123/kpeek.git
 cd kpeek
-go build -o kpeek .
+go build -ldflags "-X github.com/hacktivist123/kpeek/cmd.version=v0.7.0" -o kpeek .
 ./kpeek --help
 ```
 
+>[!INFO]
+> Replace `v0.7.0` with the appropriate release version. This approach embeds the release version in the binary, which ensures that commands like kpeek update correctly compare the local version with the latest release.
+
 - Run With `go run`
 
 ```bash
@@ -59,6 +67,72 @@ kpeek [resource/type-name] [flags]
 | `--log-tail int` | Display only the last N lines of logs (`0` for all) |
 | `--log-regex` | Regular expression to filter log lines |
 
+## How to Update
+
+kpeek includes a built-in command that checks GitHub for a newer release and updates the local binary if one is found. To use it, simply run:
+
+```bash
+kpeek update
+```
+
+If a newer version is available, kpeek will automatically download the latest release and replace your current binary. This makes staying up-to-date easy and requires no manual download or reinstallation.
+
+## Running kpeek as a kubectl Plugin
+
+kpeek is designed to work seamlessly as a standalone CLI tool—but you can also run it as a kubectl plugin for a more native Kubernetes experience. Follow the steps below to set up and use kpeek as a kubectl plugin.
+
+### Installation Steps
+
+1. **Build or Download kpeek**  
+
+   - **Build from Source:**  
+     Run the following command in your kpeek project directory:
+
+     ```bash
+     go build -o kpeek .
+     ```
+
+   - **Download Pre-Built Binary:**  
+     Alternatively, download the latest release binary from our [GitHub Releases](https://github.com/hacktivist123/kpeek/releases).
+
+2. **Rename the Binary**  
+   Kubectl recognizes plugins by the `kubectl-` prefix. Rename the kpeek binary:
+
+   ```bash
+   mv kpeek kubectl-kpeek
+    ```  
+
+3. **Place the Plugin in Your PATH**
+
+    Ensure that the directory containing kubectl-kpeek is in your system’s PATH. For example, you can move it to /usr/local/bin:
+
+    ```bash
+    sudo mv kubectl-kpeek /usr/local/bin/
+    ```
+
+    If you prefer a custom directory, add that directory to your PATH in your shell configuration file (e.g., .bashrc or .zshrc).
+
+4. **Verify Installation**
+
+    Run the following command to ensure kubectl discovers the plugin:
+
+    ```bash
+    kubectl kpeek --help
+    ```
+
+    You should see the kpeek help output, which confirms that the plugin is correctly installed.
+
+### Additional Tips
+
+- **Pre-Built Binaries**:
+If you download a pre-built binary from GitHub releases, remember to rename it to kubectl-kpeek before moving it to a directory in your $PATH.
+
+- **Plugin Discovery**:
+Kubectl automatically discovers any executable named with the kubectl- prefix. No further configuration is necessary, but you can optionally create a plugin configuration file at $HOME/.kube/plugins.yaml if you want to document your installed plugins.
+
+- **Flag Compatibility**:
+All the flags available in the standalone kpeek (e.g., --no-logs, --include-events, --log-tail, --log-regex) work exactly the same when you run kpeek as a kubectl plugin.
+
 ## Contributing
 
 - Fork this repository and clone your fork.

cmd/update.go

@@ -0,0 +1,103 @@
+package cmd
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"os"
+	"strings"
+	"time"
+
+	"github.com/blang/semver"
+	"github.com/rhysd/go-github-selfupdate/selfupdate"
+	"github.com/spf13/cobra"
+)
+
+var version = "v0.7.0"
+
+var updateCmd = &cobra.Command{
+	Use:   "update",
+	Short: "Update kpeek to the latest version",
+	Long: `Check GitHub for a newer release of kpeek and update the binary automatically.
+
+This command fetches the latest release from GitHub (repository "hacktivist123/kpeek") and
+replaces the current binary if a newer version is available. It will retry a few times if
+the network is unreachable.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println("Checking for updates...")
+
+		rawVersion := strings.TrimPrefix(version, "v")
+		vLocal, err := semver.ParseTolerant(rawVersion)
+		if err != nil {
+			fmt.Printf("Could not parse local version (%s): %v\n", version, err)
+			fmt.Println("Falling back to version 0.0.0 for update checks.")
+			vLocal = semver.MustParse("0.0.0")
+		}
+
+		const maxRetries = 3
+		var success bool
+		var updateErr error
+
+		for attempt := 1; attempt <= maxRetries; attempt++ {
+			updateErr = attemptUpdate(vLocal)
+			if updateErr == nil {
+				success = true
+				break
+			}
+
+			if isOfflineOrNetworkError(updateErr) {
+				fmt.Printf("Network error (attempt %d/%d): %v\n", attempt, maxRetries, updateErr)
+				if attempt < maxRetries {
+					fmt.Println("Retrying in 2s...")
+					time.Sleep(2 * time.Second)
+				}
+			} else {
+				break
+			}
+		}
+
+		if !success {
+			fmt.Printf("Update failed after %d attempt(s): %v\n", maxRetries, updateErr)
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(updateCmd)
+}
+
+func attemptUpdate(current semver.Version) error {
+	updater, err := selfupdate.NewUpdater(selfupdate.Config{})
+	if err != nil {
+		return fmt.Errorf("error creating updater: %w", err)
+	}
+
+	res, err := updater.UpdateSelf(current, "hacktivist123/kpeek")
+	if err != nil {
+		return err
+	}
+
+	if res.Version.Equals(current) {
+		fmt.Println("You are already using the latest version!")
+	} else {
+		fmt.Printf("Successfully updated to version %s\n", res.Version)
+	}
+	return nil
+}
+
+// isOfflineOrNetworkError checks if the error is likely a network issue, prompting a retry.
+func isOfflineOrNetworkError(err error) bool {
+	var netErr net.Error
+	if errors.As(err, &netErr) {
+		return true
+	}
+
+	lowerMsg := strings.ToLower(err.Error())
+	if strings.Contains(lowerMsg, "connection refused") ||
+		strings.Contains(lowerMsg, "dial tcp") {
+		return true
+	}
+
+	return false
+}

go.mod

@@ -12,6 +12,7 @@ require (
 )
 
 require (
+	github.com/blang/semver v3.5.1+incompatible // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/emicklei/go-restful/v3 v3.12.1 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
@@ -23,8 +24,11 @@ require (
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/gnostic-models v0.6.9 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/go-github/v30 v30.1.0 // indirect
+	github.com/google/go-querystring v1.0.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
+	github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
@@ -36,9 +40,13 @@ require (
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/rhysd/go-github-selfupdate v1.2.3 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/tcnksm/go-gitconfig v0.1.2 // indirect
+	github.com/ulikunitz/xz v0.5.9 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/oauth2 v0.24.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect