# CircleCI Documentation

> Official technical documentation for CircleCI, a continuous integration and delivery platform

> Generated: 2026-10-16T19:08:56.676Z

## Site Information

- URL: https://circleci.com/docs
- Repository: https://github.com/circleci/circleci-docs

## Markdown Exports

All documentation pages are available in markdown format for easier parsing and processing.

### How to Access Markdown Versions

1. **Direct URL conversion**: Replace the HTML page URL with `/index.md`
   - HTML: https://circleci.com/docs/guides/getting-started/first-steps/
   - Markdown: https://circleci.com/docs/guides/getting-started/first-steps/index.md

2. **Inline links in this file**: Each page listing below includes a [md] link
   - Example: Page Title (https://circleci.com/docs/page/) [md](https://circleci.com/docs/page/index.md)

3. **HTML metadata**: Each page includes `<link rel="alternate" type="text/markdown" href="index.md">` in the HTML head

### About This File (llms.txt)

- **Location**: https://circleci.com/docs/llms.txt
- **Purpose**: Provides LLMs with complete site structure, navigation, and page descriptions
- **Updates**: Automatically regenerated on each deployment
- **Discovery**: Announced via `<link rel="alternate" type="text/plain" href="/docs/llms.txt">` in page headers
- **Sitemap**: Listed in https://circleci.com/docs/sitemap-llms.xml

## How to use these docs

If you are an AI agent, read [AGENTS.md](https://circleci.com/docs/AGENTS.md) first. It has current defaults, deprecated patterns, and the differences between Cloud and Server.

For humans, or for which guide to open first, start with the [Quickstart guide](https://circleci.com/docs/guides/getting-started/getting-started/) [md](https://circleci.com/docs/guides/getting-started/getting-started/index.md).

For API work, fetch the OpenAPI specification. Do not infer request or response shapes from prose guides.

- OpenAPI (canonical): https://circleci.com/fullopenapi.yaml
- API v3 index: https://circleci.com/docs/api/v3/llms.txt
- Conventions: https://circleci.com/docs/api/v3/conventions.md


## Documentation Structure

This documentation is organized into the following Antora components:

### Guides ()
- Start: https://circleci.com/docs/guides/getting-started/first-steps/
- About CircleCI
  - CircleCI overview (https://circleci.com/docs/guides/about-circleci/about-circleci/) [md](https://circleci.com/docs/guides/about-circleci/about-circleci/index.md)
    An overview of CircleCI, continuous integration and continuous delivery
  - Benefits of CircleCI (https://circleci.com/docs/guides/about-circleci/benefits-of-circleci/) [md](https://circleci.com/docs/guides/about-circleci/benefits-of-circleci/index.md)
    Find out why teams choose CircleCI for CI/CD, including fast jobs, caching and parallelism options, and pricing plans to suit your needs.
  - Intro to the CircleCI web app (https://circleci.com/docs/guides/about-circleci/introduction-to-the-circleci-web-app/) [md](https://circleci.com/docs/guides/about-circleci/introduction-to-the-circleci-web-app/index.md)
    This document describes the basic features and settings available in the CircleCI web app.
  - Open source acknowledgements (https://circleci.com/docs/guides/about-circleci/open-source/) [md](https://circleci.com/docs/guides/about-circleci/open-source/index.md)
    List and acknowledgements for open-source projects and libraries that are used in CircleCI products and services.
- Getting started
  - First steps
    - Sign up and try CircleCI (https://circleci.com/docs/guides/getting-started/first-steps/) [md](https://circleci.com/docs/guides/getting-started/first-steps/index.md)
      Sign up for CircleCI in the web app or with the CLI, then create an organization for your team or join teammates who already use CircleCI.
    - Create an organization (https://circleci.com/docs/guides/getting-started/create-an-organization/) [md](https://circleci.com/docs/guides/getting-started/create-an-organization/index.md)
      Create a new organization in CircleCI, the top-level container for your team's projects, users, permissions, settings, and billing.
    - Invite your team (https://circleci.com/docs/guides/getting-started/invite-your-team/) [md](https://circleci.com/docs/guides/getting-started/invite-your-team/index.md)
      Invite teammates to your CircleCI organization and assign them roles so your whole team gets access.
    - Create a project (https://circleci.com/docs/guides/getting-started/create-project/) [md](https://circleci.com/docs/guides/getting-started/create-project/index.md)
      Create a project in CircleCI to give CircleCI access to the code in your repository, so it can check out that code and run pipelines against it.
    - Quickstart guide (https://circleci.com/docs/guides/getting-started/getting-started/) [md](https://circleci.com/docs/guides/getting-started/getting-started/index.md)
      A quickstart guide for adding a project to CircleCI and exploring some features
  - How-to guides
    - Hello World (https://circleci.com/docs/guides/getting-started/hello-world/) [md](https://circleci.com/docs/guides/getting-started/hello-world/index.md)
      Get started with CircleCI by printing Hello World in any execution environment.
    - Intro to YAML configuration (https://circleci.com/docs/guides/getting-started/introduction-to-yaml-configurations/) [md](https://circleci.com/docs/guides/getting-started/introduction-to-yaml-configurations/index.md)
      Get an overview of CircleCI configuration written in YAML, including the CircleCI version, execution environment, jobs, and workflows.
    - In-app config editor (https://circleci.com/docs/guides/getting-started/config-editor/) [md](https://circleci.com/docs/guides/getting-started/config-editor/index.md)
      Edit your CircleCI configuration files in the web app with the in-app configuration editor, which offers auto-completion and a save and run option.
    - Node.js quickstart (https://circleci.com/docs/guides/getting-started/language-javascript/) [md](https://circleci.com/docs/guides/getting-started/language-javascript/index.md)
      Build and test a Node.js application on CircleCI. Follow a configuration walkthrough to create a basic config.yml file for your JavaScript project.
    - Python quickstart (https://circleci.com/docs/guides/getting-started/language-python/) [md](https://circleci.com/docs/guides/getting-started/language-python/index.md)
      Set up continuous integration for a Python application on CircleCI. Follow a configuration walkthrough to create a basic config.yml file.
    - Go quickstart (https://circleci.com/docs/guides/getting-started/language-go/) [md](https://circleci.com/docs/guides/getting-started/language-go/index.md)
      Set up a Go project with CircleCI. Follow a configuration walkthrough to create a basic config.yml file that builds, tests, and deploys your project.
  - Tutorials
    - Configuration intro (https://circleci.com/docs/guides/getting-started/config-intro/) [md](https://circleci.com/docs/guides/getting-started/config-intro/index.md)
      Get started with the CircleCI config.yml file by using the shell, running code from your repository, creating workflows, and adding a manual approval.
- Migrate to CircleCI
  - Migration intro (https://circleci.com/docs/guides/migrate/migration-intro/) [md](https://circleci.com/docs/guides/migrate/migration-intro/index.md)
    This document provides an overview of the stages required to migrate your CI/CD pipelines to CircleCI.
  - Migrate from AWS (https://circleci.com/docs/guides/migrate/migrating-from-aws/) [md](https://circleci.com/docs/guides/migrate/migrating-from-aws/index.md)
    This document provides an overview of how to migrate from AWS CodeCommit to CircleCI.
  - Migrate from Azure DevOps (https://circleci.com/docs/guides/migrate/migrating-from-azuredevops/) [md](https://circleci.com/docs/guides/migrate/migrating-from-azuredevops/index.md)
    Migrate from Azure DevOps to CircleCI, including source control setup and a side-by-side comparison of build configuration syntax.
  - Migrate from Buildkite (https://circleci.com/docs/guides/migrate/migrating-from-buildkite/) [md](https://circleci.com/docs/guides/migrate/migrating-from-buildkite/index.md)
    Migrate from Buildkite to CircleCI, with guidance on source control setup and a side-by-side comparison of build configuration syntax.
  - Migrate from GitHub (https://circleci.com/docs/guides/migrate/migrating-from-github/) [md](https://circleci.com/docs/guides/migrate/migrating-from-github/index.md)
    Migrate from GitHub Actions to CircleCI. Compare jobs and workflows, actions and orbs, runners and executors, and configuration syntax.
  - Use a GitHub Actions workflow file as your pipeline configuration (https://circleci.com/docs/guides/orchestrate/use-a-github-actions-workflow-file-as-your-pipeline-configuration/) [md](https://circleci.com/docs/guides/orchestrate/use-a-github-actions-workflow-file-as-your-pipeline-configuration/index.md)
    Set up a CircleCI pipeline that runs an existing GitHub Actions workflow file, and check which GitHub Actions features are supported.
  - Migrate from GitLab (https://circleci.com/docs/guides/migrate/migrating-from-gitlab/) [md](https://circleci.com/docs/guides/migrate/migrating-from-gitlab/index.md)
    Move your CI/CD from GitLab to CircleCI. Sign up, then compare your GitLab configuration with the equivalent CircleCI configuration.
  - Migrate from Jenkins (https://circleci.com/docs/guides/migrate/migrating-from-jenkins/) [md](https://circleci.com/docs/guides/migrate/migrating-from-jenkins/index.md)
    Key differences between Jenkins and CircleCI for migration, covering job configuration, plugins, distributed builds, containers and parallelism.
  - Migrate from TeamCity (https://circleci.com/docs/guides/migrate/migrating-from-teamcity/) [md](https://circleci.com/docs/guides/migrate/migrating-from-teamcity/index.md)
    Migrate from TeamCity to CircleCI. Compare concepts and configuration, including environments, steps, build templates and complex builds.
  - Migrate from Travis CI (https://circleci.com/docs/guides/migrate/migrating-from-travis/) [md](https://circleci.com/docs/guides/migrate/migrating-from-travis/index.md)
    Migrate from Travis CI to CircleCI, covering configuration files, caching dependencies, environment variables and uploading artifacts.
- Orchestrate
  - Set up pipelines and workflows
    - Pipeline overview and setup (https://circleci.com/docs/guides/orchestrate/pipelines/) [md](https://circleci.com/docs/guides/orchestrate/pipelines/index.md)
      This document introduces the concept of pipelines and shows how pipelines can be triggered and what they include.
    - Jobs and steps overview (https://circleci.com/docs/guides/orchestrate/jobs-steps/) [md](https://circleci.com/docs/guides/orchestrate/jobs-steps/index.md)
      Get an overview of CircleCI jobs and steps, including how to pass parameters to jobs and use jobs and commands from orbs.
    - Workflow orchestration (https://circleci.com/docs/guides/orchestrate/workflows/) [md](https://circleci.com/docs/guides/orchestrate/workflows/index.md)
      Use CircleCI workflows to orchestrate jobs: control which jobs run, in what order, and under what conditions, with approvals, filters, and schedules.
    - Pipeline values and parameters (https://circleci.com/docs/guides/orchestrate/pipeline-variables/) [md](https://circleci.com/docs/guides/orchestrate/pipeline-variables/index.md)
      Learn about pipeline values and pipeline parameters, and how to use them in your CircleCI configuration.
    - Config templating (https://circleci.com/docs/guides/orchestrate/config-templating/) [md](https://circleci.com/docs/guides/orchestrate/config-templating/index.md)
      Use compile-time config templating to insert pipeline values and parameters into your CircleCI configuration.
    - Use a GitHub Actions workflow file as your pipeline configuration (https://circleci.com/docs/guides/orchestrate/use-a-github-actions-workflow-file-as-your-pipeline-configuration/) [md](https://circleci.com/docs/guides/orchestrate/use-a-github-actions-workflow-file-as-your-pipeline-configuration/index.md)
      Set up a CircleCI pipeline that runs an existing GitHub Actions workflow file, and check which GitHub Actions features are supported.
  - Trigger and schedule pipelines
    - Trigger options (https://circleci.com/docs/guides/orchestrate/triggers-overview/) [md](https://circleci.com/docs/guides/orchestrate/triggers-overview/index.md)
      Explore the ways to trigger pipelines in CircleCI, from repository events and custom webhooks to the web app, the API, and schedules.
    - Set up triggers (https://circleci.com/docs/guides/orchestrate/set-up-triggers/) [md](https://circleci.com/docs/guides/orchestrate/set-up-triggers/index.md)
      Set up triggers for your pipelines. Triggers are rules that determine when to automatically run a pipeline based on specific events and conditions.
    - GitHub trigger event options (https://circleci.com/docs/guides/orchestrate/github-trigger-event-options/) [md](https://circleci.com/docs/guides/orchestrate/github-trigger-event-options/index.md)
      A guide to the options available for triggering GitHub App pipelines. Trigger pipelines on non-push events.
    - GitLab trigger options (https://circleci.com/docs/guides/orchestrate/gitlab-trigger-options/) [md](https://circleci.com/docs/guides/orchestrate/gitlab-trigger-options/index.md)
      Use GitLab trigger filters to decide when a trigger starts a build, choosing from common options or building your own rules with a custom filter.
    - Cursor Origin trigger event options (https://circleci.com/docs/guides/orchestrate/cursor-origin-trigger-event-options/) [md](https://circleci.com/docs/guides/orchestrate/cursor-origin-trigger-event-options/index.md)
      A guide to the options available for triggering Cursor Origin pipelines. Trigger pipelines on pushes, tags, and pull request events.
    - Custom webhooks (https://circleci.com/docs/guides/orchestrate/custom-webhooks/) [md](https://circleci.com/docs/guides/orchestrate/custom-webhooks/index.md)
      Use webhooks to integrate with third-party services and subscribe to CircleCI events
    - Schedule triggers (https://circleci.com/docs/guides/orchestrate/schedule-triggers/) [md](https://circleci.com/docs/guides/orchestrate/schedule-triggers/index.md)
      Use schedule triggers to run pipelines in your CircleCI projects periodically, and configure them in the web app or with the API.
    - Set up cross-repo triggers for library consumers (https://circleci.com/docs/guides/orchestrate/set-up-cross-repo-triggers-for-library-consumers/) [md](https://circleci.com/docs/guides/orchestrate/set-up-cross-repo-triggers-for-library-consumers/index.md)
      Learn how to automatically trigger consumer repository pipelines when you tag a new library release.
    - Migrate scheduled workflows to schedule triggers (https://circleci.com/docs/guides/orchestrate/migrate-scheduled-workflows-to-schedule-triggers/) [md](https://circleci.com/docs/guides/orchestrate/migrate-scheduled-workflows-to-schedule-triggers/index.md)
      Migrate your scheduled workflows to schedule triggers: find your schedule workflow, create the new trigger, and remove the triggers section.
    - Schedule triggers with multiple workflows (https://circleci.com/docs/guides/orchestrate/schedule-triggers-with-multiple-workflows/) [md](https://circleci.com/docs/guides/orchestrate/schedule-triggers-with-multiple-workflows/index.md)
      "Learn how to set conditionals for schedule triggers in multiple workflows."
    - Set a nightly schedule trigger (https://circleci.com/docs/guides/orchestrate/set-a-nightly-schedule-trigger/) [md](https://circleci.com/docs/guides/orchestrate/set-a-nightly-schedule-trigger/index.md)
      Create a schedule trigger that runs your pipeline at midnight every night. You can set the schedule in the CircleCI web app or with the API.
  - Control workflow execution
    - Automatic reruns (https://circleci.com/docs/guides/orchestrate/automatic-reruns/) [md](https://circleci.com/docs/guides/orchestrate/automatic-reruns/index.md)
      Configure automatic reruns for failed workflows to reduce manual intervention and improve pipeline reliability
    - Skip CI, auto-cancel, and block new pipelines (https://circleci.com/docs/guides/orchestrate/skip-build/) [md](https://circleci.com/docs/guides/orchestrate/skip-build/index.md)
      Skip CI builds, auto-cancel redundant workflows, and block new work for your CircleCI organization or project.
    - Controlling serial execution across your organization (https://circleci.com/docs/guides/orchestrate/controlling-serial-execution-across-your-organization/) [md](https://circleci.com/docs/guides/orchestrate/controlling-serial-execution-across-your-organization/index.md)
      Use serial groups to run CircleCI jobs one at a time across your organization, preventing conflicts when jobs access shared resources.
    - Branch and tag filtering (https://circleci.com/docs/guides/orchestrate/using-branch-filters/) [md](https://circleci.com/docs/guides/orchestrate/using-branch-filters/index.md)
      Control whether jobs, workflows, and steps run, based on the git branch or tag, using workflow filters or expression-based conditions.
    - Select a workflow to run using pipeline parameters (https://circleci.com/docs/guides/orchestrate/selecting-a-workflow-to-run-using-pipeline-parameters/) [md](https://circleci.com/docs/guides/orchestrate/selecting-a-workflow-to-run-using-pipeline-parameters/index.md)
      "A how-to guide for selecting a workflow to run using pipeline parameters."
    - Notify a Slack channel of a paused workflow (https://circleci.com/docs/guides/orchestrate/notify-a-slack-channel-of-a-paused-workflow/) [md](https://circleci.com/docs/guides/orchestrate/notify-a-slack-channel-of-a-paused-workflow/index.md)
      Use the CircleCI Slack integration to notify a channel when a workflow is held for approval, and approve held workflows directly from Slack.
  - Share data
    - Use workspaces to share data between jobs (https://circleci.com/docs/guides/orchestrate/workspaces/) [md](https://circleci.com/docs/guides/orchestrate/workspaces/index.md)
      This document describes how to use workspaces to share data to downstream jobs in your workflows.
  - Advanced configuration
    - Orchestration cookbook (https://circleci.com/docs/guides/orchestrate/orchestration-cookbook/) [md](https://circleci.com/docs/guides/orchestrate/orchestration-cookbook/index.md)
      A cookbook of common pipeline, workflow and job execution goals and patterns
    - Dynamic configuration overview (https://circleci.com/docs/guides/orchestrate/dynamic-config/) [md](https://circleci.com/docs/guides/orchestrate/dynamic-config/index.md)
      Get an overview of CircleCI dynamic configuration, which lets you generate or assemble configuration at runtime to match your project's needs.
    - Using dynamic configuration (https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/) [md](https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/index.md)
      Follow examples of CircleCI dynamic configuration, such as passing parameters to a continuation workflow and running work based on modified files.
    - Override configuration (https://circleci.com/docs/guides/orchestrate/how-to-override-config/) [md](https://circleci.com/docs/guides/orchestrate/how-to-override-config/index.md)
      Learn how to use the override-with key in CircleCI to standardize pipelines across your organization while maintaining team flexibility.
    - Set up multiple configuration files for a project (https://circleci.com/docs/guides/orchestrate/set-up-multiple-configuration-files-for-a-project/) [md](https://circleci.com/docs/guides/orchestrate/set-up-multiple-configuration-files-for-a-project/index.md)
      A step by step guide for setting up multiple pipelines, each defined in a separate configuration file, in a CircleCI project.
    - Configure databases (https://circleci.com/docs/guides/orchestrate/databases/) [md](https://circleci.com/docs/guides/orchestrate/databases/index.md)
      This document describes how to use the official CircleCI pre-built Docker container images for a database service in CircleCI.
    - Migrate from deploy to run (https://circleci.com/docs/guides/orchestrate/migrate-from-deploy-to-run/) [md](https://circleci.com/docs/guides/orchestrate/migrate-from-deploy-to-run/index.md)
      A how-to guide on how to migrage from the deprecated deploy step to run.
    - Using shell scripts (https://circleci.com/docs/guides/orchestrate/using-shell-scripts/) [md](https://circleci.com/docs/guides/orchestrate/using-shell-scripts/index.md)
      Best practices for using shell scripts for use in CircleCI configuration
- Execution environments
  - Overview
    - Execution environments overview (https://circleci.com/docs/guides/execute/executor-intro/) [md](https://circleci.com/docs/guides/execute/executor-intro/index.md)
      Compare the CircleCI execution environments: Docker, Linux VM, macOS, Windows, GPU, and Arm VM, and learn how images and resource classes apply.
    - Resource class overview (https://circleci.com/docs/guides/execute/resource-class-overview/) [md](https://circleci.com/docs/guides/execute/resource-class-overview/index.md)
      Learn how to use resource classes in CircleCI to specify compute resources for jobs, configure self-hosted runners, and choose execution environments.
    - Resource class lifecycle (https://circleci.com/docs/guides/execute/resource-class-lifecycle/) [md](https://circleci.com/docs/guides/execute/resource-class-lifecycle/index.md)
      Find out how CircleCI deprecates and retires resource classes, what happens during a brownout, and how you can respond by updating your configuration.
  - Docker
    - Using Docker (https://circleci.com/docs/guides/execute/using-docker/) [md](https://circleci.com/docs/guides/execute/using-docker/index.md)
      Learn how to configure your jobs to run in the Docker execution environment
    - Convenience images (https://circleci.com/docs/guides/execute/circleci-images/) [md](https://circleci.com/docs/guides/execute/circleci-images/index.md)
      Find pre-built Docker convenience images maintained by CircleCI, with best practices for pinning images and a listing by language, service, and tag.
    - Migrating to next-gen images (https://circleci.com/docs/guides/execute/next-gen-migration-guide/) [md](https://circleci.com/docs/guides/execute/next-gen-migration-guide/index.md)
      Migrate from legacy CircleCI convenience images to next-gen images by switching from the circleci namespace to cimg, with notes on browser testing.
    - Using custom-built Docker images (https://circleci.com/docs/guides/execute/custom-images/) [md](https://circleci.com/docs/guides/execute/custom-images/index.md)
      Create a custom Docker image for your CircleCI jobs when convenience images do not suit your needs, then build it and store it in a Docker registry.
    - Docker authenticated pulls (https://circleci.com/docs/guides/execute/private-images/) [md](https://circleci.com/docs/guides/execute/private-images/index.md)
      This document describes how to authenticate with your Docker registry provider to pull images.
    - Running Docker commands (https://circleci.com/docs/guides/execute/building-docker-images/) [md](https://circleci.com/docs/guides/execute/building-docker-images/index.md)
      Build Docker images and run Docker commands within the Docker execution environment using remote Docker and the setup_remote_docker key.
  - Linux VM
    - Using the Linux VM execution environment (https://circleci.com/docs/guides/execute/using-linuxvm/) [md](https://circleci.com/docs/guides/execute/using-linuxvm/index.md)
      Learn how to configure your jobs to run in the Linux VM execution environment using the machine executor.
    - Using Android images with the machine executor (https://circleci.com/docs/guides/execute/android-machine-image/) [md](https://circleci.com/docs/guides/execute/android-machine-image/index.md)
      Use the Android machine image on the Linux machine executor with the Android orb or manual configuration, and review resource classes and preinstalled tools.
  - macOS
    - Using the macOS execution environment (https://circleci.com/docs/guides/execute/using-macos/) [md](https://circleci.com/docs/guides/execute/using-macos/index.md)
      "Learn how to configure a your jobs to run in the macOS execution environment."
    - Configuring a macOS app (https://circleci.com/docs/guides/execute/hello-world-macos/) [md](https://circleci.com/docs/guides/execute/hello-world-macos/index.md)
      Get started with CI/CD on the macOS execution environment by walking through an example application and configuration file for your first macOS project.
    - iOS and macOS code signing (https://circleci.com/docs/guides/execute/ios-codesigning/) [md](https://circleci.com/docs/guides/execute/ios-codesigning/index.md)
      Set up code signing for iOS and macOS projects on CircleCI using the code signing API to upload certificates and profiles, or use Fastlane Match.
  - Windows
    - Using the Windows execution environment (https://circleci.com/docs/guides/execute/using-windows/) [md](https://circleci.com/docs/guides/execute/using-windows/index.md)
      Learn how to configure a your jobs to run in the Windows execution environment.
    - Hello world Windows (https://circleci.com/docs/guides/execute/hello-world-windows/) [md](https://circleci.com/docs/guides/execute/hello-world-windows/index.md)
      Get started with continuous integration on the Windows execution environment by setting up your first Windows project with an example application.
  - Arm
    - Using the Arm VM execution environment (https://circleci.com/docs/guides/execute/using-arm/) [md](https://circleci.com/docs/guides/execute/using-arm/index.md)
      Learn how to configure a your jobs to run in the Arm VM execution environment.
  - GPU
    - Using the GPU execution environment (https://circleci.com/docs/guides/execute/using-gpu/) [md](https://circleci.com/docs/guides/execute/using-gpu/index.md)
      Learn how to configure a your jobs to run in the GPU execution environment.
  - Self-hosted runners
    - Run jobs on self-hosted runners (https://circleci.com/docs/guides/execute/run-jobs-on-self-hosted-runners/) [md](https://circleci.com/docs/guides/execute/run-jobs-on-self-hosted-runners/index.md)
      Send CircleCI jobs to self-hosted runners that your admin has set up, using a runner resource class with the machine or Docker executor.
    - Self-hosted runner overview (https://circleci.com/docs/runner/runner-overview/) [md](https://circleci.com/docs/runner/runner-overview/index.md)
      Learn how CircleCI's self-hosted runners enable you to use your own infrastructure for running jobs.
    - Runner feature comparison matrix (https://circleci.com/docs/runner/runner-feature-comparison-matrix/) [md](https://circleci.com/docs/runner/runner-feature-comparison-matrix/index.md)
      Compare the features of CircleCI machine runner and container runner, see the key differences, and decide which runner to choose for your jobs.
  - How-to guides
    - Pull an image from AWS ECR with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/index.md)
      Configure a Docker job to pull an image from AWS ECR using OIDC authentication. Set up an IAM role, then update your config to pull the image.
    - Pull an image from GCP Artifact Registry with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/index.md)
      Learn how to pull an image from GCP Artifact Registry using OIDC authentication
    - Installing and using Docker Compose (https://circleci.com/docs/guides/execute/docker-compose/) [md](https://circleci.com/docs/guides/execute/docker-compose/index.md)
      Install and use Docker Compose in your CircleCI pipelines with the machine executor or the Docker executor and remote Docker, and review its limitations.
    - Debugging container ID cannot be mapped to host ID error (https://circleci.com/docs/guides/execute/high-uid-error/) [md](https://circleci.com/docs/guides/execute/high-uid-error/index.md)
      Debugging 'Container ID XXX cannot be mapped to a host ID' error when starting a container
    - Migrating between the Docker machine executors (https://circleci.com/docs/guides/execute/docker-to-machine/) [md](https://circleci.com/docs/guides/execute/docker-to-machine/index.md)
      Best practices and considerations when migrating your executor from Docker to machine
  - Image support policies
    - Android images support policy (https://circleci.com/docs/guides/execute/android-images-support-policy/) [md](https://circleci.com/docs/guides/execute/android-images-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating Android images built for the machine executor.
    - Convenience images support policy (https://circleci.com/docs/guides/execute/convenience-images-support-policy/) [md](https://circleci.com/docs/guides/execute/convenience-images-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating the Docker convenience images published to the cimg namespace on Docker Hub.
    - Linux VM images support policy (https://circleci.com/docs/guides/execute/linux-vm-support-policy/) [md](https://circleci.com/docs/guides/execute/linux-vm-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating the Ubuntu-based Linux VM images built for the machine executor.
    - Linux CUDA images support policy (https://circleci.com/docs/guides/execute/linux-cuda-images-support-policy/) [md](https://circleci.com/docs/guides/execute/linux-cuda-images-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating Linux CUDA images used with the GPU executor.
    - Remote Docker images support policy (https://circleci.com/docs/guides/execute/remote-docker-images-support-policy/) [md](https://circleci.com/docs/guides/execute/remote-docker-images-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating the remote Docker images used by the setup_remote_docker feature.
    - Windows images support policy (https://circleci.com/docs/guides/execute/windows-images-support-policy/) [md](https://circleci.com/docs/guides/execute/windows-images-support-policy/index.md)
      Read the CircleCI policy for releasing, tagging, patching, and deprecating Windows Server images built for the Windows executor.
    - Xcode image policy (https://circleci.com/docs/guides/execute/xcode-policy/) [md](https://circleci.com/docs/guides/execute/xcode-policy/index.md)
      Read the CircleCI policy for releasing, retaining, patching, and deprecating Xcode images, including beta image support and macOS versions.
    - CircleCI image lifecycle: A complete guide (https://circleci.com/docs/guides/execute/machine-convenience-image-lifecycle/) [md](https://circleci.com/docs/guides/execute/machine-convenience-image-lifecycle/index.md)
      Understand how CircleCI deprecates machine and convenience images, how image brownouts work, and how you can minimize their impact on your jobs.
- Testing on CircleCI
  - Automated testing (https://circleci.com/docs/guides/test/test/) [md](https://circleci.com/docs/guides/test/test/index.md)
    An overview of running automated tests in CircleCI pipelines, storing test results, and choosing the right test tooling for your platform.
  - Upload test results (https://circleci.com/docs/guides/test/collect-test-data/) [md](https://circleci.com/docs/guides/test/collect-test-data/index.md)
    Upload test results with the store_test_results step to see them in CircleCI. Includes JUnit XML formatter setup and test runner examples by language.
  - Smarter Testing
    - Smarter Testing overview (https://circleci.com/docs/guides/test/smarter-testing-overview/) [md](https://circleci.com/docs/guides/test/smarter-testing-overview/index.md)
      Learn what Smarter Testing is, which capabilities are free and which have a credit charge, and the terms used across the Smarter Testing docs.
    - Get started with Smarter Testing (https://circleci.com/docs/guides/test/getting-started-with-smarter-testing/) [md](https://circleci.com/docs/guides/test/getting-started-with-smarter-testing/index.md)
      Set up circleci testsuite for Smarter Testing: configure test-suites.yml, validate it with the doctor command, and run your tests locally and in CI.
    - Use static test splitting (https://circleci.com/docs/guides/test/use-static-test-splitting/) [md](https://circleci.com/docs/guides/test/use-static-test-splitting/index.md)
      Split your tests across parallel nodes with the free, built-in static test splitting in Smarter Testing.
    - Rerun only failed tests (https://circleci.com/docs/guides/test/rerun-only-failed-tests/) [md](https://circleci.com/docs/guides/test/rerun-only-failed-tests/index.md)
      Rerun only the tests that failed when you rerun a workflow from failed. This free, built-in Smarter Testing capability needs no extra configuration.
    - Set up test impact analysis (https://circleci.com/docs/guides/test/set-up-test-impact-analysis/) [md](https://circleci.com/docs/guides/test/set-up-test-impact-analysis/index.md)
      Run only the tests impacted by your code changes. Set up test impact analysis in your test-suites.yml file to skip tests that cover unchanged files.
    - Set parallelism dynamically (https://circleci.com/docs/guides/test/set-parallelism-dynamically/) [md](https://circleci.com/docs/guides/test/set-parallelism-dynamically/index.md)
      Set a test job's parallelism when the pipeline runs, from the selected tests or a target duration for each node, with experimental dynamic parallelism.
    - Use dynamic test splitting (https://circleci.com/docs/guides/test/use-dynamic-test-splitting/) [md](https://circleci.com/docs/guides/test/use-dynamic-test-splitting/index.md)
      Distribute tests across parallel nodes so they all finish at the same time. Enable dynamic test splitting in your test-suites.yml file.
    - Auto rerun failed tests (https://circleci.com/docs/guides/test/auto-rerun-failed-tests/) [md](https://circleci.com/docs/guides/test/auto-rerun-failed-tests/index.md)
      Automatically detect and retry failed tests during a test run to reduce the impact of flaky tests. Enable the feature in your test-suites.yml file.
    - Testsuite configuration reference (https://circleci.com/docs/reference/testsuite-configuration-reference/) [md](https://circleci.com/docs/reference/testsuite-configuration-reference/index.md)
      Reference for the CircleCI Smarter Testing configuration keys in the .circleci/test-suites.yml file, including discover, run, analysis and outputs.
  - Legacy test split tooling
    - Test splitting and parallelism (https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/) [md](https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/index.md)
      A guide for test splitting and running tests across parallel compute environments to optimize your CircleCI pipelines.
    - Use the environment CLI to split tests (https://circleci.com/docs/guides/optimize/use-the-circleci-cli-to-split-tests/) [md](https://circleci.com/docs/guides/optimize/use-the-circleci-cli-to-split-tests/index.md)
      How-to guide for using the environment CLI to split tests across parallel compute environments in a pipeline.
    - Rerun failed tests with the tests run command (https://circleci.com/docs/guides/test/rerun-failed-tests/) [md](https://circleci.com/docs/guides/test/rerun-failed-tests/index.md)
      Rerun only the failed tests in a job with the legacy circleci tests run command to save time and credits, with examples for common test frameworks.
    - Troubleshoot test splitting (https://circleci.com/docs/guides/test/troubleshoot-test-splitting/) [md](https://circleci.com/docs/guides/test/troubleshoot-test-splitting/index.md)
      Tips and common errors to help troubleshoot your CircleCI test splitting implementation.
  - Testing strategies
    - Fix flaky tests (https://circleci.com/docs/guides/test/fix-flaky-tests/) [md](https://circleci.com/docs/guides/test/fix-flaky-tests/index.md)
      Learn about Chunk by CircleCI and how it can automatically identify and fix flaky tests in your CI/CD pipelines.
    - Browser testing (https://circleci.com/docs/guides/test/browser-testing/) [md](https://circleci.com/docs/guides/test/browser-testing/index.md)
      Run and debug browser tests on CircleCI with Selenium, LambdaTest, Sauce Labs, BrowserStack, Appium or Cypress, using screenshots, artifacts and VNC.
    - Generate code coverage metrics (https://circleci.com/docs/guides/test/code-coverage/) [md](https://circleci.com/docs/guides/test/code-coverage/index.md)
      Generate code coverage metrics for Ruby, Python, Java, JavaScript, PHP and Go, then view reports on CircleCI or send them to Codecov or Coveralls.
    - Testing iOS applications (https://circleci.com/docs/guides/test/testing-ios/) [md](https://circleci.com/docs/guides/test/testing-ios/index.md)
      Set up and customize iOS application testing on macOS with CircleCI, including supported Xcode versions, Fastlane, code signing and Ruby.
    - Testing macOS applications (https://circleci.com/docs/guides/test/testing-macos/) [md](https://circleci.com/docs/guides/test/testing-macos/index.md)
      Configure CircleCI for macOS app UI testing, including supported Xcode and macOS versions, Fastlane setup and managing permissions with the macOS orb.
    - Testing LLM-enabled applications through evaluations (https://circleci.com/docs/guides/test/testing-llm-enabled-applications-through-evaluations/) [md](https://circleci.com/docs/guides/test/testing-llm-enabled-applications-through-evaluations/index.md)
      Test applications powered by large language models (LLMs) with evaluations, and automate evals in your CircleCI pipelines with the CircleCI Evals orb.
    - Automate LLM evaluation testing with the CircleCI Evals orb (https://circleci.com/docs/guides/test/automate-llm-evaluation-testing-with-the-circleci-evals-orb/) [md](https://circleci.com/docs/guides/test/automate-llm-evaluation-testing-with-the-circleci-evals-orb/index.md)
      Use the CircleCI Evals orb to automate LLM evaluations in your pipeline, define test cases and review evaluation results in the CircleCI web app.
- Deploy with CircleCI
  - Deployment management
    - Overview (https://circleci.com/docs/guides/deploy/deployment-overview/) [md](https://circleci.com/docs/guides/deploy/deployment-overview/index.md)
      Get an overview of deploying to any target with CircleCI and managing deployments with deploy markers, rollbacks, Smart Deployments, and the release agent.
    - Configure deploy markers (https://circleci.com/docs/guides/deploy/configure-deploy-markers/) [md](https://circleci.com/docs/guides/deploy/configure-deploy-markers/index.md)
      Add deploy markers to your CircleCI configuration to log deployments, track their status, and roll back or promote versions from the web app.
  - Smart Deployments
    - Smart Deployments overview (https://circleci.com/docs/guides/deploy/smart-deployments-overview/) [md](https://circleci.com/docs/guides/deploy/smart-deployments-overview/index.md)
      Smart Deployments is the CircleCI continuous validation feature. Learn how the release validation engine gates releases on your monitoring signals.
    - Set up Smart Deployments (https://circleci.com/docs/guides/deploy/set-up-smart-deployments/) [md](https://circleci.com/docs/guides/deploy/set-up-smart-deployments/index.md)
      Use the guided setup in the CircleCI web app to configure Smart Deployments, including release validation and automatic rollback, from one flow.
    - Set up release validation manually (https://circleci.com/docs/guides/deploy/set-up-release-validation-manually/) [md](https://circleci.com/docs/guides/deploy/set-up-release-validation-manually/index.md)
      Configure release validation by editing your CircleCI configuration file, or when you prefer to write the validation policy yourself.
    - Release validation configuration reference (https://circleci.com/docs/guides/deploy/release-validation-reference/) [md](https://circleci.com/docs/guides/deploy/release-validation-reference/index.md)
      Reference for the validation block in your CircleCI configuration file, including webhook fields, data point mappings, and provider defaults.
  - Deploys and rollbacks
    - Set up a rollback pipeline (https://circleci.com/docs/guides/deploy/set-up-rollbacks/) [md](https://circleci.com/docs/guides/deploy/set-up-rollbacks/index.md)
      Configure a CircleCI rollback pipeline to revert a deployment to a previous stable version.
    - Set up a deploy pipeline (https://circleci.com/docs/guides/deploy/set-up-deploys/) [md](https://circleci.com/docs/guides/deploy/set-up-deploys/index.md)
      Configure a CircleCI deploy pipeline to support manual deployment of a component to a target environment.
    - Deploy a component (https://circleci.com/docs/guides/deploy/deploy-a-component/) [md](https://circleci.com/docs/guides/deploy/deploy-a-component/index.md)
      Deploy a component to a target environment using a CircleCI deploy pipeline.
    - Rollback a deployment (https://circleci.com/docs/guides/deploy/rollback-a-deployment/) [md](https://circleci.com/docs/guides/deploy/rollback-a-deployment/index.md)
      Roll back a deployment to a previous stable version using a CircleCI rollback pipeline or workflow re-run.
    - Environment hierarchy and version promotion (https://circleci.com/docs/guides/deploy/environment-hierarchy-and-version-promotion/) [md](https://circleci.com/docs/guides/deploy/environment-hierarchy-and-version-promotion/index.md)
      Learn how to use environment hierarchy and version promotion to manage your deployments through multiple environments.
  - Release agent setup
    - Release agent overview (https://circleci.com/docs/guides/deploy/release-agent-overview/) [md](https://circleci.com/docs/guides/deploy/release-agent-overview/index.md)
      Learn the basics of release management for your Kubernetes deployments with CircleCI.
    - Set up the CircleCI release agent (https://circleci.com/docs/guides/deploy/set-up-the-circleci-release-agent/) [md](https://circleci.com/docs/guides/deploy/set-up-the-circleci-release-agent/index.md)
      Tutorial outlining how to set up the CircleCI release agent, covering creating an environment integration, installing the release agent and creating components.
    - Configure your Kubernetes components (https://circleci.com/docs/guides/deploy/configure-your-kubernetes-components/) [md](https://circleci.com/docs/guides/deploy/configure-your-kubernetes-components/index.md)
      Tutorial outlining how to configure your Kubernetes components for visibility and control on the deploys dashboard.
    - Update the Kubernetes release agent (https://circleci.com/docs/guides/deploy/update-the-kubernetes-release-agent/) [md](https://circleci.com/docs/guides/deploy/update-the-kubernetes-release-agent/index.md)
      How to update the Kubernetes release agent for integrations with CircleCI deploys.
    - Manage releases (https://circleci.com/docs/guides/deploy/manage-releases/) [md](https://circleci.com/docs/guides/deploy/manage-releases/index.md)
      Manage releases from the CircleCI web app with the CircleCI release agent: restore a version, scale or restart a component, and retry a rollout.
  - How-to guides
    - Deploy Android applications (https://circleci.com/docs/guides/deploy/deploy-android-applications/) [md](https://circleci.com/docs/guides/deploy/deploy-android-applications/index.md)
      Automatically deploy your Android app to the Google Play Store from CircleCI using Fastlane, Gradle signing configuration, and environment variables.
    - Deploy to Artifactory (https://circleci.com/docs/guides/deploy/deploy-to-artifactory/) [md](https://circleci.com/docs/guides/deploy/deploy-to-artifactory/index.md)
      Upload artifacts such as JAR and WAR files to Artifactory from CircleCI using Artifactory plugins for Maven and Gradle, or the JFrog CLI.
    - Deploy to AWS (https://circleci.com/docs/guides/deploy/deploy-to-aws/) [md](https://circleci.com/docs/guides/deploy/deploy-to-aws/index.md)
      Deploy to Amazon Web Services from CircleCI: upload to S3, push Docker images to ECR, update ECS services, and deploy applications with AWS CodeDeploy.
    - Push image to ECR and deploy to ECS (https://circleci.com/docs/guides/deploy/ecs-ecr/) [md](https://circleci.com/docs/guides/deploy/ecs-ecr/index.md)
      Build and push a Docker image to AWS ECR, then deploy it to an existing AWS ECS service using CircleCI and a sample project with Terraform.
    - Deploy service update to AWS ECS (https://circleci.com/docs/guides/deploy/deploy-service-update-to-aws-ecs/) [md](https://circleci.com/docs/guides/deploy/deploy-service-update-to-aws-ecs/index.md)
      Use CircleCI orbs to build and push a Docker image, deploy a service update to AWS ECS, and verify the deployment in your workflow.
    - Deploy to Azure Container Registry (https://circleci.com/docs/guides/deploy/deploy-to-azure-container-registry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-azure-container-registry/index.md)
      This document provides examples of deploying to Azure Container Registry.
    - Deploy to Capistrano (https://circleci.com/docs/guides/deploy/deploy-to-capistrano/) [md](https://circleci.com/docs/guides/deploy/deploy-to-capistrano/index.md)
      Use this example CircleCI configuration to run Capistrano deployment commands from a job once your project is set up to use Capistrano.
    - Deploy to Cloud Foundry (https://circleci.com/docs/guides/deploy/deploy-to-cloud-foundry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-cloud-foundry/index.md)
      Configure CircleCI to deploy to Cloud Foundry with the Cloud Foundry CLI, using a blue-green pattern of dark and live deployments with optional approval.
    - Deploy to Firebase (https://circleci.com/docs/guides/deploy/deploy-to-firebase/) [md](https://circleci.com/docs/guides/deploy/deploy-to-firebase/index.md)
      Configure CircleCI to deploy to Firebase by installing firebase-tools as a dev dependency and authenticating with a service account.
    - Deploy to Google Cloud Platform (https://circleci.com/docs/guides/deploy/deploy-to-google-cloud-platform/) [md](https://circleci.com/docs/guides/deploy/deploy-to-google-cloud-platform/index.md)
      This document provides examples of deploying to Google Cloud Platform.
    - Deploy to Heroku (https://circleci.com/docs/guides/deploy/deploy-to-heroku/) [md](https://circleci.com/docs/guides/deploy/deploy-to-heroku/index.md)
      Configure CircleCI to deploy your application to Heroku, either with the Heroku orb or with a custom deploy job and environment variables.
    - Deploy iOS applications (https://circleci.com/docs/guides/deploy/deploy-ios-applications/) [md](https://circleci.com/docs/guides/deploy/deploy-ios-applications/index.md)
      Configure Fastlane to automatically deploy iOS apps from CircleCI to App Store Connect, TestFlight, Firebase, and other distribution services.
    - Deploy over SSH (https://circleci.com/docs/guides/deploy/deploy-over-ssh/) [md](https://circleci.com/docs/guides/deploy/deploy-over-ssh/index.md)
      Deploy your application over SSH from CircleCI by adding an SSH key for the target, setting the username and hostname, and creating a deploy job.
    - Publish packages to Packagecloud (https://circleci.com/docs/guides/deploy/publish-packages-to-packagecloud/) [md](https://circleci.com/docs/guides/deploy/publish-packages-to-packagecloud/index.md)
      Configure CircleCI to publish packages to Packagecloud with the packagecloud CLI or API, including npm package deployment and dependency caching.
    - Publish to npm using OIDC trusted publishing (https://circleci.com/docs/guides/deploy/deploy-to-npm-registry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-npm-registry/index.md)
      Publish packages to npm from CircleCI using OIDC trusted publishing, the recommended tokenless approach.
    - Publish to npm with an authentication token (https://circleci.com/docs/guides/deploy/deploy-to-npm-registry-with-token/) [md](https://circleci.com/docs/guides/deploy/deploy-to-npm-registry-with-token/index.md)
      Publish packages to the npm registry from CircleCI using a long-lived npm authentication token.
- Optimize
  - Optimizations reference (https://circleci.com/docs/guides/optimize/optimizations/) [md](https://circleci.com/docs/guides/optimize/optimizations/index.md)
    Ways to optimize your CircleCI pipelines, from reducing data usage with storage controls and workspaces to cutting build time with caching and parallelism.
  - Data
    - Persisting data overview (https://circleci.com/docs/guides/optimize/persist-data/) [md](https://circleci.com/docs/guides/optimize/persist-data/index.md)
      An introduction to persisting data in CircleCI with caches, workspaces and artifacts, plus how to manage your network and storage usage.
    - Caching dependencies (https://circleci.com/docs/guides/optimize/caching/) [md](https://circleci.com/docs/guides/optimize/caching/index.md)
      Speed up CircleCI jobs by caching dependencies. See how caching works, how to save and restore caches, and how to design your cache keys.
    - Build tool cache (https://circleci.com/docs/guides/optimize/build-tool-cache/) [md](https://circleci.com/docs/guides/optimize/build-tool-cache/index.md)
      Use with_tool_cache to transparently back Gradle, Bazel, Turborepo, and Xcode build caches with a CircleCI-managed remote cache.
    - Store build artifacts (https://circleci.com/docs/guides/optimize/artifacts/) [md](https://circleci.com/docs/guides/optimize/artifacts/index.md)
      Upload, download and customize storage for build artifacts on CircleCI, including core files and tips for optimizing artifact uploads.
  - Speed
    - Concurrency (https://circleci.com/docs/guides/optimize/concurrency/) [md](https://circleci.com/docs/guides/optimize/concurrency/index.md)
      This page summarizes concurrency, and suggests ways to use concurrency to your advantage.
    - Test splitting and parallelism (https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/) [md](https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/index.md)
      A guide for test splitting and running tests across parallel compute environments to optimize your CircleCI pipelines.
    - Docker layer caching overview (https://circleci.com/docs/guides/optimize/docker-layer-caching/) [md](https://circleci.com/docs/guides/optimize/docker-layer-caching/index.md)
      How to reuse unchanged cache layers in images you build to reduce overall run time
  - Config
    - Dynamic configuration (https://circleci.com/docs/guides/orchestrate/dynamic-config/) [md](https://circleci.com/docs/guides/orchestrate/dynamic-config/index.md)
      Get an overview of CircleCI dynamic configuration, which lets you generate or assemble configuration at runtime to match your project's needs.
  - How-to guides
    - Use matrix jobs (https://circleci.com/docs/guides/orchestrate/using-matrix-jobs/) [md](https://circleci.com/docs/guides/orchestrate/using-matrix-jobs/index.md)
      "A how to guide for using matrix jobs to simplify your CircleCI configuration."
    - Using dynamic configuration (https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/) [md](https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/index.md)
      Follow examples of CircleCI dynamic configuration, such as passing parameters to a continuation workflow and running work based on modified files.
    - Avoid and debug Java memory errors (https://circleci.com/docs/guides/optimize/java-oom/) [md](https://circleci.com/docs/guides/optimize/java-oom/index.md)
      Avoid and debug Java out of memory errors on CircleCI by setting JVM memory limits through container support and Java environment variables.
- Insights
  - Use Insights (https://circleci.com/docs/guides/insights/insights/) [md](https://circleci.com/docs/guides/insights/insights/index.md)
    Use the CircleCI Insights dashboard to track the health and usage of your projects, including credit usage, success rates and pipeline duration.
  - Test Insights (https://circleci.com/docs/guides/insights/insights-tests/) [md](https://circleci.com/docs/guides/insights/insights-tests/index.md)
    Analyze your test performance with Test Insights. Review recent runs and find flaky, failing and slow tests to identify opportunities for optimization.
  - Project Usage Dashboard (https://circleci.com/docs/guides/insights/project-usage-dashboard/) [md](https://circleci.com/docs/guides/insights/project-usage-dashboard/index.md)
    Use the Project Usage dashboard to understand credit consumption by workflow and job within a specific project.
  - Generate an Insights snapshot badge (https://circleci.com/docs/guides/insights/insights-snapshot-badge/) [md](https://circleci.com/docs/guides/insights/insights-snapshot-badge/index.md)
    Generate a badge that displays Insights metrics for a project. The Insights snapshot badge feature is set to be deprecated.
  - Insights glossary (https://circleci.com/docs/reference/insights-glossary/) [md](https://circleci.com/docs/reference/insights-glossary/index.md)
    Definitions for the metrics in CircleCI Insights, Insights dashboard as well as the Insights API.
- Manage roles, permissions, and authentication
  - Users, organizations, and integrations guide (https://circleci.com/docs/guides/permissions-authentication/users-organizations-and-integrations-guide/) [md](https://circleci.com/docs/guides/permissions-authentication/users-organizations-and-integrations-guide/index.md)
    A guide to understanding user accounts, organizations and integrations with version control systems in CircleCI.
  - Manage email addresses (https://circleci.com/docs/guides/permissions-authentication/manage-email-addresses/) [md](https://circleci.com/docs/guides/permissions-authentication/manage-email-addresses/index.md)
    Learn how to add, update, or remove email addresses associated with your CircleCI account.
  - Roles and permissions
    - Roles and permissions overview (https://circleci.com/docs/guides/permissions-authentication/roles-and-permissions-overview/) [md](https://circleci.com/docs/guides/permissions-authentication/roles-and-permissions-overview/index.md)
      An overview of the various project and organization roles in CircleCI and the permissions associated with each role.
    - Manage roles and permissions (https://circleci.com/docs/guides/permissions-authentication/manage-roles-and-permissions/) [md](https://circleci.com/docs/guides/permissions-authentication/manage-roles-and-permissions/index.md)
      Add and remove people in your CircleCI organization and projects, change their org-level and project-level permissions, and assign project roles.
    - Manage groups (https://circleci.com/docs/guides/permissions-authentication/manage-groups/) [md](https://circleci.com/docs/guides/permissions-authentication/manage-groups/index.md)
      How-to guides for setting up and assigning groups in CircleCI to manage roles and permissions across projects.
    - Prevent unregistered users from spending credits (https://circleci.com/docs/guides/plans-pricing/prevent-unregistered-users-from-spending-credits/) [md](https://circleci.com/docs/guides/plans-pricing/prevent-unregistered-users-from-spending-credits/index.md)
      A how-to guide to configuring your org so that unregistered users will not be able to perform actions that spend credits.
  - SSO authentication
    - SSO overview (https://circleci.com/docs/guides/permissions-authentication/sso-overview/) [md](https://circleci.com/docs/guides/permissions-authentication/sso-overview/index.md)
      An introduction to SAML single sign-on (SSO) for CircleCI: how it works, its benefits, personal API tokens with SSO, and current limitations.
    - SSO setup (https://circleci.com/docs/guides/permissions-authentication/set-up-sso/) [md](https://circleci.com/docs/guides/permissions-authentication/set-up-sso/index.md)
      Set up SAML single sign-on (SSO) for your CircleCI organization with your Identity Provider, and find out how to stop enforcing or delete an SSO connection.
    - Set up SSO group mapping with Okta (https://circleci.com/docs/guides/permissions-authentication/sso-group-mapping/) [md](https://circleci.com/docs/guides/permissions-authentication/sso-group-mapping/index.md)
      Follow this guide to set up SSO (Single sign-on) group mapping with Okta and CircleCI.
    - Sign in to an SSO-enabled org (https://circleci.com/docs/guides/permissions-authentication/sign-in-to-an-sso-enabled-organization/) [md](https://circleci.com/docs/guides/permissions-authentication/sign-in-to-an-sso-enabled-organization/index.md)
      Join an SSO-enabled CircleCI organization and authenticate with your Identity Provider to access its projects as an SSO user.
  - Multi-factor authentication (MFA)
    - MFA overview (https://circleci.com/docs/guides/permissions-authentication/mfa/) [md](https://circleci.com/docs/guides/permissions-authentication/mfa/index.md)
      Set up multi-factor authentication (MFA) for your CircleCI account, sign in with MFA, and use recovery codes if you lose access to your device.
  - OIDC tokens
    - Use OpenID Connect tokens in jobs (https://circleci.com/docs/guides/permissions-authentication/openid-connect-tokens/) [md](https://circleci.com/docs/guides/permissions-authentication/openid-connect-tokens/index.md)
      Learn how to use OpenID Connect ID tokens for access to compatible cloud services.
    - OIDC tokens with custom claims (https://circleci.com/docs/guides/permissions-authentication/oidc-tokens-with-custom-claims/) [md](https://circleci.com/docs/guides/permissions-authentication/oidc-tokens-with-custom-claims/index.md)
      Create CircleCI OIDC tokens with the environment CLI and customize the aud claim to connect your jobs to different cloud services without long-lived secrets.
    - Pull an image from AWS ECR with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/index.md)
      Configure a Docker job to pull an image from AWS ECR using OIDC authentication. Set up an IAM role, then update your config to pull the image.
    - Pull an image from GCP Artifact Registry with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/index.md)
      Learn how to pull an image from GCP Artifact Registry using OIDC authentication
  - Cloud provider authentication
    - Authorize Google Cloud SDK (https://circleci.com/docs/guides/integration/authorize-google-cloud-sdk/) [md](https://circleci.com/docs/guides/integration/authorize-google-cloud-sdk/index.md)
      Install and authorize the Google Cloud SDK in your primary container, create a service account, and authenticate to Google Container Registry.
- Manage security and secrets
  - Security features
    - How CircleCI handles security (https://circleci.com/docs/guides/security/security/) [md](https://circleci.com/docs/guides/security/security/index.md)
      How CircleCI approaches security, including encryption, sandboxing and integrations, and how to report a security issue to the security team.
    - Intro to environment variables (https://circleci.com/docs/guides/security/env-vars/) [md](https://circleci.com/docs/guides/security/env-vars/index.md)
      An introduction to environment variables in CircleCI: built-in variables, private keys and secrets, order of precedence, substitution and contexts.
    - Using contexts (https://circleci.com/docs/guides/security/contexts/) [md](https://circleci.com/docs/guides/security/contexts/index.md)
      Create and use contexts to secure and share environment variables across projects, and restrict contexts by security group, project or expression.
    - Restrict code signing management (https://circleci.com/docs/guides/security/restrict-code-signing-management/) [md](https://circleci.com/docs/guides/security/restrict-code-signing-management/index.md)
      Restrict code signing management to organization admins so only admins can manage certificates, signing bundles, and provisioning profiles.
    - IP ranges (https://circleci.com/docs/guides/security/ip-ranges/) [md](https://circleci.com/docs/guides/security/ip-ranges/index.md)
      Enable CircleCI jobs to go through a set of well-defined IP address ranges
    - Site-to-site connectivity (https://circleci.com/docs/guides/security/site-to-site-connectivity/) [md](https://circleci.com/docs/guides/security/site-to-site-connectivity/index.md)
      Run CircleCI Cloud jobs that reach private infrastructure without opening your firewall to the internet.
    - Audit logs (https://circleci.com/docs/guides/security/audit-logs/) [md](https://circleci.com/docs/guides/security/audit-logs/index.md)
      "This page describes the ways CircleCI customers can request and stream audit logs."
  - Security recommendations
    - Security overview (https://circleci.com/docs/guides/security/security-overview/) [md](https://circleci.com/docs/guides/security/security-overview/index.md)
      This document provides an introduction to security features at CircleCI.
    - Protecting against supply chain attacks (https://circleci.com/docs/guides/security/security-supply-chain/) [md](https://circleci.com/docs/guides/security/security-supply-chain/index.md)
      Reduce the risk of supply chain attacks on CircleCI as a publisher or developer by using contexts and pinning your dependencies.
    - Secure secrets handling (https://circleci.com/docs/guides/security/security-recommendations/) [md](https://circleci.com/docs/guides/security/security-recommendations/index.md)
      Protect secrets at the boundary between CircleCI and your systems. Understand command-line risks and apply mitigations such as protecting API tokens.
  - Incident management
    - Pause or stop pipelines during an incident (https://circleci.com/docs/guides/orchestrate/pause-pipelines-during-an-incident/) [md](https://circleci.com/docs/guides/orchestrate/pause-pipelines-during-an-incident/index.md)
      Decide when to cancel running work, block new pipelines, stop building, coordinate followers, or rotate and remove secrets during an incident.
    - Analyze pipelines and job steps during an incident (https://circleci.com/docs/guides/orchestrate/analyze-pipelines-during-an-incident/) [md](https://circleci.com/docs/guides/orchestrate/analyze-pipelines-during-an-incident/index.md)
      Investigate pipelines and step output, then review audit logs and assess credential exposure after an incident.
  - How-to guides
    - Set an environment variable (https://circleci.com/docs/guides/security/set-environment-variable/) [md](https://circleci.com/docs/guides/security/set-environment-variable/index.md)
      Set environment variables for your CircleCI pipelines in a shell command, step, job, context, project or container, and encode multi-line values.
    - Inject environment variables with the API (https://circleci.com/docs/guides/security/inject-environment-variables-with-api/) [md](https://circleci.com/docs/guides/security/inject-environment-variables-with-api/index.md)
      Pass variable values into your pipelines with the CircleCI API, using pipeline parameters in API v2 or build parameters in API v1.
    - Debug jobs with SSH rerun (https://circleci.com/docs/guides/execute/ssh-access-jobs/) [md](https://circleci.com/docs/guides/execute/ssh-access-jobs/index.md)
      Rerun a job with SSH to inspect log files, running processes, and directory paths, and troubleshoot permission denied errors when you connect.
    - Rotate project SSH keys (https://circleci.com/docs/guides/security/rotate-project-ssh-keys/) [md](https://circleci.com/docs/guides/security/rotate-project-ssh-keys/index.md)
      Rotate project SSH keys for GitHub, Bitbucket Cloud and GitLab projects by removing and replacing both the private and public keys.
    - Stop building a project on CircleCI (https://circleci.com/docs/guides/security/stop-building-a-project-on-circleci/) [md](https://circleci.com/docs/guides/security/stop-building-a-project-on-circleci/index.md)
      Stop building a project on CircleCI while keeping its build history, and see how this option compares with pausing pipelines during an incident.
    - Rename organizations and repositories (https://circleci.com/docs/guides/security/rename-organizations-and-repositories/) [md](https://circleci.com/docs/guides/security/rename-organizations-and-repositories/index.md)
      Rename organizations and repositories connected to CircleCI. The steps depend on whether you use the GitHub App, GitLab, GitHub OAuth app or Bitbucket Cloud.
    - Delete organizations and projects (https://circleci.com/docs/guides/security/delete-organizations-and-projects/) [md](https://circleci.com/docs/guides/security/delete-organizations-and-projects/index.md)
      Steps for deleting an organization or a project connected to CircleCI, and what to do if you only want to stop building a project.
- Manage config policies
  - Config policy management overview (https://circleci.com/docs/guides/config-policies/config-policy-management-overview/) [md](https://circleci.com/docs/guides/config-policies/config-policy-management-overview/index.md)
    Use config policies to set organization-level rules that govern which configuration elements your CircleCI projects must use, may use, or cannot use.
  - Config policy reference (https://circleci.com/docs/reference/config-policy-reference/) [md](https://circleci.com/docs/reference/config-policy-reference/index.md)
    Open preview of config policies for CircleCI. Reference page for function helpers.
  - How-to guides
    - Create and manage config policies (https://circleci.com/docs/guides/config-policies/create-and-manage-config-policies/) [md](https://circleci.com/docs/guides/config-policies/create-and-manage-config-policies/index.md)
      Learn how to write and manage config policies for CircleCI project configurations.
    - Test config policies (https://circleci.com/docs/guides/config-policies/test-config-policies/) [md](https://circleci.com/docs/guides/config-policies/test-config-policies/index.md)
      Open preview of config policies for CircleCI. Learn about testing your policies.
    - Use the CLI for config and policy development (https://circleci.com/docs/guides/config-policies/use-the-cli-for-config-and-policy-development/) [md](https://circleci.com/docs/guides/config-policies/use-the-cli-for-config-and-policy-development/index.md)
      Use the CircleCI CLI to develop and test configs and config policies locally, and to retrieve policy decision audit logs for your organization.
    - Config policies for self-hosted runner (https://circleci.com/docs/guides/config-policies/config-policies-for-self-hosted-runner/) [md](https://circleci.com/docs/guides/config-policies/config-policies-for-self-hosted-runner/index.md)
      Learn how to write a policy to restrict which projects can run jobs on a self-hosted runner.
    - Manage contexts with config policies (https://circleci.com/docs/guides/config-policies/manage-contexts-with-config-policies/) [md](https://circleci.com/docs/guides/config-policies/manage-contexts-with-config-policies/index.md)
      Write config policies that control context use in your organization by defining which contexts are allowed, blocked, or reserved by a project or branch.
- Integration
  - Add SSH Keys (https://circleci.com/docs/guides/integration/add-ssh-key/) [md](https://circleci.com/docs/guides/integration/add-ssh-key/index.md)
    Add additional SSH keys to your CircleCI project and jobs so you can deploy to other services or check out code from other repositories.
  - VCS integration
    - Set up VCS connections (https://circleci.com/docs/guides/integration/set-up-vcs-connections/) [md](https://circleci.com/docs/guides/integration/set-up-vcs-connections/index.md)
      Connect your CircleCI organization to a version control system provider, and view, configure, or remove existing connections.
    - VCS, pipeline types, and feature support (https://circleci.com/docs/guides/integration/version-control-system-integration-overview/) [md](https://circleci.com/docs/guides/integration/version-control-system-integration-overview/index.md)
      An overview guide to the version control systems you can integrate with CircleCI and the features available to each pipeline type and organization type.
    - GitHub Enterprise Server integration (https://circleci.com/docs/guides/integration/github-enterprise-server-integration/) [md](https://circleci.com/docs/guides/integration/github-enterprise-server-integration/index.md)
      Connect your self-hosted GitHub Enterprise Server instance to CircleCI Cloud.
    - Using the CircleCI GitHub App in an OAuth org (https://circleci.com/docs/guides/integration/using-the-circleci-github-app-in-an-oauth-org/) [md](https://circleci.com/docs/guides/integration/using-the-circleci-github-app-in-an-oauth-org/index.md)
      Use the CircleCI GitHub App alongside the GitHub OAuth app in an OAuth organization, and see how each integration affects project and pipeline types.
    - Status updates overview (https://circleci.com/docs/guides/integration/status-updates/) [md](https://circleci.com/docs/guides/integration/status-updates/index.md)
      An overview of commit statuses and GitHub Checks in CircleCI, including how they appear in GitHub, Bitbucket, and GitLab.
    - Enable GitHub Checks (https://circleci.com/docs/guides/integration/enable-checks/) [md](https://circleci.com/docs/guides/integration/enable-checks/index.md)
      Enable GitHub Checks so CircleCI reports workflow status to the GitHub user interface, and learn how to disable Checks or troubleshoot them.
    - Build open source projects (https://circleci.com/docs/guides/integration/oss/) [md](https://circleci.com/docs/guides/integration/oss/index.md)
      Follow best practices for building open source projects on CircleCI, including credits, security, and features and settings for public projects.
  - Webhooks and events
    - Outbound Webhooks (https://circleci.com/docs/guides/integration/outbound-webhooks/) [md](https://circleci.com/docs/guides/integration/outbound-webhooks/index.md)
      Use outbound webhooks to integrate with third-party services and subscribe to CircleCI events
    - Outbound Webhooks Reference (https://circleci.com/docs/reference/outbound-webhooks-reference/) [md](https://circleci.com/docs/reference/outbound-webhooks-reference/index.md)
      Reference for the common fields and event-specific payloads sent by CircleCI outbound webhooks.
    - Webhooks With Airtable (https://circleci.com/docs/guides/integration/webhooks-airtable/) [md](https://circleci.com/docs/guides/integration/webhooks-airtable/index.md)
      Set up CircleCI webhooks with Airtable to capture and visualize the output of your pipelines, including an example for tracking deployments.
  - Notifications and status
    - Notifications overview (https://circleci.com/docs/guides/integration/notifications/) [md](https://circleci.com/docs/guides/integration/notifications/index.md)
      Learn how to get CircleCI notifications through Slack, IRC and email notifications.
    - Slack integration (https://circleci.com/docs/guides/integration/slack-integration/) [md](https://circleci.com/docs/guides/integration/slack-integration/index.md)
      Install the CircleCI Slack app and configure project-level Slack notifications for workflow status updates.
    - Use the Slack orb to set up notifications (https://circleci.com/docs/guides/getting-started/slack-orb-tutorial/) [md](https://circleci.com/docs/guides/getting-started/slack-orb-tutorial/index.md)
      Get started with the CircleCI Slack orb: create your config.yml file, connect CircleCI with Slack, and use message templates for notifications.
    - Status Badges (https://circleci.com/docs/guides/integration/status-badges/) [md](https://circleci.com/docs/guides/integration/status-badges/index.md)
      Create and embed a CircleCI status badge that shows your project's build status in a README or any other web page or document.
  - Monitoring and observability
    - Datadog Integration (https://circleci.com/docs/guides/integration/datadog-integration/) [md](https://circleci.com/docs/guides/integration/datadog-integration/index.md)
      Learn how to integrate CircleCI with Datadog for monitoring and observability.
    - New Relic Integration (https://circleci.com/docs/guides/integration/new-relic-integration/) [md](https://circleci.com/docs/guides/integration/new-relic-integration/index.md)
      This document describes how to track and visualize analytical data across all of your jobs on CircleCI with New Relic.
    - Sumo Logic Integration (https://circleci.com/docs/guides/integration/sumo-logic-integration/) [md](https://circleci.com/docs/guides/integration/sumo-logic-integration/index.md)
      This document describes how to track and visualize analytical data across all of your jobs on CircleCI with Sumo Logic.
    - OpenTelemetry Integration (https://circleci.com/docs/guides/integration/open-telemetry-integration/) [md](https://circleci.com/docs/guides/integration/open-telemetry-integration/index.md)
      Configure CircleCI to export OpenTelemetry spans for your pipelines, workflows, jobs, and steps.
  - Cost management
    - Finout Integration (https://circleci.com/docs/guides/plans-pricing/integrate-with-finout-for-cost-management/) [md](https://circleci.com/docs/guides/plans-pricing/integrate-with-finout-for-cost-management/index.md)
      Connect CircleCI to Finout to track CI/CD costs alongside your cloud infrastructure and optimize spending with detailed cost allocation.
    - Vantage Integration (https://circleci.com/docs/guides/plans-pricing/integrate-with-vantage-for-cost-management/) [md](https://circleci.com/docs/guides/plans-pricing/integrate-with-vantage-for-cost-management/index.md)
      Connect CircleCI to Vantage to track CI/CD costs alongside your cloud infrastructure and SaaS providers.
  - Project management
    - Connect With Jira (https://circleci.com/docs/guides/integration/jira-plugin/) [md](https://circleci.com/docs/guides/integration/jira-plugin/index.md)
      Connect Jira Cloud with CircleCI using the CircleCI for Jira app or the Jira orb, so you can view build and deploy statuses in your Jira issues.
- Working with agents
  - CircleCI Agent Skills (https://circleci.com/docs/guides/toolkit/circleci-agent-skills/) [md](https://circleci.com/docs/guides/toolkit/circleci-agent-skills/index.md)
    Install CircleCI agent skills in Claude Code, Cursor, Codex, or Copilot to debug builds, optimize config, and onboard projects.
  - Fix broken builds efficiently with agents (https://circleci.com/docs/guides/toolkit/diagnose-failed-runs-with-failure-report/) [md](https://circleci.com/docs/guides/toolkit/diagnose-failed-runs-with-failure-report/index.md)
    Use --failure-report with circleci run get to retrieve condensed output for every failed step in a single call, reducing token costs in AI agent workflows.
  - MCP
    - CircleCI MCP overview (https://circleci.com/docs/guides/toolkit/circleci-mcp-overview/) [md](https://circleci.com/docs/guides/toolkit/circleci-mcp-overview/index.md)
      An overview of CircleCI's MCP offerings for AI coding assistants, how they work, best practices, and troubleshooting steps.
    - Connecting to the CircleCI MCP server (https://circleci.com/docs/guides/toolkit/connecting-to-the-circleci-mcp-server/) [md](https://circleci.com/docs/guides/toolkit/connecting-to-the-circleci-mcp-server/index.md)
      Connect an AI coding assistant to CircleCI's hosted MCP server using the Claude or Cursor directory, OAuth2, or a personal API token.
    - Connecting to the CircleCI CLI MCP (https://circleci.com/docs/guides/toolkit/connecting-to-the-circleci-cli-mcp/) [md](https://circleci.com/docs/guides/toolkit/connecting-to-the-circleci-cli-mcp/index.md)
      Enable the CircleCI CLI's built-in MCP server so AI coding assistants like Claude, Cursor, and VS Code can inspect your CI runs locally.
    - Connecting to the CircleCI Docs MCP Server (https://circleci.com/docs/guides/toolkit/connecting-to-a-docs-mcp-server/) [md](https://circleci.com/docs/guides/toolkit/connecting-to-a-docs-mcp-server/index.md)
      Connect your AI assistant to CircleCI's documentation MCP server to search CircleCI docs and knowledge sources directly from your development environment.
  - Chunk
    - Chunk Setup and Overview (https://circleci.com/docs/guides/toolkit/chunk-setup-and-overview/) [md](https://circleci.com/docs/guides/toolkit/chunk-setup-and-overview/index.md)
      An overview of Chunk by CircleCI, an AI agent for CI/CD tasks, and a guide to setting it up with your chosen model provider.
    - Install and configure the Chunk CLI (https://circleci.com/docs/guides/toolkit/install-and-configure-the-chunk-cli/) [md](https://circleci.com/docs/guides/toolkit/install-and-configure-the-chunk-cli/index.md)
      How to install and configure the Chunk CLI, a tool for integrating AI code review standards and remote validation into your development workflow.
    - How to use the Chunk CLI (https://circleci.com/docs/guides/toolkit/how-to-use-chunk-cli/) [md](https://circleci.com/docs/guides/toolkit/how-to-use-chunk-cli/index.md)
      How to use the `chunk` CLI to initialize projects, generate AI review prompts, manage Chunk sidecars, run validations, and install AI agent skills.
- Developer toolkit
  - How to find IDs (https://circleci.com/docs/guides/toolkit/how-to-find-ids/) [md](https://circleci.com/docs/guides/toolkit/how-to-find-ids/index.md)
    "This page describes how customers can find IDs of various CircleCI elements."
  - CircleCI CLI
    - The CircleCI CLI (https://circleci.com/docs/guides/toolkit/circleci-cli/) [md](https://circleci.com/docs/guides/toolkit/circleci-cli/index.md)
      A guide to the CircleCI CLI with links to setup guides, a ful reference and how-to guides for common tasks.
    - CLI migration guide (https://circleci.com/docs/guides/toolkit/cli-migration-guide/) [md](https://circleci.com/docs/guides/toolkit/cli-migration-guide/index.md)
      A mapping of legacy CircleCI CLI commands to their equivalents in CircleCI CLI v1.
  - Environment CLI
    - CircleCI environment CLI usage guide (https://circleci.com/docs/reference/environment-cli-usage-guide/) [md](https://circleci.com/docs/reference/environment-cli-usage-guide/index.md)
      Reference for the CircleCI environment CLI available in your pipelines, with subcommands, flags and usage examples, and how it differs from the local CLI.
  - In-app AI features
    - Enable AI-powered features (https://circleci.com/docs/guides/toolkit/enable-ai-powered-features/) [md](https://circleci.com/docs/guides/toolkit/enable-ai-powered-features/index.md)
      Enable AI features in CircleCI including natural language to cron translation, deploy markers, and AI pipeline editor
    - Intelligent summaries (https://circleci.com/docs/guides/toolkit/intelligent-summaries/) [md](https://circleci.com/docs/guides/toolkit/intelligent-summaries/index.md)
      An overview of the intelligent summaries feature, an AI enabled helper feature in CircleCI that provides help with build failures
  - APIs
    - APIs overview (https://circleci.com/docs/guides/toolkit/api-intro/) [md](https://circleci.com/docs/guides/toolkit/api-intro/index.md)
      Introduction to the CircleCI API versions and their capabilities including a how to choose the right API version for your use case.
    - API v3 developers guide (https://circleci.com/docs/guides/toolkit/api-v3-developers-guide/) [md](https://circleci.com/docs/guides/toolkit/api-v3-developers-guide/index.md)
      CircleCI API v3 guide for developers. Learn how to use the API to return detailed information about users, pipelines, projects, workflows, and more.
    - API v2 developers guide (https://circleci.com/docs/guides/toolkit/api-developers-guide/) [md](https://circleci.com/docs/guides/toolkit/api-developers-guide/index.md)
      Make calls to CircleCI API v2 with guidance on authentication, API tokens, getting started for each integration type, rate limits and pagination.
    - Managing API tokens (https://circleci.com/docs/guides/toolkit/managing-api-tokens/) [md](https://circleci.com/docs/guides/toolkit/managing-api-tokens/index.md)
      Create and rotate personal and project API tokens for the CircleCI API, and see when CircleCI emails you about personal tokens that are about to expire.
    - OAuth 2.0 API access with Dynamic Client Registration (https://circleci.com/docs/guides/toolkit/oauth-dynamic-client-registration/) [md](https://circleci.com/docs/guides/toolkit/oauth-dynamic-client-registration/index.md)
      Register OAuth 2.0 clients dynamically and use the authorization code flow with PKCE to obtain a CircleCI personal API token.
  - IDE tools
    - VS Code extension overview (https://circleci.com/docs/guides/toolkit/vs-code-extension-overview/) [md](https://circleci.com/docs/guides/toolkit/vs-code-extension-overview/index.md)
      Learn about how the CircleCI VS Code extension can help you manage your pipelines, workflows and jobs.
    - Get started with the VS Code extension (https://circleci.com/docs/guides/toolkit/get-started-with-the-vs-code-extension/) [md](https://circleci.com/docs/guides/toolkit/get-started-with-the-vs-code-extension/index.md)
      A quickstart for the CircleCI VS Code extension: install it, authenticate, set up your project, and configure the pipelines panel and notifications.
  - Config tools
    - Config SDK (https://circleci.com/docs/guides/toolkit/circleci-config-sdk/) [md](https://circleci.com/docs/guides/toolkit/circleci-config-sdk/index.md)
      The CircleCI Config SDK is a JavaScript package library for generating CircleCI config YAML.
    - Orb development kit (https://circleci.com/docs/orbs/author/orb-author/) [md](https://circleci.com/docs/orbs/author/orb-author/index.md)
      Start authoring CircleCI orbs. Compare registry, URL and inline orbs, get started with each type, and explore orb development tools.
    - Image Updater (https://circleci.com/docs/guides/toolkit/circleci-image-updater/) [md](https://circleci.com/docs/guides/toolkit/circleci-image-updater/index.md)
      The CircleCI image updater is an Alpha script that finds deprecated machine images you need to update across your organization's repositories.
  - Example projects and configs
    - Examples and guides overview (https://circleci.com/docs/guides/toolkit/examples-and-guides-overview/) [md](https://circleci.com/docs/guides/toolkit/examples-and-guides-overview/index.md)
      Examples and guides for building, testing and deploying applications on CircleCI, organized by programming language, framework and platform.
    - Sample config.yml files (https://circleci.com/docs/guides/toolkit/sample-config/) [md](https://circleci.com/docs/guides/toolkit/sample-config/index.md)
      Sample .circleci/config.yml files to start from, with examples of concurrent, sequential, approval and fan-in/fan-out workflows and multiple executors.
    - Database examples (https://circleci.com/docs/guides/toolkit/postgres-config/) [md](https://circleci.com/docs/guides/toolkit/postgres-config/index.md)
      See example database config.yml files using PostgreSQL/Rails and MySQL/Ruby for rails app with structure.sql, go app with postgresql, and MySQL project.
- Plans and pricing
  - CircleCI plans overview (https://circleci.com/docs/guides/plans-pricing/plan-overview/) [md](https://circleci.com/docs/guides/plans-pricing/plan-overview/index.md)
    An overview of CircleCI's credit-based plans, including features available at each plan tier.
  - Credits overview (https://circleci.com/docs/guides/plans-pricing/credits/) [md](https://circleci.com/docs/guides/plans-pricing/credits/index.md)
    Understand how credits work on CircleCI Free, Performance and Scale plans, how to manage your credit usage, and what limits apply on the Free plan.
  - User types and registration (https://circleci.com/docs/guides/plans-pricing/user-types-and-registration/) [md](https://circleci.com/docs/guides/plans-pricing/user-types-and-registration/index.md)
    Learn about registered users, active users, and unregistered users in CircleCI, and how to register for an account.
  - Manage budgets (https://circleci.com/docs/guides/plans-pricing/manage-budgets/) [md](https://circleci.com/docs/guides/plans-pricing/manage-budgets/index.md)
    Learn how to manage and monitor your CircleCI credit usage by setting spending limits at the organization and project level.

### Reference ()
- Start: https://circleci.com/docs/reference/configuration-reference/
- Configuration
  - Configuration reference (https://circleci.com/docs/reference/configuration-reference/) [md](https://circleci.com/docs/reference/configuration-reference/index.md)
    Reference for all CircleCI configuration keys used in the .circleci/config.yml file, including orbs, commands, executors, jobs, steps and workflows.
  - Reusable configuration reference (https://circleci.com/docs/reference/reusing-config/) [md](https://circleci.com/docs/reference/reusing-config/index.md)
    Reference for CircleCI 2.1 reusable configuration. Author reusable commands, executors and parameterized jobs, define conditional steps, and write inline orbs.
  - Project values and variables (https://circleci.com/docs/reference/variables/) [md](https://circleci.com/docs/reference/variables/index.md)
    Reference for all built-in environment variables and pipeline values available in your CircleCI projects, and which VCS integrations support each one.
  - Testsuite configuration reference (https://circleci.com/docs/reference/testsuite-configuration-reference/) [md](https://circleci.com/docs/reference/testsuite-configuration-reference/index.md)
    Reference for the CircleCI Smarter Testing configuration keys in the .circleci/test-suites.yml file, including discover, run, analysis and outputs.
  - Config policy reference (https://circleci.com/docs/reference/config-policy-reference/) [md](https://circleci.com/docs/reference/config-policy-reference/index.md)
    Open preview of config policies for CircleCI. Reference page for function helpers.
  - Optimization reference (https://circleci.com/docs/guides/optimize/optimizations/) [md](https://circleci.com/docs/guides/optimize/optimizations/index.md)
    Ways to optimize your CircleCI pipelines, from reducing data usage with storage controls and workspaces to cutting build time with caching and parallelism.
  - Outbound webhooks reference (https://circleci.com/docs/reference/outbound-webhooks-reference/) [md](https://circleci.com/docs/reference/outbound-webhooks-reference/index.md)
    Reference for the common fields and event-specific payloads sent by CircleCI outbound webhooks.
- API
  - CircleCI APIs overview (https://circleci.com/docs/guides/toolkit/api-intro/) [md](https://circleci.com/docs/guides/toolkit/api-intro/index.md)
    Introduction to the CircleCI API versions and their capabilities including a how to choose the right API version for your use case.
  - API v3 reference (https://circleci.com/docs/api/v3)
  - API v2 reference (https://circleci.com/docs/api/v2)
  - API v1 reference (https://circleci.com/docs/api/v1)
  - API v3 developers guide (https://circleci.com/docs/guides/toolkit/api-v3-developers-guide/) [md](https://circleci.com/docs/guides/toolkit/api-v3-developers-guide/index.md)
    CircleCI API v3 guide for developers. Learn how to use the API to return detailed information about users, pipelines, projects, workflows, and more.
  - API v2 developers guide (https://circleci.com/docs/guides/toolkit/api-developers-guide/) [md](https://circleci.com/docs/guides/toolkit/api-developers-guide/index.md)
    Make calls to CircleCI API v2 with guidance on authentication, API tokens, getting started for each integration type, rate limits and pagination.
  - Runner API reference (https://circleci.com/docs/reference/runner-api/) [md](https://circleci.com/docs/reference/runner-api/index.md)
    This document contains all the external-facing endpoints for CircleCI's self-hosted runner API.
- General
  - Concepts (https://circleci.com/docs/reference/concepts/) [md](https://circleci.com/docs/reference/concepts/index.md)
    Get to know the core CircleCI concepts, such as concurrency, configuration, contexts, jobs, orbs, executors and workflows, and how they fit together.
  - Glossary (https://circleci.com/docs/reference/glossary/) [md](https://circleci.com/docs/reference/glossary/index.md)
    A glossary of CircleCI-specific and CI/CD terminology used across the CircleCI product and documentation.
  - Environment CLI usage guide (https://circleci.com/docs/reference/environment-cli-usage-guide/) [md](https://circleci.com/docs/reference/environment-cli-usage-guide/index.md)
    Reference for the CircleCI environment CLI available in your pipelines, with subcommands, flags and usage examples, and how it differs from the local CLI.
  - Insights metrics glossary (https://circleci.com/docs/reference/insights-glossary/) [md](https://circleci.com/docs/reference/insights-glossary/index.md)
    Definitions for the metrics in CircleCI Insights, Insights dashboard as well as the Insights API.
  - Troubleshoot (https://circleci.com/docs/reference/troubleshoot/) [md](https://circleci.com/docs/reference/troubleshoot/index.md)
    Troubleshoot common problems with CircleCI orbs, pipelines, self-hosted runners and releases, with suggested fixes for each issue.
  - FAQ (https://circleci.com/docs/reference/faq/) [md](https://circleci.com/docs/reference/faq/index.md)
    Find answers to frequently asked questions about CircleCI, covering migration, orbs, self-hosted runner, pipelines, workflows, billing and more.

### Runner ()
- Start: https://circleci.com/docs/runner/runner-overview/
- Self-hosted runner overview (https://circleci.com/docs/runner/runner-overview/) [md](https://circleci.com/docs/runner/runner-overview/index.md)
  Learn how CircleCI's self-hosted runners enable you to use your own infrastructure for running jobs.
- Self-hosted runner concepts (https://circleci.com/docs/runner/runner-concepts/) [md](https://circleci.com/docs/runner/runner-concepts/index.md)
  Understand the core concepts behind CircleCI's self-hosted runner, including namespaces, resource classes, task-agent, container-agent, and concurrency.
- Runner feature comparison matrix (https://circleci.com/docs/runner/runner-feature-comparison-matrix/) [md](https://circleci.com/docs/runner/runner-feature-comparison-matrix/index.md)
  Compare the features of CircleCI machine runner and container runner, see the key differences, and decide which runner to choose for your jobs.
- Machine Runner Orchestrator
  - Machine Runner Orchestrator overview (https://circleci.com/docs/runner/machine-runner-orchestrator/) [md](https://circleci.com/docs/runner/machine-runner-orchestrator/index.md)
    Install and configure Machine Runner Orchestrator to scale CircleCI runner VMs with KubeVirt, including optional rerun job with SSH.
  - Machine Runner Orchestrator performance benchmarks (https://circleci.com/docs/runner/machine-runner-orchestrator-performance-benchmarks/) [md](https://circleci.com/docs/runner/machine-runner-orchestrator-performance-benchmarks/index.md)
    Performance benchmarks for the Machine Runner Orchestrator under increasing and burst load, covering queue times and throughput across resource classes.
- Container runner
  - Container runner installation (https://circleci.com/docs/runner/container-runner-installation/) [md](https://circleci.com/docs/runner/container-runner-installation/index.md)
    Install CircleCI's container runner on Kubernetes: create a namespace and resource class, then install the runner using the web app or the CLI.
  - Container runner performance benchmarks (https://circleci.com/docs/runner/container-runner-performance-benchmarks/) [md](https://circleci.com/docs/runner/container-runner-performance-benchmarks/index.md)
    Review container runner performance benchmarks and recommendations for agent replica count, concurrent tasks per replica, and node types.
  - Container runner reference (https://circleci.com/docs/runner/container-runner/) [md](https://circleci.com/docs/runner/container-runner/index.md)
    Operate and configure jobs with CircleCI's container runner, including resource classes, custom task pods, Helm chart parameters, and permissions.
- Machine runner 3
  - Install machine runner 3 on Linux (https://circleci.com/docs/runner/install-machine-runner-3-on-linux/) [md](https://circleci.com/docs/runner/install-machine-runner-3-on-linux/index.md)
    Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Linux.
  - Install machine runner 3 on macOS (https://circleci.com/docs/runner/install-machine-runner-3-on-macos/) [md](https://circleci.com/docs/runner/install-machine-runner-3-on-macos/index.md)
    Instructions on how to install CircleCI's self-hosted machine runner (3.0) on macOS.
  - Install machine runner 3 on Windows (https://circleci.com/docs/runner/install-machine-runner-3-on-windows/) [md](https://circleci.com/docs/runner/install-machine-runner-3-on-windows/index.md)
    Instructions on how to install CircleCI's machine runner 3  on Windows.
  - Install machine runner 3 on Docker (https://circleci.com/docs/runner/install-machine-runner-3-on-docker/) [md](https://circleci.com/docs/runner/install-machine-runner-3-on-docker/index.md)
    Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker.
  - Manual install on Linux and macOS (https://circleci.com/docs/runner/machine-runner-3-manual-installation/) [md](https://circleci.com/docs/runner/machine-runner-3-manual-installation/index.md)
    Instructions on how to manually start CircleCI's self-hosted machine runner 3 on macOS and Linux.
  - Manual install on Windows (https://circleci.com/docs/runner/machine-runner-3-manual-installation-on-windows/) [md](https://circleci.com/docs/runner/machine-runner-3-manual-installation-on-windows/index.md)
    Instructions on how to manually install CircleCI's self-hosted machine runner 3 on Windows.
  - Migrate from launch agent to machine runner 3 on Linux (https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-linux/) [md](https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-linux/index.md)
    Migrate an existing launch agent installation on Linux to machine runner 3. Uninstall launch agent, then install the machine runner 3 agent.
  - Migrate from launch agent to machine runner 3 on macOS (https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-macos/) [md](https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-macos/index.md)
    Steps to migrate from using launch agent to the machine runner 3 preview
  - Migrate from launch agent to machine runner 3 on Windows (https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-windows/) [md](https://circleci.com/docs/runner/migrate-from-launch-agent-to-machine-runner-3-on-windows/index.md)
    Steps to migrate from using launch agent to the machine runner 3 preview on Windows
  - Machine runner 3 configuration reference (https://circleci.com/docs/runner/machine-runner-3-configuration-reference/) [md](https://circleci.com/docs/runner/machine-runner-3-configuration-reference/index.md)
    Reference for the machine runner 3 YAML configuration file parameters.
- Self-hosted runner reference
  - Self-hosted runner API (https://circleci.com/docs/reference/runner-api/) [md](https://circleci.com/docs/reference/runner-api/index.md)
    This document contains all the external-facing endpoints for CircleCI's self-hosted runner API.
  - Self-hosted runner FAQ (https://circleci.com/docs/runner/runner-faqs/) [md](https://circleci.com/docs/runner/runner-faqs/index.md)
    This page answers the most frequently asked questions for the CircleCI's self-hosted runner product.
  - Troubleshoot self-hosted runner (https://circleci.com/docs/runner/troubleshoot-self-hosted-runner/) [md](https://circleci.com/docs/runner/troubleshoot-self-hosted-runner/index.md)
    Find common errors for CircleCI container and machine runners, along with the troubleshooting steps you can use to diagnose and fix them.
  - Scaling self-hosted runner (https://circleci.com/docs/runner/runner-scaling/) [md](https://circleci.com/docs/runner/runner-scaling/index.md)
    Scale self-hosted machine and container runners to match job demand, so you avoid paying for a fixed compute fleet when your workload fluctuates.
  - Monitor self-hosted runner fleets (https://circleci.com/docs/runner/monitor-runner-fleets/) [md](https://circleci.com/docs/runner/monitor-runner-fleets/index.md)
    View the state of your self-hosted runner fleets with the CircleCI CLI or API v3, including agent counts, running tasks, and queued tasks.

### Orbs ()
- Start: https://circleci.com/docs/orbs/use/orb-intro/
- Use orbs
  - Introduction to using orbs (https://circleci.com/docs/orbs/use/orb-intro/) [md](https://circleci.com/docs/orbs/use/orb-intro/index.md)
    Get started with CircleCI orbs, reusable packages of parameterizable configuration. Choose an orb type and use registry, URL or inline orbs in your config.
  - Orb concepts (https://circleci.com/docs/orbs/use/orb-concepts/) [md](https://circleci.com/docs/orbs/use/orb-concepts/index.md)
    Understand orb concepts, including orb types, configuration elements, namespaces, semantic versioning, private and public registry orbs, and orb packing.
  - Managing URL orbs allow lists (https://circleci.com/docs/orbs/use/managing-url-orbs-allow-lists/) [md](https://circleci.com/docs/orbs/use/managing-url-orbs-allow-lists/index.md)
    Manage URL orb allow-lists to restrict orb URL references to approved prefixes. Add, view and delete allow-lists in the CircleCI web app or with the API.
  - FAQ (https://circleci.com/docs/orbs/use/orbs-faq/) [md](https://circleci.com/docs/orbs/use/orbs-faq/index.md)
    Find answers to frequently asked questions and common technical issues that come up when you use CircleCI orbs in your projects.
- Author orbs
  - Introduction to authoring orbs (https://circleci.com/docs/orbs/author/orb-author/) [md](https://circleci.com/docs/orbs/author/orb-author/index.md)
    Start authoring CircleCI orbs. Compare registry, URL and inline orbs, get started with each type, and explore orb development tools.
  - Create a registry orb (https://circleci.com/docs/orbs/author/create-test-and-publish-a-registry-orb/) [md](https://circleci.com/docs/orbs/author/create-test-and-publish-a-registry-orb/index.md)
    Follow this tutorial to create, test and publish a new registry orb using the orb development kit, starting from a new GitHub repository.
  - Create a URL orb (https://circleci.com/docs/orbs/author/create-test-and-use-url-orbs/) [md](https://circleci.com/docs/orbs/author/create-test-and-use-url-orbs/index.md)
    Create URL orbs to share reusable CircleCI configuration across your organization from a location such as a Git repository. Test, update and version them.
  - Create an inline orb (https://circleci.com/docs/orbs/author/create-an-inline-orb/) [md](https://circleci.com/docs/orbs/author/create-an-inline-orb/index.md)
    Create inline orbs to package reusable configuration elements directly in your project config file, then validate and test them.
  - Registry orb testing methodologies (https://circleci.com/docs/orbs/author/testing-orbs/) [md](https://circleci.com/docs/orbs/author/testing-orbs/index.md)
    Test your registry orbs with validation, unit testing and integration testing, using the orb-tools pipeline to catch breaking changes before release.
  - Registry orb authoring process (manual) (https://circleci.com/docs/orbs/author/manual-orb-authoring-process/) [md](https://circleci.com/docs/orbs/author/manual-orb-authoring-process/index.md)
    Author a simple registry orb manually without the orb development kit: create a namespace, write and pack your orb, then validate and publish it.
  - Best practices (https://circleci.com/docs/orbs/author/orbs-best-practices/) [md](https://circleci.com/docs/orbs/author/orbs-best-practices/index.md)
    Follow best practices for developing orbs, covering naming, structure, deployment and promotion, so your orbs are easy to use and maintain.
  - FAQ (https://circleci.com/docs/orbs/author/orb-author-faq/) [md](https://circleci.com/docs/orbs/author/orb-author-faq/index.md)
    Find answers to frequently asked questions and common technical issues that come up when you author and publish CircleCI orbs.

### Server
- Versions: server-4.9, server-4.8, server-4.7, server-4.10
- Start: https://circleci.com/docs/server-admin/latest/overview/circleci-server-overview/
- CircleCI Server Overview (https://circleci.com/docs/server-admin/latest/overview/circleci-server-overview/) [md](https://circleci.com/docs/server-admin/latest/overview/circleci-server-overview/index.md)
  CircleCI Server 4.10 is a continuous integration and continuous delivery (CI/CD) platform that you can install on your GCP or AWS Kubernetes cluster.
- Release notes (https://circleci.com/docs/server-admin/latest/overview/release-notes/) [md](https://circleci.com/docs/server-admin/latest/overview/release-notes/index.md)
  Details of the new features included in each CircleCI Server 4.10 release.
- Installing CircleCI Server
  - Install on AWS
    - Phase 1: AWS prerequisites (https://circleci.com/docs/server-admin/latest/installation/phase-1-aws-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-1-aws-prerequisites/index.md)
      Find the general and AWS-specific requirements you need to meet before you install the CircleCI Server 4.10 application.
    - Phase 2: AWS Core services installation (https://circleci.com/docs/server-admin/latest/installation/phase-2-aws-core-services/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-2-aws-core-services/index.md)
      Install CircleCI Server 4.10 core services on AWS: create a namespace, pull images, set Helm values, deploy, and create a DNS entry.
    - Phase 3: AWS execution environments installation (https://circleci.com/docs/server-admin/latest/installation/phase-3-aws-execution-environments/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-3-aws-execution-environments/index.md)
      Set up CircleCI Server 4.10 execution environments on AWS, including Nomad clients and servers, machine provisioner, and runner.
    - Phase 4: AWS post-installation (https://circleci.com/docs/server-admin/latest/installation/phase-4-aws-post-installation/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-4-aws-post-installation/index.md)
      Complete your CircleCI Server 4.10 installation on AWS by setting up backup and restore, email notifications, and orb management.
  - Install on GCP
    - Phase 1: GCP prerequisites (https://circleci.com/docs/server-admin/latest/installation/phase-1-gcp-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-1-gcp-prerequisites/index.md)
      Find the general and GCP-specific requirements you need to meet before you install the CircleCI Server 4.10 application.
    - Phase 2: GCP Core services installation (https://circleci.com/docs/server-admin/latest/installation/phase-2-gcp-core-services/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-2-gcp-core-services/index.md)
      Install CircleCI Server 4.10 core services on GCP: create a namespace, pull images, set Helm values, deploy, and create a DNS entry.
    - Phase 3: GCP execution environments installation (https://circleci.com/docs/server-admin/latest/installation/phase-3-gcp-execution-environments/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-3-gcp-execution-environments/index.md)
      Set up CircleCI Server 4.10 execution environments on GCP, including Nomad clients and servers, machine provisioner, and runner.
    - Phase 4: GCP post-installation (https://circleci.com/docs/server-admin/latest/installation/phase-4-gcp-post-installation/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-4-gcp-post-installation/index.md)
      Complete your CircleCI Server 4.10 installation on GCP by setting up backup and restore, email notifications, and orb management.
  - Install in an air-gapped environment
    - Phase 1 - Prerequisites (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-1-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-1-prerequisites/index.md)
      A guide to installing CircleCI Server 4.10 in an air-gapped environment. Requirements, images and Helm charts.
    - Phase 2 - Configure object storage (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-2-configure-object-storage/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-2-configure-object-storage/index.md)
      How to configure object storage to run CircleCI Server 4.10 in an air-gapped environment.
    - Phase 3 - Install CircleCI Server (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-3-install-circleci-server/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-3-install-circleci-server/index.md)
      How to install the CircleCI Server 4.10 Helm deployment to an air-gapped environment.
    - Phase 4 - Configure Nomad clients (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-4-configure-nomad-clients/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-4-configure-nomad-clients/index.md)
      How to configure Nomad clients to run with CircleCI Server 4.10 in an air-gapped environment.
    - Phase 5 - Test installation (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-5-test-your-installation/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-5-test-your-installation/index.md)
      How to test your CircleCI Server 4.10 installation in an air-gapped environment.
    - Additional considerations (https://circleci.com/docs/server-admin/latest/air-gapped-installation/additional-considerations/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/additional-considerations/index.md)
      This page presents some items that should be considered when starting an air-gapped installation of CircleCI Server 4.10.
    - Example values file (https://circleci.com/docs/server-admin/latest/air-gapped-installation/example-values/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/example-values/index.md)
      This page presents an example values.yaml file to help with setting up an air-gapped installation of CircleCI Server 4.10.
  - Hardening your cluster (https://circleci.com/docs/server-admin/latest/installation/hardening-your-cluster/) [md](https://circleci.com/docs/server-admin/latest/installation/hardening-your-cluster/index.md)
    This section provides supplemental information on hardening your Kubernetes cluster for CircleCI Server 4.10.
  - Installing server behind a proxy (https://circleci.com/docs/server-admin/latest/installation/installing-server-behind-a-proxy/) [md](https://circleci.com/docs/server-admin/latest/installation/installing-server-behind-a-proxy/index.md)
    Install CircleCI Server 4.10 behind a proxy to monitor and control access to the internet, and review the known limitations of a proxied setup.
  - Upgrading server (https://circleci.com/docs/server-admin/latest/installation/upgrade-server/) [md](https://circleci.com/docs/server-admin/latest/installation/upgrade-server/index.md)
    "This document lists the steps required to upgrade a CircleCI Server 4.10 installation."
  - Installation reference (https://circleci.com/docs/server-admin/latest/installation/installation-reference/) [md](https://circleci.com/docs/server-admin/latest/installation/installation-reference/index.md)
    Example AWS and GCP Helm manifests for a CircleCI Server 4.10 installation, plus a reference of all available values.yaml options.
- CircleCI Server operator guide
  - Operator overview (https://circleci.com/docs/server-admin/latest/operator/operator-overview/) [md](https://circleci.com/docs/server-admin/latest/operator/operator-overview/index.md)
    Learn about the various tasks and tools involved in administering an installation of CircleCI Server 4.10.
  - Introduction to Nomad cluster operation (https://circleci.com/docs/server-admin/latest/operator/introduction-to-nomad-cluster-operation/) [md](https://circleci.com/docs/server-admin/latest/operator/introduction-to-nomad-cluster-operation/index.md)
    Learn how to operate the Nomad Cluster in your CircleCI Server 4.10 installation.
  - Resource consumption and cost management (https://circleci.com/docs/server-admin/latest/operator/resource-consumption-cost-management/) [md](https://circleci.com/docs/server-admin/latest/operator/resource-consumption-cost-management/index.md)
    Learn how CircleCI Server 4.10 consumes cloud resources and how to monitor costs.
  - Managing user accounts (https://circleci.com/docs/server-admin/latest/operator/managing-user-accounts/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-user-accounts/index.md)
    This section provides information to help CircleCI Server 4.10 operators manage user accounts.
  - Managing orbs (https://circleci.com/docs/server-admin/latest/operator/managing-orbs/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-orbs/index.md)
    Use this page to learn about orbs and how to manage them within CircleCI Server 4.10.
  - Manage virtual machines with machine provisioner (https://circleci.com/docs/server-admin/latest/operator/manage-virtual-machines-with-machine-provisioner/) [md](https://circleci.com/docs/server-admin/latest/operator/manage-virtual-machines-with-machine-provisioner/index.md)
    CircleCI Server 4.10 machine provisioner service controls how machine executor (Linux and Windows images) and Remote Docker jobs are run.
  - Configuring external services (https://circleci.com/docs/server-admin/latest/operator/configuring-external-services/) [md](https://circleci.com/docs/server-admin/latest/operator/configuring-external-services/index.md)
    This document describes how to configure the following external services for use with a CircleCI Server 4.10 installation
  - Data retention in server (https://circleci.com/docs/server-admin/latest/operator/data-retention/) [md](https://circleci.com/docs/server-admin/latest/operator/data-retention/index.md)
    Learn how to configure data retention policies for MongoDB, PostgreSQL, and object storage buckets in your CircleCI Server 4.10 installation.
  - Expanding internal database volumes (https://circleci.com/docs/server-admin/latest/operator/expanding-internal-database-volumes/) [md](https://circleci.com/docs/server-admin/latest/operator/expanding-internal-database-volumes/index.md)
    Resize the persistent volume claims for internal PostgreSQL and MongoDB databases when CircleCI Server 4.10 needs more database storage.
  - Managing load balancers (https://circleci.com/docs/server-admin/latest/operator/managing-load-balancers/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-load-balancers/index.md)
    Use this guide to make the frontend load balancer private for CircleCI Server 4.10.
  - User authentication (https://circleci.com/docs/server-admin/latest/operator/user-authentication/) [md](https://circleci.com/docs/server-admin/latest/operator/user-authentication/index.md)
    CircleCI Server 4.10 supports OAuth through GitHub or GitHub Enterprise.
  - Managing build artifacts (https://circleci.com/docs/server-admin/latest/operator/managing-build-artifacts/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-build-artifacts/index.md)
    Learn how Server 4.10 build artifacts persist data after a job is completed and provide longer-term storage of build process outputs.
  - Usage data collection (https://circleci.com/docs/server-admin/latest/operator/usage-data-collection/) [md](https://circleci.com/docs/server-admin/latest/operator/usage-data-collection/index.md)
    Learn about CircleCI Server 4.10 usage data collection for the purpose of improving our product and services.
  - CircleCI Server security features (https://circleci.com/docs/server-admin/latest/operator/circleci-server-security-features/) [md](https://circleci.com/docs/server-admin/latest/operator/circleci-server-security-features/index.md)
    This document outlines security features built into CircleCI Server 4.10 and related integrations.
  - Release cycle (https://circleci.com/docs/server-admin/latest/operator/application-lifecycle/) [md](https://circleci.com/docs/server-admin/latest/operator/application-lifecycle/index.md)
    Learn about CircleCI Server 4.10 semantic versioning and release schedules.
  - Troubleshooting and support (https://circleci.com/docs/server-admin/latest/operator/troubleshooting-and-support/) [md](https://circleci.com/docs/server-admin/latest/operator/troubleshooting-and-support/index.md)
    Use this document to find troubleshooting steps if you are having problems with your CircleCI Server 4.10 installation.
  - Backup and restore (https://circleci.com/docs/server-admin/latest/operator/backup-and-restore/) [md](https://circleci.com/docs/server-admin/latest/operator/backup-and-restore/index.md)
    This document outlines recommendations for how to back up and restore your CircleCI Server 4.10 instance data and state.
  - Upgrade MongoDB (https://circleci.com/docs/server-admin/latest/operator/upgrade-mongo/) [md](https://circleci.com/docs/server-admin/latest/operator/upgrade-mongo/index.md)
    Learn how to upgrade MongoDB up to v7.0.15 in an installation of CircleCI Server 4.10.
  - Upgrade PostgreSQL (https://circleci.com/docs/server-admin/latest/operator/upgrade-postgres/) [md](https://circleci.com/docs/server-admin/latest/operator/upgrade-postgres/index.md)
    Learn how to upgrade the internal PostgreSQL database from version 12 to 14 in an installation of CircleCI Server 4.10.
  - Monitoring stack reference Helm chart (https://circleci.com/docs/server-admin/latest/operator/monitoring-stack-reference-helm-chart/) [md](https://circleci.com/docs/server-admin/latest/operator/monitoring-stack-reference-helm-chart/index.md)
    Learn how to deploy your own monitoring stack for CircleCI Server 4.10 using our Helm chart as a reference.
  - FAQs (https://circleci.com/docs/server-admin/latest/operator/faq/) [md](https://circleci.com/docs/server-admin/latest/operator/faq/index.md)
    Find answers about the CircleCI Server 4.10 data retention policy, what control is granted over Nomad certificates.

### Home ()
- Start: https://circleci.com/docs/

## Platform Badges

Documentation pages include platform badges that indicate feature availability:

- **Cloud**: The features and processes described on the page are available for CircleCI Cloud
- **Server Admin**: This guide is for CircleCI Server administrators
- **Server v4+**: The features and processes described on the page are available for CircleCI Server v4.x+
- **Server v4.x** (specific versions like v4.2, v4.3): This guide is for that specific CircleCI Server version
- **Server v3.x** (specific versions): This guide is for that specific CircleCI Server version

Pages may show multiple badges if a feature is available on multiple platforms.
If no badge is shown, assume the feature is available on all platforms.

## Common URL Patterns

- Guides: https://circleci.com/docs/guides/<topic>/
- Reference: https://circleci.com/docs/reference/<topic>/
- Runner: https://circleci.com/docs/runner/<topic>/
- Orbs: https://circleci.com/docs/orbs/<topic>/
- Server Admin: https://circleci.com/docs/server-admin-<version>/<topic>/
- API: https://circleci.com/docs/api/<version>/

## API Documentation

This is the CircleCI API (v3). **Use it for all new integrations.** It is where new
capabilities land, with consistent conventions the old v2 API never had (UUID
identifiers, cursor pagination, a single error object). If you are an agent generating
code against the CircleCI API and the task does not require an existing v2 integration,
use v3:

- **API Index for LLMs**: https://circleci.com/docs/docs/api/v3/llms.txt
- **Full Reference as Markdown**: https://circleci.com/docs/docs/api/v3/index.md
  - Every operation, and the v3 conventions in full
- **Conventions**: https://circleci.com/docs/docs/api/v3/conventions.md
- **Full OpenAPI Spec**: https://circleci.com/docs/fullopenapi.json (also https://circleci.com/docs/fullopenapi.yaml)
- **Human-Readable Docs**: https://circleci.com/docs/docs/api/v3

## Legacy API Documentation (v2)

v2 remains fully supported for existing integrations, but is not the current
recommendation - see API Documentation above for new work. v2 documentation in
LLM-friendly format:

- **API Index for LLMs**: https://circleci.com/docs/api/v2/llms.txt
  - Structured index of all API endpoints
  - Tag-grouped operations with descriptions
  - Authentication and rate limiting information
- **Per-Endpoint Markdown**: https://circleci.com/docs/api/v2/operations/{operationId}.md
  - Individual markdown files for each API endpoint
  - Complete schemas, parameters, and examples
  - Example: https://circleci.com/docs/api/v2/operations/createContext.md
- **Machine-Readable Index**: https://circleci.com/docs/api/v2/operations/index.json
- **Full OpenAPI Spec**: https://circleci.com/docs/api/v2/openapi.json
- **Human-Readable Docs**: https://circleci.com/docs/api/v2/

## Server Versions

- Server 4.9: 4.9.6
- Server 4.8: 4.8.12
- Server 4.7: 4.7.15
- Server 4.6: 4.6.6
- Server 4.5: 4.5.5
- Server 4.4: 4.4.7
- Server 4.3: 4.3.9
- Server 4.2: 4.2.7
- Server 4.10: 4.10.1
- Server 4.1: 4.1.10
- Server 4.0: 4.0.6