arguments

package

Go to main page

Versions in this module

v0

v0.23.0

Oct 8, 2026

v0.22.0

Oct 6, 2026

Changes in this version

+ const DefaultPlanSetOutDir

+ const DefaultWaveApplyOutDir

+ type LiveAffected struct

+ Ignore []string

+ JSON bool

+ Range string

+ Roots []string

+ func BindLiveAffected(cli *CommandLine) *LiveAffected

+ func ParseLiveAffected(args []string) (*LiveAffected, tfdiags.Diagnostics)

+ type LivePlanSet struct

+ OutDir string

+ ParallelEstates int

+ Roots []string

+ View *View

+ func BindLivePlanSet(cli *CommandLine) *LivePlanSet

+ func ParseLivePlanSet(args []string) (*LivePlanSet, func(), tfdiags.Diagnostics)

+ type LiveSummary struct

+ JSON bool

+ Markdown bool

+ MarkdownLimit int

+ Path string

+ func BindLiveSummary(cli *CommandLine) *LiveSummary

+ func ParseLiveSummary(args []string) (*LiveSummary, tfdiags.Diagnostics)

+ type LiveWaveApply struct

+ Canaries []string

+ Digest string

+ JSON bool

+ OutDir string

+ ParallelEstates int

+ PlanSet string

+ Resume string

+ Wave int

+ func BindLiveWaveApply(cli *CommandLine) *LiveWaveApply

+ func ParseLiveWaveApply(args []string) (*LiveWaveApply, tfdiags.Diagnostics)

+ type LiveWaves struct

+ Canaries []string

+ JSON bool

+ PlanSet string

+ Roots []string

+ Wave int

+ func BindLiveWaves(cli *CommandLine) *LiveWaves

+ func ParseLiveWaves(args []string) (*LiveWaves, tfdiags.Diagnostics)

v0.21.0

Oct 2, 2026

Changes in this version

+ func ParseLintingRules(rules []string) (collections.Set[linting.RuleAddr], collections.Set[linting.RuleAddr])

type Apply

+ View *View

+ func BindApply(cli *CommandLine) *Apply

+ func BindApplyDestroy(cli *CommandLine) *Apply

+ type Argument struct

+ Cli cli.Argument

+ Name string

+ Optional bool

+ Process func([]string) ([]string, error)

+ Variadic bool

type Backend

+ func BindBackend(cli *CommandLine) *Backend

+ func BindBackendWithMigration(cli *CommandLine) *Backend

+ type CommandLine struct

+ ArgHelp string

+ Args []Argument

+ Backend *Backend

+ FlagGroups []FlagGroup

+ Flags map[string]*Flag

+ Operation *Operation

+ PostHooks Hooks

+ PreHooks Hooks

+ State *State

+ Vars *Vars

+ View *View

+ func (c *CommandLine) BoolVar(p *bool, name string, value bool, usage string) *Flag

+ func (c *CommandLine) CliArguments() []cli.Argument

+ func (c *CommandLine) CliFlags() []cli.Flag

+ func (c *CommandLine) DurationVar(p *time.Duration, name string, value time.Duration, usage string) *Flag

+ func (c *CommandLine) Flag(flag *Flag) *Flag

+ func (c *CommandLine) IntVar(p *int, name string, value int, usage string) *Flag

+ func (c *CommandLine) ParseDirect(ctx context.Context, args []string) tfdiags.Diagnostics

+ func (c *CommandLine) ParseLegacy(args []string) tfdiags.Diagnostics

+ func (c *CommandLine) PositionalArg(p *string, name string, optional bool)

+ func (c *CommandLine) PositionalArgs(remaining []string) tfdiags.Diagnostics

+ func (c *CommandLine) PositionalError(remaining []string, argsErrored bool) tfdiags.Diagnostics

+ func (c *CommandLine) PostHook(h func() tfdiags.Diagnostics)

+ func (c *CommandLine) PreHook(h func() tfdiags.Diagnostics)

+ func (c *CommandLine) RawFlags(p flags.RawFlags, name string, usage string) *Flag

+ func (c *CommandLine) RemainCheck(remaining []string) tfdiags.Diagnostics

+ func (c *CommandLine) StringArrayVar(p *[]string, name string, value []string, usage string) *Flag

+ func (c *CommandLine) StringVar(p *string, name string, value string, usage string) *Flag

+ func (c *CommandLine) VariadicArg(p *[]string, name string)

type Console

+ View *View

+ func BindConsole(cli *CommandLine) *Console

+ type Flag struct

+ Cli func() cli.Flag

+ Display string

+ Global bool

+ GroupID string

+ Hidden bool

+ IsSet func() bool

+ Name string

+ Stdlib func(*flag.FlagSet)

+ Usage string

+ func (f *Flag) SetDisplay(display string) *Flag

+ func (f *Flag) SetGlobal(mixed bool) *Flag

+ func (f *Flag) SetGroup(id string) *Flag

+ func (f *Flag) SetHidden(hidden bool) *Flag

+ type FlagGroup struct

+ Description string

+ ID string

+ Suffix string

+ Title string

type Fmt

+ View *View

+ func BindFmt(cli *CommandLine) *Fmt

type Get

+ View *View

+ func BindGet(cli *CommandLine) *Get

type Graph

+ View *View

+ func BindGraph(cli *CommandLine) *Graph

+ type Hook func() tfdiags.Diagnostics

+ type Hooks []Hook

+ func (h Hooks) Run() tfdiags.Diagnostics

type Import

+ View *View

+ func BindImport(cli *CommandLine) *Import

type Init

+ View *View

+ func BindInit(cli *CommandLine) *Init

type LiveBucket

+ func BindLiveBucket(cli *CommandLine) *LiveBucket

+ type LiveCheck struct

+ Dir string

+ JSON bool

+ func BindLiveCheck(cli *CommandLine) *LiveCheck

+ func ParseLiveCheck(args []string) (*LiveCheck, tfdiags.Diagnostics)

type LiveCluster

+ func BindLiveCluster(cli *CommandLine) *LiveCluster

type LiveImport

+ func BindLiveImport(cli *CommandLine) *LiveImport

type LiveLs

+ View *View

+ func BindLiveLs(cli *CommandLine) *LiveLs

type LiveMv

+ func BindLiveMv(cli *CommandLine) *LiveMv

type LivePlan

+ func BindLivePlan(cli *CommandLine) *LivePlan

type Login

+ View *View

+ func BindLogin(cli *CommandLine) *Login

type Logout

+ View *View

+ func BindLogout(cli *CommandLine) *Logout

type MetadataFunctions

+ View *View

+ func BindMetadataFunctions(cli *CommandLine) *MetadataFunctions

type Operation

+ func BindOperation(cli *CommandLine) *Operation

type Output

+ View *View

+ func BindOutput(cli *CommandLine) *Output

type Plan

+ View *View

+ func BindPlan(cli *CommandLine) *Plan

type Providers

+ View *View

+ func BindProviders(cli *CommandLine) *Providers

type ProvidersLock

+ View *View

+ func BindProvidersLock(cli *CommandLine) *ProvidersLock

type ProvidersMirror

+ View *View

+ func BindProvidersMirror(cli *CommandLine) *ProvidersMirror

type ProvidersSchema

+ View *View

+ func BindProvidersSchema(cli *CommandLine) *ProvidersSchema

type Refresh

+ View *View

+ func BindRefresh(cli *CommandLine) *Refresh

type Show

+ View *View

+ func BindShow(cli *CommandLine) *Show

type State

+ func BindState(cli *CommandLine, mask stateFlag) *State

type StateList

+ View *View

+ func BindStateList(cli *CommandLine) *StateList

type StateMv

+ View *View

+ func BindStateMv(cli *CommandLine) *StateMv

type StatePull

+ View *View

+ func BindStatePull(cli *CommandLine) *StatePull

type StatePush

+ View *View

+ func BindStatePush(cli *CommandLine) *StatePush

type StateReplaceProvider

+ View *View

+ func BindStateReplaceProvider(cli *CommandLine) *StateReplaceProvider

type StateRm

+ View *View

+ func BindStateRm(cli *CommandLine) *StateRm

type StateShow

+ View *View

+ func BindStateShow(cli *CommandLine) *StateShow

type Taint

+ View *View

+ func BindTaint(cli *CommandLine, isTaint bool) *Taint

type Test

+ View *View

+ func BindTest(cli *CommandLine) *Test

type Unlock

+ View *View

+ func BindUnlock(cli *CommandLine) *Unlock

type Validate

+ View *View

+ func BindValidate(cli *CommandLine) *Validate

type Vars

+ func BindVars(cli *CommandLine) *Vars

type Version

+ View *View

+ func BindVersion(cli *CommandLine) *Version

type View

+ InputEnabled bool

+ JSONInto *os.File

+ LintExclude collections.Set[linting.RuleAddr]

+ LintInclude collections.Set[linting.RuleAddr]

+ ViewType ViewType

+ func BindView(cli *CommandLine, mask viewFlag) *View

type Workspace

+ View *View

+ func BindWorkspace(cli *CommandLine) *Workspace

type WorkspaceDelete

+ View *View

+ func BindWorkspaceDelete(cli *CommandLine) *WorkspaceDelete

type WorkspaceList

+ View *View

+ func BindWorkspaceList(cli *CommandLine) *WorkspaceList

type WorkspaceNew

+ View *View

+ func BindWorkspaceNew(cli *CommandLine) *WorkspaceNew

type WorkspaceSelect

+ View *View

+ func BindWorkspaceSelect(cli *CommandLine) *WorkspaceSelect

type WorkspaceShow

+ View *View

+ func BindWorkspaceShow(cli *CommandLine) *WorkspaceShow

v0.20.0

Sep 28, 2026

Changes in this version

+ const ReportAdoptable

+ const ReportForeign

+ const ReportUnowned

+ var ReportFilterWords = []string

type Plan

+ Filter ReportFilter

+ type ReportFilter []string

+ func (f ReportFilter) Active() bool

+ func (f ReportFilter) Shows(category string) bool

v0.19.0

Sep 23, 2026

Changes in this version

type LiveBucket

+ BucketOwner string

+ type LiveCluster struct

+ Estate string

+ JSON bool

+ Namespace string

+ PlanIdentity bool

+ func ParseLiveCluster(args []string) (*LiveCluster, tfdiags.Diagnostics)

v0.18.0

Sep 19, 2026

Changes in this version

+ type LiveBucket struct

+ Bucket string

+ Estate string

+ JSON bool

+ Region string

+ func ParseLiveBucket(args []string) (*LiveBucket, tfdiags.Diagnostics)

v0.17.0

Sep 10, 2026

v0.16.0

Sep 9, 2026

v0.15.0

Sep 8, 2026

v0.14.0

Sep 7, 2026

v0.13.0

Sep 6, 2026

v0.12.0

Sep 4, 2026

Changes in this version

+ type LiveLs struct

+ ConfigDir string

+ Consistent bool

+ Estate string

+ Region string

+ ViewOptions ViewOptions

+ func ParseLiveLs(args []string) (*LiveLs, func(), tfdiags.Diagnostics)

type LiveMv

+ JSON bool

v0.11.0

Sep 3, 2026

v0.10.1

Sep 3, 2026

v0.10.0

Sep 3, 2026

Changes in this version

type LiveMv

+ FromEstate string

v0.9.0

Sep 2, 2026

v0.8.0

Sep 1, 2026

v0.7.0

Sep 1, 2026

v0.6.0

Sep 1, 2026

v0.5.0

Aug 31, 2026

Changes in this version

type LiveImport

+ Parallelism int

type Plan

+ AdoptionOnly bool

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)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL