Detect if the current environment is a CI server (Evacuated from NSA/Microsoft Github)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Thomas Watson 8153f8844c
1.1.0
5 years ago
.gitignore Initial commit 7 years ago
.travis.yml Test against Node.js v5 and v6 6 years ago
LICENSE Bump copyright year 5 years ago
README.md Add CLI 5 years ago
bin.js Add CLI 5 years ago
index.js Depend on ci-info 6 years ago
package.json 1.1.0 5 years ago
test.js Fix Travis testing issues 6 years ago

README.md

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

Build status 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

Officially supported CI servers:

Other CI tools using environment variables like BUILD_ID or CI would be detected as well.

License

MIT