Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

is-ci

watson76.9mMIT4.1.0TypeScript support: included

Detect if the current environment is a CI server

ci, continuous, integration, test, detect

readme

is-ci

Returns true if the current environment is a Continuous Integration server.

Please open an issue if your CI server isn't properly detected :)

npm Tests js-standard-style

Installation

npm install is-ci --save

Programmatic Usage

const isCI = require('is-ci')

if (isCI) {
  console.log('The code is running on a CI server')
}

CLI Usage

For CLI usage you need to have the is-ci executable in your PATH. There's a few ways to do that:

  • Either install the module globally using npm install is-ci -g
  • Or add the module as a dependency to your app in which case it can be used inside your package.json scripts as is
  • Or provide the full path to the executable, e.g. ./node_modules/.bin/is-ci
is-ci && echo "This is a CI server"

Supported CI tools

Refer to ci-info docs for all supported CI's

License

MIT

changelog

Changelog

v4.1.0

v4.0.0

v3.0.1

  • remove .github folder from published files (dd15229)

v3.0.0

Breaking changes:

  • update to ci-info v3. This drops support for EOL node versions 6, 13

v2.0.0

Breaking changes:

  • Drop support for Node.js end-of-life versions: 0.10, 0.12, 4, 5, 7, and 9

Other changes:

See ci-info changelog for a list of newly supported CI servers.