inside-ci/README.md
Jonatan Nilsson 95f00d8700
All checks were successful
/ deploy (push) Successful in 17s
readme: Add docs for in-ci and not-ci
2024-11-19 10:46:15 +00:00

26 lines
445 B
Markdown

# inside-ci
Quick tool to check if we are inside a CI environment
# API
`insideCi()`
Returns true if inside CI. Otherwise returns false.
# CLI
## `inside-ci` or `in-ci`
Returns code 0 if inside CI. Otherwise returns an error code of 1.
* `inside-ci || echo 'We are not inside CI, install some stuff'`
* `in-ci && echo 'We are inside CI, install some stuff'`
Example:
`is-ci || husky install`
## `not-ci`
Inverse of the above command