JasonEtco / github-user-status

A CLI for setting your GitHub user status

[WIP] GitHub User Status CLI

A CLI for setting your GitHub user status

Usage

You'll need to set a GitHub personal access token to GITHUB_TOKEN, with the user scope if you want to change your own status. You can also use the -t=<token> flag.

Get your own status

$ npx github-user-status

With a GitHub personal access token:

$ npx github-user-status -t <token>

Get the status of a user

$ npx github-user-status -u <user>

Change your status

$ npx github-user-status -m <message> -e [emoji]

Programmatic Usage

const { getUserStatus, changeUserStatus } = require('github-user-status')

// Get your own status
getUserStatus(token)

// Get a user's status
getUserStatus(token, 'JasonEtco')

// Set your status
changeUserStatus(
  {
    message, // string, required
    emoji, // string
    expiresAt, // string
    limitedAvailability, // boolean
  },
  token
)