https://github.com/jonchurch/set-gh-status

CLI to set Github User Status
https://github.com/jonchurch/set-gh-status

Last synced: about 1 month ago
JSON representation

CLI to set Github User Status

• Host: GitHub
• URL: https://github.com/jonchurch/set-gh-status
• Owner: jonchurch
• License: mit
• Created: 2020-04-22T04:54:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-22T11:43:01.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T03:43:55.156Z (9 months ago)
• Language: JavaScript
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Set Github Status

## Description

Set your [Github User Status](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#setting-a-status) from the command line.

## Usage

**Requires a Gitub Personal Access Token with the `user` and `notifications` scopes. Go [here to create one](https://github.com/settings/tokens).**

You can either export your token as an environment variable `SET_STATUS_TOKEN`, or pass it as an option:

```

export SET_STATUS_TOKEN=

set-gh-status -t  -m "Shoveling code"

```

To use `set-gh-status`, either install it globally from npm, or run it with `npx`:

```

npx set-gh-status -t  -m "Squashing bugs and giving hugs" -e ❤️

npm i -g set-gh-status

```

### Options

To see all options run `set-gh-status --help`.

```

npx set-gh-status --help

Options:

  -m, --message  status message to set

  -e, --emoji    status emoji, in unicode or :emoji: form

  -b, --busy     indicate if busy                                      [boolean]

  -t, --token    Github personal access token, requires user scopes

  -h, --help     Show help                                             [boolean]

  -v, --version  Show version number                                   [boolean]

```