1**********************************************
2Standard Setup of Toolchain for Mac OS
3**********************************************
4
5:link_to_translation:`zh_CN:[中文]`
6
7Install Prerequisites
8=====================
9
10ESP-IDF will use the version of Python installed by default on macOS.
11
12- install pip::
13
14    sudo easy_install pip
15
16- install CMake & Ninja build:
17
18  - If you have HomeBrew_, you can run::
19
20      brew install cmake ninja dfu-util
21
22  - If you have MacPorts_, you can run::
23
24      sudo port install cmake ninja dfu-util
25
26  - Otherwise, consult the CMake_ and Ninja_ home pages for macOS installation downloads.
27
28- It is strongly recommended to also install ccache_ for faster builds. If you have HomeBrew_, this can be done via ``brew install ccache`` or ``sudo port install ccache`` on MacPorts_.
29
30.. note::
31   If an error like this is shown during any step::
32
33     xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun
34
35   Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.
36
37Installing Python 3
38-------------------
39
40Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python 2.7 will not be included by default in future versions of macOS. Check what Python you currently have::
41
42  python --version
43
44If the output is like ``Python 2.7.17``, your default interpreter is Python 2.7. If so, also check if Python 3 isn't already installed on your computer::
45
46  python3 --version
47
48If above command returns an error, it means Python 3 is not installed.
49
50Below is an overview of steps to install Python 3.
51
52  - Installing with HomeBrew_ can be done as follows::
53
54      brew install python3
55
56  - If you have MacPorts_, you can run::
57
58      sudo port install python38
59
60Next Steps
61==========
62
63To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
64
65.. _cmake: https://cmake.org/
66.. _ninja: https://ninja-build.org/
67.. _ccache: https://ccache.samba.org/
68.. _homebrew: https://brew.sh/
69.. _MacPorts: https://www.macports.org/install.php
70.. _Catalina 10.15 release notes: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes
71