.. _install-macos:

###########################
Installation - macOS / OS X
###########################

This guide provides instructions on installing the Cozmo SDK for computers running with a macOS operating system.

^^^^^^^^^^^^^^^^^^^
Installation Videos
^^^^^^^^^^^^^^^^^^^

For your convenience, videos are provided showing the installation steps being followed on a macOS / OS X computer; one using an iOS device, and one using an Android device. There is also full text-based documentation below these.

.. raw:: html

    <video width="690" height="388" controls>
        <source src="/videos/install-macos-ios.mp4" type="video/mp4">
        Your browser does not support the video tag.
    </video>

    <video width="690" height="388" controls>
        <source src="/videos/install-macos-android.mp4" type="video/mp4">
        Your browser does not support the video tag.
    </video>

|

^^^^^^^^^^^^^^^^^^^
Python Installation
^^^^^^^^^^^^^^^^^^^

1. Install `Homebrew <http://brew.sh>`_ on your system according to the latest instructions. If you already had brew installed then update it by opening a Terminal window and typing in the following::

    brew update

2. Once Homebrew is installed and updated, type the following into the Terminal window to install the latest version of Python 3::

    brew install python3

^^^^^^^^^^^^^^^^
SDK Installation
^^^^^^^^^^^^^^^^

**Important: In 2025 and later, the Cozmo SDK requires a local dependency named ``cozmoclad`` that is no longer available from PyPI.**

You **must** install it manually before continuing.

1. Open Terminal, then run the following command to download ``cozmoclad``::

    curl -o cozmoclad-3.6.6-py3-none-any.whl https://raw.githubusercontent.com/DDLbots/cozmo-python-sdk/refs/heads/master/cozmoclad/cozmoclad-3.6.6-py3-none-any.whl

2. Then install it with pip::

    pip3 install --user ./cozmoclad-3.6.6-py3-none-any.whl

3. Finally, install the SDK itself::

    pip3 install --user 'cozmo[camera]'

Note that the `[camera]` option adds support for processing images from Cozmo's camera.

"""""""""""
SDK Upgrade
"""""""""""

To upgrade the SDK from a previous install, follow these steps:

1. **Uninstall the old version of `cozmoclad`** (if installed)::

    pip3 uninstall cozmoclad

2. **Download the updated ``cozmoclad`` wheel**::

    curl -o cozmoclad-3.6.6-py3-none-any.whl https://raw.githubusercontent.com/DDLbots/cozmo-python-sdk/refs/heads/master/cozmoclad/cozmoclad-3.6.6-py3-none-any.whl

3. **Reinstall ``cozmoclad``**::

    pip3 install --user ./cozmoclad-3.6.6-py3-none-any.whl

4. **Upgrade the SDK itself**::

    pip3 install --user --upgrade cozmo

^^^^^^^^^^^^^^^^^^^
Mobile Device Setup
^^^^^^^^^^^^^^^^^^^

* **iOS** devices do not require any special setup in order to run the Cozmo SDK on a macOS system.
* **Android** devices require installation of :ref:`adb` (adb) in order to run the Cozmo SDK. This is required for the computer to communicate with the Android mobile device over a USB cable and runs automatically when required.

----

`Terms and Conditions <https://anki.bot/policies/terms-of-service>`_ and `Privacy Policy <https://anki.bot/policies/privacy-policy>`_