Skip to content

Merging to release-5.14: TT-15449: document Homebrew install for Tyk Sync on macOS (#2730) #2794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharadregoti merged 1 commit into from
Aug 27, 2026
Merged

Merging to release-5.14: TT-15449: document Homebrew install for Tyk Sync on macOS (#2730) #2794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions product-stack/tyk-sync/installing-tyk-sync.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
---
title: "Install Tyk Sync"
description: "Learn how to install Tyk Sync using Docker or Packagecloud"
keywords: "Tyk Sync, Installation, Docker, API Management"
description: "Learn how to install Tyk Sync using Docker, Packagecloud, or Homebrew"
keywords: "Tyk Sync, Installation, Docker, Homebrew, macOS, API Management"
sidebarTitle: "Installation"
---

## 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 and Packagecloud.
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

Expand Down Expand Up @@ -55,6 +56,24 @@ The below instructions are for Debian/Ubuntu systems. For other distributions, r

3. **Verification**

```bash
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
brew install TykTechnologies/tyk/tyk-sync
```

2. **Verification**

```bash
tyk-sync version
```