# hub-ci-status
> A reimplementation of the ci-status subcommand of hub(1) in JavaScript for checking the GitHub CI and checks status of a commit with Node.
Latest version **2.0.0** (published 2026-05-30) · MIT license · 0 weekly downloads
## Install
```sh
npm install hub-ci-status
pnpm add hub-ci-status
yarn add hub-ci-status
bun add hub-ci-status
```
Provides the command `hub-ci-status`.
## Health
**Score 65/100 (B)** — status: active.
Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.
Warnings: low downloads; no types.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-05-30 |
| First published | 2021-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | 20 \|\| >=22 |
| Dependencies | 2 |
| Unpacked size | 45.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1 |
| Author | Kevin Locke |
| Maintainers | kevinoid |
| Keywords | ci, cli, continuous integration, github, hub |
## Links
- npm: https://www.npmjs.com/package/hub-ci-status
- Repository: https://github.com/kevinoid/hub-ci-status
- Issues: https://github.com/kevinoid/hub-ci-status/issues
- npm.io page: https://npm.io/package/hub-ci-status
## Dependencies (2)
- [commander](https://npm.io/package/commander.md) ^15.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^22.0.0
## Alternatives
- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads
## Recent versions
- 2.0.0 (latest) — 2026-05-30
- 1.0.0 — 2021-08-06
- 0.1.0 — 2021-02-01
## README
Hub CI Status
=============
[](https://github.com/kevinoid/hub-ci-status/actions/workflows/node.js.yml?query=branch%3Amain)
[](https://app.codecov.io/gh/kevinoid/hub-ci-status/branch/main)
[](https://libraries.io/npm/hub-ci-status)
[](https://www.npmjs.com/package/hub-ci-status)
[](https://www.npmjs.com/package/hub-ci-status)
A reimplementation of the [ci-status
subcommand](https://hub.github.com/hub-ci-status.1.html) of
[hub](https://hub.github.com/) in JavaScript for querying the GitHub [CI
status](https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference)
and [checks
status](https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference)
of a commit using Node.
## Introductory Examples
To get the combined CI and checks status of the checked out commit, invoke
`hub-ci-status` in a git repository with a GitHub remote:
$ hub-ci-status
pending
$ echo $?
2
### Status of Branch/Tag/Commit
To get the status of a particular commit, pass the name (any name suitable for
[`git rev-parse`](https://git-scm.com/docs/git-rev-parse)) as an argument:
$ hub-ci-status mybranch
failure
$ echo $?
1
### Wait for Pending
If the CI status or checks may not have completed, the `-w`/`--wait` option
can be passed (with an optional timeout in seconds) to wait until the status
is not pending:
$ hub-ci-status --wait 60
success
$ echo $?
0
By default, the process will exit as soon as any CI status or check fails. To
wait until all statuses/checks have finished, add `-W`/`--wait-all`.
### Verbose Output
For more verbose output, including the status context and target URL, pass the
`-v`/`--verbose` option:
$ hub-ci-status -v
● Test on Node.js * x64 on windows-latest https://github.com/kevinoid/hub-ci-status/runs/1808395138
● Test on Node.js 10 x64 on windows-latest https://github.com/kevinoid/hub-ci-status/runs/1808395109
● Test on Node.js 10 x64 on ubuntu-latest https://github.com/kevinoid/hub-ci-status/runs/1808395075
✔︎ Lint and Test on Node.js * x64 on ubuntu-latest https://github.com/kevinoid/hub-ci-status/runs/1808388960
success
Note: This option can be passed twice to print progress messages for `--wait`
to `stderr`.
## Additional Features
This module supports a few features which are not supported by [`hub
ci-status`](https://hub.github.com/hub-ci-status.1.html):
* `--wait` flag allows waiting until the status is not `pending`, with a
configurable timeout.
([github/hub#1809](https://github.com/github/hub/issues/1809))
* `--wait-all` flag allows waiting until all statuses and checks are not
`pending` (rather than exiting after first failure).
## Installation
[This package](https://www.npmjs.com/package/hub-ci-status) can be
installed using [npm](https://www.npmjs.com/), either globally or locally, by
running:
```sh
npm install hub-ci-status
```
## Contributing
Contributions are appreciated. Contributors agree to abide by the [Contributor
Covenant Code of
Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
If this is your first time contributing to a Free and Open Source Software
project, consider reading [How to Contribute to Open
Source](https://opensource.guide/how-to-contribute/)
in the Open Source Guides.
If the desired change is large, complex, backwards-incompatible, can have
significantly differing implementations, or may not be in scope for this
project, opening an issue before writing the code can avoid frustration and
save a lot of time and effort.
## License
This project is available under the terms of the [MIT License](LICENSE.txt).
See the [summary at TLDRLegal](https://tldrlegal.com/license/mit-license).
---
_Source: https://npm.io/package/hub-ci-status · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._