zkat / is_ci

Super lightweight and dead-simple CI detection.

This crate tells you if you're in a CI environment or not. It does not tell you which you're in, but it makes a good effort to make sure to accurately tell you whether you're in one.

This crate is based on the @npmcli/ci-detect package.

If you need more information about the specific CI environment you're running in and you can handle a heavier dependency, please consider using ci_info instead.

Example

// You can call this repeatedly if you want to get the same result, cached.
let am_i_in_ci_right_now = is_ci::cached();

// If you expect your environment to change between calls, use this instead:
let checking_again_just_in_case = is_ci::uncached();

License

is_ci is released to the Rust community under the ISC License.

It is based on @npmcli/ci-detect which is released to the community under the ISC License.

is_ci's Issues

Please explain in more places how does it work

Hi. Maybe I have trust issues :D, but seeing a crate like this my first and only question was: "how does it know?". I suspected it is checking some env variables, but it took me quite a bit of clicking to arrive at the actual code. Seems like "This crate checks CI and other env variables set by popular CI systems" is worth putting in a https://docs.rs/is_ci/latest/is_ci/ and README.md

BTW. I would feel better if I knew there's a way to force the result both ways. Seems like CI=0 or CI=false or something like that is not implemented. Just thinking aloud. Anyway, thank you for this project.