is-ci

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 :)

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

v4.1.0

• add types (116335d)

Similar packages

Other packages similar to is-ci

ci-info

Similar to is-ci, ci-info provides information about the CI environment the code is running in. It offers more detailed information compared to is-ci, such as the name of the CI service and whether the environment is a pull request. This makes ci-info a more versatile choice if you need more than just a boolean check.

is-ci-cli

is-ci-cli extends the basic functionality of is-ci by providing a command-line interface (CLI). This allows users to check for a CI environment directly from the command line without writing any JavaScript code. While is-ci is primarily used within scripts, is-ci-cli can be used directly in shell scripts or CI configuration files.