TerraHub Commands
Getting started with TerraHub CLI is pretty straightforward:
  1. 1.
    Next, check if npm is installed:
    1
    npm --version
    Copied!
    The output should look similar to the one below (no need to copy paste):
    1
    v5.6.0
    Copied!
    NOTE: If npm is missing, check out Downloading and installing Node.js and npm
  2. 2.
    Install terrahub globally using npm:
    1
    npm install --global terrahub
    Copied!
    The output should look similar to the one below (no need to copy paste):
    1
    ~/.nvm/versions/node/v8.10.0/lib
    Copied!
  3. 3.
    Test if terrahub cli was installed properly:
    1
    terrahub --help
    Copied!
    NOTE: TerraHub CLI doesn't magically collect your data and upload to TerraHub API, which is further visualized in TerraHub Console. In order to do that, please sign up for a free account at console.terrahub.io and navigate to Settings page to copy TerraHub Token. Next, setup TerraHub Token as THUB_TOKEN environmental variable or update token value in global config file - $HOME/.terrahub/.terrahub.json.
When running terrahub --help, you will get a list of commands, summarized below:
Command
Description
Status
# terrahub management
project
create new or define existing folder as project that manages terraform configuration
:heavy_check_mark:
component
create new or include existing terraform configuration into current terrahub project
:heavy_check_mark:
configure
add, change or remove config parameters from terrahub config files
:heavy_check_mark:
graph
show dependencies graph for terraform configuration mapped as terrahub components
:heavy_check_mark:
# terraform execution
apply
run terraform apply across multiple terrahub components
:heavy_check_mark:
destroy
run terraform destroy across multiple terrahub components
:heavy_check_mark:
init
run terraform init across multiple terrahub components
:heavy_check_mark:
output
run terraform output across multiple terrahub components
:heavy_check_mark:
plan
run terraform plan across multiple terrahub components
:heavy_check_mark:
refresh
run terraform refresh across multiple terrahub components
:heavy_check_mark:
workspace
run terraform workspace across multiple terrahub components
:heavy_check_mark:
# cloud automation
build
build code used by terraform configuration (e.g. AWS Lambda, Google Functions)
:heavy_check_mark:
run
execute automated workflow terraform init > workspace > plan > apply
:heavy_check_mark:
list
list cloud resources by projects > accounts > regions > services > resources
:heavy_check_mark:
Last modified 2yr ago
Copy link