tfctl run start

The tfctl run start command starts a new run on a workspace.

Usage

$ tfctl run start WORKSPACE [options]

Description

The tfctl run start command creates a new plan and apply run with the most recent configuration.

If the auto-apply setting is enabled on the workspace and no errors occur, the plan is automatically applied.

Use --plan-only to create a speculative plan-only run that is never applied. This overrides the workspace's auto-apply setting.

Arguments

• WORKSPACE: (Required) Workspace ID or workspace name.

Flags

• --organization=NAME: Organization name. Required when using a workspace name instead of ID.

  • Optional.
  • Data type: string
  • Default value: Auto-resolved from profile or Terraform cloud configuration

• --debugging-mode: Enables trace logging for this run. Sets TF_LOG=trace in the Terraform environment for this run.

  • Optional.
  • Data type: boolean
  • Default value: false

• --message=TEXT: A message to attach to the run.

  • Optional.
  • Data type: string
  • Default value: None

• --allow-empty-apply: Allow the run to proceed even if the plan has no changes. Useful for performing operations that are unrelated to provisioning infrastructure, such as upgrading Terraform or provider versions, when no other changes are present.

  • Optional.
  • Data type: boolean
  • Default value: false

• --plan-only: Create a speculative plan-only run that is never applied. Overrides the workspace's auto-apply setting.

  • Optional.
  • Data type: boolean
  • Default value: false

Global flags

Refer to Global flags reference for information about flags you can use with all commands.

Examples

The following examples demonstrate how to start a new run on a workspace.

Start a new run in a workspace by ID

The following example starts a new run in a workspace using its workspace ID.

$ tfctl run start ws-abc123

Start a new run in a workspace by name

The following example starts a new run in a workspace using its name and organization.

$ tfctl run start my-workspace --organization my-org

Start a plan-only run that is not applied

The following example starts a plan-only run that is not applied automatically.

$ tfctl run start ws-abc123 --plan-only

Start a run with a custom message

The following example starts a run with a custom message describing the changes.

$ tfctl run start ws-abc123 --message "Deploying version 2.0"

Start a run with debugging enabled

The following example starts a run with debugging mode enabled for troubleshooting.

$ tfctl run start ws-abc123 --debugging-mode

Related

• tfctl run status