https://github.com/jakoch/cpp-devbox
C++ DevBox is a docker devcontainer for C++ development. Based on Debian with LLVM, GCC, VulkanSDK, CMake, VCPKG, zsh.
https://github.com/jakoch/cpp-devbox
bookworm clang-17 clang-18 cpp debian-12 debian-13 docker gcc-12 gcc-13 llvm trixie vulkan-sdk
Last synced: about 2 months ago
JSON representation
C++ DevBox is a docker devcontainer for C++ development. Based on Debian with LLVM, GCC, VulkanSDK, CMake, VCPKG, zsh.
- Host: GitHub
- URL: https://github.com/jakoch/cpp-devbox
- Owner: jakoch
- License: mit
- Created: 2023-07-24T22:13:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T19:29:07.000Z (over 1 year ago)
- Last Synced: 2024-05-22T20:37:52.184Z (over 1 year ago)
- Topics: bookworm, clang-17, clang-18, cpp, debian-12, debian-13, docker, gcc-12, gcc-13, llvm, trixie, vulkan-sdk
- Language: Dockerfile
- Homepage:
- Size: 91.8 KB
- Stars: 7
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# C++ DevBox [](https://github.com/jakoch/cpp-devbox)
A Docker-based development container for C/C++ development.
It is designed especially for use with Visual Studio Code or any IDE
that supports the devcontainer standard. The images can also be used in CI workflows.
## Purpose
cpp-devbox streamlines the setup of a complete C++ development stack in standardized and portable containers. It is optimized for modern C++ projects on Linux, providing compilers and tools for debugging, testing, documentation, CI.
The primary goal of these images is to enable a ready-to-use C++ development environment within Visual Studio Code using a [devcontainer configuration](https://github.com/jakoch/cpp-devbox#fetching-the-prebuilt-container-images-using-a-devcontainer-config).
## Technical Base and Images
### Distributions
This repository provides Dockerfiles for building container images based on Debian Linux.
We offer images for:
- Debian 12 (Bookworm, oldstable),
- Debian 13 (Trixie, stable),
- Debian 14 (Forky, testing) and
- Debian SID (unstable).
## Container Images
There are two main variants per distribution: one with the standard toolchain
and one with an additional Vulkan SDK and Mesa for graphics development.
- **base:** Includes GCC and LLVM.
- **with-vulkansdk:** Includes GCC, LLVM, and additionally the Vulkan SDK with Mesa.
## Container Registries
The images are automatically published to Github Container Registry (GHCR) and
the Docker Hub (hub.docker.com) upon updates.
For a complete list of C++ related tools, see [What is pre-installed?](#what-is-pre-installed).
## Available Images
[bookworm-latest]: https://ghcr.io/jakoch/cpp-devbox:bookworm-latest
[trixie-latest]: https://ghcr.io/jakoch/cpp-devbox:trixie-latest
[forky-latest]: https://ghcr.io/jakoch/cpp-devbox:forky-latest
[bookworm-with-vulkansdk-latest]: https://ghcr.io/jakoch/cpp-devbox:bookworm-with-vulkansdk-latest
[trixie-with-vulkansdk-latest]: https://ghcr.io/jakoch/cpp-devbox:trixie-with-vulkansdk-latest
[forky-with-vulkansdk-latest]: https://ghcr.io/jakoch/cpp-devbox:forky-with-vulkansdk-latest
| ⭣ Version Tag OS ⭢ | Debian 12 - Bookworm | Debian 13 - Trixie | Debian 14 - Forky |
|-----------------------------------|---------------------------|---------------------|---------------------|
| Latest | [bookworm-latest]
 | [trixie-latest]
 | [forky-latest]
| Latest "with-vulkansdk" | [bookworm-with-vulkansdk-latest]
 | [trixie-with-vulkansdk-latest]
 | [forky-with-vulkansdk-latest]
You find the [versioning scheme for images below](#versioning-scheme-for-images).
## What is pre-installed?
The image provides all essential C++ ecosystem tools for a complete development
environment. Including shell & basic utilities, compilers, build systems,
debugging tools, assemblers, package managers, documentation tools, and
optional graphics SDKs.
Here is a basic overview of the pre-installed tools.
For details, please refer to the Dockerfiles.
On top of the Debian base image the following tools are installed:
- zsh with plugins: autosuggestions, completions, history substring search
- git, nano, jq
- curl, wget
- cppcheck, valgrind
- lcov, gcov, gcovr
- strace, ltrace
- perf, gprof
- nasm, fasm
- meson
- CMake (latest version)
- ccache (latest version)
- vcpkg (latest version)
- mold (latest version)
- Doxygen (latest version)
- git, github cli
The **with-vulkansdk** distributions additionally contain the Vulkan SDK and Mesa.
### [Dockerfile for Debian 12 - Bookworm](https://github.com/jakoch/cpp-devbox/blob/main/.devcontainer/debian/12-bookworm/Dockerfile) (oldstable)
The following C/C++ compilers and their toolchains are available:
- LLVM 20.1.0
- GCC 12.2.0
- GCC 13.4.0
### [Dockerfile for Debian 13 - Trixie](https://github.com/jakoch/cpp-devbox/blob/main/.devcontainer/debian/13-trixie/Dockerfile) (stable)
The following C/C++ compilers and their toolchains are available:
- LLVM 21.1.0
- GCC 14.2.0
### [Dockerfile for Debian 14 - Forky](https://github.com/jakoch/cpp-devbox/blob/main/.devcontainer/debian/14-forky/Dockerfile) (testing)
The following C/C++ compilers and their toolchains are available:
- LLVM 21.1.0
- GCC 14.3.0
- GCC 15.2.0
### VulkanSDK
The `with-vulkansdk` image variant additionally contains:
- Vulkan SDK 1.4.321.1
- Mesa 22.3.6 (bookworm), 24.2.8 (trixie), 24.2.8 (forky)
- (for software rendering with [LLVMpipe](https://docs.mesa3d.org/drivers/llvmpipe.html))
[What is the latest version of VulkanSDK?](https://vulkan.lunarg.com/sdk/latest.json)
## Prerequisites
You need the following things to run this:
- Docker
- Visual Studio Code
## How to run this?
There are two ways of setting the container up.
Either by building the container image locally or by fetching the prebuilt container image from a container registry.
### Building the Container Image locally using VSCode
- **Step 1.** Get the source: clone this repository using git or download the zip
- **Step 2.** In VSCode open the folder in a container (`Remote Containers: Open Folder in Container`):
This will build the container image (`Starting Dev Container (show log): Building image..`)
Which takes a while...
Then, finally...
- **Step 3.** Enjoy! :sunglasses:
### Fetching the prebuilt container images using Docker
This container image is published to the Github Container Registry (GHCR) and the Docker Hub (hub.docker.com).
You may find the Docker Hub repository here: https://hub.docker.com/r/jakoch/cpp-devbox
You may find the GHCR package here: https://github.com/jakoch/cpp-devbox/pkgs/container/cpp-devbox
In order to pull from GHCR add the prefix (`ghcr.io/`).
**Command Line**
You can install the container image from the command line:
```bash
docker pull ghcr.io/jakoch/cpp-devbox:trixie-latest
```
```bash
docker pull jakoch/cpp-devbox:trixie-latest
```
For the image containing Vulkan SDK append `with-vulkansdk-latest`:
```bash
docker pull jakoch/cpp-devbox:trixie-with-vulkansdk-latest
```
**Dockerfile**
You might also use this container image as a base image in your own `Dockerfile`:
```bash
FROM jakoch/cpp-devbox:trixie-latest
```
### Fetching the prebuilt container images using a .devcontainer config
**Devcontainer.json**
You might use this container image in the `.devcontainer/devcontainer.json` file of your project:
```json
{
"name": "My C++ Project DevBox",
"image": "ghcr.io/jakoch/cpp-devbox:trixie-latest"
}
```
**Devcontainer.json + with-vulkansdk image**
You might use this container image in the `.devcontainer/devcontainer.json` file of your project:
```json
{
"name": "My C++ Project DevBox",
"image": "ghcr.io/jakoch/cpp-devbox:trixie-with-vulkansdk-latest"
}
```
#### Developer Notes
### Versioning Scheme for Images
The container images use the following versioning scheme.
The base URL for GHCR.io is: `ghcr.io/jakoch/cpp-devbox:{tag}`.
#### Scheduled Builds
The following container tags are created for scheduled builds:
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{date}}`
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{date}}`
#### For git tag
The following container tags are created for git tags:
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{{ version }}`
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{{ major }}.{{ minor }}`
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{ version }}`
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{ major }}.{{ minor }}`
#### Latest
The container tag "latest" is applied to the latest build:
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-latest`
- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-latest`
### Field Notes for building devbox-test locally
- Before building, please remove any CMake build artifacts from the `devbox-test` directory. Otherwise, these files may be copied into the container and block a
clean rebuild.
- To build and run `devbox-test`, use the following command (for Linux/macOS):
```
docker run --rm -v "$(PWD)/devbox-test:/test-src" -w /test-src ghcr.io/jakoch/cpp-devbox:trixie-latest zsh -c "./build.sh"
```
- On Windows, use a relative path for the volume mount:
```
docker run --rm -v ".\devbox-test:/test-src" -w /test-src ghcr.io/jakoch/cpp-devbox:trixie-latest zsh -c "./build.sh"
```
- This command mounts the `devbox-test` folder into the container as `/test-src`, then runs `build.sh` inside the container using `zsh`.
### License
- Open Source: MIT License.
- Copyright: Jens A. Koch and contributors.
### Snappy AI-Generated Project Summary
cpp-devbox provides developers with a robust, ready-to-use C++ stack, complete with build tools, debuggers, analysis utilities, and modern graphics development support. Ideal for both local development and CI/CD pipelines.
### A Punchy One-Liner for Marketing
cpp-devbox: A ready-to-go C++ development stack for coding, debugging, and CI/CD—out of the box.