A cross-platform build utility based on Lua
Modern C/C++ build tool: Simple, Fast, Powerful dependency package integration

Support this project

Technical support

Introduction (中文)

Xmake = Build backend + Project Generator + Package Manager + [Remote|Distributed] Build + Cache

Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache

Installation

With cURL

curl -fsSL https://xmake.io/shget.text| bash

With Wget

wget https://xmake.io/shget.text -O -| bash

With PowerShell

irm https://xmake.io/psget.text| iex

Other installation methods

Simple Project Description

target("console")set_kind("binary")add_files("src/*.c")

Package dependencies

add_requires("tbox 1.6.*","zlib","libpng ~1.6")

Command line interface reference

Build a project

$ xmake

Run target

$ xmake run console

Debug target

$ xmake run -d console

Run test

$ xmaketest

Configure platform

$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release]$ xmake

Menu configuration

$ xmake f --menu

Supported platforms

Supported toolchains

$ xmake show -l toolchainsxcode         Xcode IDEmsvc          Microsoft Visual C/C++ Compilerclang-cl      LLVM Clang C/C++ Compiler compatible with msvcyasm          The Yasm Modular Assemblerclang         A C language family frontendfor LLVMgo            Go Programming Language Compilerdlang         D Programming Language Compiler (Auto)dmd           D Programming Language Compilerldc           The LLVM-based D Compilergdc           The GNU D Compiler (GDC)gfortran      GNU Fortran Programming Language Compilerzig           Zig Programming Language Compilersdcc          Small Device C Compilercuda          CUDA Toolkit (nvcc, nvc, nvc++, nvfortran)ndk           Android NDKrust          Rust Programming Language Compilerswift         Swift Programming Language Compilerllvm          A collection of modular and reusable compiler and toolchain technologiescross         Common cross compilation toolchainnasm          NASM Assemblergcc           GNU Compiler Collectionmingw         Minimalist GNUfor Windowsgnu-rm        GNU Arm Embedded Toolchainenvs          Environment variables toolchainfasm          Flat Assemblertinycc        Tiny C Compileremcc          A toolchainfor compiling to asm.js and WebAssemblyicc           Intel C/C++ Compilerifort         Intel Fortran Compilerifx           Intel LLVM Fortran Compilermuslcc        The musl-based cross-compilation toolchainfpc           Free Pascal Programming Language Compilerwasi          WASI-enabled WebAssembly C/C++ toolchainnim           Nim Programming Language Compilercircle        A new C++20 compilerarmcc         ARM Compiler Version 5 of Keil MDKarmclang      ARM Compiler Version 6 of Keil MDKc51           Keil development toolsfor the 8051 Microcontroller Architectureicx           Intel LLVM C/C++ Compilerdpcpp         Intel LLVM C++ Compilerfor data parallel programming model based on Khronos SYCLmasm32        The MASM32 SDKiverilog      Icarus Verilogverilator     Verilator open-source SystemVerilog simulator and lint systemcosmocc       build-once run-anywherehdk           Harmony SDKti-c2000      TI-CGT C2000 compilerti-c6000      TI-CGT C6000 compileriararm        IAR ARM C/C++ Compilerkotlin-native Kotlin Native Programming Language Compiler

Supported languages

Features

Supported Project Types

Package management

Download and build

Supported package repositories

Package management features

Processing architecture

Distributed Compilation

Remote Compilation

Local/Remote Build Cache

Benchmark

Multi-task parallel compilation

Single task compilation

More Examples

Debug and release profiles

add_rules("mode.debug","mode.release")target("console")set_kind("binary")add_files("src/*.c")ifis_mode("debug")thenadd_defines("DEBUG")end

Custom scripts

target("test")set_kind("binary")add_files("src/*.c")after_build(function (target)print("hello: %s",target:name())os.exec("echo %s",target:targetfile())end)

Automatic integration of dependent packages

add_requires("tbox >1.6.1","libuv master","vcpkg::ffmpeg","brew::pcre2/libpcre2-8")add_requires("conan::openssl/1.1.1g", {alias="openssl",optional=true,debug=true})target("test")set_kind("binary")add_files("src/*.c")add_packages("tbox","libuv","vcpkg::ffmpeg","brew::pcre2/libpcre2-8","openssl")

Qt QuickApp Program

target("test")add_rules("qt.quickapp")add_files("src/*.cpp")add_files("src/qml.qrc")

Cuda Program

target("test")set_kind("binary")add_files("src/*.cu")add_cugencodes("native")add_cugencodes("compute_35")

WDK/UMDF Driver Program

target("echo")add_rules("wdk.driver","wdk.env.umdf")add_files("driver/*.c")add_files("driver/*.inx")add_includedirs("exe")target("app")add_rules("wdk.binary","wdk.env.umdf")add_files("exe/*.cpp")

Darwin Applications

target("test")add_rules("xcode.application")add_files("src/*.m","src/**.storyboard","src/*.xcassets")add_files("src/Info.plist")

Framework and Bundle Program (Darwin)

target("test")add_rules("xcode.framework")-- or xcode.bundleadd_files("src/*.m")add_files("src/Info.plist")

OpenMP Program

add_requires("libomp", {optional=true})target("loop")set_kind("binary")add_files("src/*.cpp")add_rules("c++.openmp")add_packages("libomp")

Zig Program

target("test")set_kind("binary")add_files("src/main.zig")

Automatically fetch remote toolchain

fetch a special version of LLVM

add_requires("llvm 10.x", {alias="llvm-10"})target("test")set_kind("binary")add_files("src/*.c")set_toolchains("llvm@llvm-10")

Fetch a cross-compilation toolchain

add_requires("muslcc")target("test")set_kind("binary")add_files("src/*.c")set_toolchains("@muslcc")

Fetch toolchain and packages

add_requires("muslcc")add_requires("zlib","libogg", {system=false})set_toolchains("@muslcc")target("test")set_kind("binary")add_files("src/*.c")add_packages("zlib","libogg")

Plugins

Generate IDE project file plugin（makefile, vs2002 - vs2022 .. ）

$ xmake project -k vsxmake -m"debug,release"# New vsproj generator (Recommended)$ xmake project -k vs -m"debug,release"$ xmake project -k cmake$ xmake project -k ninja$ xmake project -k compile_commands

Run a custom lua script plugin

$ xmake l ./test.lua$ xmake l -c"print('hello xmake!')"$ xmake l lib.detect.find_tool gcc$ xmake l> print("hello xmake!")> {1, 2, 3}< {    1,    2,    3  }

IDE/Editor Integration

Xmake Gradle Plugin (JNI)

plugins {  id 'org.tboox.gradle-xmake-plugin' version '1.1.5'}android {    externalNativeBuild {        xmake {            path "jni/xmake.lua"        }    }}

$./gradlew app:assembleDebug>Task :nativelib:xmakeConfigureForArm64>Task :nativelib:xmakeBuildForArm64>> xmake build[ 50%]: cache compiling.debug nativelib.cc[ 75%]: linking.debug libnativelib.so[100%]: build ok!>> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/arm64-v8a>Task :nativelib:xmakeConfigureForArmv7>Task :nativelib:xmakeBuildForArmv7>> xmake build[ 50%]: cache compiling.debug nativelib.cc[ 75%]: linking.debug libnativelib.so[100%]: build ok!>> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/armeabi-v7a>Task :nativelib:preBuild>Task :nativelib:assemble>Task :app:assembleDebug

CI Integration

GitHub Action

uses:xmake-io/github-action-setup-xmake@v1with:xmake-version:latest

Who is using Xmake?

Contacts

Thanks