> ## Documentation Index
> Fetch the complete documentation index at: https://tyk-joancamostyk-patch-12.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Tyk Sync

> Learn how to install Tyk Sync using Docker, Packagecloud, or Homebrew

## Overview

**Tyk Sync** is a command line tool and library to manage and synchronise a Tyk installation with your version control system (VCS). It's especially helpful for DevOps teams aiming to automate deployments and manage API configurations efficiently.

On this page, you will find instructions on how to install Tyk Sync using Docker, Packagecloud, or Homebrew.

## Installation Options

| Method                                                        | Description                            |
| :------------------------------------------------------------ | :------------------------------------- |
| **[Docker](#install-on-docker)**                              | Run Tyk Sync in a container            |
| **[Packagecloud](#install-via-package-manager-packagecloud)** | Hosts packages for linux distributions |
| **[Homebrew](#install-on-macos-homebrew)**                    | Package manager for macOS              |

## Install on Docker

1. **Pull the Docker image**

   Select a specific version from [Docker Hub](https://hub.docker.com/r/tykio/tyk-sync/tags)

   ```bash theme={null}
   SYNC_VERSION=v2.1
   docker pull tykio/tyk-sync:$SYNC_VERSION
   ```

2. **Run Tyk Sync**

   ```bash theme={null}
   docker run tykio/tyk-sync:$SYNC_VERSION version
   ```

## Install via Package Manager (Packagecloud)

The below instructions are for Debian/Ubuntu systems. For other distributions, refer to the [Packagecloud documentation](https://packagecloud.io/tyk/tyk-sync).

1. **Add the Tyk Sync repository**

   For Debian/Ubuntu systems:

   ```bash theme={null}
   curl -s https://packagecloud.io/install/repositories/tyk/tyk-sync/script.deb.sh | sudo bash
   ```

2. **Install Tyk Sync**

   ```bash theme={null}
   sudo apt-get install tyk-sync
   ```

3. **Verification**

   ```bash theme={null}
   tyk-sync version
   ```

## Install on macOS (Homebrew)

<Note>
  Homebrew installation is available from Tyk Sync **v2.2.0** onwards. For earlier versions, use [Docker](#install-on-docker) instead.
</Note>

1. **Install Tyk Sync**

   ```bash theme={null}
   brew install TykTechnologies/tyk/tyk-sync
   ```

2. **Verification**

   ```bash theme={null}
   tyk-sync version
   ```