Cake - Reference

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta name="description" /> <meta name="keywords" content="static content generator,static site generator,static site,HTML,web development,.NET,C#,Razor,Markdown,YAML" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="shortcut icon" href="/assets/img/favicon.ico" type="image/x-icon"> <link rel="icon" href="/assets/img/favicon.ico" type="image/x-icon"> <title>Cake - Reference</title> <link href="/assets/css/highlight.css" rel="stylesheet"> <link href="/assets/css/bootstrap/bootstrap.css" rel="stylesheet" /> <link href="/assets/css/adminlte/AdminLTE.css" rel="stylesheet" /> <link href="/assets/css/theme/theme.css" rel="stylesheet" /> <link href="//fonts.googleapis.com/css?family=Roboto+Mono:400,700|Roboto:400,400i,700,700i" rel="stylesheet"> <link href="/assets/css/font-awesome.min.css" rel="stylesheet" type="text/css"> <link href="/assets/css/override.css" rel="stylesheet" /> <script src="/assets/js/jquery-2.2.3.min.js"></script> <script src="/assets/js/bootstrap.min.js"></script> <script src="/assets/js/app.min.js"></script> <script src="/assets/js/highlight.pack.js"></script> <script src="/assets/js/jquery.slimscroll.min.js"></script> <script src="/assets/js/jquery.sticky-kit.min.js"></script> <script src="/assets/js/mermaid.min.js"></script> <script src="/assets/js/svg-pan-zoom.min.js"></script>  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" /> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> <script type="text/javascript" src="/assets/js/anchor.min.js"></script> <link href="https://dotnet.social/@cakebuild" rel="me"> <link href="https://dotnet.social/@cakecontrib" rel="me"> </head> <body class="hold-transition wyam layout-boxed "> <div class="top-banner"></div> <div class="wrapper with-container">  <header class="main-header"> <a href="/" class="logo">  <span class="logo-mini"><img src="/assets/img/logo.png"></span>  <span class="logo-lg"><img src="/assets/img/logo.png"></span> </a> <nav class="navbar navbar-static-top" role="navigation">  <a href="#" class="sidebar-toggle visible-xs-block" data-toggle="offcanvas" role="button"> <span class="sr-only">Toggle side menu</span> <i class="fa fa-chevron-circle-right"></i> </a> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse"> <span class="sr-only">Toggle side menu</span> <i class="fa fa-chevron-circle-down"></i> </button> </div>  <div class="collapse navbar-collapse pull-left" id="navbar-collapse"> <ul class="nav navbar-nav"> <div class="navbar-right navbar-form"> <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off" autofocus> </div> <li><a href="/blog">Blog</a></li> <li><a href="/docs">Documentation</a></li> <li class="active"><a href="/dsl">Reference</a></li> <li><a href="/extensions">Extensions</a></li> <li><a href="/community">Community</a></li> <li><a href="/api">API</a></li> <li><a href="https://opencollective.com/cake"><i class="fa-solid fa-heart"></i> Support Us</a></li> <li><a href="https://github.com/cake-build"><i class="fa-brands fa-github"></i> Source</a></li> </ul> </div>   </nav> </header>  <aside class="main-sidebar "> <section class="infobar" data-spy="affix" data-offset-top="60" data-offset-bottom="200"> <div><p><a href="https://github.com/cake-build/website/blob/master/input/dsl/index.cshtml"><i class="fa fa-pencil-square" aria-hidden="true"></i> Edit Content</a></p></div> <div id="infobar-headings"></div> </section> <section class="sidebar"> <ul class="sidebar-menu"> <li> <div id="category-filter"> <div class="checkbox"> <label> <input type="checkbox" class="showAddinAliases" data-toggle="toggle" checked> <span>Aliases from addins<span> </label> </div> </div> <hr> <div id="aliasCategories"> <i id="aliasCategorySearchIcon" class="fa-solid fa-filter"></i> <input id="aliasCategorySearch" type="text" class="search" aria-label="Enter categories to which should be filtered" placeholder="Filter categories..." autocomplete="off" value> <ul class="list sidebar-menu" style="display:none;"> <li data-name="7Zip" data-builtin="False"><a href="/dsl/7zip">7Zip</a></li> <li data-name="ActiveDirectory" data-builtin="False"><a href="/dsl/activedirectory">ActiveDirectory</a></li> <li data-name="AliaSql" data-builtin="False"><a href="/dsl/aliasql">AliaSql</a></li> <li data-name="Android" data-builtin="False"><a href="/dsl/android">Android</a></li> <li data-name="Android AVD Manager" data-builtin="False"><a href="/dsl/android-avd-manager">Android AVD Manager</a></li> <li data-name="Android Emulator" data-builtin="False"><a href="/dsl/android-emulator">Android Emulator</a></li> <li data-name="Android SDK Manager" data-builtin="False"><a href="/dsl/android-sdk-manager">Android SDK Manager</a></li> <li data-name="AndroidAppManifest" data-builtin="False"><a href="/dsl/androidappmanifest">AndroidAppManifest</a></li> <li data-name="Apigee" data-builtin="False"><a href="/dsl/apigee">Apigee</a></li> <li data-name="AppCenter" data-builtin="False"><a href="/dsl/appcenter">AppCenter</a></li> <li data-name="AppleSimulator" data-builtin="False"><a href="/dsl/applesimulator">AppleSimulator</a></li> <li data-name="AppPackager" data-builtin="False"><a href="/dsl/apppackager">AppPackager</a></li> <li data-name="AppVeyor" data-builtin="False"><a href="/dsl/appveyor">AppVeyor</a></li> <li data-name="Arguments" data-builtin="True"><a href="/dsl/arguments">Arguments</a></li> <li data-name="AsanaCommand" data-builtin="False"><a href="/dsl/asanacommand">AsanaCommand</a></li> <li data-name="Asciidoctor" data-builtin="False"><a href="/dsl/asciidoctor">Asciidoctor</a></li> <li data-name="asciidoctorj" data-builtin="False"><a href="/dsl/asciidoctorj">asciidoctorj</a></li> <li data-name="Assembly Info" data-builtin="True"><a href="/dsl/assembly-info">Assembly Info</a></li> <li data-name="AutoRest" data-builtin="False"><a href="/dsl/autorest">AutoRest</a></li> <li data-name="AWS" data-builtin="False"><a href="/dsl/aws">AWS</a></li> <li data-name="Azure" data-builtin="False"><a href="/dsl/azure">Azure</a></li> <li data-name="Azure DevOps" data-builtin="False"><a href="/dsl/azure-devops">Azure DevOps</a></li> <li data-name="AzureStorage" data-builtin="False"><a href="/dsl/azurestorage">AzureStorage</a></li> <li data-name="BDD" data-builtin="False"><a href="/dsl/bdd">BDD</a></li> <li data-name="BenchmarkDotNet" data-builtin="False"><a href="/dsl/benchmarkdotnet">BenchmarkDotNet</a></li> <li data-name="BitDiffer" data-builtin="False"><a href="/dsl/bitdiffer">BitDiffer</a></li> <li data-name="Board" data-builtin="False"><a href="/dsl/board">Board</a></li> <li data-name="Boots" data-builtin="False"><a href="/dsl/boots">Boots</a></li> <li data-name="Bower" data-builtin="False"><a href="/dsl/bower">Bower</a></li> <li data-name="BrowserStack" data-builtin="False"><a href="/dsl/browserstack">BrowserStack</a></li> <li data-name="Build System" data-builtin="True"><a href="/dsl/build-system">Build System</a></li> <li data-name="Buildah" data-builtin="False"><a href="/dsl/buildah">Buildah</a></li> <li data-name="Bumpy" data-builtin="False"><a href="/dsl/bumpy">Bumpy</a></li> <li data-name="Cake" data-builtin="True"><a href="/dsl/cake">Cake</a></li> <li data-name="Cake.ApiReference.Uploader" data-builtin="False"><a href="/dsl/cake.apireference.uploader">Cake.ApiReference.Uploader</a></li> <li data-name="Cake.XmlDoc.Checker" data-builtin="False"><a href="/dsl/cake.xmldoc.checker">Cake.XmlDoc.Checker</a></li> <li data-name="CakeBoss" data-builtin="False"><a href="/dsl/cakeboss">CakeBoss</a></li> <li data-name="Changelog" data-builtin="False"><a href="/dsl/changelog">Changelog</a></li> <li data-name="Chocolatey" data-builtin="True"><a href="/dsl/chocolatey">Chocolatey</a></li> <li data-name="Chutzpah" data-builtin="False"><a href="/dsl/chutzpah">Chutzpah</a></li> <li data-name="CKPack" data-builtin="False"><a href="/dsl/ckpack">CKPack</a></li> <li data-name="ClickOnce" data-builtin="False"><a href="/dsl/clickonce">ClickOnce</a></li> <li data-name="CloudFormaiton" data-builtin="False"><a href="/dsl/cloudformaiton">CloudFormaiton</a></li> <li data-name="CMake" data-builtin="False"><a href="/dsl/cmake">CMake</a></li> <li data-name="Cobertura" data-builtin="False"><a href="/dsl/cobertura">Cobertura</a></li> <li data-name="CocoaPods" data-builtin="False"><a href="/dsl/cocoapods">CocoaPods</a></li> <li data-name="Codecov" data-builtin="False"><a href="/dsl/codecov">Codecov</a></li> <li data-name="CodeQL" data-builtin="False"><a href="/dsl/codeql">CodeQL</a></li> <li data-name="Command" data-builtin="True"><a href="/dsl/command">Command</a></li> <li data-name="Communication" data-builtin="False"><a href="/dsl/communication">Communication</a></li> <li data-name="Compilation" data-builtin="False"><a href="/dsl/compilation">Compilation</a></li> <li data-name="Compression" data-builtin="True"><a href="/dsl/compression">Compression</a></li> <li data-name="Configuration" data-builtin="False"><a href="/dsl/configuration">Configuration</a></li> <li data-name="Coveralls" data-builtin="False"><a href="/dsl/coveralls">Coveralls</a></li> <li data-name="Create Docs" data-builtin="False"><a href="/dsl/create-docs">Create Docs</a></li> <li data-name="CsvHelper" data-builtin="False"><a href="/dsl/csvhelper">CsvHelper</a></li> <li data-name="Curl" data-builtin="False"><a href="/dsl/curl">Curl</a></li> <li data-name="Dart" data-builtin="False"><a href="/dsl/dart">Dart</a></li> <li data-name="Database" data-builtin="False"><a href="/dsl/database">Database</a></li> <li data-name="Debootstrap" data-builtin="False"><a href="/dsl/debootstrap">Debootstrap</a></li> <li data-name="DependenciesAnalyser" data-builtin="False"><a href="/dsl/dependenciesanalyser">DependenciesAnalyser</a></li> <li data-name="DependencyCheck" data-builtin="False"><a href="/dsl/dependencycheck">DependencyCheck</a></li> <li data-name="Deploy.Azure" data-builtin="False"><a href="/dsl/deploy.azure">Deploy.Azure</a></li> <li data-name="Deployment" data-builtin="False"><a href="/dsl/deployment">Deployment</a></li> <li data-name="DeviceXunitTestReceiver" data-builtin="False"><a href="/dsl/devicexunittestreceiver">DeviceXunitTestReceiver</a></li> <li data-name="Diagnostics" data-builtin="True"><a href="/dsl/diagnostics">Diagnostics</a></li> <li data-name="Directory Operations" data-builtin="True"><a href="/dsl/directory-operations">Directory Operations</a></li> <li data-name="Discord" data-builtin="False"><a href="/dsl/discord">Discord</a></li> <li data-name="DocFx" data-builtin="False"><a href="/dsl/docfx">DocFx</a></li> <li data-name="Docker" data-builtin="False"><a href="/dsl/docker">Docker</a></li> <li data-name="Documentation" data-builtin="False"><a href="/dsl/documentation">Documentation</a></li> <li data-name="DocumentDatabase" data-builtin="False"><a href="/dsl/documentdatabase">DocumentDatabase</a></li> <li data-name="DoInDirectory" data-builtin="False"><a href="/dsl/doindirectory">DoInDirectory</a></li> <li data-name="DotCover" data-builtin="True"><a href="/dsl/dotcover">DotCover</a></li> <li data-name="DotNet" data-builtin="True"><a href="/dsl/dotnet">DotNet</a></li> <li data-name="DotNetCore Global Tool" data-builtin="False"><a href="/dsl/dotnetcore-global-tool">DotNetCore Global Tool</a></li> <li data-name="DotNetCoreEf" data-builtin="False"><a href="/dsl/dotnetcoreef">DotNetCoreEf</a></li> <li data-name="DotNetVersionDetector" data-builtin="False"><a href="/dsl/dotnetversiondetector">DotNetVersionDetector</a></li> <li data-name="Dry Run" data-builtin="True"><a href="/dsl/dry-run">Dry Run</a></li> <li data-name="Eazfuscator.Net" data-builtin="False"><a href="/dsl/eazfuscator.net">Eazfuscator.Net</a></li> <li data-name="Email" data-builtin="False"><a href="/dsl/email">Email</a></li> <li data-name="Ember" data-builtin="False"><a href="/dsl/ember">Ember</a></li> <li data-name="Endpoint" data-builtin="False"><a href="/dsl/endpoint">Endpoint</a></li> <li data-name="EntityFramework6" data-builtin="False"><a href="/dsl/entityframework6">EntityFramework6</a></li> <li data-name="EntityFrameworkCore" data-builtin="False"><a href="/dsl/entityframeworkcore">EntityFrameworkCore</a></li> <li data-name="Environment" data-builtin="True"><a href="/dsl/environment">Environment</a></li> <li data-name="Environmental XML configuration transformations" data-builtin="False"><a href="/dsl/environmental-xml-configuration-transformations">Environmental XML configuration transformations</a></li> <li data-name="ESLint" data-builtin="False"><a href="/dsl/eslint">ESLint</a></li> <li data-name="ExcelDnaPack" data-builtin="False"><a href="/dsl/exceldnapack">ExcelDnaPack</a></li> <li data-name="Fastlane" data-builtin="False"><a href="/dsl/fastlane">Fastlane</a></li> <li data-name="Figlet" data-builtin="False"><a href="/dsl/figlet">Figlet</a></li> <li data-name="File Helpers" data-builtin="False"><a href="/dsl/file-helpers">File Helpers</a></li> <li data-name="File Manipulation" data-builtin="False"><a href="/dsl/file-manipulation">File Manipulation</a></li> <li data-name="File Operations" data-builtin="True"><a href="/dsl/file-operations">File Operations</a></li> <li data-name="FileSet" data-builtin="False"><a href="/dsl/fileset">FileSet</a></li> <li data-name="Fixie" data-builtin="True"><a href="/dsl/fixie">Fixie</a></li> <li data-name="FluentMigrator" data-builtin="False"><a href="/dsl/fluentmigrator">FluentMigrator</a></li> <li data-name="Flutter" data-builtin="False"><a href="/dsl/flutter">Flutter</a></li> <li data-name="Flyway" data-builtin="False"><a href="/dsl/flyway">Flyway</a></li> <li data-name="Ftp" data-builtin="False"><a href="/dsl/ftp">Ftp</a></li> <li data-name="FTP" data-builtin="False"><a href="/dsl/ftp">FTP</a></li> <li data-name="Gem" data-builtin="False"><a href="/dsl/gem">Gem</a></li> <li data-name="Genymotion" data-builtin="False"><a href="/dsl/genymotion">Genymotion</a></li> <li data-name="GerritCodeReview" data-builtin="False"><a href="/dsl/gerritcodereview">GerritCodeReview</a></li> <li data-name="Git" data-builtin="False"><a href="/dsl/git">Git</a></li> <li data-name="Git Versioning" data-builtin="False"><a href="/dsl/git-versioning">Git Versioning</a></li> <li data-name="GitHub" data-builtin="False"><a href="/dsl/github">GitHub</a></li> <li data-name="GitLab" data-builtin="False"><a href="/dsl/gitlab">GitLab</a></li> <li data-name="GitLink" data-builtin="True"><a href="/dsl/gitlink">GitLink</a></li> <li data-name="GitLink v3" data-builtin="True"><a href="/dsl/gitlink-v3">GitLink v3</a></li> <li data-name="GitReleaseManager" data-builtin="True"><a href="/dsl/gitreleasemanager">GitReleaseManager</a></li> <li data-name="GitReleaseNotes" data-builtin="True"><a href="/dsl/gitreleasenotes">GitReleaseNotes</a></li> <li data-name="Gitter" data-builtin="False"><a href="/dsl/gitter">Gitter</a></li> <li data-name="GitVersion" data-builtin="True"><a href="/dsl/gitversion">GitVersion</a></li> <li data-name="Globbing" data-builtin="True"><a href="/dsl/globbing">Globbing</a></li> <li data-name="Gradle" data-builtin="False"><a href="/dsl/gradle">Gradle</a></li> <li data-name="Graphite" data-builtin="False"><a href="/dsl/graphite">Graphite</a></li> <li data-name="grate" data-builtin="False"><a href="/dsl/grate">grate</a></li> <li data-name="Guard" data-builtin="False"><a href="/dsl/guard">Guard</a></li> <li data-name="Handlebars" data-builtin="False"><a href="/dsl/handlebars">Handlebars</a></li> <li data-name="HandlebarsDotNet" data-builtin="False"><a href="/dsl/handlebarsdotnet">HandlebarsDotNet</a></li> <li data-name="Helm" data-builtin="False"><a href="/dsl/helm">Helm</a></li> <li data-name="Hg" data-builtin="False"><a href="/dsl/hg">Hg</a></li> <li data-name="HgVersion" data-builtin="False"><a href="/dsl/hgversion">HgVersion</a></li> <li data-name="HipChat" data-builtin="False"><a href="/dsl/hipchat">HipChat</a></li> <li data-name="HockeyApp" data-builtin="False"><a href="/dsl/hockeyapp">HockeyApp</a></li> <li data-name="Homebrew" data-builtin="False"><a href="/dsl/homebrew">Homebrew</a></li> <li data-name="Hosts" data-builtin="False"><a href="/dsl/hosts">Hosts</a></li> <li data-name="HTTP Operations" data-builtin="True"><a href="/dsl/http-operations">HTTP Operations</a></li> <li data-name="IIS" data-builtin="False"><a href="/dsl/iis">IIS</a></li> <li data-name="ILMerge" data-builtin="True"><a href="/dsl/ilmerge">ILMerge</a></li> <li data-name="ILRepack" data-builtin="True"><a href="/dsl/ilrepack">ILRepack</a></li> <li data-name="ImageOptimizer" data-builtin="False"><a href="/dsl/imageoptimizer">ImageOptimizer</a></li> <li data-name="Inno Setup" data-builtin="True"><a href="/dsl/inno-setup">Inno Setup</a></li> <li data-name="ISO" data-builtin="False"><a href="/dsl/iso">ISO</a></li> <li data-name="Issues" data-builtin="False"><a href="/dsl/issues">Issues</a></li> <li data-name="Jekyll" data-builtin="False"><a href="/dsl/jekyll">Jekyll</a></li> <li data-name="Jira" data-builtin="False"><a href="/dsl/jira">Jira</a></li> <li data-name="JMeter" data-builtin="False"><a href="/dsl/jmeter">JMeter</a></li> <li data-name="Json" data-builtin="False"><a href="/dsl/json">Json</a></li> <li data-name="KeePass" data-builtin="False"><a href="/dsl/keepass">KeePass</a></li> <li data-name="Kubectl" data-builtin="False"><a href="/dsl/kubectl">Kubectl</a></li> <li data-name="Kudu" data-builtin="False"><a href="/dsl/kudu">Kudu</a></li> <li data-name="LibMan" data-builtin="False"><a href="/dsl/libman">LibMan</a></li> <li data-name="License Header" data-builtin="False"><a href="/dsl/license-header">License Header</a></li> <li data-name="Liquibase" data-builtin="False"><a href="/dsl/liquibase">Liquibase</a></li> <li data-name="Localization" data-builtin="False"><a href="/dsl/localization">Localization</a></li> <li data-name="Logging" data-builtin="True"><a href="/dsl/logging">Logging</a></li> <li data-name="Mage" data-builtin="False"><a href="/dsl/mage">Mage</a></li> <li data-name="Markdownlint" data-builtin="False"><a href="/dsl/markdownlint">Markdownlint</a></li> <li data-name="Mastodon" data-builtin="False"><a href="/dsl/mastodon">Mastodon</a></li> <li data-name="Microsoft Teams" data-builtin="False"><a href="/dsl/microsoft-teams">Microsoft Teams</a></li> <li data-name="Microsoft.Extensions.Configuration" data-builtin="False"><a href="/dsl/microsoft.extensions.configuration">Microsoft.Extensions.Configuration</a></li> <li data-name="MiniCover" data-builtin="False"><a href="/dsl/minicover">MiniCover</a></li> <li data-name="MinVer" data-builtin="False"><a href="/dsl/minver">MinVer</a></li> <li data-name="MkDocs" data-builtin="False"><a href="/dsl/mkdocs">MkDocs</a></li> <li data-name="Mono API Tools" data-builtin="False"><a href="/dsl/mono-api-tools">Mono API Tools</a></li> <li data-name="MSBuild" data-builtin="True"><a href="/dsl/msbuild">MSBuild</a></li> <li data-name="MSBuild Resource" data-builtin="True"><a href="/dsl/msbuild-resource">MSBuild Resource</a></li> <li data-name="MSBuildTask" data-builtin="False"><a href="/dsl/msbuildtask">MSBuildTask</a></li> <li data-name="MsDeploy" data-builtin="False"><a href="/dsl/msdeploy">MsDeploy</a></li> <li data-name="MSpec" data-builtin="True"><a href="/dsl/mspec">MSpec</a></li> <li data-name="MSTest" data-builtin="True"><a href="/dsl/mstest">MSTest</a></li> <li data-name="NDepend" data-builtin="False"><a href="/dsl/ndepend">NDepend</a></li> <li data-name="Netlify" data-builtin="False"><a href="/dsl/netlify">Netlify</a></li> <li data-name="NewRelic" data-builtin="False"><a href="/dsl/newrelic">NewRelic</a></li> <li data-name="Node" data-builtin="False"><a href="/dsl/node">Node</a></li> <li data-name="Npm" data-builtin="False"><a href="/dsl/npm">Npm</a></li> <li data-name="NScan" data-builtin="False"><a href="/dsl/nscan">NScan</a></li> <li data-name="NSIS" data-builtin="True"><a href="/dsl/nsis">NSIS</a></li> <li data-name="NSpec" data-builtin="False"><a href="/dsl/nspec">NSpec</a></li> <li data-name="NSwag" data-builtin="False"><a href="/dsl/nswag">NSwag</a></li> <li data-name="NuGet" data-builtin="True"><a href="/dsl/nuget">NuGet</a></li> <li data-name="NUnit" data-builtin="True"><a href="/dsl/nunit">NUnit</a></li> <li data-name="NUnit v3" data-builtin="True"><a href="/dsl/nunit-v3">NUnit v3</a></li> <li data-name="OctoDeploy" data-builtin="False"><a href="/dsl/octodeploy">OctoDeploy</a></li> <li data-name="Octopus Deploy" data-builtin="True"><a href="/dsl/octopus-deploy">Octopus Deploy</a></li> <li data-name="OpenAPI" data-builtin="False"><a href="/dsl/openapi">OpenAPI</a></li> <li data-name="OpenCover" data-builtin="True"><a href="/dsl/opencover">OpenCover</a></li> <li data-name="Openshift" data-builtin="False"><a href="/dsl/openshift">Openshift</a></li> <li data-name="Orchard" data-builtin="False"><a href="/dsl/orchard">Orchard</a></li> <li data-name="Paket" data-builtin="False"><a href="/dsl/paket">Paket</a></li> <li data-name="Pandoc" data-builtin="False"><a href="/dsl/pandoc">Pandoc</a></li> <li data-name="PARAMETERS" data-builtin="False"><a href="/dsl/parameters">PARAMETERS</a></li> <li data-name="Path" data-builtin="False"><a href="/dsl/path">Path</a></li> <li data-name="PlasticSCM" data-builtin="False"><a href="/dsl/plasticscm">PlasticSCM</a></li> <li data-name="plist" data-builtin="False"><a href="/dsl/plist">plist</a></li> <li data-name="Pnpm" data-builtin="False"><a href="/dsl/pnpm">Pnpm</a></li> <li data-name="Postman" data-builtin="False"><a href="/dsl/postman">Postman</a></li> <li data-name="Powershell" data-builtin="False"><a href="/dsl/powershell">Powershell</a></li> <li data-name="Process" data-builtin="True"><a href="/dsl/process">Process</a></li> <li data-name="ProGet" data-builtin="False"><a href="/dsl/proget">ProGet</a></li> <li data-name="Prompt" data-builtin="False"><a href="/dsl/prompt">Prompt</a></li> <li data-name="Protobuf" data-builtin="False"><a href="/dsl/protobuf">Protobuf</a></li> <li data-name="Pulumi" data-builtin="False"><a href="/dsl/pulumi">Pulumi</a></li> <li data-name="Raygun" data-builtin="False"><a href="/dsl/raygun">Raygun</a></li> <li data-name="ReadyAPITestEngine" data-builtin="False"><a href="/dsl/readyapitestengine">ReadyAPITestEngine</a></li> <li data-name="ReadyAPITestRunner" data-builtin="False"><a href="/dsl/readyapitestrunner">ReadyAPITestRunner</a></li> <li data-name="Release Notes" data-builtin="True"><a href="/dsl/release-notes">Release Notes</a></li> <li data-name="ReportGenerator" data-builtin="True"><a href="/dsl/reportgenerator">ReportGenerator</a></li> <li data-name="ReportUnit" data-builtin="True"><a href="/dsl/reportunit">ReportUnit</a></li> <li data-name="ReSharper" data-builtin="True"><a href="/dsl/resharper">ReSharper</a></li> <li data-name="ReSharperReports" data-builtin="False"><a href="/dsl/resharperreports">ReSharperReports</a></li> <li data-name="Rest" data-builtin="False"><a href="/dsl/rest">Rest</a></li> <li data-name="ResxConverter" data-builtin="False"><a href="/dsl/resxconverter">ResxConverter</a></li> <li data-name="Roundhouse" data-builtin="True"><a href="/dsl/roundhouse">Roundhouse</a></li> <li data-name="RSync" data-builtin="False"><a href="/dsl/rsync">RSync</a></li> <li data-name="Sample" data-builtin="False"><a href="/dsl/sample">Sample</a></li> <li data-name="Scripty" data-builtin="False"><a href="/dsl/scripty">Scripty</a></li> <li data-name="Security" data-builtin="True"><a href="/dsl/security">Security</a></li> <li data-name="Semantic Versioning" data-builtin="False"><a href="/dsl/semantic-versioning">Semantic Versioning</a></li> <li data-name="SendGrid" data-builtin="False"><a href="/dsl/sendgrid">SendGrid</a></li> <li data-name="Services" data-builtin="False"><a href="/dsl/services">Services</a></li> <li data-name="SFTP" data-builtin="False"><a href="/dsl/sftp">SFTP</a></li> <li data-name="SharePoint" data-builtin="False"><a href="/dsl/sharepoint">SharePoint</a></li> <li data-name="Signing" data-builtin="True"><a href="/dsl/signing">Signing</a></li> <li data-name="SitecoreCodegen" data-builtin="False"><a href="/dsl/sitecorecodegen">SitecoreCodegen</a></li> <li data-name="Slack" data-builtin="False"><a href="/dsl/slack">Slack</a></li> <li data-name="SmartAssembly" data-builtin="False"><a href="/dsl/smartassembly">SmartAssembly</a></li> <li data-name="SonarQube" data-builtin="False"><a href="/dsl/sonarqube">SonarQube</a></li> <li data-name="SpecFlow" data-builtin="True"><a href="/dsl/specflow">SpecFlow</a></li> <li data-name="SqlPackage" data-builtin="False"><a href="/dsl/sqlpackage">SqlPackage</a></li> <li data-name="SqlServer" data-builtin="False"><a href="/dsl/sqlserver">SqlServer</a></li> <li data-name="SqlTools" data-builtin="False"><a href="/dsl/sqltools">SqlTools</a></li> <li data-name="Squirrel" data-builtin="False"><a href="/dsl/squirrel">Squirrel</a></li> <li data-name="SSRS" data-builtin="False"><a href="/dsl/ssrs">SSRS</a></li> <li data-name="Storyteller" data-builtin="False"><a href="/dsl/storyteller">Storyteller</a></li> <li data-name="Strong Naming" data-builtin="False"><a href="/dsl/strong-naming">Strong Naming</a></li> <li data-name="StrongNameSigner" data-builtin="False"><a href="/dsl/strongnamesigner">StrongNameSigner</a></li> <li data-name="Stylecop" data-builtin="False"><a href="/dsl/stylecop">Stylecop</a></li> <li data-name="Svn" data-builtin="False"><a href="/dsl/svn">Svn</a></li> <li data-name="Swagger" data-builtin="False"><a href="/dsl/swagger">Swagger</a></li> <li data-name="Systemctl" data-builtin="False"><a href="/dsl/systemctl">Systemctl</a></li> <li data-name="TalendAdminApi" data-builtin="False"><a href="/dsl/talendadminapi">TalendAdminApi</a></li> <li data-name="TalendCommandLine" data-builtin="False"><a href="/dsl/talendcommandline">TalendCommandLine</a></li> <li data-name="Terraform" data-builtin="False"><a href="/dsl/terraform">Terraform</a></li> <li data-name="Testing" data-builtin="False"><a href="/dsl/testing">Testing</a></li> <li data-name="Text" data-builtin="True"><a href="/dsl/text">Text</a></li> <li data-name="Tfs" data-builtin="False"><a href="/dsl/tfs">Tfs</a></li> <li data-name="TfsBuildVariables" data-builtin="False"><a href="/dsl/tfsbuildvariables">TfsBuildVariables</a></li> <li data-name="Tfx" data-builtin="False"><a href="/dsl/tfx">Tfx</a></li> <li data-name="Topshelf" data-builtin="False"><a href="/dsl/topshelf">Topshelf</a></li> <li data-name="TravisCI" data-builtin="False"><a href="/dsl/travisci">TravisCI</a></li> <li data-name="Twitter" data-builtin="False"><a href="/dsl/twitter">Twitter</a></li> <li data-name="Unity" data-builtin="False"><a href="/dsl/unity">Unity</a></li> <li data-name="Unity3D" data-builtin="False"><a href="/dsl/unity3d">Unity3D</a></li> <li data-name="Vagrant" data-builtin="False"><a href="/dsl/vagrant">Vagrant</a></li> <li data-name="VariableManager" data-builtin="False"><a href="/dsl/variablemanager">VariableManager</a></li> <li data-name="Version Reader" data-builtin="False"><a href="/dsl/version-reader">Version Reader</a></li> <li data-name="Vsce" data-builtin="False"><a href="/dsl/vsce">Vsce</a></li> <li data-name="VsMetrics" data-builtin="False"><a href="/dsl/vsmetrics">VsMetrics</a></li> <li data-name="VSTest" data-builtin="True"><a href="/dsl/vstest">VSTest</a></li> <li data-name="VSWhere" data-builtin="True"><a href="/dsl/vswhere">VSWhere</a></li> <li data-name="Vulnerabilities" data-builtin="False"><a href="/dsl/vulnerabilities">Vulnerabilities</a></li> <li data-name="Watch" data-builtin="False"><a href="/dsl/watch">Watch</a></li> <li data-name="WebDeploy" data-builtin="False"><a href="/dsl/webdeploy">WebDeploy</a></li> <li data-name="Webpack" data-builtin="False"><a href="/dsl/webpack">Webpack</a></li> <li data-name="WindowsAppStore" data-builtin="False"><a href="/dsl/windowsappstore">WindowsAppStore</a></li> <li data-name="WiX" data-builtin="True"><a href="/dsl/wix">WiX</a></li> <li data-name="Wyam2" data-builtin="False"><a href="/dsl/wyam2">Wyam2</a></li> <li data-name="Xamarin" data-builtin="False"><a href="/dsl/xamarin">Xamarin</a></li> <li data-name="Xamarin Binding Utilities" data-builtin="False"><a href="/dsl/xamarin-binding-utilities">Xamarin Binding Utilities</a></li> <li data-name="XBuild" data-builtin="True"><a href="/dsl/xbuild">XBuild</a></li> <li data-name="XCBuild" data-builtin="False"><a href="/dsl/xcbuild">XCBuild</a></li> <li data-name="XCode" data-builtin="False"><a href="/dsl/xcode">XCode</a></li> <li data-name="XCPath" data-builtin="False"><a href="/dsl/xcpath">XCPath</a></li> <li data-name="XCRuntime" data-builtin="False"><a href="/dsl/xcruntime">XCRuntime</a></li> <li data-name="XCStudio" data-builtin="False"><a href="/dsl/xcstudio">XCStudio</a></li> <li data-name="XDT" data-builtin="False"><a href="/dsl/xdt">XDT</a></li> <li data-name="XML" data-builtin="True"><a href="/dsl/xml">XML</a></li> <li data-name="XmlDocMarkdown" data-builtin="False"><a href="/dsl/xmldocmarkdown">XmlDocMarkdown</a></li> <li data-name="xUnit" data-builtin="True"><a href="/dsl/xunit">xUnit</a></li> <li data-name="xUnit v2" data-builtin="True"><a href="/dsl/xunit-v2">xUnit v2</a></li> <li data-name="Yaml" data-builtin="False"><a href="/dsl/yaml">Yaml</a></li> <li data-name="Yarn" data-builtin="False"><a href="/dsl/yarn">Yarn</a></li> <li data-name="Yeoman" data-builtin="False"><a href="/dsl/yeoman">Yeoman</a></li> </ul> </div> </li> <link href="//cdn.jsdelivr.net/gh/gitbrent/bootstrap4-toggle@3.6.1/css/bootstrap4-toggle.min.css" rel="stylesheet"> <script src="//cdn.jsdelivr.net/gh/gitbrent/bootstrap4-toggle@3.6.1/js/bootstrap4-toggle.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.js"></script> <script> function showAddinAliases() { // Show categories which only contain aliases from addins categoryList.filter(); // List aliases from addins $('div .addinAliases').fadeIn(); $.AdminLTE.layout.fix(); } function hideAddinAliases() { // Hide categories which only contain aliases from addins categoryList.filter(function(item) { return (item.values().builtin == "True"); }); // Hide aliases from addins $('div .addinAliases').fadeOut(); $.AdminLTE.layout.fix(); } function setAddinAliasesVisibility(visible) { visible ? showAddinAliases() : hideAddinAliases(); } // Initialize list.js var options = { valueNames: [ { data: ['name'] }, { data: ['builtin'] } ] }; var categoryList = new List('aliasCategories', options); var $showAddinAliases = $('.showAddinAliases'); $showAddinAliases.on('change', function() { sessionStorage.showAddinAliases = this.checked; setAddinAliasesVisibility(this.checked); }); // Read initial state for filter from storage. // If currenty category contains only aliases from addins we ignore state (e.g. when direct link to addin category, but toggle previously disabled) var isCategoryFromAddin = false $showAddinAliases.prop('checked', isCategoryFromAddin || (( typeof sessionStorage.showAddinAliases !== 'undefined' ) ? (sessionStorage.showAddinAliases === 'true') : true )); $( document ).ready(function() { setAddinAliasesVisibility($showAddinAliases.prop('checked')); $('.sidebar-menu').show(); $.AdminLTE.layout.fix(); }); </script> </ul> </section> </aside>  <div class="content-wrapper"> <section class="content-header"> <h1>Reference</h1> </section> <section class="content"> <p> This reference guide describes the various methods and properties which make up the Cake build language, or DSL. </p> <p> The DSL is made up of <a href="/docs/fundamentals/aliases">script aliases</a>, that offers specific functionality within the context of a Cake build script. </p> <p> Listed are aliases which are shipped with Cake, but also aliases which are part of community maintained <a href="/extensions">addins</a>. </p> <p> <input type="text" class="form-control" id="search-query-dsl" placeholder="Search aliases" autocomplete="off" autofocus> </p> <script type="text/javascript"> docsearch({ apiKey: '7c45d75e5cd2fddcb761d830d2b8ee27', indexName: 'cakebuild', inputSelector: '#search-query-dsl', debug: false, algoliaOptions: { facetFilters: ["tags:dsl"], hitsPerPage: 10 } }); </script> </section> </div>  <footer class="main-footer"> </footer> </div> <div class="wrapper bottom-wrapper"> <footer class="bottom-footer"> <p class="text-muted"> <a href="https://github.com/cake-build/cake" target="_blank" title="Cake on GitHub"><i class="fa-brands fa-github"></i> GitHub</a> | <a href="https://x.com/cakebuildnet" target="_blank" title="Cake on X"><i class="fa-brands fa-x-twitter"></i></a> | <a href="https://dotnet.social/@cakebuild" target="_blank" title="Cake in the Fediverse (Mastodon)"><i class="fa-brands fa-mastodon"></i></a> | <a href="https://bsky.app/profile/cakebuild.net" title="Cake on Bluesky" target="_blank"><i class="fa-brands fa-bluesky"></i></a> <br/> Copyright © <a href="http://dotnetfoundation.org" target="_blank">.NET Foundation</a> and contributors. <br/> Generated by <a href="https://github.com/Wyamio/Wyam" target="_blank">Wyam</a> </p> </footer> </div> <a href="javascript:" id="return-to-top"><i class="fa fa-chevron-up"></i></a>  <script type="text/javascript"> docsearch({ apiKey: '7c45d75e5cd2fddcb761d830d2b8ee27', indexName: 'cakebuild', inputSelector: '#search-query', debug: false, algoliaOptions: { hitsPerPage: 10 } }); </script>  <script> $(function () { $('[data-toggle="tooltip"]').tooltip() }) </script>  <script> // Allow to set ".no-anchor" class to not have an anchor on an element. anchors.add('.content h1:not(.no-anchor), .content h2:not(.no-anchor), .content h3:not(.no-anchor), .content h4:not(.no-anchor)'); </script>  <script type="text/javascript" src="/assets/js/clipboard.min.js"></script> <script type="text/javascript"> var snippets = document.querySelectorAll("pre > code"); [].forEach.call(snippets, function(snippet) { snippet.insertAdjacentHTML("beforebegin", "<button class='btn-copy' data-clipboard-snippet><img class='clippy' width=13 src='/assets/img/clippy.svg' alt='Copy to clipboard'></button>"); }); var clipboardSnippets = new Clipboard('[data-clipboard-snippet]', { target: function(trigger) { return trigger.nextElementSibling; } }); clipboardSnippets.on('success', function(e) { e.clearSelection(); showTooltip(e.trigger, "Copied!"); }); clipboardSnippets.on('error', function(e) { showTooltip(e.trigger, fallbackMessage(e.action)); }); var btns = document.querySelectorAll('.btn-copy'); for (var i = 0; i < btns.length; i++) { btns[i].addEventListener('mouseleave', function(e) { e.currentTarget.setAttribute('class', 'btn-copy'); e.currentTarget.removeAttribute('aria-label'); }); } function showTooltip(elem, msg) { elem.setAttribute('class', 'btn-copy tooltipped tooltipped-s'); elem.setAttribute('aria-label', msg); } function fallbackMessage(action) { var actionMsg = ''; var actionKey = (action === 'cut' ? 'X' : 'C'); if (/iPhone|iPad/i.test(navigator.userAgent)) { actionMsg = 'No support :('; } else if (/Mac/i.test(navigator.userAgent)) { actionMsg = 'Press ⌘-' + actionKey + ' to ' + action; } else { actionMsg = 'Press Ctrl-' + actionKey + ' to ' + action; } return actionMsg; } </script> <script> // Close the sidebar if we select an anchor link $(".main-sidebar a[href^='#']:not('.expand')").click(function(){ $(document.body).removeClass('sidebar-open'); }); $(document).ready(function() { mermaid.initialize( { flowchart: { useMaxWidth: false }, startOnLoad: false, cloneCssStyles: false }); mermaid.init(undefined, ".mermaid"); // Remove the max-width setting that Mermaid sets var mermaidSvg = $('.mermaid svg'); mermaidSvg.addClass('img-responsive'); mermaidSvg.css('max-width', ''); // Make it scrollable var target = document.querySelector(".mermaid svg"); if(target !== null) { var panZoom = window.panZoom = svgPanZoom(target, { zoomEnabled: true, controlIconsEnabled: true, fit: true, center: true, maxZoom: 20, zoomScaleSensitivity: 0.6 }); // Do the reset once right away to fit the diagram panZoom.resize(); panZoom.fit(); panZoom.center(); $(window).resize(function(){ panZoom.resize(); panZoom.fit(); panZoom.center(); }); } $('pre code').each(function(i, block) { hljs.highlightBlock(block); }); }); hljs.initHighlightingOnLoad(); // Back to top $(window).scroll(function() { if ($(this).scrollTop() >= 200) { // If page is scrolled more than 50px $('#return-to-top').fadeIn(1000); // Fade in the arrow } else { $('#return-to-top').fadeOut(1000); // Else fade out the arrow } }); $('#return-to-top').click(function() { // When arrow is clicked $('body,html').animate({ scrollTop : 0 // Scroll to top of body }, 500); }); </script> </body> </html>

CINXE.COM

Cake - Reference