Skip to main content

Mac

Install the airpipe command​

  curl -fsSL https://download.airpipe.io/install.sh | sh

Installs the latest release for this machine (Apple Silicon) after checking its SHA-256, into /usr/local/bin, or ~/.local/bin when that would need a password it cannot ask for. It installs no service and needs no API key: sign in with airpipe login, then run airpipe server --config-dir ./configs. A binary installed this way runs straight away: the Gatekeeper prompt below is for one downloaded through a browser. To install a particular version, or somewhere else:

  curl -fsSL https://download.airpipe.io/install.sh | AIRPIPE_VERSION=3.23.1 AIRPIPE_INSTALL_DIR=~/bin sh

To run Air Pipe as a service that starts at boot, use setup.sh below instead.

Retrieve API Key​

Log in and create an API key at https://app.airpipe.io/apikeys. It is shown once, when you create it, so copy it then (lost it? create a new one and delete the old)

Permissions & Security​

On new Apple devices, gatekeeper will block the binary from running by default.

After you attempt to run it once simply with ./airpipe you will need to allow it by going to Privacy & Security scroll towards the bottom, and there will be a prompt to allow the binary.

Run it as a service​

Installs the binary to /usr/local/bin and a launchd service that starts it at boot and restarts it if it stops. Configs go in /etc/airpipe/configs; the agent's identity is kept in /var/lib/airpipe, and its log is /var/log/airpipe/airpipe-service.log.

  curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- \
    --api-key enter-your-api-key-12345

  sudo launchctl bootstrap system /Library/LaunchDaemons/com.airpipe.plist

Restart it with sudo launchctl kickstart -k system/com.airpipe, and stop it with sudo launchctl bootout system/com.airpipe. macOS builds are for Apple Silicon only.

Download the binary to the current directory​

  curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- \
    --api-key enter-your-api-key-12345 \
    --download

Download the binary to the current directory and generate directories​

This is typically used in tutorial mode.

  curl -s https://download.airpipe.io/setup.sh | sudo bash -s -- \
    --api-key enter-your-api-key-12345 \
    --local

Download directly, without piping to a shell​

If you would rather not pipe a script into sudo bash, fetch the binary yourself. Every release publishes a SHA-256 next to it so you can verify what you downloaded before running it.

macOS ships shasum rather than sha256sum:

  # Resolve the current version
  VERSION=$(curl -sf https://download.airpipe.io/latest.version)

  # Apple Silicon (there is no Intel macOS build)
  BASE="https://download.airpipe.io/${VERSION}/darwin/aarch64"

  curl -fLO "${BASE}/airpipe"
  curl -fLO "${BASE}/airpipe.sha256"

  shasum -a 256 -c airpipe.sha256    # expects: airpipe: OK
  chmod +x airpipe

Only run the binary once the checksum reports OK. If it does not match, the download is incomplete or has been tampered with — delete it and fetch again.

You still need an API key to start it:

  ./airpipe server --api-key enter-your-api-key-12345 --config-dir ./configs

Gatekeeper will block it on first run — see Permissions & Security above.

Download Binary