snippetbashTip

cmake — Cross-platform build automation system, that generates recipes for native build systems. More inform

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

automationcommandbuildclicrossplatformsystemcmake

Problem

How to use the cmake command: Cross-platform build automation system, that generates recipes for native build systems. More information: <https://cmake.org/cmake/help/latest/manual/cmake.1.html>.

Solution

cmake — Cross-platform build automation system, that generates recipes for native build systems. More information: <https://cmake.org/cmake/help/latest/manual/cmake.1.html>.

Generate a build recipe in the current directory with CMakeLists.txt from a project directory:

cmake {{path/to/project_directory}}

Use a generated recipe in a given directory to build artifacts:

cmake --build {{path/to/build_directory}}

Install the build artifacts into /usr/local/ and strip debugging symbols:

cmake --install {{path/to/build_directory}} --strip

Generate a build recipe, with build type set to Release with CMake variable:

cmake {{path/to/project_directory}} -D CMAKE_BUILD_TYPE=Release

Generate a build recipe using generator_name as the underlying build system:

cmake -G {{generator_name}} {{path/to/project_directory}}

Install the build artifacts using a custom prefix for paths:

cmake --install {{path/to/build_directory}} --strip --prefix {{path/to/directory}}

Run a custom build target:

cmake --build {{path/to/build_directory}} {{[-t|--target]}} {{target_name}}

Display help:

cmake {{[-h|--help]}}

Code Snippets

Generate a build recipe in the current directory with `CMakeLists.txt` from a project directory

cmake {{path/to/project_directory}}

Use a generated recipe in a given directory to build artifacts

cmake --build {{path/to/build_directory}}

Install the build artifacts into `/usr/local/` and strip debugging symbols

cmake --install {{path/to/build_directory}} --strip

Generate a build recipe, with build type set to `Release` with CMake variable

cmake {{path/to/project_directory}} -D CMAKE_BUILD_TYPE=Release

Generate a build recipe using `generator_name` as the underlying build system

cmake -G {{generator_name}} {{path/to/project_directory}}

Context

tldr-pages: common/cmake

Revisions (0)

No revisions yet.