Run a Local Linkup Session

Prerequisites

• Linkup deployed to a Cloudflare domain

Installing the CLI

With Homebrew

To use link up locally the easiest way to get started is to use the linkup cli:

brew tap mentimeter/mentimeter
brew install linkup

Using the install.py script

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/mentimeter/linkup/refs/heads/main/linkup-cli/install | python3

# Or to install a pre-release version (beta)

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/mentimeter/linkup/refs/heads/main/linkup-cli/install | python3 - --channel beta

Once you have the cli installed you can start a linkup session by running:

linkup start      <--- Gives you your unique session name
linkup status     <--- Shows how your session is configured
linkup local web  <--- Routes traffic of the `web` service to your local machine
linkup stop       <-- Stops your session