The terraform login
command can be used to automatically obtain and save an
API token for HCP Terraform, Terraform Enterprise, or any other host that offers Terraform services.
Usage: terraform login [hostname]
If you don't provide an explicit hostname, Terraform will assume you want to
log in to HCP Terraform at app.terraform.io
.
By default, Terraform will obtain an API token and save it in plain text in a
local CLI configuration file called credentials.tfrc.json
. When you run
terraform login
, it will explain specifically where it intends to save
the API token and give you a chance to cancel if the current configuration is
not as desired.
If you don't wish to store your API token in the default location, you can optionally configure a credentials helper program which knows how to store and later retrieve credentials in some other system, such as your organization's existing secrets management system.
The terraform login
command works with any server supporting the
login protocol, including HCP Terraform
and Terraform Enterprise.