https://github.com/brunoscheufler/ghstatus
:ok_hand: A simple tool to retrieve and update your GitHub status from your terminal
https://github.com/brunoscheufler/ghstatus
cli github golang graphql tool
Last synced: 13 days ago
JSON representation
:ok_hand: A simple tool to retrieve and update your GitHub status from your terminal
- Host: GitHub
- URL: https://github.com/brunoscheufler/ghstatus
- Owner: BrunoScheufler
- License: mit
- Archived: true
- Created: 2019-03-17T11:10:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-13T19:38:48.000Z (over 6 years ago)
- Last Synced: 2024-06-21T06:04:40.657Z (over 1 year ago)
- Topics: cli, github, golang, graphql, tool
- Language: Go
- Homepage: https://brunoscheufler.com/blog/2019-03-17-updating-your-github-status-with-ghstatus
- Size: 40 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ghstatus
> A simple tool to retrieve and update your GitHub status from your terminal
```bash
# Get your current status
$ ghstatus
Current status: 🐋 Containerizing and shipping all the things
```
```bash
# Update your status
$ ghstatus set :whale: Containerizing all the things!
🎉 Updated your status!
# Or set yourself as busy
$ ghstatus --busy set :sleeping: Taking a nap
🎉 Updated your status!
```
## installation
Head over to the [releases page](https://github.com/BrunoScheufler/ghstatus/releases) and get your ghstatus binary!
Once you've downloaded a binary and made it executable, run it once and head over to the newly-generated config file (located in `~/.config/ghstatus/config.json` by default, you can change this behaviour by setting the `--config` flag to point to your file location of choice) and enter your GitHub access token. The token has to be permitted to access the following scopes: `user`, `read:org`.
## usage
> Note: If you want to add quotes or other special characters to your status message, please escape them correctly using backslashes.
To see the full list of supported operations, simply execute `ghstatus help`.
## additional notes
All of the included functionality is achieved by using a few great packages, such as
- [mapstructure](https://github.com/mitchellh/mapstructure) for handling JSON -> map -> struct workflows
- [aurora](https://github.com/logrusorgru/aurora) for all of the terminal colors
- [emoji](https://github.com/kyokomi/emoji) for the :sparkles: emoji magic
## license
This project is licensed under the [MIT License](LICENSE.md)