Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

arguments

package

Go to main page

Versions in this module

v0

v0.3.0

Aug 24, 2026

Changes in this version

type Apply

+ Verbose bool

+ type LiveImport struct

+ Approve bool

+ Estate string

+ StatePath string

+ func ParseLiveImport(args []string) (*LiveImport, tfdiags.Diagnostics)

type Plan

+ Verbose bool

v0.2.0

Aug 12, 2026

Changes in this version

+ const DefaultParallelism

+ const DefaultStateFilename

+ func OpenJSONIntoFile(jsonIntoFlag string) (*os.File, func(), tfdiags.Diagnostics)

+ type Apply struct

+ AutoApprove bool

+ Operation *Operation

+ PlanPath string

+ ShowSensitive bool

+ State *State

+ SuppressForgetErrorsDuringDestroy bool

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseApply(args []string) (*Apply, func(), tfdiags.Diagnostics)

+ func ParseApplyDestroy(args []string) (*Apply, func(), tfdiags.Diagnostics)

+ type Backend struct

+ ForceInitCopy bool

+ IgnoreRemoteVersion bool

+ MigrateState bool

+ Reconfigure bool

+ func (b *Backend) AddIgnoreRemoteVersionFlag(f *flag.FlagSet)

+ func (b *Backend) AddMigrationFlags(f *flag.FlagSet)

+ type Console struct

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseConsole(args []string) (*Console, func(), tfdiags.Diagnostics)

+ type DeprecationWarningLevel uint8

+ const DeprecationWarningLevelAll

+ const DeprecationWarningLevelLocal

+ const DeprecationWarningLevelNone

+ func ParseDeprecatedWarningLevel(s string) DeprecationWarningLevel

+ func (i DeprecationWarningLevel) String() string

+ type Fmt struct

+ Check bool

+ Diff bool

+ List bool

+ Paths []string

+ Recursive bool

+ ViewOptions ViewOptions

+ Write bool

+ func ParseFmt(args []string) (*Fmt, func(), tfdiags.Diagnostics)

+ type Get struct

+ TestsDirectory string

+ Update bool

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseGet(args []string) (*Get, func(), tfdiags.Diagnostics)

+ type Graph struct

+ DrawCycles bool

+ GraphType string

+ ModuleDepth int

+ PlanPath string

+ Vars *Vars

+ Verbose bool

+ ViewOptions ViewOptions

+ func ParseGraph(args []string) (*Graph, func(), tfdiags.Diagnostics)

+ type Import struct

+ Backend *Backend

+ ConfigPath string

+ Parallelism int

+ ResourceAddress string

+ ResourceID string

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseImport(args []string, wd *workdir.Dir) (*Import, func(), tfdiags.Diagnostics)

+ type Init struct

+ Backend *Backend

+ BackendFlagSet bool

+ CloudFlagSet bool

+ FlagBackend bool

+ FlagCloud bool

+ FlagConfigExtra flags.RawFlags

+ FlagFromModule string

+ FlagGet bool

+ FlagLockfile string

+ FlagPluginPath flags.FlagStringSlice

+ FlagUpgrade bool

+ State *State

+ TestsDirectory string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseInit(args []string) (*Init, func(), tfdiags.Diagnostics)

+ type LiveMv struct

+ AllowMissingConfig bool

+ DryRun bool

+ Estate string

+ RawNewAddr string

+ RawOldAddr string

+ func ParseLiveMv(args []string) (*LiveMv, tfdiags.Diagnostics)

+ type LivePlan struct

+ Estate string

+ func ParseLivePlan(args []string) (*LivePlan, func(), tfdiags.Diagnostics)

+ type Login struct

+ Host string

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseLogin(args []string) (*Login, func(), tfdiags.Diagnostics)

+ type Logout struct

+ Host string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseLogout(args []string) (*Logout, func(), tfdiags.Diagnostics)

+ type MetadataFunctions struct

+ ViewOptions ViewOptions

+ func ParseMetadataFunctions(args []string) (*MetadataFunctions, func(), tfdiags.Diagnostics)

+ type Operation struct

+ Excludes []addrs.Targetable

+ ForceReplace []addrs.AbsResourceInstance

+ Parallelism int

+ PlanMode plans.Mode

+ Refresh bool

+ Targets []addrs.Targetable

+ func (o *Operation) Parse() tfdiags.Diagnostics

+ type Output struct

+ Name string

+ ShowSensitive bool

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseOutput(args []string) (*Output, func(), tfdiags.Diagnostics)

+ type Plan struct

+ DetailedExitCode bool

+ GenerateConfigPath string

+ Operation *Operation

+ OutPath string

+ ShowSensitive bool

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParsePlan(args []string) (*Plan, func(), tfdiags.Diagnostics)

+ type Providers struct

+ TestsDirectory string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseProviders(args []string) (*Providers, func(), tfdiags.Diagnostics)

+ type ProvidersLock struct

+ FsMirrorDir string

+ NetMirrorURL string

+ OciMirrorTemplate string

+ OptPlatforms flags.FlagStringSlice

+ Providers []string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseProvidersLock(args []string) (*ProvidersLock, func(), tfdiags.Diagnostics)

+ type ProvidersMirror struct

+ Directory string

+ OptPlatforms flags.FlagStringSlice

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseProvidersMirror(args []string) (*ProvidersMirror, func(), tfdiags.Diagnostics)

+ type ProvidersSchema struct

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseProvidersSchema(args []string) (*ProvidersSchema, func(), tfdiags.Diagnostics)

+ type Refresh struct

+ Operation *Operation

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseRefresh(args []string) (*Refresh, func(), tfdiags.Diagnostics)

+ type Show struct

+ ShowSensitive bool

+ TargetArg string

+ TargetType ShowTargetType

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseShow(args []string) (*Show, func(), tfdiags.Diagnostics)

+ type ShowTargetType int

+ const ShowConfig

+ const ShowModule

+ const ShowPlan

+ const ShowState

+ const ShowUnknownType

+ func (i ShowTargetType) String() string

+ type State struct

+ BackupPath string

+ Lock bool

+ LockTimeout time.Duration

+ StateOutPath string

+ StatePath string

+ func (s *State) AddBackupFlag(f *flag.FlagSet, defVal string)

+ func (s *State) AddStateInFlag(f *flag.FlagSet, defVal string)

+ type StateList struct

+ InstancesRawAddr []string

+ LookupId string

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStateList(args []string) (*StateList, func(), tfdiags.Diagnostics)

+ type StateMv struct

+ Backend *Backend

+ BackupPathOut string

+ DryRun bool

+ RawDestAddr string

+ RawSrcAddr string

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStateMv(args []string) (*StateMv, func(), tfdiags.Diagnostics)

+ type StatePull struct

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStatePull(args []string) (*StatePull, func(), tfdiags.Diagnostics)

+ type StatePush struct

+ Backend *Backend

+ Force bool

+ State *State

+ StateSrc string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStatePush(args []string) (*StatePush, func(), tfdiags.Diagnostics)

+ type StateReplaceProvider struct

+ AutoApprove bool

+ Backend *Backend

+ RawDestAddr string

+ RawSrcAddr string

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseReplaceProvider(args []string) (*StateReplaceProvider, func(), tfdiags.Diagnostics)

+ type StateRm struct

+ Backend *Backend

+ DryRun bool

+ State *State

+ TargetAddrs []string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStateRm(args []string) (*StateRm, func(), tfdiags.Diagnostics)

+ type StateShow struct

+ ShowSensitive bool

+ State *State

+ TargetRawAddr string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseStateShow(args []string) (*StateShow, func(), tfdiags.Diagnostics)

+ type Taint struct

+ AllowMissing bool

+ Backend *Backend

+ State *State

+ TargetAddress addrs.AbsResourceInstance

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseTaint(isTaint bool, args []string) (*Taint, func(), tfdiags.Diagnostics)

+ type Test struct

+ Filter []string

+ TestDirectory string

+ Vars *Vars

+ Verbose bool

+ ViewOptions ViewOptions

+ func ParseTest(args []string) (*Test, func(), tfdiags.Diagnostics)

+ type Unlock struct

+ Force bool

+ LockID string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseUnlock(args []string) (*Unlock, func(), tfdiags.Diagnostics)

+ type Validate struct

+ NoTests bool

+ Path string

+ TestDirectory string

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseValidate(args []string) (*Validate, func(), tfdiags.Diagnostics)

+ type Vars struct

+ func (v *Vars) All() []flags.RawFlag

+ func (v *Vars) Empty() bool

+ type Version struct

+ ViewOptions ViewOptions

+ func ParseVersion(args []string) (*Version, func(), tfdiags.Diagnostics)

+ type View struct

+ CompactWarnings bool

+ Concise bool

+ ConsolidateErrors bool

+ ConsolidateWarnings bool

+ ModuleDeprecationWarnLvl DeprecationWarningLevel

+ NoColor bool

+ ShowSensitive bool

+ func ParseView(args []string) (*View, []string)

+ type ViewOptions struct

+ InputEnabled bool

+ JSONInto *os.File

+ ViewType ViewType

+ func (v *ViewOptions) AddFlags(cmdFlags *flag.FlagSet, input bool)

+ func (v *ViewOptions) AddGranularFlags(cmdFlags *flag.FlagSet, input bool, jsonInto bool)

+ func (v *ViewOptions) Parse() (func(), tfdiags.Diagnostics)

+ type ViewType rune

+ const ViewHuman

+ const ViewJSON

+ const ViewNone

+ const ViewRaw

+ func (vt ViewType) String() string

+ type Workspace struct

+ ViewOptions ViewOptions

+ func ParseWorkspace(args []string) (*Workspace, func(), tfdiags.Diagnostics)

+ type WorkspaceDelete struct

+ Force bool

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ WorkspaceName string

+ func ParseWorkspaceDelete(args []string) (*WorkspaceDelete, func(), tfdiags.Diagnostics)

+ type WorkspaceList struct

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseWorkspaceList(args []string) (*WorkspaceList, func(), tfdiags.Diagnostics)

+ type WorkspaceNew struct

+ State *State

+ Vars *Vars

+ ViewOptions ViewOptions

+ WorkspaceName string

+ func ParseWorkspaceNew(args []string) (*WorkspaceNew, func(), tfdiags.Diagnostics)

+ type WorkspaceSelect struct

+ CreateIfMissing bool

+ Vars *Vars

+ ViewOptions ViewOptions

+ WorkspaceName string

+ func ParseWorkspaceSelect(args []string) (*WorkspaceSelect, func(), tfdiags.Diagnostics)

+ type WorkspaceShow struct

+ Vars *Vars

+ ViewOptions ViewOptions

+ func ParseWorkspaceShow(args []string) (*WorkspaceShow, func(), tfdiags.Diagnostics)