# github-ci-status

**Repository Path**: mirrors_keybase/github-ci-status

## Basic Information

- **Project Name**: github-ci-status
- **Description**: Check the current CI status of a repo using GitHub's Statuses API
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## github-ci-status

github-ci-status will tell you whether the currently checked out state of a
Git repository was tested by a CI on GitHub, using the GitHub Statuses API.

The output can look like this:
```
λ ci
Checking keybase/client:5ab4553d88

✔ The Travis CI build passed
✔ AppVeyor build succeeded
✔ Your tests passed on CircleCI!
✔ CI tests passed

λ echo $?
0
```
Or this:
```
λ ci
Checking keybase/client:1280c0238c

✔ Your tests passed on CircleCI!
✖ AppVeyor build failed
✖ The Travis CI build failed
✖ CI tests failed

λ echo $?
2
```
Or this:
```
λ ci --required-tests 3
Checking keybase/client:1207f99be4

✔ Your tests passed on CircleCI!
✔ The Travis CI build passed
⚠ The required number of tests weren't run (2 vs 3)

λ echo $?
4
```

### Usage

Just run `ci` inside your repo.  The repo should have the `origin` remote set
to GitHub.  Only works on public repos at the moment, but it would be easy to
support private and GitHub Enterprise repos too.