datadog/datadog-ci

Latest recorded source activity: August 4, 2026 at 08:06

SkillsMP catalog refreshed: November 5, 2026 at 19:57

skills collected: 2

GitHub stars: 163
GitHub forks: 74

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/datadog/datadog-ci.

Repository README

Repository README source: README.md

Read the source README

Expand full README

# Datadog CI [![NPM Version](https://img.shields.io/npm/v/@datadog/datadog-ci)](https://www.npmjs.com/package/@datadog/datadog-ci) [![Continuous Integration](https://github.com/DataDog/datadog-ci/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/DataDog/datadog-ci/actions/workflows/ci.yml?query=branch%3Amaster) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Node.js Version](https://img.shields.io/badge/Node.js-20+-green) Execute commands from your Continuous Integration (CI) and Continuous Delivery (CD) pipelines to integrate with existing Datadog products. See the [Usage section](#usage) for a list of available commands. ## How to install the CLI The `datadog-ci` CLI can be installed in three ways: - [@datadog/datadog-ci](https://www.npmjs.com/package/@datadog/datadog-ci) NPM package - [Standalone binary](#standalone-binary) - [Docker image](#container-image) To install the NPM package: ```sh # NPM npm install --save-dev @datadog/datadog-ci # Yarn yarn add --dev @datadog/datadog-ci ``` If you want to use `datadog-ci` without installing it in your project: ```sh # Install globally with NPM npm install -g @datadog/datadog-ci # ...or with Yarn 1 (Classic) yarn global add @datadog/datadog-ci # ...or run a one-shot install with NPM npx @datadog/datadog-ci@v5 [scope] # or with Yarn yarn dlx @datadog/datadog-ci@v5 [scope] ``` > [!WARNING] > Datadog recommends pinning an exact version of `datadog-ci` to avoid being impacted by breaking changes introduced in major versions of datadog-ci, > or being vulnerable to supply chain attacks. ## Installing a plugin Plugins are NPM packages that were split from the main `@datadog/datadog-ci` NPM package to reduce its installation size. If you are using the NPM package, you can manage plugins with the following commands: ```sh # List available plugins datadog-ci plugin list # Install a plugin datadog-ci plugin install <scope> ``` If you are using the [standalone binary](#standalone-binary), all plugins are already included, so you don't need to install them separately. ### Plugin auto-installation For backward compatibility, running a command that requires a plugin automatically installs the plugin if it is not already installed. > [!WARNING] > Datadog recommends explicitly installing plugins with `datadog-ci plugin install <scope>` to skip auto-installation. You can also disable auto-installation with `DISABLE_PLUGIN_AUTO_INSTALL=1`. ### Overriding the plugin version By default, `datadog-ci plugin install` installs a plugin version that matches the version of `datadog-ci` you are running. To override that behavior, use the `PLUGIN_INSTALL_VERSION_OVERRIDE` environment variable: ```sh PLUGIN_INSTALL_VERSION_OVERRIDE=5.23.0 datadog-ci plugin install synthetics ``` This environment variable is also respected when datadog-ci auto-installs a missing plugin. The value must be an exact semantic version (`X.Y.Z`), without ranges such as `^5.23.0`. ## Usage ```bash Usage: datadog-ci <scope> <command> [options] ``` The following `<scope>` and `<command>` values are available. #### `aas` **README:** [📚](/packages/plugin-aas) | **Documentation:** [🔗](https://docs.datadoghq.com/serverless/azure_app_services/) | **Plugin:** `@datadog/datadog-ci-plugin-aas` - `instrument`: Apply Datadog instrumentation to the given Azure Web Apps (or slots). - `uninstrument`: Revert Datadog instrumentation from the given Azure Web Apps (or slots). #### `cloud-run` **README:** [📚](/packages/plugin-cloud-run) | **Documentation:** [🔗](https://docs.datadoghq.com/serverless/google_cloud_run/) | **Plugin:** `@datadog/datadog-ci-plugin-cloud-run` - `flare`: Troubleshoot your issues with Cloud Run service configuration. - `instrument`: Apply Datadog instrumentation to the given Cloud Run Services. - `uninstrument`: Revert Datadog instrumentation from the given Cloud Run Services. #### `container-app` **README:** [📚](/packages/plugin-container-app) | **Documentation:** [🔗](https://docs.datadoghq.com/serverless/azure_container_apps/sidecar/) | **Plugin:** `@datadog/datadog-ci-plugin-container-app` - `instrument`: Apply Datadog instrumentation to Azure Container Apps. - `uninstrument`: Revert Datadog instrumentation from Azure Container Apps. #### `coverage` **README:** [📚](/packages/plugin-coverage) | **Documentation:** [🔗](https://docs.datadoghq.com/code_coverage/) - `upload`: Upload code coverage report files to Datadog. #### `dora` **README:** [📚](/packages/plugin-dora) | **Documentation:** [🔗](https://docs.datadoghq.com/dora_metrics/) - `deployment`: Send a new deployment event for DORA Metrics to Datadog. #### `dsyms` **README:** [📚](/packages/base/src/commands/dsyms) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/error_tracking/ios/) - `upload`: Upload iOS dSYM files for Error Tracking (macOS only). #### `flutter-symbols` **README:** [📚](/packages/base/src/commands/flutter-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/error_tracking/flutter/) - `upload`: Upload Flutter symbols for Error Tracking. #### `gate` **README:** [📚](/packages/plugin-gate) | **Documentation:** [🔗](https://docs.datadoghq.com/quality_gates/) > [!WARNING] > > **Deprecated:** Datadog Quality Gates is being replaced by the new PR Gates in 2026. To start the migration, please fill out this form: https://forms.gle/qnhANsE1ABtHrjqz9 > > Learn more about PR Gates: https://docs.datadoghq.com/pr_gates - `evaluate`: Evaluate Quality Gates rules in Datadog. #### `git-metadata` **README:** [📚](/packages/base/src/commands/git-metadata) | **Documentation:** [🔗](https://docs.datadoghq.com/integrations/guide/source-code-integration/) - `upload`: Upload Git metadata for the Source Code Integration. #### `junit` **README:** [📚](/packages/base/src/commands/junit) | **Documentation:** [🔗](https://docs.datadoghq.com/tests/setup/junit_xml/) - `upload`: Upload JUnit test reports for Test Visibility. #### `lambda` **README:** [📚](/packages/plugin-lambda) | **Documentation:** [🔗](https://docs.datadoghq.com/serverless/aws_lambda/) | **Plugin:** `@datadog/datadog-ci-plugin-lambda` - `flare`: Troubleshoot your issues with Datadog instrumentation on your AWS Lambda functions. - `instrument`: Apply Datadog instrumentation to the given AWS Lambda functions. - `uninstrument`: Revert Datadog instrumentation from the given AWS Lambda functions. #### `measure` **README:** [📚](/packages/base/src/commands/measure) | **Documentation:** [🔗](https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_measures/) - Add measures to a CI Visibility pipeline trace or job span in Datadog. #### `pe-symbols` **README:** [📚](/packages/base/src/commands/pe-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/profiler/enabling/ddprof/) - `upload`: Upload Windows PE debug info files for Profiling. #### `ppdb-symbols` **README:** [📚](/packages/base/src/commands/ppdb-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/application_monitoring/maui/error_tracking/) - `upload`: Upload .NET MAUI Portable PDB files for Error Tracking. #### `react-native` **README:** [📚](/packages/base/src/commands/react-native) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/error_tracking/reactnative/) - `codepush`: Upload React Native CodePush sourcemaps for Error Tracking. [🔗](https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/setup/codepush/) - `upload`: Upload React Native sourcemaps for Error Tracking. - `xcode`: Upload React Native sourcemaps for Error Tracking from the XCode bundle build phase. #### `sarif` **README:** [📚](/packages/plugin-sarif) | **Documentation:** [🔗](https://docs.datadoghq.com/code_analysis/static_analysis/) - `upload`: Upload Static Analysis Results Interchange Format (SARIF) reports to Datadog. #### `sbom` **README:** [📚](/packages/plugin-sbom) | **Documentation:** [🔗](https://docs.datadoghq.com/code_analysis/software_composition_analysis/) - `upload`: Upload Software Bill of Materials (SBOM) files to Datadog. #### `sourcemaps` **README:** [📚](/packages/base/src/commands/sourcemaps) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps/) - `upload`: Upload JavaScript sourcemaps for Error Tracking. #### `stepfunctions` **README:** [📚](/packages/plugin-stepfunctions) | **Documentation:** [🔗](https://docs.datadoghq.com/serverless/step_functions/installation/?tab=datadogcli) | **Plugin:** `@datadog/datadog-ci-plugin-stepfunctions` - `instrument`: Instrument AWS Step Function with Datadog to get logs and traces. - `uninstrument`: Uninstrument AWS Step Function. #### `synthetics` **README:** [📚](/packages/plugin-synthetics) | **Plugin:** `@datadog/datadog-ci-plugin-synthetics` - `run-tests`: Run Continuous Testing tests from the CI. [🔗](https://docs.datadoghq.com/continuous_testing/) - `upload-application`: Upload a new version to an existing mobile application in Datadog. [🔗](https://docs.datadoghq.com/mobile_app_testing/) #### `tag` **README:** [📚](/packages/base/src/commands/tag) | **Documentation:** [🔗](https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_measures/) - Add custom tags to a CI Visibility pipeline trace or job span in Datadog. #### `terraform` **README:** [📚](/packages/plugin-terraform) | **Plugin:** `@datadog/datadog-ci-plugin-terraform` - `upload`: Upload Terraform plan or state files to Datadog for enhanced cloud-to-code mapping and policy evaluation. #### `trace` **README:** [📚](/packages/base/src/commands/trace) | **Documentation:** [🔗](https://docs.datadoghq.com/continuous_integration/pipelines/custom_commands/) - Add custom commands to a CI Visibility pipeline in Datadog. - `span` ([📚](/packages/base/src/commands/span)): Report a custom span to a CI Visibility pipeline in Datadog without wrapping a command. #### `unity-symbols` **README:** [📚](/packages/base/src/commands/unity-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/error_tracking/unity/) - `upload`: Upload Unity symbols for Error Tracking. ### Beta commands The following are **beta** commands, you can enable them with with `DD_BETA_COMMANDS_ENABLED=1`: #### `deployment` **README:** [📚](/packages/plugin-deployment) | **Documentation:** [🔗](https://docs.datadoghq.com/continuous_delivery/) - `mark`: Mark a CI job as a deployment. - `correlate`: Correlate GitOps CD deployments with application repositories CI pipelines. [🔗](https://docs.datadoghq.com/continuous_delivery/deployments/argocd#correlate-deployments-with-ci-pipelines) - `correlate-image`: Correlate an image from a CD provider with its source commit. [🔗](https://docs.datadoghq.com/continuous_delivery/deployments/argocd#correlate-images-with-source-code) - `gate`: Evaluate a Deployment Gate. [🔗](https://docs.datadoghq.com/deployment_gates/) #### `ecs-fargate` **README:** [📚](/packages/plugin-ecs-fargate) | **Documentation:** [🔗](https://docs.datadoghq.com/integrations/aws-fargate/) | **Plugin:** `@datadog/datadog-ci-plugin-ecs-fargate` - `instrument`: Apply Datadog instrumentation to an Amazon ECS Fargate task definition. - `uninstrument`: Revert Datadog instrumentation from an Amazon ECS Fargate task definition. #### `elf-symbols` **README:** [📚](/packages/base/src/commands/elf-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/profiler/enabling/ddprof/) - `upload`: Upload Elf debug info files for Profiling. #### `wasm-symbols` **README:** [📚](/packages/base/src/commands/wasm-symbols) | **Documentation:** [🔗](https://docs.datadoghq.com/real_user_monitoring/guide/upload-webassembly-symbols/) - `upload`: Upload WebAssembly (.wasm) debug info files for Error Tracking. #### `wasm-sourcemaps` **README:** [📚](/packages/base/src/commands/wasm-sourcemaps) - `upload`: Upload WebAssembly source maps (`*.wasm.map`) for Error Tracking, identified by service, version, and module URL. ### FIPS support The `fips` option allows `datadog-ci` to use a FIPS cryptographic module provider if the OpenSSL library installed on the host system provides it. **Note**: `datadog-ci` cannot assert if such a provider is available, and doesn't throw any error if the provider is not FIPS validated. Node.js versions below 17 are incompatible with OpenSSL 3, which provides FIPS support. If you are using a Node.js version below 17, enabling the `fips` option causes the command to throw an error. The option `fips-ignore-error` ignores this error. #### `fips` Enable `datadog-ci` FIPS support if a FIPS validated provider is installed on the host system. If you do not have a FIPS provider installed, `datadog-ci` does not raise an error. - ENV variable: `DATADOG_FIPS=true` - CLI param: `--fips` #### `fips-ignore-error` Ignore Node.js errors if FIPS cannot be enabled on the host system. **Note**: the absence of an error doesn't indicate that FIPS is enabled successfully. - ENV variable: `DATADOG_FIPS_IGNORE_ERROR=true` - CLI param: `--fips-ignore-error` ### Version banner Every invocation prints a `datadog-ci v<version>` banner to `stderr`. To silence it — for example to keep CI logs quiet when the CLI runs many times — set: - ENV variable: `DD_CI_SKIP_VERSION_BANNER=true` ## More ways to install the CLI ### Standalone binary If installing Node.js in the CI is an issue, you can download `datadog-ci` as a standalone binary: - It's built against the official Node.js distribution for supported architectures and attached to [GitHub releases](https://github.com/DataDog/datadog-ci/releases). - It includes all plugins, so you don't need to install them separately. Supported architectures: - `linux-x64` - `linux-arm64` - `alpine-x64` - `alpine-arm64` - `darwin-x64` (MacOS) - `darwin-arm64` (MacOS) - `win-x64` (Windows) > [!WARNING] > Using `strip` to remove debugging symbols from the standalone binary as an attempt to make it smaller may cause segmentation faults when running `datadog-ci`. See https://github.com/nodejs/postject/issues/90. > [!NOTE] > To determine the version when unable to run `datadog-ci --version` (for example, because of segmentation faults or an architecture mismatch), run `grep --text STANDALONE_BINARY_VERSION path/to/datadog-ci`. To install the standalone binary: #### Linux ```sh # Linux x64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_linux-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci # Linux arm64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_linux-arm64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci ``` #### Alpine ```sh # Alpine x64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_alpine-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci # Alpine arm64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_alpine-arm64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci ``` #### MacOS ```sh # MacOS x64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_darwin-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci # MacOS arm64 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_darwin-arm64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci ``` #### Windows ```sh # Windows x64 Invoke-WebRequest -Uri "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_win-x64" -OutFile "datadog-ci.exe" ``` Then, you can run `datadog-ci` commands normally: ```sh datadog-ci version ``` ### Container image To run `datadog-ci` from a container, you can use the `datadog/ci` image available in [Docker Hub](https://hub.docker.com/r/datadog/ci) as well as the public [Amazon ECR](https://gallery.ecr.aws/datadog/ci) and [Google GC](https://console.cloud.google.com/gcr/images/datadoghq/global/ci) registries. ```shell docker pull datadog/ci ``` This example demonstrates how to run a command using the container and passing in the API and app keys: ```shell export DD_API_KEY=$(cat /secret/dd_api_key) export DD_APP_KEY=$(cat /secret/dd_app_key) docker run --rm -it -v $(pwd):/w -e DD_API_KEY -e DD_APP_KEY datadog/ci <command> [<subcommand>] [options] ``` #### Building your own container image You can build an image using the provided [Dockerfile](https://github.com/DataDog/datadog-ci/blob/master/container/Dockerfile): ```sh cd container docker build --tag datadog-ci . ``` Optionally, you can use the `VERSION` build argument to build an image for a specific version: ```sh docker build --build-arg "VERSION=v3.9.0" --tag datadog-ci . ``` ## Migration guide If you are upgrading from a previous major version, read our [MIGRATING.md](MIGRATING.md) document to understand the changes and how to adapt your scripts. ## Development Before contributing to this open source project, read our [CONTRIBUTING.md](CONTRIBUTING.md) document. ## License [Apache License, v2.0](LICENSE)

Loading the repository README…

Skills in this repository

Software Developers Software Quality Assurance Analysts & Testers

2 occupation categories · 100% classified

skill

occupation

description

updated

create-plugin

Software Developers

Scaffold a new datadog-ci plugin end-to-end using repository conventions.

2026-08-04

write-tests

Software Quality Assurance Analysts & Testers

Write tests for datadog-ci commands and helpers using established repository patterns.

2026-08-04

Showing 2 of 2 collected skills.