iTerm2 Companion App
iTerm2 Buddy is the companion app for your iPhone. Once paired with iTerm2 on your Mac, it lets your phone work together with your terminal.
You can download iTerm2 Buddy from the iOS App Store. Scan this code with your iPhone or iPad:
How to Pair
- On your Mac, open iTerm2 and choose iTerm2 > Companion Device Settings….
- Make sure the iTerm2 Companion plugin is installed and that “Allow companion device pairing” is turned on. As a security measure to prevent unauthorized users from linking their device to your computer, you'll need to enter an administrator password to enable this.
- Click Download Plugin. This takes you to the download page in your web browser.
- Download the plugin from the web browser and then extract the zip file.
- Click Show QR Code and authenticate with Touch ID or your password. iTerm2 will then show a QR code.
- On your iPhone, open iTerm2 Buddy, tap Scan, and point the camera at the QR code.
- Confirm the 6-digit code shown on your phone in iTerm2 to finish pairing.
Security
Since your terminal's contents are highly sensitive, security is a top priority for communication between iTerm2 and the companion app. End-to-end encryption using Noise protocol ensures that only your Mac and your iPhone can see the content that is shared with the companion app. For details, see the relay design document.
Enterprise administrators can prevent usage of the companion by blocking installation of the plugin, which is a Mac app with bundle ID com.googlecode.iterm2.iTermCompanion.
Beta version
- On your iPhone, install Apple’s TestFlight app from the App Store, if you don’t already have it.
- Open the iTerm2 Buddy beta invitation: Join the iTerm2 Buddy beta. (Open this link on your iPhone, not your Mac.)
- In TestFlight, tap Accept, then Install, to put iTerm2 Buddy on your phone.