Skip to main content
Version: 0.40.0


$ driftctl scan [OPTIONS]
$ driftctl scan --from tfstate+s3://terraform.tfstate --to github+tf --output console://


Scan resources from the input Terraform statefile and compare it to your current profile infrastructure.




Currently, driftctl only supports reading IaC from a Terraform state. We are investigating to support the Terraform code as well, as a state does not represent an intention.


Multiple states can be read by passing --from flags. You can also use glob patterns to match multiple state files at once.


When no state is specified for the scan, driftctl automatically reads your HCL files in the current directory as an attempt to find which state to use. This feature currently only works with the following backends: local, gcs, s3, azurerm as well as cloud configuration for Terraform Cloud.

If it doesn't succeed, driftctl fallback looking for a local terraform.tfstate file.


# I want to read a local state and a state stored in an S3 bucket:
$ driftctl scan \
--from tfstate+s3://statebucketdriftctl/terraform.tfstate \
--from tfstate://terraform_toto.tfstate

# In a given local folder
# driftctl will recursively use all files under this folder.
# N.B. Symlinks under the root folder will be ignored.
# If the folder itself is a symlink it will be followed.
$ driftctl scan --from tfstate://my-states/directory
# Only match state files in that directory
$ driftctl scan --from tfstate://my-states/directory/*.tfstate

# Using glob pattern to recursively use any *.tfstate file.
$ driftctl scan --from tfstate://path/to/**/*.tfstate
$ driftctl scan --from tfstate+s3://example-bucket/*.tfstate
$ driftctl scan --from tfstate+gs://example-bucket/**/*.tfstate
$ driftctl scan --from tfstate+azurerm://example-container/states/*.tfstate

# This works for

# We also support HTTP(s) URLs with authentication
# the tool will fetch the file from the given URL
# You can use the --headers option if you need to add extra headers to the request (e.g: for authentication purposes)
$ driftctl scan --from tfstate+ --headers 'Authorization=Basic ...; X-Custom-Header=value'

# You can also read the current state for a given workspace from Terraform Cloud
# Don't forget to provide your Terraform Cloud API token
# The Terraform Cloud integration supports both workspace ids, and workspace names

$ driftctl scan --from tfstate+tfcloud://$WORKSPACE_ID --tfc-token $TFC_TOKEN
$ driftctl scan --from tfstate+tfcloud://$ORGANIZATION_NAME/$WORKSPACE_NAME --tfc-token $TFC_TOKEN

# You can also read the current state for a given workspace from Terraform Enterprise by passing the tfc-endpoint value
# that's specific to your Org's Terraform Enterprise installation
# You can obtain your workspace id from the General Settings of the workspace
# Don't forget to provide your Terraform Enterprise API token
$ driftctl scan --from tfstate+tfcloud://$WORKSPACE_ID --tfc-token $TFC_TOKEN --tfc-endpoint ''

# You can use azure blob storage too
# See below how to setup authentication for that backend
$ driftctl scan --to azure+tf --from tfstate+azurerm://my-container/terraform.tfstate
# Blob patterns are also supported
$ driftctl scan --to azure+tf --from tfstate+azurerm://my-container/states/**

Supported IaC sources

  • Terraform state
  • Local: --from tfstate://terraform.tfstate
  • S3: --from tfstate+s3://my-bucket/path/to/state.tfstate
  • GCS: --from tfstate+gs://my-bucket/path/to/state.tfstate
  • HTTPS: --from tfstate+https://my-url/state.tfstate
  • Terraform Cloud / Terraform Enterprise: --from tfstate+tfcloud://WORKSPACE_ID
  • Azure blob storage: --from tfstate+azurerm://container-name/path/to/state.tfstate

You can use any unsupported backend by using terraform to pipe your state in a file and then use this file with driftctl:

$ terraform state pull > state.tfstate
$ driftctl scan --from tfstate://state.tfstate

driftctl needs read-only access so you could use the policy below to ensure minimal access to your state file.

"Version": "2012-10-17",
"Statement": [
"Effect": "Allow",
"Action": "s3:ListBucket",
"Resource": "arn:aws:s3:::mybucket"
"Effect": "Allow",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::mybucket/path/to/my/key"
HTTP + GitLab

The HTTP backend supports the GitLab managed Terraform State using their API.

All you need is a GitLab repository that contains a Terraform state and an access token with the read_api scope.

Here's what the command looks like:

$ GITLAB_TOKEN=<access_token> \
driftctl scan \
--from tfstate+<project_id>/terraform/state/<path_to_state> \
--headers "Authorization=Bearer ${GITLAB_TOKEN}"

You can find more information about the GitLab managed Terraform State on the GitLab documentation website.

Azure blob storage

To be able to access state from azure blob storage, you have to define these two environment variables

$ export AZURE_STORAGE_KEY=...
$ driftctl scan --from tfstate+azurerm://my-container/terraform.tfstate

# You can also use inline flags
$ driftctl scan --azurerm-storage-account 'storageaccountname' --azurerm-account-key 'key' --from tfstate+azurerm://my-container/terraform.tfstate

You can find theses values in your Azure console here:



driftctl supports multiple kinds of output formats and by default uses the standard output (console).

Environment: DCTL_OUTPUT


$ driftctl scan
$ driftctl scan --output console://
$ DCTL_OUTPUT=console:// driftctl scan

driftctl can write to multiple outputs at once by passing multiple --output flags.

Found missing resources:
- driftctl-bucket-test-2
Found resources not covered by IaC:
- driftctl-bucket-test-3
Found 3 resource(s)
- 33% coverage
- 1 covered by IaC
- 1 not covered by IaC
- 1 missing on cloud provider


$ driftctl scan --output json:///tmp/result.json # Will output results to /tmp/result.json
$ driftctl scan --output json://result.json # Will output results to ./result.json
$ driftctl scan --output json://stdout # Will output results in json to stdout directly
$ DCTL_OUTPUT=json://result.json driftctl scan
"summary": {
"total_resources": 3,
"total_unmanaged": 1,
"total_missing": 1,
"total_managed": 1,
"total_iac_source_count": 1
"managed": [
// list of resources found in IaC and in sync with remote
"id": "driftctl-bucket-test-1",
"type": "aws_s3_bucket",
"source": { // Source encapsulates metadata explaining where the resource is coming from within an IaC
"source": "tfstate://terraform.tfstate", // Represents the Terraform state file
"namespace": "module", // If you use Terraform module, it will be displayed here
"internal_name": "my_name" // Represents the internal Terraform resource's name
"unmanaged": [
// list of resources found in remote but not in IaC
"id": "driftctl-bucket-test-3",
"type": "aws_s3_bucket"
"missing": [
// list of resources found in IaC but not on remote
"id": "driftctl-bucket-test-2",
"type": "aws_s3_bucket"
"coverage": 33,
"provider_name": "AWS",
"provider_version": "2.18.5",
// Scan duration in seconds
"scan_duration": 27,
"date": "2022-04-08T10:35:00Z"



You can now visualize your scan results in your browser with the HTML output:

$ driftctl scan --output html://output.html # Will output results to ./output.html
$ DCTL_OUTPUT=html://output.html driftctl scan

Output HTML With Drifts Output HTML Without Drifts


driftctl supports multiple providers. By default it will scan against AWS, but you can change this using --to.


Environment: DCTL_TO

$ driftctl scan --to PROVIDER+TYPE

# examples:
$ driftctl scan --to aws+tf
$ DCTL_TO=github+tf driftctl scan

Supported Providers

driftctl supports these providers:

  • github+tf
  • aws+tf
  • gcp+tf
  • azure+tf


This flag prevents stdout to be use for anything but the scan result.


When running driftctl against an AWS account, you may experience unnecessary noises with resources that don't belong to you. It can be the case if you have an organization account in which you will by default have a service-linked role associated to your account (e.g. AWSServiceRoleForOrganizations). For now, driftctl ignores those service-linked resources by default.

If you still want to include those resources in the report anyway, you can enable the strict mode.

For now, resources include:

  • Service-linked AWS IAM roles, including their policies and policy attachments


# Enable the strict mode
$ driftctl scan --strict


You can specify a terraform provider version to use. If none, driftctl uses defaults from the table below:



# I use terraform provider 3.43.0 so I can use this provider with driftctl to avoid scan errors
# driftctl will scan with an AWS terraform provider v3.43.0
$ DCTL_TF_PROVIDER_VERSION=3.43.0 driftctl scan

# Same parameter is used for every cloud provider
# driftctl will scan with a GitHub terraform provider v4.10.1
$ DCTL_TF_PROVIDER_VERSION=4.10.1 driftctl scan --to github+tf


The default name for a driftignore file is .driftignore. If for some reason you want to use a custom filename, you can do so using the --driftignore flag. This is especially useful when you have multiple driftignore files, where each of them represents a particular use case.


You can use only one driftignore file at once.


# Apply ignore directives from the /path/to/driftignore file
$ driftctl scan --driftignore /path/to/driftignore


You can change the directory path that driftctl uses for configuration. By default, it is the $HOME directory.

This can be useful, for example, if you want to invoke driftctl in an AWS Lambda function where you can only use the /tmp folder.


$ driftctl scan --config-dir path_to_driftctl_config_dir
$ DCTL_CONFIG_DIR=path_to_driftctl_config_dir driftctl scan


By default, driftctl tries to read a Terraform lock file (.terraform.lock.hcl) in the current directory, so driftctl can automatically detect which provider to use, according to the --to flag. You can specify a custom path for that file using the --tf-lockfile flag. If parsing the lockfile fails for some reason, errors will be logged and scan will continue.


Note that when using both --tf-lockfile and --tf-provider-version flags together, --tf-provider-version will simply take precedence overall.


$ driftctl scan --to aws+tf --tf-lockfile path/to/.terraform.lock.hcl


This flag allows you to output only resources that are not managed by your IaC.


$ driftctl scan --only-unmanaged

Found resources not covered by IaC:
- AWSServiceRoleForAPIGateway-arn:aws:iam::aws:policy/aws-service-role/APIGatewayServiceRolePolicy
- AWSServiceRoleForAWSCloud9-arn:aws:iam::aws:policy/aws-service-role/AWSCloud9ServiceRolePolicy
- custom-role
Found 5 resource(s)
- 40% coverage
- 2 resource(s) managed by Terraform
- 3 resource(s) not managed by Terraform

Exit codes

If no drift is found and all infrastructure is in sync with the infrastructure-as-code state (after accounting for filters and driftignore), driftctl will exit with status 0.

If drift is found, driftctl will exit with status 1.

If any other error occurs, driftctl will exit with status 2.