consul/website/content/docs/nia/installation/run.mdx

---
layout: docs
page_title: Run Consul-Terraform-Sync
sidebar_title: Run Consul-Terraform-Sync
description: >-
  Consul-Terraform-Sync requires a Terraform Provider, a Terraform Module and a running Consul Cluster outside of the consul-terraform-sync daemon.
---

# Run Consul-Terraform-Sync

1. Move the `consul-terraform-sync` binary to a location available on your `PATH`.

  ```shell-session
  $ mv ~/Downloads/consul-terraform-sync /usr/local/bin/consul-terraform-sync
  ```

2. Create the config.hcl file, all the options are available [here](/docs/nia/installation/configuration).

3. Run consul-terraform-sync.

  ```shell-session
  $ consul-terraform-sync -config-file <config.hcl>
  ```

4. Check status of tasks. Replace port number if configured in Step 2. See additional API endpoints [here](/docs/nia/api)

  ```shell-session
  $ curl localhost:8558/status/tasks
  ```