github-user-status
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

[WIP] GitHub User Status CLI

A CLI for setting your GitHub user status

NPM Build Status Codecov

Usage

You'll need to set a GitHub personal access token, with the user scope if you want to change your own status.

Get your own status

$ npx github-user-status

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
)

Readme

Keywords

none

Package Sidebar

Install

npm i github-user-status

Weekly Downloads

3

Version

0.1.2

License

none

Unpacked Size

18.7 kB

Total Files

17

Last publish

Collaborators

  • jasonetco