https://xmake.io/

1<!DOCTYPE html>
2<html lang="en-US" dir="ltr">
3  <head>
4    <meta charset="utf-8">
5    <meta name="viewport" content="width=device-width,initial-scale=1">
6    <title>Xmake</title>
7    <meta name="description" content="A cross-platform build utility based on Lua">
8    <meta name="generator" content="VitePress v2.0.0-alpha.6">
9    <link rel="preload stylesheet" href="/assets/style.COTVmSRV.css" as="style">
10    <link rel="preload stylesheet" href="/vp-icons.css" as="style">
11    

11<script type="module" src="/assets/chunks/metadata.87a0fcd5.js"></script>

11
12    

12<script type="module" src="/assets/app.DMbBgzw6.js"></script>

12
13    <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
14    <link rel="modulepreload" href="/assets/chunks/theme.BU2nr8zi.js">
15    <link rel="modulepreload" href="/assets/chunks/framework.jYGXzUOM.js">
16    <link rel="modulepreload" href="/assets/index.md.CVKMBUlh.lean.js">
17    <link rel="icon" type="image/svg+xml" href="/assets/img/logo.svg">
18    <link rel="icon" type="image/png" href="/assets/img/logo.png">
19    <meta name="theme-color" content="#3c8772">
20    <meta property="og:type" content="website">
21    <meta property="og:site_name" content="Xmake">
22    <meta property="og:url" content="https://xmake.io/">
23    <meta name="algolia-site-verification" content="47A51984C60C423B">
24    

24<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>

24
25    

25<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>

25
26    <meta property="og:locale" content="en-US">
27    <meta property="og:title" content="Xmake | A cross-platform build utility based on Lua">
28    <link href="/llms.txt" rel="describedby">
29  </head>
30  <body>
31    <div id="app"><div class="Layout" data-v-5e06b97a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0b0ada53></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0b0ada53>Skip to content</a><!--]--><!----><header class="VPNav" data-v-5e06b97a data-v-ae24b3ad><div class="VPNavBar" data-v-ae24b3ad data-v-0ae64501><div class="wrapper" data-v-0ae64501><div class="container" data-v-0ae64501><div class="title" data-v-0ae64501><div class="VPNavBarTitle" data-v-0ae64501 data-v-1e38c6bc><a class="title" href="/" data-v-1e38c6bc><!--[--><!--]--><!--[--><img class="VPImage logo" src="/assets/img/logo.svg" width="24" height="24" alt data-v-8426fc1a><!--]--><span data-v-1e38c6bc>Xmake</span><!--[--><!--]--></a></div></div><div class="content" data-v-0ae64501><div class="content-body" data-v-0ae64501><!--[--><!--]--><div class="VPNavBarSearch search" data-v-0ae64501><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-0ae64501 data-v-39714824><span id="main-nav-aria-label" class="visually-hidden" data-v-39714824> Main Navigation </span><!--[--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-39714824 data-v-3ab3deac><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-3ab3deac><span class="text" data-v-3ab3deac><!----><span data-v-3ab3deac>Docs</span><span class="vpi-chevron-down text-icon" data-v-3ab3deac></span></span></button><div class="menu" data-v-3ab3deac><div class="VPMenu" data-v-3ab3deac data-v-c9afd7f1><div class="items" data-v-c9afd7f1><!--[--><!--[--><div class="VPMenuLink" data-v-c9afd7f1 data-v-35975db6><a class="VPLink link" href="/guide/introduction.html" data-v-35975db6><!--[--><span data-v-35975db6>Guide</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-c9afd7f1 data-v-35975db6><a class="VPLink link" href="/guide/quick-start.html" data-v-35975db6><!--[--><span data-v-35975db6>Quick Start</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-c9afd7f1 data-v-35975db6><a class="VPLink link" href="/examples/cpp/basic.html" data-v-35975db6><!--[--><span data-v-35975db6>Examples</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-c9afd7f1 data-v-35975db6><a class="VPLink link" href="/api/description/specification.html" data-v-35975db6><!--[--><span data-v-35975db6>API Reference</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/blog/" tabindex="0" data-v-39714824 data-v-e56f3d57><!--[--><span data-v-e56f3d57>Blog</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-39714824 data-v-3ab3deac><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-3ab3deac><span class="text" data-v-3ab3deac><!----><span data-v-3ab3deac>Ecosystem</span><span class="vpi-chevron-down text-icon" data-v-3ab3deac></span></span></button><div class="menu" data-v-3ab3deac><div class="VPMenu" data-v-3ab3deac data-v-c9afd7f1><div class="items" data-v-c9afd7f1><!--[--><!--[--><div class="VPMenuGroup" data-v-c9afd7f1 data-v-74489cb8><p class="title" data-v-74489cb8>Resources</p><!--[--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link vp-external-link-icon" href="https://packages.xmake.io/" target="_blank" rel="noreferrer" data-v-35975db6><!--[--><span data-v-35975db6>Xmake Packages</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link vp-external-link-icon" href="https://github.com/xmake-io/xmake-skills" target="_blank" rel="noreferrer" data-v-35975db6><!--[--><span data-v-35975db6>Xmake Skills</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--[--><div class="VPMenuGroup" data-v-c9afd7f1 data-v-74489cb8><p class="title" data-v-74489cb8>Help</p><!--[--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link vp-external-link-icon" href="https://github.com/xmake-io/xmake/issues" target="_blank" rel="noreferrer" data-v-35975db6><!--[--><span data-v-35975db6>Feedback</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--[--><div class="VPMenuGroup" data-v-c9afd7f1 data-v-74489cb8><p class="title" data-v-74489cb8>About</p><!--[--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link" href="/about/contact.html" data-v-35975db6><!--[--><span data-v-35975db6>Community</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link" href="/about/who_is_using_xmake.html" data-v-35975db6><!--[--><span data-v-35975db6>Who is using Xmake?</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link" href="/about/team.html" data-v-35975db6><!--[--><span data-v-35975db6>Meet the Team</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-74489cb8 data-v-35975db6><a class="VPLink link" href="/about/author.html" data-v-35975db6><!--[--><span data-v-35975db6>About Author</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/about/sponsor.html" tabindex="0" data-v-39714824 data-v-e56f3d57><!--[--><span data-v-e56f3d57>Sponsor ❤️</span><!--]--></a>

31<!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-0ae64501 data-v-88af2de4 data-v-3ab3deac><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-3ab3deac><span class="text" data-v-3ab3deac><span class="vpi-languages option-icon" data-v-3ab3deac></span><!----><span class="vpi-chevron-down text-icon" data-v-3ab3deac></span></span></button><div class="menu" data-v-3ab3deac><div class="VPMenu" data-v-3ab3deac data-v-c9afd7f1><!----><!--[--><!--[--><div class="items" data-v-88af2de4><p class="title" data-v-88af2de4>English</p><!--[--><div class="VPMenuLink" data-v-88af2de4 data-v-35975db6><a class="VPLink link" href="/zh/" data-v-35975db6><!--[--><span data-v-35975db6>简体中文</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-0ae64501 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-0ae64501 data-v-0394ad82 data-v-d474d15f><!--[--><a class="VPSocialLink no-icon" href="https://github.com/xmake-io/xmake" aria-label="github" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://twitter.com/waruqi" aria-label="twitter" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-twitter"></span></a><a class="VPSocialLink no-icon" href="https://discord.gg/xmake" aria-label="discord" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-discord"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-0ae64501 data-v-bb2aa2f0 data-v-3ab3deac><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-3ab3deac><span class="vpi-more-horizontal icon" data-v-3ab3deac></span></button><div class="menu" data-v-3ab3deac><div class="VPMenu" data-v-3ab3deac data-v-c9afd7f1><!----><!--[--><!--[--><div class="group translations" data-v-bb2aa2f0><p class="trans-title" data-v-bb2aa2f0>English</p><!--[--><div class="VPMenuLink" data-v-bb2aa2f0 data-v-35975db6><a class="VPLink link" href="/zh/" data-v-35975db6><!--[--><span data-v-35975db6>简体中文</span><!--]--></a></div><!--]--></div><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div></div></div><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-d474d15f><!--[--><a class="VPSocialLink no-icon" href="https://github.com/xmake-io/xmake" aria-label="github" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://twitter.com/waruqi" aria-label="twitter" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-twitter"></span></a><a class="VPSocialLink no-icon" href="https://discord.gg/xmake" aria-label="discord" target="_blank" rel="noopener" data-v-d474d15f data-v-bd121fe5><span class="vpi-social-discord"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-0ae64501 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-0ae64501><div class="divider-line" data-v-0ae64501></div></div></div><!----></header><!----><!----><div class="VPContent is-home" id="VPContent" data-v-5e06b97a data-v-aff0b8d7><div class="VPHome" data-v-aff0b8d7 data-v-8b561e3d><!--[--><!--]--><div class="VPHero VPHomeHero" data-v-8b561e3d data-v-f930dc11><div class="container" data-v-f930dc11><div class="main" data-v-f930dc11><!--[--><!--]--><!--[--><!--[--><!--[--><!--[--><!--[--><!--[--><h1 class="heading" data-v-1cc27d70><span class="xmake-hero-name" data-v-1cc27d70><span class="name clip" data-v-1cc27d70>Xmake</span><a class="xmake-release-badge" href="https://github.com/xmake-io/xmake/releases/tag/v3.1.1" target="_blank" rel="noreferrer" title="View v3.1.1 release notes" aria-label="View v3.1.1 release notes" data-v-1cc27d70><span class="VPBadge tip small xmake-release-badge-chip" data-v-1cc27d70><!--[-->v3.1.1<!--]--></span></a></span><span class="text" data-v-1cc27d70>A cross-platform build utility based on Lua</span></h1><p class="tagline" data-v-1cc27d70><i>Modern C/C++ build tools</i></p><!--]--><!--]--><!--]--><!--]--><!--]--><!--]--><!--[--><!--]--><div class="actions" data-v-f930dc11><!--[--><div class="action" data-v-f930dc11><a class="VPButton medium brand" href="/guide/quick-start.html" data-v-f930dc11 data-v-01bff58b><!--[-->Get Started -&gt;<!--]--></a></div><div class="action" data-v-f930dc11><a class="VPButton medium brand" href="/guide/best-practices/ai-qa-optimization.html" data-v-f930dc11 data-v-01bff58b><!--[-->Ask AI<!--]--></a></div><div class="action" data-v-f930dc11><a class="VPButton medium alt" href="https://github.com/xmake-io/xmake" target="_blank" rel="noreferrer" data-v-f930dc11 data-v-01bff58b><!--[-->GitHub<!--]--></a></div><!--]--></div><!--[--><!--]--></div><!----></div></div><!--[--><!--]--><!--[--><!--]--><div class="VPFeatures VPHomeFeatures" data-v-8b561e3d data-v-a6181336><div class="container" data-v-a6181336><div class="items" data-v-a6181336><!--[--><div class="grid-3 item" data-v-a6181336><div class="VPLink no-icon VPFeature" data-v-a6181336 data-v-5219619b><!--[--><article class="box" data-v-5219619b><div class="icon" data-v-5219619b>🚀</div><h2 class="title" data-v-5219619b>Simple and Fast</h2><p class="details" data-v-5219619b>Features a concise Lua syntax that is accessible even without prior experience. Delivers high-performance builds with built-in caching, parallel compilation, and optimized dependency analysis.</p><!----></article><!--]--></div></div><div class="grid-3 item" data-v-a6181336><div class="VPLink no-icon VPFeature" data-v-a6181336 data-v-5219619b><!--[--><article class="box" data-v-5219619b><div class="icon" data-v-5219619b>💪</div><h2 class="title" data-v-5219619b>Powerful</h2><p class="details" data-v-5219619b>Offers extensive flexibility through custom rules, plugins, and modules. Supports remote and distributed builds, mixed-language projects, and automatic project generation for major IDEs.</p><!----></article><!--]--></div></div><div class="grid-3 item" data-v-a6181336><div class="VPLink no-icon VPFeature" data-v-a6181336 data-v-5219619b><!--[--><article class="box" data-v-5219619b><div class="icon" data-v-5219619b>📦</div><h2 class="title" data-v-5219619b>Package Management</h2><p class="details" data-v-5219619b>

31Streamlines dependency management by automatically fetching and integrating C/C++ libraries and toolchains. Supports private repositories, cloud builds, and seamless integration with Conan and Vcpkg.</p><!----></article><!--]--></div></div><!--]--></div></div></div><!--[--><!--]--><div class="vp-doc container" style="" data-v-8b561e3d data-v-8e2d4988><!--[--><div style="position:relative;" data-v-8b561e3d><div><div style="display:none;" hidden data-nosnippet>Are you an LLM? View /llms.txt for optimized Markdown documentation, or /llms-full.txt for full documentation bundle</div></div></div><!--]--></div></div></div><!----><!--[--><!--]--></div></div>
32    
33    
34  </body>
35</html>