stack

README

spacectl stack state

spacectl stack state manages Terraform/OpenTofu state files for Spacelift stacks.

pull

Downloads the current state file for a stack.

# Output to stdout
spacectl stack state pull --id my-stack

# Save to file
spacectl stack state pull --id my-stack -o terraform.tfstate

# Auto-detect stack from current directory
spacectl stack state pull

# Pretty-print
spacectl stack state pull --id my-stack | jq .

Prerequisites

The stack must have:

• Manages state enabled (Spacelift manages the Terraform state)
• External state access enabled (stack setting)

The user must have State download permission or Space admin role.

Documentation

Index

• func Command() cmd.Command
• func RegisterMCPTools(s *server.MCPServer, options McpOptions)
• type ConfigInput
• type ConfigType
• type EnvironmentVariable
• type LocalPreviewOptions
• type McpOptions
• type RuntimeConfigInput
• type StackFilter
• type StateDownloadUrlInput

Functions

func Command

func Command() cmd.Command

Command returns the stack command subtree.

func RegisterMCPTools

func RegisterMCPTools(s *server.MCPServer, options McpOptions)

Types

type ConfigInput

type ConfigInput struct {
	ID        graphql.ID      `json:"id"`
	Type      ConfigType      `json:"type"`
	Value     graphql.String  `json:"value"`
	WriteOnly graphql.Boolean `json:"writeOnly"`
}

ConfigInput represents the input required to create or update a config element.

type ConfigType

type ConfigType string

ConfigType is a type of configuration element.

type EnvironmentVariable

type EnvironmentVariable struct {
	Key   graphql.String `json:"key"`
	Value graphql.String `json:"value"`
}

EnvironmentVariable represents a key-value pair of environment variables

type LocalPreviewOptions

type LocalPreviewOptions struct {
	StackID            string
	EnvironmentVars    []EnvironmentVariable
	Targets            []string
	Path               *string
	FindRepositoryRoot bool
	DisregardGitignore bool
	UseHeaders         bool
	NoUpload           bool
	RunMetadata        *string
	PrioritizeRun      bool
	ShowUploadProgress bool
	IncludeGitDir      bool
}

type McpOptions

type McpOptions struct {
	UseHeadersForLocalPreview bool
}

type RuntimeConfigInput

type RuntimeConfigInput struct {
	Yaml *string `json:"yaml"`
}

RuntimeConfigInput represents the input for triggering a run with a runtime configuration.

type StackFilter

type StackFilter[T hasIDAndName] func(*T) bool

StackFilter is a function to filter stacks based on their properties.

type StateDownloadUrlInput

type StateDownloadUrlInput struct {
	StackID graphql.ID `json:"stackId"`
}