xmake
A cross-platform build utility based on Lua
Modern C/C++ build tool: Simple, Fast, Powerful dependency package integration
Support this project
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. π
Introduction (δΈζ)
What is Xmake?
- Xmake is a cross-platform build utility based on the Lua scripting language.
- Xmake is very lightweight and has no dependencies outside of the standard library.
- Uses the
xmake.luafile to maintain project builds with a simple and readable syntax.
Xmake can be used to directly build source code (like with Make or Ninja), or it can generate project source files like CMake or Meson. It also has a built-in package management system to help users integrate C/C++ dependencies.
Xmake = Build backend + Project Generator + Package Manager + [Remote|Distributed] Build + Cache
Although less precise, one can still understand Xmake in the following way:
Xmake β Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
If you want to know more, please refer to the Documentation, GitHub or Gitee. You are also welcome to join our community.
The official Xmake repository can be found at xmake-io/xmake-repo.

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
If you don't want to use the above scripts to install Xmake, visit the Installation Guide for other installation methods (building from source, package managers, etc.).
Simple Project Description
target("console")
set_kind("binary")
add_files("src/*.c")
Creates a new target console of kind binary, and adds all the files ending in .c in the src directory.
Package dependencies
add_requires("tbox 1.6.*", "zlib", "libpng ~1.6")
Adds a requirement of tbox v1.6, zlib (any version), and libpng v1.6.
The official xmake package repository exists at: xmake-repo
Command line interface reference
The below assumes you are currently in the project's root directory.
Build a project
$ xmake
Run target
$ xmake run console
Debug target
$ xmake run -d console
Run test
$ xmake test
Configure platform
$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release]
$ xmake
Menu configuration
$ xmake f --menu
Supported platforms
- Windows (x86, x64, arm, arm64, arm64ec)
- macOS (i386, x86_64, arm64)
- Linux (i386, x86_64, arm, arm64, riscv, mips, 390x, sh4 ...)
- FreeBSD (i386, x86_64)
- NetBSD (i386, x86_64)
- OpenBSD (i386, x86_64)
- DragonflyBSD (i386, x86_64)
- Solaris (i386, x86_64)
- Android (x86, x86_64, armeabi, armeabi-v7a, arm64-v8a)
- iOS (armv7, armv7s, arm64, i386, x86_64)
- WatchOS (armv7k, i386)
- AppleTVOS (armv7, arm64, i386, x86_64)
- AppleXROS (arm64, x86_64)
- MSYS (i386, x86_64)
- MinGW (i386, x86_64, arm, arm64)
- Cygwin (i386, x86_64)
- Wasm (wasm32, wasm64)
- Haiku (i386, x86_64)
- Harmony (x86_64, armeabi-v7a, arm64-v8a)
- Cross (cross-toolchains ..)
Supported toolchains
$ xmake show -l toolchains
xcode Xcode IDE
msvc Microsoft Visual C/C++ Compiler
clang-cl LLVM Clang C/C++ Compiler compatible with msvc
yasm The Yasm Modular Assembler
clang A C language family frontend for LLVM
go Go Programming Language Compiler
dlang D Programming Language Compiler (Auto)
dmd D Programming Language Compiler
ldc The LLVM-based D Compiler
gdc The GNU D Compiler (GDC)
gfortran GNU Fortran Programming Language Compiler
flang LLVM Fortran Compiler
zig Zig Programming Language Compiler
zigcc Use zig cc/c++ as C/C++ Compiler
sdcc Small Device C Compiler
cuda CUDA Toolkit (nvcc, nvc, nvc++, nvfortran)
ndk Android NDK
rust Rust Programming Language Compiler
swift Swift Programming Language Compiler
llvm A collection of modular and reusable compiler and toolchain technologies
cross Common cross compilation toolchain
nasm NASM Assembler
gcc GNU Compiler Collection
mingw Minimalist GNU for Windows
gnu-rm GNU Arm Embedded Toolchain
envs Environment variables toolchain
fasm Flat Assembler
tinycc Tiny C Compiler
emcc A toolchain for compiling to asm.js and WebAssembly
icc Intel C/C++ Compiler
ifort Intel Fortran Compiler
ifx Intel LLVM Fortran Compiler
muslcc The musl-based cross-compilation toolchain
fpc Free Pascal Programming Language Compiler
wasi WASI-enabled WebAssembly C/C++ toolchain
nim Nim Programming Language Compiler
dotnet .NET SDK Toolchain
circle A new C++20 compiler
armcc ARM Compiler Version 5 of Keil MDK
armclang ARM Compiler Version 6 of Keil MDK
c51 Keil development tools for the 8051 Microcontroller Architecture
icx Intel LLVM C/C++ Compiler
dpcpp Intel LLVM C++ Compiler for data parallel programming model based on Khronos SYCL
masm32 The MASM32 SDK
iverilog Icarus Verilog
verilator Verilator open-source SystemVerilog simulator and lint system
cosmocc build-once run-anywhere
hdk Harmony SDK
ti-c2000 TI-CGT C2000 compiler
ti-c6000 TI-CGT C6000 compiler
iararm IAR ARM C/C++ Compiler
kotlin-native Kotlin Native Programming Language Compiler
filc A memory safe implementation of the C and C++ programming languages (https://fil-c.org/)
ascendc Huawei Ascend C (bisheng compiler driver)
Supported languages
- C and C++
- Objective-C and Objective-C++
- Swift
- Assembly
- Golang
- Rust
- Dlang
- Fortran
- Cuda
- Zig
- Vala
- Pascal
- Nim
- Verilog
- FASM
- NASM
- YASM
- MASM32
- Cppfront
- Kotlin
- C#
- Ascend C
Features
Xmake exhibits: