Guide
How to manually install Workbrew on a Device
Petros Amoiridis
For most deployments, Workbrew should be distributed via your MDM. See the deployment guides for MDM-specific instructions. Use this guide when you need to add a single Device manually, for example during evaluation or troubleshooting.
Prerequisites
- A Workbrew Workspace with an active account
- Terminal access with
sudoon the target Device - macOS (or Linux/WSL for beta support)
Get the install script from the Console
The Workbrew Console generates a Device-specific install script that includes your Workspace API key. You can find it in two places:
- Go to the Devices page and click manually in the subtitle to open the Manual Setup dialog
- Alternatively, go to Workspace Settings and expand Workbrew Workspace API key and installation script
Copy the install script from either location and share it with the Device user if you are not running it yourself.
Run the install script on the device
The script from the Console covers three steps:
- API key setup: Creates the Workbrew home directory and writes your Workspace API key to it. This is how the Device identifies itself to your Workspace on first check-in.
- Command Line Tools for Xcode (macOS only): Installs the Command Line Tools if they are not already present. You can also install them beforehand using
xcode-select --installor Apple's .pkg. - Workbrew Installer: Download and install the latest Workbrew Installer .pkg for macOS (or .sh for Linux/WSL for beta support).
After the script completes, the Device will check in with the Workbrew Console within 15 minutes and appear on the Devices page.
Related docs
- Troubleshooting - PATH setup, permission errors, and brew services after install
- How to fix zsh errors after installing Workbrew - shell warnings common after install
- Network requirements - required domains and ports if the Device doesn't check in
- Adding users to the workbrew_users group via MDM - configuring who can run
brew - Getting started with Workbrew - Device Groups, policies, and Default Packages
- Frequently asked questions - access modes, uninstalling, and other common questions