um2563-stm32cubeide-installation-guide-stmicroelectronics
um2563-stm32cubeide-installation-guide-stmicroelectronics
User manual
Introduction
This installation guide for STM32CubeIDE gives directions on how to install software on each of the operating systems it
supports. It is primarily intended to software developers or system administrators who are about to install the STM32CubeIDE
product.
This installation guide covers the following topics:
• System requirements
• Important information
• STM32CubeIDE installation (Windows®)
• STM32CubeIDE installation (Linux®)
• STM32CubeIDE installation (macOS®)
• Update an STM32CubeIDE installation
• Uninstall STM32CubeIDE (Windows®)
• Uninstall STM32CubeIDE (Linux®)
• Uninstall STM32CubeIDE (macOS®)
DT61952V1
1 System requirements
STM32CubeIDE is tested and verified on the Microsoft® Windows®, Linux®, and macOS® versions listed in this
chapter.
Important: Only 64-bit OS versions are supported.
STM32CubeIDE supports STM32 32-bit products based on the Arm® Cortex® processor.
Note: Arm is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
1.2 Linux®
• Ubuntu® LTS 20.04
• Ubuntu® LTS 22.04
• Fedora® 37
Note: Linux® is a registered trademark of Linus Torvalds.
Ubuntu® is a registered trademark of Canonical Ltd.
Fedora® is a trademark of Red Hat, Inc.
1.3 macOS®
• macOS® 13 (Ventura)
• macOS® 14 (Sonoma)
Note: Refer to Section 5.1: Application launch for possible macOS® Gatekeeper permission requests when launching
STM32CubeIDE.
macOS® is a trademark of Apple Inc., registered in the U.S. and other countries and regions.
All other trademarks are the property of their respective owners.
2 Important information
This section describes how to install the STM32CubeIDE product on Microsoft® Windows®.
Note: The installation is done through a product installer. Make sure that the user account, from which the installer is
launched, has administrative privileges.
Proceed as follows:
1. Launch the product installer (.exe file)
st-stm32cubeide_VERSION_ARCHITECHURE.exe
where:
– VERSION is the actual product version and build date
Example: 1.0.0_2026_20190221_1309
– ARCHITECTURE is the architecture of the target host computer to run STM32CubeIDE
Example: x86_64
If, when launching the product installer, it reports an attempt to install a version that is already installed:
a. Launch the register dialog by typing regedit.exe in the search bar
b. Remove registry key
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\STMicroelectronics\STM32CubeIDE
2. During the installation process, the operating system may display a dialog stating: “Do you want to allow
this app to make changes to your device?” with info “Verified publisher:
STMicroelectronics Software AB”. Accept ([YES]) to let the installer continue.
3. Wait for the installer Welcome dialog to be displayed and click on [Next >].
4. Read the license agreement. Click on [I Agree] to accept the terms of the agreement, or [Cancel] to abort the
installation. If the agreement is accepted, the installation wizard continues.
5. In this dialog, the user selects the location for the installation. It is recommended to choose a short path to
avoid facing Windows® limitations with too long paths for the workspace.
6. Wait for the Choose Components dialog to be displayed. Select the GDB Server components to be installed
together with STM32CubeIDE. A server is needed for each type of JTAG probe used for debugging with
STM32CubeIDE.
7. Click on [Install] to start the installation. The drivers that were selected are installed in parallel with this
installation of STM32CubeIDE from here on.
8. Click on [Next] to continue to the final step of the installation process. That is a Confirmation dialog
informining the user that the installation is finished. Once the user clicks on [Finish], the installation process in
complete.
4. Double click on the .pkg file indicated with the curved arrow and text stating “Install me 1st”.
5. This installation is required and installs the ST Link Server. Click on the [Continue] button.
6. In this dialog, select the location for the installation of the ST Link Server.
7. Click on [Install]. Log in to authorize the installation if prompted to do so.
8. If a warning is displayed stating "This package is incompatible with this version of macOS
and may fail to install", click on [Install Anyway].
10. After successfully installing ST Link Server, drag the STM32CubeIDE icon to the Applications folder as
indicated by the straight arrow.
11. Wait for the installation to finish. When done, it is possible to launch STM32CubeIDE from the Launchpad by
clicking on the IDE icon.
The Eclipse® update mechanism permits the quick update of available patches when STM32CubeIDE is already
installed. To use this mechanism:
1. Launch STM32CubeIDE
2. Update the tool by [Help]>[Check for updates...]
3. Restart STM32CubeIDE
– Either automatically if STM32CubeIDE proposes it
– By exiting STM32CubeIDE and restarting it otherwise
By default, the update is done with the last version. If another version is needed, follow the steps below:
1. Open the Install dialog box as shown in Figure 17 by [Help]>[Install new software...]
4. Add the desired version number at the end of the url in the [Location] field as shown in Figure 19
Note: The update mechanism has the same requirements as the installation in term of administration rights. If the
installation has been made with administration rights, the update must be made also with the same
administration rights.
The uninstallation of STM32CubeIDE depends on the distribution. Uninstall STM32CubeIDE according to the step
below corresponding to the distribution used:
• For any distribution or if the distribution is not known:
sudo /opt/st/stm32cubeide_xxxx/uninstall.sh
• For RPM-based distributions (such as Red Hat®, CentOS™, SUSE®, Fedora® or others):
sudo rpm -e st-stm32cubeide_xxxx st-stlink-udev-rules st-stlink-server segger-
jlink-udev-rules
• For Debian-based distributions (such as Debian®, Ubuntu® or others):
sudo apt-get remove st-stm32cubeide-xxxx st-stlink-udev-rules st-stlink-server
segger-jlink-udev-rules
To uninstall STM32CubeIDE:
1. Locate the version of STM32CubeIDE to uninstall in the Applications folder in the Finder
2. Drag the STM32CubeIDE app to uninstall to the trash
3. To delete the app permantently, choose [Finder]>[Empty Trash]
Revision history
Table 1. Document revision history
Contents
1 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1 Microsoft® Windows® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Linux® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3 macOS® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.4 Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 Important information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1 Product installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Installing from USB memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Product upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3 STM32CubeIDE installation (Windows®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4 STM32CubeIDE installation (Linux®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5 STM32CubeIDE installation (macOS®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.1 Application launch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.2 Rosetta® installation on M1-based computers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
6 Update an STM32CubeIDE installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
7 Uninstall STM32CubeIDE (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
8 Uninstall STM32CubeIDE (Linux®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
9 Uninstall STM32CubeIDE (macOS®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
List of figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
List of figures
Figure 1. Installer welcome page (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 2. License agreement dialog (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 3. Installer location dialog (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 4. Selection of components dialog (Windows®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 5. Installation successful (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 6. Installation finished (Windows®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Figure 7. License agreement dialog (macOS®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Figure 8. Installation welcome page (macOS®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Figure 9. ST Link Server welcome page (macOS®). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Figure 10. ST Link Server installer location dialog (macOS®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Figure 11. ST Link Server installation finished (macOS®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Figure 12. STM32CubeIDE install page (macOS®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 13. Installation progress bar (macOS®) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 14. macOS® - Gatekeeper requesting permission to launch STM32CubeIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 15. Authentication window for Rosetta® installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 16. Rosetta® installation proceeding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 17. Install dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 18. Preferences window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 19. Edit Site dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15