macOS Install Guide🔗
This guide was created using macOS 11.1
It is expected that this guide should work from 10.15 upwards but has only been tested with 11.1
Open Terminal.app by clicking the magnifying glass icon in the top right of your screen.
terminal and hit Enter.
Install Homebrew, this should install the Xcode Command Line Tools for you as well.
This command might take a while to run depending on the speed of your internet connection.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install pipx pyenv
Add pipx to your path with:
echo 'export PATH="$HOME/.local/bin/:$PATH"' >> ~/.zshrc
and reload your shell environment with:
If you are using a shell other than ZSH you will need to edit and source the appropriate config file
brew install --cask docker github visual-studio-code
Use pyenv to install Python:
This command might take a while to run depending on the speed of your computer.
pyenv install 3.10:latest
Look for the line
Installing Python-3.10.n... (where
n is a number).
This is the full version it has installed for you, eg
Then enable this version (eg
3.10.1) in pyenv:
pyenv global system 3.10.1
Then install the OpenSAFELY CLI with pipx, using the Python installed in the previous step:
pipx install opensafely --python ~/.pyenv/shims/python3.10
Test the installation of OpenSAFELY CLI. This should print out the usage and available sub commands:
% opensafely --help usage: opensafely [-h] [--version] COMMAND ... optional arguments: -h, --help show this help message and exit --version show program's version number and exit available commands: COMMAND help Show this help message and exit run Run project.yaml actions locally codelists Commands for interacting with https://www.opencodelists.org/
Set up Docker by opening the app you installed earlier:
You'll be warned about the system dialogue which is about to pop up, choose "OK".
Enter your password and click "Install Helper".
Now that the Docker application is open you can click "Skip tutorial" and close the window. The Docker service will continue to run in the background and can be accessed from the Docker icon in your menu bar.
Now you can navigate to a research repo, on your local machine, and use
opensafely via the command line.