CLI Tools Reference

The Sol3 SDK provides command-line tools to streamline development and deployment workflows.

Tip

Refer to each tool’s --help documentation for detailed usage information and options.

devcontainer (not SDK specific)

VSCode devcontainer CLI for managing development containers.

# Start devcontainer
devcontainer up --workspace-folder .

# Enter interactive shell
devcontainer exec --workspace-folder . bash

# Stop and remove (container name is set in the project's
# .devcontainer/devcontainer.json runArgs; default: sol3-sdk-example)
docker stop sol3-sdk-example && docker rm sol3-sdk-example

sol3_new_project

Bootstrap a new project from the SDK template (run on the host, before starting the devcontainer).

./sol3-sdk/scripts/sol3_new_project my-project

sol3_setup_sysroot

Populate a target sysroot under /opt/sysroots/<arch>. The devcontainer does not ship the sysroot pre-populated, so run this once per devcontainer before configuring/building with a preset that requires it.

sol3_setup_sysroot x64
sol3_setup_sysroot arm64

sol3_activate_sysroot

Activate a sysroot environment for running applications built with the SDK. Sets LD_LIBRARY_PATH (and QEMU_LD_PREFIX for running ARM64 binaries under qemu) so the loader finds the sysroot libraries.

# Run application
sol3_activate_sysroot x64 ./out/build/x64/bin/example_app

# Interactive shell
sol3_activate_sysroot x64

Tests run via ctest --preset <arch> get this environment automatically and do not need activation. See Sysroot Architecture for details on how sysroots work.

sol3_camera_server_mock

A mock camera server (SDK app, not a script) that serves synthetic RAW10 frames over the camera shared-memory transport, so the camera client and pipeline can be exercised on an x64 workstation without Sol3 hardware. See tutorial 01 for the server + client workflow.

sol3_build_app_image

Build Docker application images for deployment.

# Build ARM64 image for Sol3 deployment
sol3_build_app_image example_app arm64 --cmake-preset arm64

# Build with custom tag
sol3_build_app_image example_app arm64 --cmake-preset arm64 --tag v1.0.0

sol3_deploy_app_image

Deploy application images to Sol3 devices via Docker registry.

# Deploy to device
sol3_deploy_app_image my-app-arm64:latest root@192.168.1.100

The script automatically handles registry setup, SSH tunneling, and image transfer.

sol3_manage

Manage your Sol3’s OS, including over-the-air updates, partitioning, and flashing.

# Show available commands
sol3_manage --help

See the update guide for more information.