feat: support TALOS_HOME env var

Use TALOS_HOME for state instead of ~/.talos, when defined.

Signed-off-by: Skye Soss <skye@soss.website>
(cherry picked from commit 4f62186)

Author: Skye Soss

cmd/talosctl/cmd/completion.go

@@ -38,11 +38,11 @@ Note for zsh users: [1] zsh completions are only supported in versions of zsh >=
 ## Load the talosctl completion code for bash into the current shell
 	source <(talosctl completion bash)
 ## Write bash completion code to a file and source if from .bash_profile
-	talosctl completion bash > ~/.talos/completion.bash.inc
-	printf "
+	talosctl completion bash > "${TALOS_HOME:-$HOME/.talos}/completion.bash.inc"
+	printf '
 		# talosctl shell completion
-		source '$HOME/.talos/completion.bash.inc'
-		" >> $HOME/.bash_profile
+		source "${TALOS_HOME:-$HOME/.talos}/completion.bash.inc"
+		' >> $HOME/.bash_profile
 	source $HOME/.bash_profile
 # Load the talosctl completion code for fish[1] into the current shell
 	talosctl completion fish | source

pkg/machinery/client/config/path.go

@@ -20,8 +20,12 @@ type Path struct {
 	WriteAllowed bool
 }
 
-// GetTalosDirectory returns path to Talos directory (~/.talos).
+// GetTalosDirectory returns path to Talos directory ($TALOS_HOME or ~/.talos).
 func GetTalosDirectory() (string, error) {
+	if path, ok := os.LookupEnv(constants.TalosHomeEnvVar); ok && filepath.IsAbs(path) {
+		return path, nil
+	}
+
 	home, err := os.UserHomeDir()
 	if err != nil {
 		return "", err

pkg/machinery/constants/constants.go

@@ -602,6 +602,9 @@ const (
 	// TalosConfigEnvVar is the environment variable for setting the Talos configuration file path.
 	TalosConfigEnvVar = "TALOSCONFIG"
 
+	// TalosHomeEnvVar is the environment variable for setting the Talos state directory file path.
+	TalosHomeEnvVar = "TALOS_HOME"
+
 	// APISocketPath is the path to file socket of apid.
 	APISocketPath = SystemRunPath + "/apid/apid.sock"
 

website/content/v1.12/reference/cli.md

@@ -432,11 +432,11 @@ talosctl completion SHELL [flags]
 ## Load the talosctl completion code for bash into the current shell
 	source <(talosctl completion bash)
 ## Write bash completion code to a file and source if from .bash_profile
-	talosctl completion bash > ~/.talos/completion.bash.inc
-	printf "
+	talosctl completion bash > "${TALOS_HOME:-$HOME/.talos}/completion.bash.inc"
+	printf '
 		# talosctl shell completion
-		source '$HOME/.talos/completion.bash.inc'
-		" >> $HOME/.bash_profile
+		source "${TALOS_HOME:-$HOME/.talos}/completion.bash.inc"
+		' >> $HOME/.bash_profile
 	source $HOME/.bash_profile
 # Load the talosctl completion code for fish[1] into the current shell
 	talosctl completion fish | source