CMakeHub

<div align="center">

Unified CMake Module Manager

A centralized repository for discovering, selecting, and integrating third-party CMake modules.

</div>

---

What is CMakeHub?

CMakeHub is a unified CMake module manager that provides a "central warehouse" for CMake modules. It solves the problem of scattered CMake modules across different GitHub repositories, making it easy to discover, select, and integrate them into your projects.

Important: CMakeHub is not a package manager like vcpkg or Conan. It's a module manager that helps you find and use CMake modules more easily.

---

Features

Core Features

• 🔍 Unified Discovery: Browse and search for CMake modules in one place
• 🚀 Simple Integration: Load modules with a single command
• 🔄 Automatic Dependencies: Modules automatically declare and load their dependencies
• ⚠️ Conflict Detection: Prevents loading incompatible modules
• ✅ Version Checking: Ensures compatibility with your CMake and C++ versions
• 💾 Smart Caching: Download once, use everywhere (shared across projects)
• 📄 License Management: Automatically track module licenses for compliance

Advanced Features

• ⚙️ Config Penetration: Pass parameters directly to modules
• 🏷️ Version Selection: Specify exact module versions
• 🔎 Module Search: Search modules by name, description, or tags
• 📊 Dependency Visualization: Generate dependency graphs
• 🧹 Cache Management: View and clean module cache
• 🌍 Cross-Platform Filtering: Automatic platform compatibility warnings
• 🔄 Update Management: Easy module updates via cache clearing
• ✅ Compatibility Check: Verify module compatibility before loading
• 💻 Command Line Interface: CLI tool for quick module discovery and management

---

Quick Start

Installation

Option 1: Clone Repository

# Clone CMakeHub
git clone https://github.com/caomengxuan666/CMakeHub.git
cd CMakeHub

# Or add as a submodule
git submodule add https://github.com/caomengxuan666/CMakeHub.git cmake/cmakehub

Option 2: Install CLI Tool (Recommended)

# Install CLI tool from PyPI (requires Python 3.6+)
pip install cmakehub

# Or clone repository and install locally
git clone https://github.com/caomengxuan666/CMakeHub.git
cd CMakeHub
pip install -e .

After installation, you can use the CLI tool:

cmakehub --help
cmakehub list
cmakehub search sanitizers

Basic Usage

# In your CMakeLists.txt
cmake_minimum_required(VERSION 3.19)
project(MyProject CXX)

# Include CMakeHub
include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmakehub/loader.cmake)

# Load modules
cmakehub_use(sanitizers)
cmakehub_use(coverage)

# Now use the modules' features
enable_testing()
add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE mylib)

Configuration Options

# Set cache directory (optional)
set(CMH_CACHE_DIR "$ENV{HOME}/.cmakehub/cache")

# Enable verbose output (optional)
set(CMAKEHUB_VERBOSE ON)

# Set version check mode (STRICT, WARNING, SILENT)
set(CMAKEHUB_VERSION_CHECK_MODE "STRICT")

---

Advanced Usage

Pass Parameters to Modules (Config Penetration)

cmakehub_use(sanitizers
    ADDRESS_SANITIZER ON
    UNDEFINED_SANITIZER ON
)

Specify Module Version

cmakehub_use(cotire VERSION "master")
cmakehub_use(cpm VERSION "0.42.0")

Discover Modules

# List all available modules
cmakehub_list()

# Search for modules
cmakehub_search(sanitizer)
cmakehub_search(testing)

Check Compatibility

# Check if a module is compatible with your system
cmakehub_check_compatibility(sanitizers)

# List all compatible modules
cmakehub_list_compatible_modules()

Manage Cache

# View cache information
cmakehub_cache_info()

# Clear specific module cache
cmakehub_cache_clear(sanitizers)

# Clear all cache
cmakehub_cache_clear()

Update Modules

# Update specific module (clears cache)
cmakehub_update(sanitizers)

# Update all used modules
cmakehub_update()

Visualize Dependencies

# Generate dependency graph
cmakehub_dependency_graph(dependencies.dot)

# Convert to PNG (requires Graphviz)
# dot -Tpng dependencies.dot -o dependencies.png

Module Information

# Get detailed information about a module
cmakehub_info(sanitizers)

# Show licenses of all loaded modules
cmakehub_show_licenses()

---

Command Line Interface

CMakeHub includes a Python CLI tool for quick module discovery and management without needing to write CMake code.

Installation

# Install CLI tool
pip install -e .

# Or globally
python setup.py install

Commands

List Modules

# List all modules
cmakehub list

# List modules in a category
cmakehub list --category testing
cmakehub list -c code_quality

# Compact output
cmakehub list --compact

Search Modules

# Search by keyword
cmakehub search sanitizers
cmakehub search testing

# Case-insensitive search
cmakehub search Sanitizers

Get Module Info

# Display detailed module information
cmakehub info sanitizers
cmakehub info cotire

Check Compatibility

# Check if a module is compatible with your system
cmakehub check sanitizers
cmakehub check cotire

Cache Management

# Show cache statistics
cmakehub cache

# Clear all cache
cmakehub cache --clear

# Clear specific module cache
cmakehub cache --clear sanitizers

Update Modules

# Update specific module (clears cache)
cmakehub update sanitizers

# Update all modules
cmakehub update

# Update and download immediately
cmakehub update --download-now
cmakehub update sanitizers --download-now

Generate CMake Code

# Generate CMake code for a module
cmakehub use sanitizers

# Specify version
cmakehub use cotire --version master
cmakehub use cotire -v master

# Add options
cmakehub use sanitizers ADDRESS_SANITIZER ON UNDEFINED_SANITIZER ON

# Save to file
cmakehub use sanitizers --output my_project/CMakeLists.txt

# Append to existing file
cmakehub use cotire --append CMakeLists.txt

# Add test
cmakehub use doctest --test

Initialize Project

# Create a new CMakeHub project
cmakehub init my_project

cd my_project

This creates a complete project structure:

my_project/
├── CMakeLists.txt
├── cmake/
│   └── hub/
│       └── loader.cmake
├── src/
│   └── main.cpp
├── .gitignore
└── README.md

Use Cases

Quick Module Discovery

# Find modules for testing
cmakehub search testing
cmakehub list --category testing

# Check if a module is compatible
cmakehub check sanitizers

Project Initialization

# Create a new project with CMakeHub
cmakehub init my_app
cd my_app

# Add modules
cmakehub use sanitizers --append CMakeLists.txt
cmakehub use coverage --append CMakeLists.txt

Cache Management

# View cache size
cmakehub cache

# Clear outdated modules
cmakehub update --download-now

CLI vs CMake API

| Feature | CLI | CMake API | |---------|-----|-----------| | List modules | ✅ cmakehub list | ✅ cmakehub_list() | | Search modules | ✅ cmakehub search | ✅ cmakehub_search() | | Get module info | ✅ cmakehub info | ✅ cmakehub_info() | | Check compatibility | ✅ cmakehub check | ✅ cmakehub_check_compatibility() | | Cache management | ✅ cmakehub cache | ✅ cmakehub_cache_info() | | Update modules | ✅ cmakehub update | ✅ cmakehub_update() | | Load modules | ❌ (use cmakehub use) | ✅ cmakehub_use() | | Dependency graph | ❌ | ✅ cmakehub_dependency_graph() | | Generate CMake code | ✅ cmakehub use | ❌ | | Initialize project | ✅ cmakehub init | ❌ |

---

Available Modules

CMakeHub includes 48 curated CMake modules organized by category:

Build Optimization (6)

• cotire: Precompiled headers and unity builds
• lto_optimization: Link Time Optimization (LTO/IPO)
• precompiled_header: Precompiled header setup
• cpp_standards: C++ standards configuration
• c_standards: C standards configuration
• compile_options: Compiler options management

Code Quality (10)

• sanitizers: ASan, UBSan, TSan, MSan integration
• coverage: Code coverage with gcov/lcov
• coverage_cg: Code coverage from cginternals
• clang_tidy_tools: Clang-Tidy integration
• clang_tidy_cg: Clang-Tidy from cginternals
• cppcheck_cg: Cppcheck integration
• compiler_warnings: Compiler warning helpers
• code_formatter: clang-format integration
• afl_fuzzing: AFL fuzzing instrumentation
• gcov: Gcov coverage tool

Debugging (2)

• launchers: Create launcher scripts for IDEs
• compiler_info: Get compiler information

Dependency Management (2)

• cpm: Lightweight CMake package manager
• conan: Conan package manager integration

Platform (5)

• android_toolchain: Android NDK toolchain
• ios_toolchain: iOS/macOS/watchOS/tvOS toolchain
• cuda: CUDA auxiliary functions
• use_folders: Enable IDE folders (MSVC)
• qt_helper: Qt integration helper

Testing (5)

• add_gtest: Google Test integration
• doctest: Doctest testing framework
• catch2_cmake: Catch2 testing framework
• find_or_build_gtest: Find or build GTest
• afl_fuzzing: AFL fuzzing

Documentation (2)

• doxygen_helper: Doxygen documentation helpers
• dependency_graph: Generate depen