​
CLI Workspace Provider

The Terraform Cloud scanner syncs workspaces from your Terraform Cloud account into Ctrlplane, allowing you to deploy, upgrade and manage workspaces.

​
Usage

To sync in all Terraform Cloud workspaces, you’ll need:
  1. A Terraform Cloud API key with read access to your workspaces
  2. Your Terraform Cloud organization name (e.g. example)
To see all available options, run: 
ctrlc sync tfe --help
Here is a basic example of how to sync in all Terraform Cloud workspaces: 
ctrlc sync tfe \
    --tfe-token <TFE_TOKEN> \
    --organization <TFE_ORG> \
    --interval 5m

​
Resource Schemas

​
Workspace

When syncing workspaces from Terraform Cloud, each workspace will have the following schema:
​
version
string
default:"terraform-cloud/v1"
The version of the schema
​
kind
string
default:"Workspace"
The type of resource
​
name
string
Name of the workspace
​
identifier
string
The unique identifier of the workspace
​
config
Terraform Cloud workspace config
​
metadata
Terraform Cloud workspace metadata