Skip to main content

Project-API

Core APIs

APIBrief
_ACTIONThe action that will be run
_ARGSArray of action args
_MAIN_SCRIPT
_MAIN_SCRIPT_DIR
_OPTIONS
_OSThe currently targeted operating system
_PREMAKE_COMMAND
_PREMAKE_DIR
_PREMAKE_VERSIONThe version of the currently executing instance of Premake
_WORKING_DIR
architecture
atlUse Microsoft's Active Template Library
basedir
bindirs
buildaction
buildcommands
buildcustomizations
builddependencies
buildinputs
buildlog
buildmessage
buildoptionsAdditional build options (passed directly to compiler)
buildoutputs
buildrule
callingconventionSets the function calling convention
cdialect
charactersetSet the character encoding
cleancommands
cleanextensions
clrUse Microsoft's Common Language Runtime
compileas
compilebuildoutputs
configfile
configmap
configuration
configurations
copylocal
cppdialect
customtoolnamespace
debugargs
debugcommand
debugconnectcommandsDebugger commands to execute on remote target connection
debugconstants
debugdirWorking directory for debug session
debugenvsEnv vars for debug session
debugextendedprotocolUse gdb 'extended' protocol; maintain a persistent connection
debugformatFormat for embedded debug information
debugger
debuggertype
debuglevel
debugpathmap
debugportPort to use for remote debugging
debugremotehostTarget for remote debugging
debugsearchpathsSearch paths for source code while debugging
debugstartupcommandsDebugger commands to execute on debugger startup
debugtoolargs
debugtoolcommand
defaultplatform
defaultplatform
defines
dependson
deploymentoptions
disablewarnings
display
display
docdir
docname
editandcontinue
editorintegrationEnable or disable IDE integration
enableunitybuild
enablewarnings
endian
entrypointSpecify the program entry point function
exceptionhandlingEnable or disable exception handling
external
externalanglebrackets
externalincludedirs
externalrule
externalwarnings
fatalwarnings
fileextension
filename
files
filter
flags
floatingpoint
floatingpointexceptions
forceincludes
forceusings
fpu
framework
functionlevellinking
gccprefix
group
headerdir
headername
icon
ignoredefaultlibrariesSpecify a list of default libraries to ignore
imageoptions
imagepath
implibdir
implibextension
implibname
implibprefix
implibsuffix
include
includedirs
includedirsafter
includeexternal
inliningTells the compiler when it should inline functions
intrinsics
kind
language
largeaddressaware
libdirs
linkbuildoutputs
linkgroupsTurn on/off linkgroups for gcc/clang
linkoptionsAdditional linker options (passed directly to linker)
links
locale
locationSpecifies the directory for the generated workspace/project file
makesettings
namespace
nativewchar
nuget
nugetsource
objdirOutput dir for object/intermediate files
optimizeOptimization level
pchheaderPrecompiled header file
pchsourcePrecompiled header source file (which should build the PCH)
picPosition independent code
platforms
postbuildcommands
postbuildmessage
prebuildcommands
prebuildmessage
preferredtoolarchitecture
prelinkcommands
prelinkmessage
project
propertydefinition
rebuildcommands
resdefines
resincludedirs
resoptions
resourcegenerator
rttiEnable or disable runtime type information
rule
rules
runtime
sanitizeEnable fsanitize compiler options
sharedlibtype
startproject
strictaliasing
stringpooling
symbolsTurn symbol generation on/off
symbolspathAllows you to specify the target location of the symbols
sysincludedirs
syslibdirs
system
tags
targetdir
targetextension
targetname
targetprefix
targetsuffix
toolset
toolsversion
undefines
usingdirs
uuidSet project GUID (for VS projects/workspaces)
vectorextensionsEnable hardware vector extensions
versionconstants
versionlevel
vpaths
warnings
workspace

Builtin Extension APIs

The following API reference is for use with various built-in extensions.

D language APIsBrief
debugconstantsDeclare debug identifiers
debuglevelDeclare debug level
docdirOutput dir for ddoc generation
docnameFilename for the ddoc output
headerdirOutput dir for interface file generation
headernameFilename for the interface (.di) file
versionconstantsDeclare version identifiers
versionlevelDeclare version level
Xcode APIsBrief
xcodebuildsettings
xcodebuildresources