Add note about powershell formatting

This commit is contained in:
Laura Pacilio 2022-03-18 17:15:24 -04:00
parent 4dd45e6bfa
commit c7afb7db94
2 changed files with 8 additions and 4 deletions

View File

@ -15,14 +15,16 @@ works with local state.
Usage: `terraform state pull` Usage: `terraform state pull`
This command will download the state from its current location, upgrade the This command downloads the state from its current location, upgrades the
local copy to the latest state file version that is compatible with local copy to the latest state file version that is compatible with
locally-installed Terraform, and output the raw format to stdout. locally-installed Terraform, and outputs the raw format to stdout.
This is useful for reading values out of state (potentially pairing this This is useful for reading values out of state (potentially pairing this
command with something like [jq](https://stedolan.github.io/jq/)). It is command with something like [jq](https://stedolan.github.io/jq/)). It is
also useful if you need to make manual modifications to state. also useful if you need to make manual modifications to state.
~> Note: This command cannot be used to inspect the Terraform version of You cannot use this command to inspect the Terraform version of
the remote state, as it will always be converted to the current Terraform the remote state, as it will always be converted to the current Terraform
version before output. version before output.
-> **Note:** Terraform state files must be in UTF-8 format without a byte order mark (BOM). For PowerShell on Windows, use `Set-Content` to automatically encode files in UTF-8 format. For example, run `terraform state pull | sc terraform.tfstate`

View File

@ -16,13 +16,15 @@ manual intervention is necessary with the remote state.
Usage: `terraform state push [options] PATH` Usage: `terraform state push [options] PATH`
This command will push the state specified by PATH to the currently This command pushes the state specified by PATH to the currently
configured [backend](/language/settings/backends). configured [backend](/language/settings/backends).
If PATH is "-" then the state data to push is read from stdin. This data If PATH is "-" then the state data to push is read from stdin. This data
is loaded completely into memory and verified prior to being written to is loaded completely into memory and verified prior to being written to
the destination state. the destination state.
-> **Note:** Terraform state files must be in UTF-8 format without a byte order mark (BOM). For PowerShell on Windows, use `Set-Content` to automatically encode files in UTF-8 format. For example, run `terraform state push | sc terraform.tfstate`.
Terraform will perform a number of safety checks to prevent you from Terraform will perform a number of safety checks to prevent you from
making changes that appear to be unsafe: making changes that appear to be unsafe: