Skip to content

README.md

Latest commit

 

History

History
85 lines (58 loc) · 1.8 KB

README.md

File metadata and controls

85 lines (58 loc) · 1.8 KB

gh_status.nu

A Nushell script to check GitHub Status from your terminal.

Usage

Basic

gh-status
image

Incidents

gh-status --incidents
image

Maintenance

gh-status --maintenance
image

Watch mode

Re-renders the output on a loop, bypassing the cache on each tick:

gh-status --watch
gh-status -w -n 10sec

# Or use the dedicated command, which supports the same flags:
gh-watch
gh-watch -n 10sec --incidents

Output modes

gh-status --emoji   # Force emoji icons
gh-status --text    # Plain text, no colors or icons
gh-status --json    # Output raw JSON response
gh-status --raw     # Output structured records for piping
gh-status --demo    # Show a demo of components and incidents

Other flags

gh-status --force   # Bypass cache
gh-status --debug   # Print cache path, icon mode, and status
gh-status --test    # Use fake test data

Installation

  1. Save the script as gh_status.nu.

  2. Source it in your config.nu or run directly:

    source gh_status.nu
gh-status

Configuration

Nerd Font icons

To enable Nerd Font icons by default, add this to your Nushell environment file (find it by running $nu.env-path):

$env.NERD_FONTS = "1"

The script will then use Nerd Font glyphs automatically, unless you override with --emoji or --text.