xmake

A cross-platform build utility based on Lua

xmake is a cross-platform build utility based on lua.

The project focuses on making development and building easier and provides many features (e.g package, install, plugin, macro, action, option, task ...), so that any developer can quickly pick it up and enjoy a productivity boost when developing and building projects.

If you want to know more, please refer to:

• Documents
• HomePage
• Github
• Gitee

bash <(curl -fsSL https://xmake.io/shget.text)

bash <(wget https://xmake.io/shget.text -O -)

Invoke-Expression (Invoke-Webrequest 'https://xmake.io/psget.text' -UseBasicParsing).Content

An official xmake package repository: xmake-repo

$ xmake

$ xmake run console

$ xmake run -d console

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

$ xmake f --menu

The test project: xmake-core

• Windows (x86, x64)
• macOS (i386, x86_64)
• Linux (i386, x86_64, cross-toolchains ..)
• Android (x86, x86_64, armeabi, armeabi-v7a, arm64-v8a)
• iOS (armv7, armv7s, arm64, i386, x86_64)
• WatchOS (armv7k, i386)
• MSYS (i386, x86_64)
• MinGW (i386, x86_64)
• Cygwin (i386, x86_64)
• SDCC (stm8, mcs51, ..)
• Cross (cross-toolchains ..)

• C
• C++
• Objective-C and Objective-C++
• Swift
• Assembly
• Golang
• Rust
• Dlang
• Cuda

• Static Library
• Shared Library
• Console
• Cuda Program
• Qt Application
• WDK Driver (umdf/kmdf/wdm)
• WinSDK Application
• MFC Application

Debug and release modes:

add_rules("mode.debug", "mode.release")

target("console")
    set_kind("binary")
    add_files("src/*.c")
    if is_mode("debug") then
        add_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)

Download and use packages in xmake-repo or third-party repositories:

add_requires("tbox >1.6.1", "libuv master", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8")
add_requires("conan::OpenSSL/1.0.2n@conan/stable", {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_30")

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")

More wdk driver program examples (umdf/kmdf/wdm), please see WDK Program Examples

$ 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

$ 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 
  }

More builtin plugins, please see: Builtin plugins

Please download and install more other plugins from the plugins repository xmake-plugins.

• xmake-vscode

• xmake-sublime

• xmake-idea

• xmake.vim (third-party, thanks @luzhlon)

Some projects using xmake:

• tbox
• gbox
• vm86
• more

• Email：[email protected]
• Homepage：tboox.org
• Community：/r/tboox on reddit
• ChatRoom：Char on telegram, Chat on gitter
• Source Code：Github, Gitee
• QQ Group: 343118190(full), 662147501
• Wechat Public: tboox-os

This project exists thanks to all the people who have contributed:

• TitanSnow: provide the xmake logo and install scripts
• uael: provide the semantic versioning library sv
• OpportunityLiu: improve cuda, tests and ci

Thank you to all our backers! 🙏 [Become a backer]

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]