github.com/erriapo/terraform@v0.6.12-0.20160203182612-0340ea72354f/website/source/intro/getting-started/install.html.markdown (about)

     1  ---
     2  layout: "intro"
     3  page_title: "Installing Terraform"
     4  sidebar_current: "gettingstarted-install"
     5  description: |-
     6    Terraform must first be installed on your machine. Terraform is distributed as a binary package for all supported platforms and architecture. This page will not cover how to compile Terraform from source.
     7  ---
     8  
     9  # Install Terraform
    10  
    11  Terraform must first be installed on your machine. Terraform is distributed
    12  as a [binary package](/downloads.html) for all supported platforms and
    13  architecture. This page will not cover how to compile Terraform from
    14  source.
    15  
    16  ## Installing Terraform
    17  
    18  To install Terraform, find the [appropriate package](/downloads.html) for
    19  your system and download it. Terraform is packaged as a zip archive.
    20  
    21  After downloading Terraform, unzip the package into a directory where
    22  Terraform will be installed. The directory will contain a set of binary
    23  programs, such as `terraform`, `terraform-provider-aws`, etc. The final
    24  step is to make sure the directory you installed Terraform to is on the
    25  PATH. See
    26  [this page](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux)
    27  for instructions on setting the PATH on Linux and Mac.
    28  [This page](https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows)
    29  contains instructions for setting the PATH on Windows.
    30  
    31  Example for Linux/Mac - Type the following into your terminal:
    32  >`PATH=/usr/local/terraform/bin:/home/your-user-name/terraform:$PATH`
    33  
    34  Example for Windows - Type the following into Powershell:
    35  >`set PATH=%PATH%;C:\terraform`
    36  
    37  
    38  ## Verifying the Installation
    39  
    40  After installing Terraform, verify the installation worked by opening a new
    41  terminal session and checking that `terraform` is available. By executing
    42  `terraform` you should see help output similar to that below:
    43  
    44  ```
    45  $ terraform
    46  usage: terraform [--version] [--help] <command> [<args>]
    47  
    48  Available commands are:
    49      apply      Builds or changes infrastructure
    50      destroy    Destroy Terraform-managed infrastructure
    51      get        Download and install modules for the configuration
    52      graph      Create a visual graph of Terraform resources
    53      init       Initializes Terraform configuration from a module
    54      output     Read an output from a state file
    55      plan       Generate and show an execution plan
    56      refresh    Update local state file against real resources
    57      remote     Configure remote state storage
    58      show       Inspect Terraform state or plan
    59      taint      Manually mark a resource for recreation
    60      version    Prints the Terraform version
    61  ```
    62  
    63  If you get an error that `terraform` could not be found, then your PATH
    64  environment variable was not setup properly. Please go back and ensure
    65  that your PATH variable contains the directory where Terraform was installed.
    66  
    67  Otherwise, Terraform is installed and ready to go! Nice!
    68  
    69  ## Next Step
    70  
    71  Time to [build infrastructure](/intro/getting-started/build.html)
    72  using a minimal Terraform configuration file. You will be able to
    73  examine Terraform's execution plan before you deploy it to AWS.