https://github.com/sindresorhus/is-in-ci

Check if the process is running in a Continuous Integration (CI) environment
https://github.com/sindresorhus/is-in-ci

Last synced: about 13 hours ago
JSON representation

Check if the process is running in a Continuous Integration (CI) environment

• Host: GitHub
• URL: https://github.com/sindresorhus/is-in-ci
• Owner: sindresorhus
• License: mit
• Created: 2023-10-27T18:28:31.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-09T06:14:26.000Z (8 months ago)
• Last Synced: 2024-04-13T17:56:32.662Z (5 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 27
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome - sindresorhus/is-in-ci - Check if the process is running in a Continuous Integration (CI) environment (others)

README

        
# is-in-ci

> Check if the process is running in a [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) environment

## Install

```sh

npm install is-in-ci

```

## Usage

```js

import isInCi from 'is-in-ci';

if (isInCi) {

	console.log('Running in a CI environment');

}

```

It looks for these environment variables: `CI`, `CONTINUOUS_INTEGRATION`, or any with a `CI_` prefix.

## CLI

```sh

is-in-ci && echo 'Running in a CI environment'

```

Exits with code `0` in CI environments and `1` otherwise.

## FAQ

### How can I add a CI service?

Request the CI service to include the `CI` environment variable. Most already do.

### How is this different from [`is-ci`](https://github.com/watson/is-ci)?

The `is-ci` package attempts to detect every CI service, which is unsustainable. It also has a higher risk of false-positives. For example, it detects the environment variable `RUN_ID` as CI-specific, although other services could use it. Constant updates for new CIs create version fragmentation, resulting in inconsistent behavior across dependent packages. Pushing for CI services to use a standardized CI environment variable is a more robust solution.

## Related

- [is-inside-container](https://github.com/sindresorhus/is-inside-container) - Check if the process is running inside a container

- [is-interactive](https://github.com/sindresorhus/is-interactive) - Check if stdout or stderr is interactive