This guide covers Ubuntu version 24.04 LTS and later.
  If you are using a different Linux distribution see :ref:`installation_linux`.

  .. code-block:: bash

     sudo apt update
     sudo apt upgrade

  On macOS Mojave or later, select *System Preferences* >
  *Software Update*. Click *Update Now* if necessary.

  On other versions, see `this Apple support topic
  <https://support.apple.com/en-us/HT201541>`_.

  .. note::

     x86-64 macOS is not supported.

  Select *Start* > *Settings* > *Update & Security* > *Windows Update*.
  Click *Check for updates* and install any that are available.

  .. _install_dependencies_ubuntu:

  #. Use ``apt`` to install the required dependencies:

     .. code-block:: bash

        sudo apt install --no-install-recommends git cmake ninja-build gperf \
          ccache dfu-util device-tree-compiler wget python3-dev python3-venv python3-tk \
          xz-utils file make gcc gcc-multilib g++-multilib libsdl2-dev libmagic1

     .. note::

        Due to the unavailability of ``gcc-multilib`` and ``g++-multilib`` on AArch64
        (ARM64) systems, you may need to omit them from the list of packages to install.

  #. Verify the versions of the main dependencies installed on your system by entering:

     .. code-block:: bash

        cmake --version
        python3 --version
        dtc --version

     Check those against the versions in the table in the beginning of this section.
     Refer to the :ref:`installation_linux` page for additional information on updating
     the dependencies manually.

  .. _install_dependencies_macos:

  #. Install `Homebrew <https://brew.sh/>`_:

     .. code-block:: bash

        /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  #. After the Homebrew installation script completes, follow the on-screen
     instructions to add the Homebrew installation to the path.

     .. code-block:: bash

        (echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile
        source ~/.zprofile

  #. Use ``brew`` to install the required dependencies:

     .. code-block:: bash

        brew install cmake ninja gperf python3 python-tk ccache qemu dtc libmagic wget openocd

  #. Add the Homebrew Python folder to the path, in order to be able to
     execute ``python`` and ``pip`` as well ``python3`` and ``pip3``.

       .. code-block:: bash

          (echo; echo 'export PATH="'$(brew --prefix)'/opt/python/libexec/bin:$PATH"') >> ~/.zprofile
          source ~/.zprofile

  .. note::

     Due to issues finding executables, the Zephyr Project doesn't
     currently support application flashing using the `Windows Subsystem
     for Linux (WSL)
     <https://msdn.microsoft.com/en-us/commandline/wsl/install_guide>`_
     (WSL).

     Therefore, we don't recommend using WSL when getting started.

  In modern version of Windows (10 and later) it is recommended to install the Windows Terminal
  application from the Microsoft Store. Instructions are provided for a ``cmd.exe`` or
  PowerShell command prompts.

  These instructions rely on Windows' official package manager, `winget`_.
  If using winget isn't an option, you can install dependencies from their
  respective websites and ensure the command line tools are on your
  :envvar:`PATH` :ref:`environment variable <env_vars>`.

  |p|

  .. _install_dependencies_windows:

  #. In modern Windows versions, winget is already pre-installed by default.
     You can verify that this is the case by typing ``winget`` in a terminal
     window. If that fails, you can then `install winget`_.

  #. Open a Command Prompt (``cmd.exe``) or PowerShell terminal window.
     To do so, press the Windows key, type ``cmd.exe`` or PowerShell and
     click on the result.

  #. Use ``winget`` to install the required dependencies:

     .. code-block:: bat

        winget install Kitware.CMake Ninja-build.Ninja oss-winget.gperf Python.Python.3.12 Git.Git oss-winget.dtc wget 7zip.7zip

  #. Close the terminal window.

  .. note::

     You may need to add the 7zip installation folder to your ``PATH``.

  #. Create a new virtual environment:

     .. code-block:: bash

        python3 -m venv ~/zephyrproject/.venv

  #. Activate the virtual environment:

     .. code-block:: bash

        source ~/zephyrproject/.venv/bin/activate

     Once activated your shell will be prefixed with ``(.venv)``. The
     virtual environment can be deactivated at any time by running
     ``deactivate``.

     .. note::

        Remember to activate the virtual environment every time you
        start working.

  #. Install west:

     .. code-block:: bash

        pip install west

  #. Get the Zephyr source code:

     .. only:: not release

        .. code-block:: bash

           west init ~/zephyrproject
           cd ~/zephyrproject
           west update

     .. only:: release

        .. We need to use a parsed-literal here because substitutions do not work in code
           blocks. This means users can't copy-paste these lines as easily as other blocks but
           should be good enough still :)

        .. parsed-literal::

           west init ~/zephyrproject --mr v |zephyr-version-ltrim|
           cd ~/zephyrproject
           west update

  #. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
     automatically load boilerplate code required for building Zephyr
     applications.

     .. code-block:: bash

        west zephyr-export

  #. Install Python dependencies using ``west packages``.

     .. code-block:: bash

        west packages pip --install

     .. note::

        This could downgrade or upgrade west itself.

  #. Create a new virtual environment:

     .. code-block:: bash

        python3 -m venv ~/zephyrproject/.venv

  #. Activate the virtual environment:

     .. code-block:: bash

        source ~/zephyrproject/.venv/bin/activate

     Once activated your shell will be prefixed with ``(.venv)``. The
     virtual environment can be deactivated at any time by running
     ``deactivate``.

     .. note::

        Remember to activate the virtual environment every time you
        start working.

  #. Install west:

     .. code-block:: bash

        pip install west

  #. Get the Zephyr source code:

     .. code-block:: bash

        west init ~/zephyrproject
        cd ~/zephyrproject
        west update

  #. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
     automatically load boilerplate code required for building Zephyr
     applications.

     .. code-block:: bash

        west zephyr-export

  #. Install Python dependencies using ``west packages``.

     .. code-block:: bash

        west packages pip --install

     .. note::

        This could downgrade or upgrade west itself.

  #. Open a ``cmd.exe`` or PowerShell terminal window **as a regular user**

  #. Create a new virtual environment:

     .. tabs::

        .. code-tab:: bat

           cd %HOMEPATH%
           python -m venv zephyrproject\.venv

        .. code-tab:: powershell

           cd $Env:HOMEPATH
           python -m venv zephyrproject\.venv

  #. Activate the virtual environment:

     .. note::

        Python's virtual environment activation in PowerShell requires
        running a script itself, which needs to be allowed.

        .. code-block:: powershell

           Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

     .. tabs::

        .. code-tab:: bat

           zephyrproject\.venv\Scripts\activate.bat

        .. code-tab:: powershell

           zephyrproject\.venv\Scripts\Activate.ps1

     Once activated your shell will be prefixed with ``(.venv)``. The
     virtual environment can be deactivated at any time by running
     ``deactivate``.

     .. note::

        Remember to activate the virtual environment every time you
        start working.

  #. Install west:

     .. code-block:: bat

        pip install west

  #. Get the Zephyr source code:

     .. code-block:: bat

        west init zephyrproject
        cd zephyrproject
        west update

  #. Export a :ref:`Zephyr CMake package <cmake_pkg>`. This allows CMake to
     automatically load boilerplate code required for building Zephyr
     applications.

     .. code-block:: bat

        west zephyr-export

  #. Install Python dependencies using ``west packages``.

     .. tabs::

        .. code-tab:: bat

           cmd /c zephyr\scripts\utils\west-packages-pip-install.cmd

        .. code-tab:: powershell

           python -m pip install @((west packages pip) -split ' ')

     .. note::

        This could downgrade or upgrade west itself.

  Install the Zephyr SDK using the ``west sdk install``.

     .. code-block:: bash

        cd ~/zephyrproject/zephyr
        west sdk install

  .. tip::

      Using the command options, you can specify the SDK installation destination
      and which architecture of toolchains to install.
      See ``west sdk install --help`` for details.

  Install the Zephyr SDK using the ``west sdk install``.

     .. code-block:: bash

        cd ~/zephyrproject/zephyr
        west sdk install

  .. tip::

      Using the command options, you can specify the SDK installation destination
      and which architecture of toolchains to install.
      See ``west sdk install --help`` for details.

  Install the Zephyr SDK using the ``west sdk install``.

     .. tabs::

        .. code-tab:: bat

           cd %HOMEPATH%\zephyrproject\zephyr
           west sdk install

        .. code-tab:: powershell

           cd $Env:HOMEPATH\zephyrproject\zephyr
           west sdk install

  .. tip::

      Using the command options, you can specify the SDK installation destination
      and which architecture of toolchains to install.
      See ``west sdk install --help`` for details.

If you want to install Zephyr SDK without using the ``west sdk`` command,
please see :ref:`toolchain_zephyr_sdk_install`.

  .. code-block:: bash

     cd ~/zephyrproject/zephyr
     west build -p always -b <your-board-name> samples/basic/blinky

  .. code-block:: bash

     cd ~/zephyrproject/zephyr
     west build -p always -b <your-board-name> samples/basic/blinky

  .. tabs::

     .. code-tab:: bat

        cd %HOMEPATH%\zephyrproject\zephyr
        west build -p always -b <your-board-name> samples\basic\blinky

     .. code-tab:: powershell

        cd $Env:HOMEPATH\zephyrproject\zephyr
        west build -p always -b <your-board-name> samples\basic\blinky

You may need to install additional :ref:`host tools <flash-debug-host-tools>`
required by your board. The ``west flash`` command will print an error if any
required dependencies are missing.

When using Linux, you may need to configure udev rules the first time
of using a debug probe.
Please also see :ref:`setting-udev-rules`.