osx

macOS installation

(Return to Installation ToC)

Before you begin

Installing
Command line interface
Web PVR Manager
Installation notes
Upgrading
Uninstalling

Before you begin

Only macOS 10.10 (Yosemite) or higher is supported
Only macOS system Perl is supported. If you use perlbrew, plenv, ActivePerl, MacPorts Perl, Homebrew Perl, etc., you are responsible for configuring it correctly.
The macOS get_iplayer package installs scripts in /usr/local/bin. These will overwrite any scripts installed manually or with a Homebrew package. You are strongly advised to remove any previous installations not installed by the get_iplayer package installer.

Installing

macOS users should install get_iplayer with the provided package installer. Download the latest release from:

https://github.com/get-iplayer/get_iplayer_macos/releases/latest

The installer includes all necessary dependencies: AtomicParsley, ffmpeg and additional Perl modules needed by get_iplayer. This is the only supported configuration of get_iplayer on macOS. If you use any other version of these tools, your installation of get_iplayer is not supported.

Before installation, close all running instances of get_iplayer, including any Web PVR Manager server window that is open.

Double-click the installer .pkg file to launch it and follow the wizard steps. Notes:

There are no user-selectable options
get_iplayer is always installed on your system volume
You will be prompted for your password
The installer is not signed, so it may be necessary to bypass Gatekeeper by using Right-Click (or Ctrl-Click) on the .pkg file's icon and selecting "Open"

Command-line interface (CLI)

To start the CLI, open Terminal and enter commands at the prompt:
```
 get_iplayer [...]
```
Hit Return after each one to run it. See the documentation for examples of get_iplayer commands.
After installation, you should update the programme index cache:
```
 # TV programmes only (default)
 get_iplayer --refresh
 # TV and radio programmes
 get_iplayer --refresh --type=tv,radio
```
If yours is a new installation, the update will take longer than usual since get_iplayer will be building a full 30-day cache.

The default location for downloaded programmes is your current working directory. It is likely that you will wish to use a custom location, which can be set in your get_iplayer preferences. For example:

 # single directory for TV and radio
 get_iplayer --prefs-add --output="$HOME/get_iplayer"
 # separete directories for TV and radio
 get_iplayer --prefs-add --output-tv "$HOME/Movies/get_iplayer" --output-radio "$HOME/Music/get_iplayer"

Web PVR Manager (WPM)

To start the WPM, open Terminal and enter this command at the prompt:
```
 get_iplayer_web_pvr
```
Hit Return to launch the WPM server in your Terminal window.
After the WPM server launches, your default browser will be opened to this URL:

http://127.0.0.1:1935

If the WPM client does not open in your browser automatically, click the link above or enter the address in your web browser.
After the WPM has opened in your browser, select the programme types you wish to index (e.g., BBC TV, BBC Radio), then click the Refresh Cache button. A new tab or window will open that shows the cache being refreshed. If yours is a new installation, the update will take longer than usual since get_iplayer will be building a full 30-day cache.
Stop the WPM server by typing Ctrl-C in the Terminal window where it is running.

Notes

The provided versions of AtomicParsley and ffmpeg are only available while get_iplayer is running and can be referenced in --command strings as simply "AtomicParsley" or "ffmpeg". If you wish to use them outside of get_iplayer, you will find them in /usr/local/get_iplayer/bin.

Upgrading

Upgrade to future releases by downloading the latest package installer and running it as described above. It will automatically replace your previous version.