Quick Start

Installation

NOTE

Xmake is not recommended for root installation, because this is very insecure. If the user has to download the root, if the prompt Xmake fails to run, please pass the --root parameter as prompted or set XMAKE_ROOT=y. The environment variable is forcibly enabled, provided that the user needs to pay attention to the risk of incorrect operating system file files under root.

curlwgetpowershell

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

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

powershell

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

If we want to install a specific version and branch, you can append the version number and branch parameters later

curl -fsSL https://xmake.io/shget.text | bash -s dev
curl -fsSL https://xmake.io/shget.text | bash -s v2.7.7
Invoke-Expression (Invoke-Webrequest 'https://xmake.io/psget.text' -UseBasicParsing).Content v2.7.7

NOTE

If the ps script execution prompt fails, you can try to execute in administrator mode.

Windows

Download the Xmake windows installer from Releases
Run xmake-[version].[win32|win64].exe

NOTE

Releases/xmake-[version].[win32|win64].zip has not installer, we need unzip it and add PATH environment variables by ourself.

In addition, the installation package with xmake-tinyc-xxx.exe, which integrates the tinyc compiler environment, and comes with libc and winapi header files. By installing this package, you can compile c programs normally without msvc. This is very useful for users who want to write some c tests or algorithm codes temporarily, but don't want to install msvc, but the installation package will be slightly larger than 2-3M.

scoopwinget

scoop install xmake

winget install xmake

Msys/Mingw

mingw64mingw32

pacman -Sy mingw-w64-x86_64-xmake

pacman -Sy mingw-w64-i686-xmake

MacOS

brew install xmake

Linux distributions

Ubuntu PPA

sudo add-apt-repository ppa:xmake-io/xmake
sudo apt update
sudo apt install xmake

Gentoo

Refer to here to add GURU to your system repository
Install dev-util/xmake

sudo emerge -a --autounmask dev-util/xmake

Other Linux

Download xmake xmake-x.x.x.gz.run install package from Releases

sudo chmod 777 ./xmake-x.x.x.gz.run
./xmake-x.x.x.gz.run

FreeBSD

Due to package name conflicts, only xmake-io can be used as the package name.

pkg install xmake-io

Termux (Android)

pkg install xmake

Bundle package

If you don't want to install, we also provide another Bundle packaging format, which does not require user installation, a single executable file, can be run and used after downloading, and is easy to distribute.

It will build all Lua scripts into the Xmake executable file, without the need for additional installation and configuration of any environment variables.

We can get them from Releases, and there are currently some Bundle packages as follows.

xmake-bundle-v2.9.8.arm64.exe
xmake-bundle-v2.9.8.cosmocc
xmake-bundle-v2.9.8.linux.x86_64
xmake-bundle-v2.9.8.macos.arm64
xmake-bundle-v2.9.8.macos.x86_64
xmake-bundle-v2.9.8.win32.exe
xmake-bundle-v2.9.8.win64.exe

Among them, the package with the .cosmocc suffix provides the ability to run across platforms, but the support for Windows is still relatively weak, and it is not recommended to use it on Windows.

The others are single executable files for specific platforms, and users can download and use them as needed according to their own systems.

Source compilation and installation

Download source code

git clone --recursive https://github.com/xmake-io/xmake.git
cd ./xmake

If you think the source of github is too slow, you can pull it through the mirror source of gitee or gitlab:

git clone --recursive https://gitee.com/tboox/xmake.git
git clone --recursive https://gitlab.com/tboox/xmake.git

NOTE

Since the current Xmake source maintains dependencies via git submodule, it is necessary to add the --recursive parameter to pull all submodules at the same time. Please do not download the tar.gz source directly, because github does not automatically package submodules. Code.

If you forget to add --recursive when git clone, you can also execute git submodule update --init to pull all submodules, for example:

git submodule update --init

Build and install

Linuxwindows

./configure
make -j4
./scripts/get.sh __local__ __install_only__
source ~/.xmake/profile

cd ./core
xmake

NOTE

./get.sh __local__ is installed to ~/.local/xmake, and then loaded by source ~/.xmake/profile, so after the installation, the current terminal fails to execute Xmake, If the prompt is not found, manually execute source ~/.xmake/profile, and the next time you open the terminal, you don't need it.

If you encounter problems with readline, please install readline-devel or libreadline-dev dependencies. This is optional. It is only needed when the xmake lua command executes REPL.

Update and Upgrade

Starting with v2.2.3, the xmake update command has been added to quickly update and upgrade itself. The default is to upgrade to the latest version. Of course, you can also specify to upgrade or roll back to a version:

xmake update 2.7.1

We can also specify an update to the master/dev branch version:

xmake update master
xmake update dev

Update from the specified git source

xmake update github:xmake-io/xmake#master
xmake update gitee:tboox/xmake#dev # gitee mirror

If just update the xmake lua script changes, you can add -s/--scriptonly to quickly update the lua script.

xmake update -s dev

Finally, if we want to uninstall Xmake, we're sorry to see you go! Still, it is supported: xmake update --uninstall.

Create Project

$ xmake create hello

And xmake will generate some files for c++ language project:

hello
├── src
│   └─main.cpp
└── xmake.lua

It is a simple console program only for printing hello xmake!

The content of xmake.lua is very simple:

xmake.lua

lua

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

target("hello")
    set_kind("binary")
    add_files("src/*.cpp")

Build Project

$ cd hello
$ xmake

Run Program

$ xmake run

Debug Program

To debug the hello, you need change to the debug mode and build it.

$ xmake config -m debug
$ xmake

Then run the following command to debug target program.

$ xmake run -d hello

It will start the debugger (.e.g lldb, gdb, windbg, vsjitdebugger, ollydbg ..) to load our program.

[lldb]$target create "build/hello"
Current executable set to 'build/hello' (x86_64).
[lldb]$b main
Breakpoint 1: where = hello`main, address = 0x0000000100000f50
[lldb]$r
Process 7509 launched: '/private/tmp/hello/build/hello' (x86_64)
Process 7509 stopped
* thread #1: tid = 0x435a2, 0x0000000100000f50 hello`main, queue = 'com.apple.main-thread', stop reason = breakpoint 1.1
    frame #0: 0x0000000100000f50 hello`main
hello`main:
->  0x100000f50 <+0>:  pushq  %rbp
    0x100000f51 <+1>:  movq   %rsp, %rbp
    0x100000f54 <+4>:  leaq   0x2b(%rip), %rdi          ; "hello world!"
    0x100000f5b <+11>: callq  0x100000f64               ; symbol stub for: puts
[lldb]$

To study more debug command, please click the url GDB to LLDB command map

If you want to use the specify debugger, try

$ xmake f --debugger=gdb
$ xmake run -d hello

What's Next?

Continue with the guide. Create Project
Checkout the examples. Examples
Checkout API reference. API Reference

Quick Start ​

Installation ​

Windows ​

Msys/Mingw ​

MacOS ​

Linux distributions ​

Ubuntu PPA ​

Gentoo ​

Other Linux ​

FreeBSD ​

Termux (Android) ​

Bundle package ​

Source compilation and installation ​

Download source code ​

Build and install ​

Update and Upgrade ​

Create Project ​

Build Project ​

Run Program ​

Debug Program ​

What's Next? ​

Quick Start

Installation

Windows

Msys/Mingw

MacOS

Linux distributions

Ubuntu PPA

Gentoo

Other Linux

FreeBSD

Termux (Android)

Bundle package

Source compilation and installation

Download source code

Build and install

Update and Upgrade

Create Project

Build Project

Run Program

Debug Program

What's Next?