Terraform Cloud/Enterprise Typescript Client

The Typescript API client for Terraform Cloud/Enterprise.

This client supports the Terraform Cloud V2 API. As Terraform Enterprise is a self-hosted distribution of Terraform Cloud, this client supports both Cloud and Enterprise use cases. In all package documentation and API, the platform will always be stated as 'Terraform Enterprise' - but a feature will be explicitly noted as only supported in one or the other, if applicable (rare).

Note this client is in beta and is subject to change (though it is generally quite stable). We will indicate any breaking changes by releasing new versions. Until the release of v1.0, any minor version changes will indicate possible breaking changes. Patch version changes will be used for both bugfixes and non-breaking changes.

Installation

Installation can be done with a normal npm install node-tfe:

Usage

import Client from 'node-tfe';

Construct a new TFE client, then use the various endpoints on the client to access different parts of the Terraform Enterprise API. For example, to list all organizations:

const client = new Client({
  token: 'insert-your-token-here',
});

const workspaces = await client.Workspaces.list('your-organization-name');

Documentation

For complete usage of the API client, see the full package docs.

API Coverage

Only the following Terraform Cloud/Enterprise V2 API are supported:

• Workspaces
• ConfigurationVersions
• Runs
• StateVersions
• Organizationtags

Issues and Contributing

If you find an issue with this package, please report an issue. If you'd like, we welcome any contributions. Fork this repository and submit a pull request.

Releases

Documentation updates and test fixes that only touch test files don't require a release or tag. You can just merge these changes into master once they have been approved.

Creating a release

1. Merge your approved branch into master.

2. Create a new release in GitHub.

   • Click on "Releases" and then "Draft a new release"

   • Set the tag version to a new tag, using Semantic Versioning as a guideline.

   • Set the target as master.

   • Set the Release title to the tag you created, vX.Y.Z

   • Use the description section to describe why you're releasing and what changes you've made. You should include links to merged PRs

   • Consider using the following headers in the description of your release:

     • BREAKING CHANGES: Use this for any changes that aren't backwards compatible. Include details on how to handle these changes.
     • FEATURES: Use this for any large new features added,
     • ENHANCEMENTS: Use this for smaller new features added
     • BUG FIXES: Use this for any bugs that were fixed.
     • NOTES: Use this section if you need to include any additional notes on things like upgrading, upcoming deprecations, or any other information you might want to highlight.

     Markdown example:

     ENHANCEMENTS
     
     - Add description of new small feature (#3)[link-to-pull-request]
     
     BUG FIXES
     
     - Fix description of a bug (#2)[link-to-pull-request]
     - Fix description of another bug (#1)[link-to-pull-request]

   • Don't attach any binaries. The zip and tar.gz assets are automatically created and attached after you publish your release.

   • Click "Publish release" to save and publish your release.