install-nix-action/node_modules/is-ci/README.md
Domen Kožar 08403cd828
v5
2019-11-13 17:14:48 +01:00

1.3 KiB

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

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

License

MIT