3 min • read

Install

Install Telepresence by running the commands below for your OS. If you are not the administrator of your cluster, you will need administrative RBAC permissions to install and use Telepresence in your cluster.

GNU/Linux
shell
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/latest/telepresence -o /usr/local/bin/telepresence
# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
macOS
shell
# Intel Macs
# Install via brew:
brew install datawire/blackbird/telepresence
# OR install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/latest/telepresence -o /usr/local/bin/telepresence
# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
# Apple silicon Macs
# Install via brew:
brew install datawire/blackbird/telepresence-arm64
# OR Install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/arm64/latest/telepresence -o /usr/local/bin/telepresence
# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
Windows
powershell
# To install Telepresence, run the following Powershell commands
# with an account that has Administrator privileges.
# 1. Download the latest windows zip file
# This contains telepresence.exe and its dependencies (~50 MB):
Invoke-WebRequest https://app.getambassador.io/download/tel2/windows/amd64/latest/telepresence.zip -OutFile telepresence.zip
# 2. Extract the zip file to your desired directory, then delete the zip file:
Expand-Archive -Path telepresence.zip -DestinationPath telepresenceInstaller/telepresence
Remove-Item 'telepresence.zip'
cd telepresenceInstaller/telepresence
# 3. Run install-telepresence.ps1 to install telepresence's dependencies:
Set-ExecutionPolicy Bypass -Scope Process
.\install-telepresence.ps1
# 4. Remove the unzipped directory:
cd ../..
Remove-Item telepresenceInstaller
# 5. Close the Powershell window, then open a new instance of it.
# Telepresence is now usable as telepresence.exe.

Telepresence logo What's Next?

Follow one of our quick start guides to start using Telepresence, either with our sample app or in your own environment.

Installing nightly versions of Telepresence

We build and publish the contents of the default branch, release/v2, of Telepresence nightly, Monday through Friday, for macOS (Intel and Apple silicon), Linux, and Windows.

The tags are formatted like so: vX.Y.Z-nightly-$gitShortHash.

vX.Y.Z is the most recent release of Telepresence with the patch version (Z) bumped one higher. For example, if our last release was 2.3.4, nightly builds would start with v2.3.5, until a new version of Telepresence is released.

$gitShortHash will be the short hash of the git commit of the build.

Use these URLs to download the most recent nightly build.

GNU/Linux
shell
https://app.getambassador.io/download/tel2/linux/amd64/nightly/telepresence
macOS
shell
# Intel Macs
https://app.getambassador.io/download/tel2/darwin/amd64/nightly/telepresence
# Apple silicon Macs
https://app.getambassador.io/download/tel2/darwin/arm64/nightly/telepresence
Windows
shell
https://app.getambassador.io/download/tel2/windows/amd64/nightly/telepresence.zip

Installing older versions of Telepresence

Use these URLs to download an older version for your OS (including older nightly builds), replacing x.y.z with the versions you want.

GNU/Linux
shell
https://app.getambassador.io/download/tel2/linux/amd64/x.y.z/telepresence
macOS
shell
# Intel Macs
https://app.getambassador.io/download/tel2/darwin/amd64/x.y.z/telepresence
# Apple silicon Macs
https://app.getambassador.io/download/tel2/darwin/arm64/x.y.z/telepresence
Windows
shell
https://app.getambassador.io/download/tel2/windows/amd64/x.y.z/telepresence