• Introduction
  • What’s new in Conan 2.0
  • Install
  • Tutorial
  • Integrations
  • Examples
  • Reference
    • Commands
    • conanfile.txt
    • conanfile.py
    • Recipe tools
      • conan.tools.cmake
      • conan.tools.gnu
      • conan.tools.apple
      • conan.tools.env
      • conan.tools.build
      • conan.tools.files
      • conan.tools.meson
      • conan.tools.system
      • conan.tools.microsoft
      • Git
    • Extensions
  • FAQ
  • Changelog

Sign up for release updates:

conan
  • Docs »
  • Reference »
  • Recipe tools
  • Edit on GitHub

Recipe tools¶

Tools are all things that can be imported and used in Conan recipes.

The import path is always like:

from conan.tools.cmake import CMakeToolchain, CMakeDeps, CMake
form conan.tools.microsoft import MSBuildToolchain, MSBuildDeps, MSBuild

The main guidelines are:

  • Everything that recipes can import belong to from conan.tools. Any other thing is private implementation and shouldn’t be used in recipes.
  • Only documented, public (not preceded by _) tools can be used in recipes.

Contents:

  • conan.tools.cmake
    • CMakeDeps
    • CMakeToolchain
    • CMake
    • cmake_layout
  • conan.tools.gnu
    • AutotoolsDeps
    • AutotoolsToolchain
    • Autotools
    • PkgConfigDeps
    • PkgConfig
  • conan.tools.apple
    • XcodeDeps
    • XcodeToolchain
    • XcodeBuild
    • conan.tools.apple.fix_apple_shared_install_name()
    • conan.tools.apple.is_apple_os()
    • conan.tools.apple.to_apple_arch()
    • conan.tools.apple.XCRun()
  • conan.tools.env
    • Environment
    • EnvVars
    • VirtualBuildEnv
    • VirtualRunEnv
  • conan.tools.build
    • Building
    • Cppstd
  • conan.tools.files
    • conan.tools.files basic operations
    • conan.tools.files downloads
    • conan.tools.files patches
    • conan.tools.files checksums
    • conan.tools.files.symlinks
    • conan.tools.files AutoPackager
  • conan.tools.meson
    • MesonToolchain
    • MesonDeps
    • Meson
  • conan.tools.system
    • conan.tools.system.package_manager
  • conan.tools.microsoft
    • MSBuild
    • MSBuildDeps
    • MSBuildToolchain
    • VCVars
    • NMakeDeps
    • NMaketoolchain
    • vs_layout
    • conan.tools.microsoft.visual
    • conan.tools.microsoft.subsystems
  • Git
Next Previous

© Copyright 2016-2022, JFrog. Last updated on Jan 27, 2023. Cookies Settings

Version: 2.0
Versions
1.57
1.56
1.55
1.54
1.53
1.52
1.51
1.50
1.49
1.48
1.47
1.46
1.45
1.44
1.43
1.42
1.41
1.40
1.39
1.38
1.37
1.36
1.35
1.34
1.33
1.32
1.31
1.30
1.29
1.28
1.27
1.26
1.25
1.24
1.23
1.22
1.21
1.20
1.19
1.18
1.17
1.16
1.15
1.14
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
2.0
latest
Downloads
PDF