Setup scripts for creating a docker image with the STM32CubeCLT (Command Line Tools package) and some other helpful utilities.
A prebuilt image of this docker container is available on DockerHub at coolnamesalltaken/st-docker.
Run these commands from the top level directory.
NOTE: Cloning git repos onto windows may result in files with CR+LF line endings. Docker does NOT like these, and they will break everything. Make sure that you set git config --global core.autocrlf false before cloning repos that will get added or mounted to a Docker container.
Follow the instructions below for using the pre-built image from dockerhub, or build the image yourself.
Run docker image pull coolnamesalltaken/st-docker:latest on your command line to pull the latest pre-built image. If I screwed something up with a recent push to the dockerhub repo, you may want to specify a different tag instead!
Be sure to run git submodule update --init --recursive before building! You may need to change Git's long filename setting for this to complete successfully.
From this directory, run the following shell command. This will build the Docker file in the current directory and tag it with the name "st-docker".
docker build -t coolnamesalltaken/st-docker .If you want to output stdout and stderr from the build process to a log file, use the following command instead.
docker build --no-cache --progress=plain -t coolnamesalltaken/st-docker . &>build.logNavigate to the directory you would like to bind to the docker container. Use the commands in 3A, 3B, or 3C (depending on your prefernece and operating system) to start the docker container and bind it to your current directory. This will create a container that is bind-mounted to your present working directory, so any files you change in your directory will also be changed in the docker container. If you stop the docker container and start it up again later, it will still be bound to the specified directory.
If you use this docker container for multiple projects, you will end up with a number of different st-docker containers, each bind-mounted to a separate project directory.
This is the easiest option for running a st-docker container! Copy compose.example.yml into the project folder that you would like to mount to your docker container, and edit it to change where your project will mount to in the container.
Run the docker container by calling docker compose up in the directory with the compose YAML file. You can inspect the container using a BASH shell by executing docker compose exec st-docker bash.
Start an interactive docker container on Linux or Mac with the command below. Mounts the current directory to /root/<current directory>.
docker run --name st-docker -it --mount type=bind,source="$(pwd)",target=/root/$(pwd) coolnamesalltaken/st-dockerStart an interactive docker container on Windows with the command below. Mounts the current directory to /root/<current directory>.
winpty docker run --name st-docker -it --mount type=bind,source="$(pwd)",target=/root/$(pwd) coolnamesalltaken/st-dockerConnect to the docker container with VS Code or another IDE and enjoy developing! The STM32CubeCLT binaries have been added to $PATH, and are also available at /opt/st/stm32cubeclt_1.15.0 (or whatever the most recent version is).