From 8ad2f27b94fd41b1d46f4cbb84dd268d754fcb18 Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Wed, 15 Jul 2026 10:08:55 -0600 Subject: [PATCH] Document the C++ cloud build environment Add a note to the cloud build section explaining that C++ modules compile on a Debian-based Linux image (the same environment that builds the RDK), and how to install build dependencies via the module setup step. Closes #5208. --- docs/cli/build-and-deploy-modules.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/cli/build-and-deploy-modules.md b/docs/cli/build-and-deploy-modules.md index c68bbb76d6..fcaad9e233 100644 --- a/docs/cli/build-and-deploy-modules.md +++ b/docs/cli/build-and-deploy-modules.md @@ -145,6 +145,12 @@ viam module upload --version=1.0.0 --platform=linux/arm64 dist/archive-arm64.tar For CI/CD workflows, use cloud builds to compile your module on Viam's build infrastructure. +{{% alert title="C++ build environment" color="note" %}} +On Linux, cloud builds compile C++ modules in a Debian-based environment, the same one that builds the Viam {{< glossary_tooltip term_id="rdk" text="RDK" >}}. +To match this environment locally and add any libraries your module needs, install build dependencies with `apt-get` in your module's setup step. +The [C++ example module](https://github.com/viamrobotics/module-example-cpp) follows this pattern in its `apt-setup.sh` script. +{{% /alert %}} + Start a cloud build: ```sh {class="command-line" data-prompt="$"}