Skip to main content

A client for HashiCorp Terraform Cloud

Project description

Terraform Cloud Client

An API client for HashiCorp's Terraform Cloud


$ pip install terraform-cloud-client

This client is only tested on python 3.7

Usage as a library

Set up:

>>> import tfc
>>> client = tfc.TerraformClient("my_api_token", "my_organization", "my_workspace")

Get Terraform variables:

>>> variables = client.get_variables()
>>> variables
    'my_username': <TerraformVariable id='var-someid1', name='my_username', value='john_doe'>,
    'my_password': <TerraformVariable id='var-someid2', name='my_password', sensitive>,
>>> username_variable = variables['my_username']
>>> username_variable.value

Change the value of a variable:

>>> client.update_variable(, new_value='jane_doe')

Trigger a run:

>>> run = client.create_run('My message')
>>> run.url # Go here in a web browser to view the run

Usage as a command line tool

Installing this via pip also installs a tfc command line tool

$ tfc --help
usage: tfc [-h] [--message MESSAGE]
           organization workspace [name=value [name=value ...]]

Trigger a Terraform Cloud run

positional arguments:
  organization          The name of your organization in Terraform Cloud
  workspace             The name of your workspace in Terraform Cloud
  name=value            Set terraform variable NAME to VALUE before creating
                        the run

optional arguments:
  -h, --help            show this help message and exit
  --message MESSAGE, -m MESSAGE
                        The message to be associated with this run

Put your API token in the TERRAFORM_CLOUD_TOKEN environment variable

So for example:

$ tfc my_organization my_workspace foo=baz --message="Reticulating splines"
Updated 'foo' from 'bar' to 'baz'
Created run run-g6SmSsLVKg71yeNw - check status at:

The message argument can contain variables which are expanded at runtime. These follow the same formatting rules as Python's str.format(...). The variables which are currently defined are:

  • git_repository
  • git_branch
  • git_commit_subject
  • git_commit_author

So for example:

$ tfc my_organization my_workspace foo=baz --message="{git_commit_subject} (author: {git_commit_author}, branch: {git_branch}, repo: {git_repository})"

might create a run with the message:

My commit message (author: Joe Bloggs, branch: my-branch, repo: terraform-cloud-client)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terraform-cloud-client-0.0.3.tar.gz (5.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page