菜单
Use when defining user-configurable build options (`option(...)`), reading them from targets, or exposing them on the `xmake f` command line. Covers showmenu, default, values, and option-driven config.h generation.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use when switching xmake's output theme (colors, progress style, emoji) or fixing garbled/unreadable terminal output — `xmake g --theme=...`. Built-in themes: default, ninja, emoji, dark, light, plain, powershell.
Use when the user is starting a new Xmake project, installing Xmake, or needs the minimal xmake.lua structure. Covers installation, `xmake create`, the project layout, and the smallest valid xmake.lua.
Use when writing or reviewing an `xmake.lua` (project, package recipe, or toolchain) and you want to follow idiomatic xmake style — description vs script domain separation, naming, indentation, `set_` vs `add_`, option/config organization, and common conventions used across xmake-repo and the xmake project itself. Apply this alongside `xmake-targets`/`xmake-packages`/etc. as a stylistic overlay.
Use when creating a new xmake project from a built-in or third-party template (`xmake create -t <template>`), listing available templates, or authoring and distributing custom templates (built-in, user-global, or via xmake-repo). Covers template layout, `${TARGET_NAME}` / `${FAQ}` substitution, and language selection.
Use when invoking Xmake from the command line — configuring, building, running, cleaning, installing, packing, or inspecting a project. Covers the common flags for `xmake f`, `xmake`, `xmake run`, `xmake install`, `xmake pack`, and friends.
Use when exporting an xmake project to another build system or IDE — `compile_commands.json` for clangd/LSP, `CMakeLists.txt`, `build.ninja`, Visual Studio solution (`vsxmake`), or an Xcode project. Covers `xmake project -k <kind>` and how each generator is typically used.
| name | xmake-options |
| description | Use when defining user-configurable build options (`option(...)`), reading them from targets, or exposing them on the `xmake f` command line. Covers showmenu, default, values, and option-driven config.h generation. |
Options are user-facing switches that can be set via xmake f --name=value and queried from targets and conditions.
option("enable_foo")
set_default(false)
set_showmenu(true)
set_description("Enable the foo subsystem")
option_end()
set_showmenu(true) makes the option visible in xmake f --menu and xmake f --help.
target("app")
add_files("src/*.cpp")
if has_config("enable_foo") then
add_files("src/foo/*.cpp")
add_defines("ENABLE_FOO=1")
end
has_config("name") returns true when the option is truthy. Use get_config("name") to read the actual value.
option("backend")
set_default("vulkan")
set_values("vulkan", "metal", "d3d12")
set_showmenu(true)
xmake f --backend=metal
option("has_avx2")
add_cxflags("-mavx2")
add_cxxincludes("immintrin.h")
add_cxxsnippets("int f(){ return _mm256_set1_epi32(1)[0]; }")
Xmake runs the snippet at configure time; the option becomes enabled if the probe compiles.
target("app")
set_configdir("$(buildir)/config")
add_configfiles("src/config.h.in")
set_configvar("ENABLE_FOO", has_config("enable_foo") and 1 or 0)
src/config.h.in can reference ${define ENABLE_FOO} or ${ENABLE_FOO}.
xmake f --enable_foo=y --backend=metal -m release
xmake
xmake-targetsxmake-toolchains