Sha256: 5a0bba6520e6701cb87293228a0d9cfde86525b36aa078fe0ff446505ca236c0
Contents?: true
Size: 1.27 KB
Versions: 24
Compression:
Stored size: 1.27 KB
Contents
# is-ci
Returns `true` if the current environment is a Continuous Integration
server.
Please [open an issue](https://github.com/watson/is-ci/issues) if your
CI server isn't properly detected :)
[](https://www.npmjs.com/package/is-ci)
[](https://github.com/watson/is-ci/actions)
[](https://github.com/feross/standard)
## Installation
```bash
npm install is-ci --save
```
## Programmatic Usage
```js
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`
```bash
is-ci && echo "This is a CI server"
```
## Supported CI tools
Refer to [ci-info](https://github.com/watson/ci-info#supported-ci-tools) docs for all supported CI's
## License
[MIT](LICENSE)
Version data entries
24 entries across 24 versions & 1 rubygems