Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/github-actions-watcher
A CLI tool to see the status of your all GitHub Actions workflows in real time
https://github.com/spatie/github-actions-watcher
actions github watcher
Last synced: 5 days ago
JSON representation
A CLI tool to see the status of your all GitHub Actions workflows in real time
- Host: GitHub
- URL: https://github.com/spatie/github-actions-watcher
- Owner: spatie
- License: mit
- Created: 2021-12-02T19:07:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T12:31:56.000Z (6 months ago)
- Last Synced: 2025-01-01T04:05:10.842Z (12 days ago)
- Topics: actions, github, watcher
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 20.8 MB
- Stars: 124
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# A CLI tool to see the status of all your GitHub Actions workflows in real time
[](https://packagist.org/packages/spatie/github-actions-watcher)
[](https://github.com/spatie/github-actions-watcher/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/spatie/github-actions-watcher)
The official GitHub CLI allows you to monitor a single workflow on the terminal. Using our GitHub Actions Watcher tool you can monitor the results of all your GitHub Actions. When installed, you can just execute `actions-watcher` to see all results.
By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.
## Support us
[
](https://spatie.be/github-ad-click/github-actions-watcher)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Source diving this tool
In [this stream on YouTube](https://www.youtube.com/watch?v=fkBuSR6_OuE), we'll guide you through the entire source code of the tool.
## Installation
You can install the tool via composer:
```bash
composer global require spatie/github-actions-watcher
```
## Usage
You can just execute the tool on your cli.
```bash
actions-watcher
```
By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.
## Authenticating with GitHub
To see results of private repos, you must authenticate with GitHub. Even when working with public repos, we highly recommend authenticating, as you'll get higher rate limit when the tools communicates with GitHub.
You can authenticate with GitHub by executing this command:
```bash
actions-watcher login
```
After having completed the login flow, a token will be stored on your disk. At no point, Spatie can see any data of your repos or user.
To destroy the token on your hard disk, execute the `logout` command.
```
actions-watcher logout
```
## Single pass
If you don't want to poll for new results, but just want to see current results use the `--single-pass` option
```bash
actions-watcher --single-pass
```
## Using an alternative repo and/or branch
By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.
If you want to use another repo or branch, use the `--repo` and `--branch` flags.
```bash
actions-watcher --repo=your-organisation/your-repo-name --branch=other-branch
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
A big thank you to [Francisco Madeira](https://github.com/xiCO2k) and [Owen Voke](https://github.com/owenvoke) for helping us with the layout of the screens.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.