v1.16.5/internal/command/workspace_select.go

// Copyright IBM Corp. 2014, 2026
// SPDX-License-Identifier: BUSL-1.1

package command

import (
	"fmt"
	"strings"

	"github.com/hashicorp/cli"
	"github.com/hashicorp/terraform/internal/command/arguments"
	"github.com/hashicorp/terraform/internal/tfdiags"
	"github.com/posener/complete"
)

type WorkspaceSelectCommand struct {
	Meta
	LegacyName bool
}

func (c *WorkspaceSelectCommand) Run(rawArgs []string) int {
	var diags tfdiags.Diagnostics

	// Process global flags and configure the view/UI.
	rawArgs = c.Meta.process(rawArgs)
	envCommandShowWarning(c.Ui, c.LegacyName)

	// Process command-specific arguments.
	// Currently there are no arguments for this command, so ignore the returned value for now.
	args, diags := arguments.ParseWorkspaceSelect(rawArgs)
	if diags.HasErrors() {
		c.showDiagnostics(diags)
		return cli.RunResultHelp
	}

	// Block selecting a workspace if an environment variable will override the new selection anyway.
	//
	// We ignore errors raised about the value of the override ENV, or the value of the currently selected
	// workspace; this command should help users recover from those errors, not block them.
	current, isOverridden, _ := c.WorkspaceOverridden()
	if isOverridden {
		c.Ui.Error(envIsOverriddenSelectError)
		return 1
	}

	// Load the backend
	c.bypassWorkspaceNameValidityCheck = true // allow selecting a new workspace when the current one is invalid.
	configPath := c.WorkingDir.RootModuleDir()
	b, diags := c.backend(configPath, args.ViewType)
	if diags.HasErrors() {
		c.showDiagnostics(diags)
		return 1
	}

	// This command will not write state
	c.ignoreRemoteVersionConflict(b)

	states, wDiags := b.Workspaces()
	if wDiags.HasErrors() {
		c.Ui.Error(wDiags.Err().Error())
		return 1
	}
	c.showDiagnostics(diags) // output warnings, if any

	name := args.Name
	if name == current {
		// already using this workspace
		return 0
	}

	found := false
	for _, s := range states {
		if name == s {
			found = true
			break
		}
	}

	var newState bool

	if !found {
		if args.OrCreate {
			_, sDiags := b.StateMgr(name)
			if sDiags.HasErrors() {
				c.Ui.Error(sDiags.Err().Error())
				return 1
			}
			newState = true
		} else {
			c.Ui.Error(fmt.Sprintf(envDoesNotExist, name))
			return 1
		}
	}

	err := c.SetWorkspace(name)
	if err != nil {
		c.Ui.Error(err.Error())
		return 1
	}

	if newState {
		c.Ui.Output(c.Colorize().Color(fmt.Sprintf(
			strings.TrimSpace(envCreated), name)))
	} else {
		c.Ui.Output(
			c.Colorize().Color(
				fmt.Sprintf(envChanged, name),
			),
		)
	}

	return 0
}

func (c *WorkspaceSelectCommand) AutocompleteArgs() complete.Predictor {
	return completePredictSequence{
		c.completePredictWorkspaceName(),
		complete.PredictDirs(""),
	}
}

func (c *WorkspaceSelectCommand) AutocompleteFlags() complete.Flags {
	return nil
}

func (c *WorkspaceSelectCommand) Help() string {
	helpText := `
Usage: terraform [global options] workspace select NAME

  Select a different Terraform workspace.

Options:

    -or-create=false    Create the Terraform workspace if it doesn't exist.

`
	return strings.TrimSpace(helpText)
}

func (c *WorkspaceSelectCommand) Synopsis() string {
	return "Select a workspace"
}