refactor: redesign with cobra and add autocomplete and version option (#39)

* refactor: redesign with cobra and add autocomplete and version option

* chore: update github action version

* feat: use viper for reading config from file

* feat: use yaml format for config file

* chore: change config format of dns to yaml

* fix: change yaml to yml

* chore: make exeption better

Author: ArmanTaheriGhaleTaki

.github/workflows/go.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '>1.23.1'
+        go-version: '>1.24.0'
 
     - name: Test
       run: go test -v ./...

.github/workflows/golangci-lint.yml

@@ -25,11 +25,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Install Go
-        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
+        uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
         with:
-          go-version: 1.23.x
+          go-version: 1.24.x
       - name: Lint
-        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
+        uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
         with:
           args: --verbose
-          version: v1.62.0
+          version: v2.1.6

.golangci.yml

@@ -1,32 +1,47 @@
+version: "2"
 linters:
   enable:
     - depguard
-    - goimports
     - misspell
     - revive
-
-issues:
-  exclude-rules:
-    - path: _test.go
-      linters:
-        - errcheck
-
-linters-settings:
-  depguard:
-    rules:
-      no_exec_policy:
-        files:
-          - "!$test"
-        deny:
-          - pkg: "os/exec"
-            desc: "Using os/exec to run sub processes it not allowed by policy"
-  errcheck:
-    exclude-functions:
-      # Used in HTTP handlers, any error is handled by the server itself.
-      - (net/http.ResponseWriter).Write
-  revive:
+  settings:
+    depguard:
+      rules:
+        no_exec_policy:
+          files:
+            - '!$test'
+          deny:
+            - pkg: os/exec
+              desc: Using os/exec to run sub processes it not allowed by policy
+    errcheck:
+      exclude-functions:
+        - (net/http.ResponseWriter).Write
+    revive:
+      rules:
+        - name: unused-parameter
+          severity: warning
+          disabled: true
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
     rules:
-      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
-      - name: unused-parameter
-        severity: warning
-        disabled: true
+      - linters:
+          - errcheck
+        path: _test.go
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.goreleaser.yaml

@@ -6,7 +6,7 @@ before:
 
 builds:
   - id: "403unlockercli-linux"  # Unique ID for this build
-    main: ./cmd/403unlockercli
+    main: ./cmd
     binary: "403unlocker"
     env:
       - CGO_ENABLED=0
@@ -15,19 +15,23 @@ builds:
     goarch:
       - amd64
       - arm64
+    ldflags:
+      - -X 403unlocker-cli/cmd/cli.Version={{ .Version }}
 
   - id: "403unlockercli-windows"  # Unique ID for this build
-    main: ./cmd/403unlockercli
+    main: ./cmd
     binary: "403unlocker"
     env:
       - CGO_ENABLED=0
     goos:
       - windows
     goarch:
       - amd64
+    ldflags:
+      - -X 403unlocker-cli/cmd/cli.Version={{ .Version }}
 
   - id: "403unlockercli-darwin"  # Unique ID for this build
-    main: ./cmd/403unlockercli
+    main: ./cmd
     binary: "403unlocker"
     env:
       - CGO_ENABLED=0
@@ -36,6 +40,8 @@ builds:
     goarch:
       - amd64
       - arm64
+    ldflags:
+      - -X 403unlocker-cli/cmd/cli.Version={{ .Version }}
 
 archives:
   - format: tar.gz
@@ -65,4 +71,4 @@ release:
 
     ---
 
-    Released by [GoReleaser](https://github.com/goreleaser/goreleaser).
+    Released by [GoReleaser](https://github.com/goreleaser/goreleaser).

Makefile

@@ -1,10 +1,10 @@
 
 OUTPUT = 403unlocker
-MAIN = cmd/403unlockercli/main.go
+MAIN = cmd/main.go
 BIN_DIR = ~/.local/bin
 CONFIG_DIR= ~/.config/403unlocker
-DNS_CONFIG_FILE_URL=https://raw.githubusercontent.com/403unlocker/403Unlocker-cli/refs/heads/main/config/dns.conf
-DOCKER_CONFIG_FILE_URL=https://raw.githubusercontent.com/403unlocker/403Unlocker-cli/refs/heads/main/config/dockerRegistry.conf
+DNS_CONFIG_FILE_URL=https://raw.githubusercontent.com/403unlocker/403Unlocker-cli/refs/heads/main/config/dns.yml
+DOCKER_CONFIG_FILE_URL=https://raw.githubusercontent.com/403unlocker/403Unlocker-cli/refs/heads/main/config/dockerRegistry.yml
 
 .DEFAULT_GOAL := help
 
@@ -23,23 +23,23 @@ lint:
 
 
 build:
-	@go build -o $(OUTPUT) $(MAIN)
+	@go build -ldflags "-X 403unlocker-cli/cmd/cli.Version=dev" -o  $(OUTPUT) $(MAIN)
 
 
-test: 
+test:
 	@go test ./...
 
 
-clean: 
+clean:
 	@rm -f $(OUTPUT)
 
 
-install: build 
+install: build
 	@echo "Installing $(OUTPUT) to $(BIN_DIR)..."
 	@install -m 755 $(OUTPUT) $(BIN_DIR)
-	@echo "Downloading config files dns.conf to $(CONFIG_DIR)..."
+	@echo "Downloading config files dns.yml to $(CONFIG_DIR)..."
 	@wget $(DNS_CONFIG_FILE_URL) -q -P $(CONFIG_DIR)
-	@echo "Downloading dockerRegistry.conf $(CONFIG_DIR)..."
+	@echo "Downloading dockerRegistry.yml $(CONFIG_DIR)..."
 	@wget $(DOCKER_CONFIG_FILE_URL) -q -P $(CONFIG_DIR)
 
 

cmd/403unlockercli/main.go

@@ -0,0 +1,41 @@
+package cli
+
+import (
+	"403unlocker-cli/internal/dns"
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	timeoutBestDns int
+	checkfirst     bool
+)
+
+var bestdnsCmd = &cobra.Command{
+	Use:   "bestdns",
+	Short: "Finds the fastest DNS SNI-Proxy for downloading a specific URL",
+	Long: `Finds the fastest DNS SNI-Proxy for downloading a specific URL
+
+Examples:
+	403unlocker bestdns --timeout 15 https://packages.gitlab.com/gitlab/gitlab-ce/packages/el/7/gitlab-ce-16.8.0-ce.0.el7.x86_64.rpm/download.rpm`,
+	Args: cobra.ExactArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if !dns.URLValidator(args[0]) {
+			fmt.Println("Error: Invalid URL")
+			return cmd.Help()
+		}
+		return dns.CheckWithURL(args[0], checkfirst, timeoutBestDns)
+	},
+	Aliases: []string{"dns"},
+	ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return []string{}, cobra.ShellCompDirectiveNoFileComp
+	},
+}
+
+func init() {
+	bestdnsCmd.PersistentFlags().IntVarP(&timeoutBestDns, "timeout", "t", 10, "Sets timeout")
+	bestdnsCmd.PersistentFlags().BoolVarP(&checkfirst, "check", "c", false, "first check with GET to route '/' of domain ")
+
+	rootCmd.AddCommand(bestdnsCmd)
+}

cmd/cli/bestdns.go

@@ -0,0 +1,32 @@
+package cli
+
+import (
+	"403unlocker-cli/internal/check"
+
+	"github.com/spf13/cobra"
+)
+
+var checkCmd = &cobra.Command{
+	Use:   "check",
+	Short: "Checks if the DNS SNI-Proxy can bypass 403 error for a specific domain",
+	Long: `Checks if the DNS SNI-Proxy can bypass 403 error for a specific domain
+
+Examples:
+    403unlocker check https://pkg.go.dev`,
+	Args: cobra.ExactArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if !check.DomainValidator(args[0]) {
+			cmd.Printf("Error: '%s' is not a valid domain format\n\n", args[0])
+			return cmd.Help()
+		}
+		return check.CheckWithDNS(args[0])
+	},
+	Aliases: []string{"c"},
+	ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return []string{}, cobra.ShellCompDirectiveNoFileComp
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(checkCmd)
+}

cmd/cli/check.go

@@ -0,0 +1,38 @@
+package cli
+
+import (
+	"403unlocker-cli/internal/docker"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	timeoutFastDocker int
+)
+
+var fastdockerCmd = &cobra.Command{
+	Use:   "fastdocker",
+	Short: "Finds the fastest docker registries for a specific docker image",
+	Long: `Examples:
+    403unlocker fastdocker --timeout 15 gitlab/gitlab-ce:17.0.0-ce.0`,
+	Args: cobra.ExactArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if docker.DockerImageValidator(args[0]) {
+			return docker.CheckWithDockerImage(args[0], timeoutFastDocker)
+		} else {
+			cmd.Printf("Error: '%s' is not a valid docker image format\n\n", args[0])
+			return cmd.Help()
+		}
+	},
+	Aliases: []string{"docker"},
+	ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return []string{}, cobra.ShellCompDirectiveNoFileComp
+	},
+}
+
+func init() {
+	fastdockerCmd.PersistentFlags().IntVarP(&timeoutFastDocker, "timeout", "t", 10, "Sets timeout")
+
+	rootCmd.AddCommand(fastdockerCmd)
+
+}

cmd/cli/fastdocker.go

@@ -0,0 +1,26 @@
+package cli
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var Version = "dev" // <- Injected by ldflags
+
+var rootCmd = &cobra.Command{
+	Use:     "403unlocker",
+	Short:   "403Unlocker-CLI is a versatile command-line tool designed to bypass 403 restrictions effectively",
+	Long:    `403Unlocker-CLI is a versatile command-line tool designed to bypass 403 restrictions effectively`,
+	Version: Version, // Enables --version flag
+}
+
+func Execute() {
+	err := rootCmd.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+}
+
+func init() {
+}