xmake-remote-compilation

Xmake Remote Compilation

Remote compilation is "run the entire build + run + test on a remote machine, transparently". Different from distributed compilation (which offloads individual compile jobs to a cluster): remote compilation sends one project to one server, and every xmake/xmake run/xmake test command executes there.

Use it for:

• Editing on a laptop, building on a beefy Linux box.
• Cross-OS development (compile Windows binaries from macOS or vice versa) without ssh pain.
• Running targets on a device with the right hardware (GPU/NDK/Xcode).

Compared to ssh-based workflows, this doesn't suffer from flaky terminal sessions and integrates into any editor without IDE-specific remote-dev features.

1. Start the server

xmake service                       # foreground (starts all configured services)
xmake service -vD                   # verbose
xmake service --start               # daemonize
xmake service --stop
xmake service --restart

First run creates ~/.xmake/service/server.conf and prints a token.

Server config

{
    known_hosts = { },
    logfile     = "/home/ruki/.xmake/service/server/logs.txt",
    remote_build = {
        listen  = "0.0.0.0:9691",
        workdir = "/home/ruki/.xmake/service/server/remote_build"
    },
    tokens = { "e438d816c95958667747c318f1532c0f" }
}

• listen — host:port (default 9691).
• workdir — where projects are synced on the server.
• tokens — token allowlist.
• known_hosts — optional IP allowlist (harden exposed servers).

2. Client config — single host

~/.xmake/service/client.conf:

{
    remote_build = {
        connect = "192.168.56.110:9691",
        token   = "e438d816c95958667747c318f1532c0f"
    }
}

3. Client config — multiple hosts (v3.0.7+)

{
    remote_build = {
        hosts = {
            { name = "local",   connect = "127.0.0.1:9691",     token = "ab9dcb6f..." },
            { name = "windows", connect = "10.5.138.247:9691",  token = "0e052f8c..." },
            { name = "linux",   connect = "10.5.138.100:9691",  token = "7889e254..." }
        }
    }
}