Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watson/is-ci
Detect if the current environment is a CI server
https://github.com/watson/is-ci
Last synced: 3 days ago
JSON representation
Detect if the current environment is a CI server
- Host: GitHub
- URL: https://github.com/watson/is-ci
- Owner: watson
- License: mit
- Created: 2015-10-07T23:37:23.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-26T04:00:45.000Z (about 3 years ago)
- Last Synced: 2024-10-29T13:05:43.212Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 384
- Watchers: 7
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - is-ci - Detect if the current environment is a CI server. ![](https://img.shields.io/github/stars/watson/is-ci.svg?style=social&label=Star) (Repository / Check/Detect)
- awesome-javascript - is-ci
- awesome-javascript - is-ci
README
# 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 :)[![npm](https://img.shields.io/npm/v/is-ci.svg)](https://www.npmjs.com/package/is-ci)
[![Tests](https://github.com/watson/is-ci/workflows/Tests/badge.svg)](https://github.com/watson/is-ci/actions)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](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)