mirror of https://github.com/ghostty-org/ghostty.git synced 2026-04-18 13:30:29 +00:00

Files

Mitchell Hashimoto 555bf7e922 build: add cmake static library support

Expose both shared and static libraries as separate CMake imported
targets (ghostty-vt and ghostty-vt-static) rather than toggling
between them with BUILD_SHARED_LIBS. The zig build already produces
both in a single invocation, so both are always available.

The find_package config template is updated to export both targets
as ghostty-vt::ghostty-vt and ghostty-vt::ghostty-vt-static.

Add a c-vt-cmake-static example that demonstrates linking the static
library via FetchContent with -Dsimd=false to avoid C++ runtime
dependencies.

2026-03-21 15:08:24 -07:00

ghostty-vt-config.cmake.in

build: add cmake static library support

2026-03-21 15:08:24 -07:00

README.md

build: replace lib-vt step with -Demit-lib-vt option

2026-03-21 07:03:06 -07:00

README.md

CMake Support for libghostty-vt

The top-level CMakeLists.txt wraps the Zig build system so that CMake projects can consume libghostty-vt without invoking zig build manually. Running cmake --build triggers zig build -Demit-lib-vt automatically.

This means downstream projects do require a working Zig compiler on PATH to build, but don't need to know any Zig-specific details.

Using FetchContent (recommended)

Add the following to your project's CMakeLists.txt:

include(FetchContent)
FetchContent_Declare(ghostty
    GIT_REPOSITORY https://github.com/ghostty-org/ghostty.git
    GIT_TAG main
)
FetchContent_MakeAvailable(ghostty)

add_executable(myapp main.c)
target_link_libraries(myapp PRIVATE ghostty-vt)

This fetches the Ghostty source, builds libghostty-vt via Zig during your CMake build, and links it into your target. Headers are added to the include path automatically.

Using a local checkout

If you already have the Ghostty source checked out, skip the download by pointing CMake at it:

cmake -B build -DFETCHCONTENT_SOURCE_DIR_GHOSTTY=/path/to/ghostty
cmake --build build

Using find_package (install-based)

Build and install libghostty-vt first:

cd /path/to/ghostty
cmake -B build
cmake --build build
cmake --install build --prefix /usr/local

Then in your project:

find_package(ghostty-vt REQUIRED)

add_executable(myapp main.c)
target_link_libraries(myapp PRIVATE ghostty-vt::ghostty-vt)

Files

ghostty-vt-config.cmake.in — template for the CMake package config file installed alongside the library, enabling find_package() support.

Example

See example/c-vt-cmake/ for a complete working example.