# datadog-ci

**Repository Path**: mirrors_DataDog/datadog-ci

## Basic Information

- **Project Name**: datadog-ci
- **Description**: Use Datadog from your CI.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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/workflows/Continuous%20Integration/badge.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![NodeJS Version](https://img.shields.io/badge/Node.js-18+-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 package is under [@datadog/datadog-ci](https://www.npmjs.com/package/@datadog/datadog-ci) and can be installed through NPM or Yarn:

```sh
# NPM
npm install --save-dev @datadog/datadog-ci

# Yarn
yarn add --dev @datadog/datadog-ci
```

If you need `datadog-ci` as a CLI tool instead of a package, you can run it with [`npx`](https://www.npmjs.com/package/npx) or install it globally:

```sh
# npx
npx @datadog/datadog-ci [command]

# NPM install globally
npm install -g @datadog/datadog-ci

# Yarn v1 add globally
yarn global add @datadog/datadog-ci
```

For more ways to install the CLI, see [this section](#more-ways-to-install-the-cli).

## Usage

```bash
Usage: datadog-ci <command> [<subcommand>] [options]
```

The following values are available for each `<command>` and (optionally) `<subcommand>`.

See each command's linked README for more details, or click on [📚](https://docs.datadoghq.com/) to see the related documentation page.

#### `aas`
- `instrument`: Apply Datadog instrumentation to the given [Azure App Services](/packages/plugin-aas). [📚](https://docs.datadoghq.com/serverless/azure_app_services/)
- `uninstrument`: Revert Datadog instrumentation from the given [Azure App Services](/packages/plugin-aas).

#### `cloud-run`
- `flare`: Troubleshoot your issues with [Cloud Run service](/packages/plugin-cloud-run) configuration. [📚](https://docs.datadoghq.com/serverless/google_cloud_run)
- `instrument`: Apply Datadog instrumentation to the given [Cloud Run Services](/packages/plugin-cloud-run). [📚](https://docs.datadoghq.com/serverless/google_cloud_run/)
- `uninstrument`: Revert Datadog instrumentation from the given [Cloud Run Services](/packages/plugin-cloud-run). [📚](https://docs.datadoghq.com/serverless/google_cloud_run/)

#### `coverage`
- `upload`: Upload code coverage report files to Datadog. [📚](https://docs.datadoghq.com/code_coverage/)

#### `dora`
- `deployment`: Send a new deployment event for [DORA Metrics](/packages/plugin-dora) to Datadog. [📚](https://docs.datadoghq.com/dora_metrics/)

#### `dsyms`
- `upload`: Upload [iOS dSYM files](/packages/datadog-ci/src/commands/dsyms) for Error Tracking (macOS only). [📚](https://docs.datadoghq.com/real_user_monitoring/error_tracking/ios/)

#### `flutter-symbols`
- `upload`: Upload [Flutter symbols](/packages/datadog-ci/src/commands/flutter-symbols) for Error Tracking. [📚](https://docs.datadoghq.com/real_user_monitoring/error_tracking/flutter/)

#### `unity-symbols`
- `upload`: Upload [Unity symbols](/packages/datadog-ci/src/commands/unity-symbols) for Error Tracking.

#### `git-metadata`
- `upload`: Upload [Git metadata](/packages/datadog-ci/src/commands/git-metadata) for the Source Code Integration. [📚](https://docs.datadoghq.com/integrations/guide/source-code-integration/)

#### `junit`
- `upload`: Upload [JUnit test reports](/packages/datadog-ci/src/commands/junit) for Test Visibility. [📚](https://docs.datadoghq.com/tests/setup/junit_xml/)

#### `lambda`
- `flare`: Troubleshoot your issues with Datadog instrumentation on your [AWS Lambda functions](/packages/plugin-lambda).
- `instrument`: Apply Datadog instrumentation to the given [AWS Lambda functions](/packages/plugin-lambda).
- `uninstrument`: Revert Datadog instrumentation from the given [AWS Lambda functions](/packages/plugin-lambda).

#### `measure`

- Add [measures](/packages/datadog-ci/src/commands/measure) to a CI Visibility pipeline trace or job span in Datadog. [📚](https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_measures/)

#### `react-native`
- `codepush`: Upload [React Native CodePush sourcemaps](/packages/datadog-ci/src/commands/react-native) for Error Tracking. [📚](https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/setup/codepush/)
- `upload`: Upload [React Native sourcemaps](/packages/datadog-ci/src/commands/react-native) for Error Tracking. [📚](https://docs.datadoghq.com/real_user_monitoring/error_tracking/reactnative/)
- `xcode`: Upload [React Native sourcemaps](/packages/datadog-ci/src/commands/react-native) for Error Tracking from the XCode bundle build phase. [📚](https://docs.datadoghq.com/real_user_monitoring/error_tracking/reactnative/)

#### `sarif`
- `upload`: Upload [Static Analysis Results Interchange Format (SARIF)](/packages/plugin-sarif) reports to Datadog. [📚](https://docs.datadoghq.com/code_analysis/static_analysis/)

#### `sbom`
- `upload`: Upload [Software Bill of Materials (SBOM)](/packages/plugin-sbom) files to Datadog. [📚](https://docs.datadoghq.com/code_analysis/software_composition_analysis/)

#### `sourcemaps`
- `upload`: Upload [JavaScript sourcemaps](/packages/datadog-ci/src/commands/sourcemaps) for Error Tracking. [📚](https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps)

#### `stepfunctions`
- `instrument`: Instrument [AWS Step Function](/packages/plugin-stepfunctions) with Datadog to get logs and traces. [📚](https://docs.datadoghq.com/serverless/step_functions/installation/?tab=datadogcli)
- `uninstrument`: Uninstrument [AWS Step Function](/packages/plugin-stepfunctions). [📚](https://docs.datadoghq.com/serverless/step_functions/installation/?tab=datadogcli)

#### `synthetics`
- `run-tests`: Run [Continuous Testing tests](/packages/plugin-synthetics) from the CI. [📚](https://docs.datadoghq.com/continuous_testing/)
- `upload-application`: Upload a new version to an [existing mobile application](/packages/plugin-synthetics/src) in Datadog. [📚](https://docs.datadoghq.com/mobile_app_testing/)

#### `tag`
- Add [custom tags](/packages/datadog-ci/src/commands/tag) to a CI Visibility pipeline trace or job span in Datadog. [📚](https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_measures/)

#### `trace`
- Add [custom commands](/packages/datadog-ci/src/commands/trace) to a CI Visibility pipeline in Datadog. [📚](https://docs.datadoghq.com/continuous_integration/pipelines/custom_commands/)

### Beta commands

The following are **beta** commands, you can enable them with with `DD_BETA_COMMANDS_ENABLED=1`:

#### `deployment`
- `mark`: Mark a CI job as a [deployment](/packages/plugin-deployment#mark). [📚](https://docs.datadoghq.com/continuous_delivery/)
- `correlate`: [Correlate](/packages/plugin-deployment#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](/packages/plugin-deployment#correlate-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](/packages/plugin-deployment#gate). [📚](https://docs.datadoghq.com/deployment_gates/)

#### `elf-symbols`
- `upload`: Upload [Elf debug info files](/packages/datadog-ci/src/commands/elf-symbols) for Profiling (requires binutils). [📚](https://docs.datadoghq.com/profiler/enabling/ddprof)

#### `pe-symbols`
- `upload`: Upload [Windows PE debug info files](/packages/datadog-ci/src/commands/pe-symbols) for Profiling. [📚](https://docs.datadoghq.com/profiler/enabling/ddprof)

#### `gate`
- `evaluate`: Evaluate [Quality Gates](/packages/plugin-gate) rules in Datadog. [📚](https://docs.datadoghq.com/quality_gates/)


### 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.
The released `datadog-ci` binary now uses Node.js version 18 to be compatible with OpenSSL 3.

#### `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`


## More ways to install the CLI

### Standalone binary

If installing NodeJS in the CI is an issue, standalone binaries are provided with [releases](https://github.com/DataDog/datadog-ci/releases). _linux-x64_, _linux-arm64_, _darwin-x64_, _darwin-arm64_ (MacOS) and _win-x64_ (Windows) are supported.

To install:

#### Linux

```sh
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
```

#### MacOS

```sh
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
```

#### Windows

```sh
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" --t 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)