refactor

Author: uzaxirr

README.md

@@ -2418,3 +2418,15 @@ The code is available as open source under the terms of the [Apache License 2.0]
  <a href = "https://github.com/civo/cli/graphs/contributors">
    <img src = "https://contrib.rocks/image?repo=civo/cli"/>
  </a>
+
+# Get the status of the console for an instance
+civo instance console status INSTANCE_ID/HOSTNAME
+
+# Stop the console session for an instance
+civo instance console stop INSTANCE_ID/HOSTNAME
+
+# Open console (default duration)
+civo instance console INSTANCE_ID/HOSTNAME
+
+# Open console with custom duration
+civo instance console INSTANCE_ID/HOSTNAME --duration 2h

cmd/instance/instance_vnc.go renamed to cmd/instance/console.go

@@ -14,42 +14,38 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// maxAttempts represents the max number of attempts (each one every 7s) to connect to the vnc URL
+// maxAttempts represents the max number of attempts (each one every 7s) to connect to the console URL
 const maxAttempts = 5
 
 var duration string
 
-var instanceVncCmd = &cobra.Command{
+var instanceConsoleCmd = &cobra.Command{
 	Use:     "console",
-	Aliases: []string{"vnc", "access"},
-	Example: "civo instance vnc INSTANCE-ID/NAME [--duration 2h]",
+	Aliases: []string{"connect"},
+	Example: "civo instance console INSTANCE-ID/NAME [--duration 2h]",
 	Args:    cobra.MinimumNArgs(1),
-	Short:   "Enable and access the noVNC console on an instance",
-	Long: `Enable and access the console (through the VNC protocol via the default browser) on an instance with optional duration.
+	Short:   "Connect to the console of an instance",
+	Long: `Enable and access the console (through the default browser) on an instance with optional duration.
 Duration follows Go's duration format (e.g. "30m", "1h", "24h")`,
 	Run: func(cmd *cobra.Command, args []string) {
 		utility.EnsureCurrentRegion()
 
-		// Create the API client
 		client, err := config.CivoAPIClient()
 		if err != nil {
 			utility.Error("Failed to connect to Civo's API: %s", err)
 			os.Exit(1)
 		}
 
-		// Set the region if specified by the user
 		if common.RegionSet != "" {
 			client.Region = common.RegionSet
 		}
 
-		// Locate the instance
 		instance, err := client.FindInstance(args[0])
 		if err != nil {
 			utility.Error("Unable to find instance with ID/Name '%s': %s", args[0], err)
 			os.Exit(1)
 		}
 
-		// Enable VNC for the instance with optional duration
 		var vnc civogo.InstanceVnc
 		if duration != "" {
 			vnc, err = client.GetInstanceVnc(instance.ID, duration)
@@ -61,19 +57,16 @@ Duration follows Go's duration format (e.g. "30m", "1h", "24h")`,
 			os.Exit(1)
 		}
 
-		// Display VNC details
 		utility.Info("Console access successfully enabled for instance: %s", instance.Hostname)
 		utility.Info("Console access URL: %s", vnc.URI)
 		utility.Info("We're preparing console access. This may take a while...")
 
-		// exchange apikey with a valid JWT (accessing the VNC url is allowed only via JWTs)
 		exchangeTokenResp, err := client.ExchangeAuthToken(&civogo.ExchangeAuthTokenRequest{})
 		if err != nil {
 			utility.Error("Failed to exchange your apikey with a valid Civo JWT '%s': %s", instance.Hostname, err)
 			os.Exit(1)
 		}
 
-		// chain the bearer token to the URI to let it be opened via the default browser:
 		vnc.URI = fmt.Sprintf("%s&token=%s", vnc.URI, exchangeTokenResp.AccessToken)
 
 		err = waitEndpointReady(vnc.URI)
@@ -85,7 +78,6 @@ Duration follows Go's duration format (e.g. "30m", "1h", "24h")`,
 		utility.Info("Opening the console in your default browser...")
 		time.Sleep(3 * time.Second)
 
-		// Open VNC in the browser
 		err = browser.OpenInBrowser(vnc.URI)
 		if err != nil {
 			utility.Error("Failed to open the console access URL in the browser: %s", err)
@@ -95,8 +87,6 @@ Duration follows Go's duration format (e.g. "30m", "1h", "24h")`,
 	},
 }
 
-// endpointReady checks if the given URL endpoint is ready by sending a GET request
-// and returning true if the HTTP status code is 200 OK.
 func endpointReady(url string) bool {
 	utility.Info("New attempt to reach the console URL...")
 	resp, err := http.Get(url)
@@ -108,8 +98,6 @@ func endpointReady(url string) bool {
 	return resp.StatusCode == http.StatusOK
 }
 
-// waitEndpointReady continuously checks the given URL endpoint every 5 seconds
-// until it becomes ready (i.e., it does not return an HTTP 503 status).
 func waitEndpointReady(url string) error {
 	var attempt int
 	for {

cmd/instance/instance_vnc_status.go renamed to cmd/instance/console_status.go

@@ -10,11 +10,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var instanceVncStatusCmd = &cobra.Command{
-	Use:     "vnc-status <INSTANCE_ID_OR_NAME>",
-	Aliases: []string{"vncstatus"},
-	Short:   "Get the status of the VNC console for an instance",
-	Example: "civo instance vnc-status my-instance",
+var instanceConsoleStatusCmd = &cobra.Command{
+	Use:     "status",
+	Short:   "Get the status of the console for an instance",
+	Example: "civo instance console status my-instance",
 	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		utility.EnsureCurrentRegion()
@@ -37,10 +36,10 @@ var instanceVncStatusCmd = &cobra.Command{
 		vnc, err := client.GetInstanceVncStatus(instance.ID)
 		if err != nil {
 			if strings.Contains(err.Error(), "404") {
-				utility.Info("The VNC session for instance %s (%s) does not exist or has expired.", instance.Hostname, instance.ID)
+				utility.Info("The console session for instance %s (%s) does not exist or has expired.", instance.Hostname, instance.ID)
 				os.Exit(0)
 			}
-			utility.Error("Getting VNC status for instance %s: %s", instance.ID, err)
+			utility.Error("Getting console status for instance %s: %s", instance.ID, err)
 			os.Exit(1)
 		}
 
@@ -59,3 +58,7 @@ var instanceVncStatusCmd = &cobra.Command{
 		}
 	},
 }
+
+func init() {
+	instanceConsoleCmd.AddCommand(instanceConsoleStatusCmd)
+}

cmd/instance/instance_vnc_stop.go renamed to cmd/instance/console_stop.go

@@ -11,11 +11,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var instanceVncStopCmd = &cobra.Command{
-	Use:     "vnc-stop <INSTANCE_ID_OR_NAME>",
-	Aliases: []string{"vncstop"},
-	Short:   "Stop the VNC console session for an instance",
-	Example: "civo instance vnc-stop my-instance",
+var instanceConsoleStopCmd = &cobra.Command{
+	Use:     "stop",
+	Short:   "Stop the console session for an instance",
+	Example: "civo instance console stop my-instance",
 	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		utility.EnsureCurrentRegion()
@@ -38,10 +37,10 @@ var instanceVncStopCmd = &cobra.Command{
 		resp, err := client.DeleteInstanceVncSession(instance.ID)
 		if err != nil {
 			if strings.Contains(err.Error(), "404") {
-				utility.Info("There is no active VNC session for instance %s (%s) to stop.", instance.Hostname, instance.ID)
+				utility.Info("There is no active console session for instance %s (%s) to stop.", instance.Hostname, instance.ID)
 				os.Exit(0)
 			}
-			utility.Error("Stopping VNC session for instance %s: %s", instance.ID, err)
+			utility.Error("Stopping console session for instance %s: %s", instance.ID, err)
 			os.Exit(1)
 		}
 
@@ -53,14 +52,18 @@ var instanceVncStopCmd = &cobra.Command{
 
 		if common.OutputFormat == "human" {
 			if string(resp.Result) == "ok" {
-				fmt.Printf("VNC session for instance %s (%s) was stopped successfully.\n",
+				fmt.Printf("Console session for instance %s (%s) was stopped successfully.\n",
 					utility.Green(instance.Hostname), instance.ID)
 			} else {
-				fmt.Printf("Failed to stop VNC session for instance %s (%s). Result: %s\n",
+				fmt.Printf("Failed to stop console session for instance %s (%s). Result: %s\n",
 					utility.Red(instance.Hostname), instance.ID, string(resp.Result))
 			}
 		} else {
 			ow.WriteSingleObjectJSON(common.PrettySet)
 		}
 	},
 }
+
+func init() {
+	instanceConsoleCmd.AddCommand(instanceConsoleStopCmd)
+}

cmd/instance/instance.go

@@ -38,9 +38,7 @@ func init() {
 	InstanceCmd.AddCommand(instancePublicIPCmd)
 	InstanceCmd.AddCommand(instancePasswordCmd)
 	InstanceCmd.AddCommand(instanceTagCmd)
-	InstanceCmd.AddCommand(instanceVncCmd)
-	InstanceCmd.AddCommand(instanceVncStatusCmd)
-	InstanceCmd.AddCommand(instanceVncStopCmd)
+	InstanceCmd.AddCommand(instanceConsoleCmd)
 	InstanceCmd.AddCommand(instanceRecoveryCmd)
 	InstanceCmd.AddCommand(instanceRecoveryStatusCmd)
 	InstanceCmd.AddCommand(snapshotCmd)
@@ -71,10 +69,10 @@ func init() {
 	instanceCreateCmd.Flags().StringArrayVar(&allowedIPs, "allowed-ips", []string{}, "A comma separated list of IP addresses that the instance is allowed to use")
 	instanceCreateCmd.Flags().IntVar(&networkBandwidthLimit, "network-bandwidth-limit", 0, "The network bandwidth limit for the instance in Mbps (0 for unlimited)")
 
-	instanceVncCmd.Flags().StringVarP(&duration, "duration", "d", "", "Duration for VNC access (e.g. 30m, 1h, 24h)")
-
 	instanceStopCmd.Flags().BoolVarP(&waitStop, "wait", "w", false, "wait until the instance's is stoped")
 
+	instanceConsoleCmd.Flags().StringVarP(&duration, "duration", "", "", "The duration for the console session (e.g., '30m', '1h'). Default is provider-dependent.")
+
 	instanceAllowedIPsUpdateCmd.Flags().StringSliceVarP(&allowedIPsUpdate, "ips", "", []string{}, "Comma-separated list of IP addresses to allow (e.g., --ips 1.2.3.4,5.6.7.8). To clear all IPs, provide an empty string.")
 
 	instanceBandwidthUpdateCmd.Flags().IntVarP(&bandwidthLimitUpdate, "limit", "l", 0, "Network bandwidth limit in Mbps (e.g., 1000). Use 0 for unlimited")