GH-AUTH-STATUS(1)

💅 GH-AUTH-STATUS(1) — the GitHub CLI manual, bestie edition 🎀

okay so this is gh-auth-status, straight out of the GitHub CLI manual, and it's genuinely the glow-up your terminal needs ✨

---

🌸 NAME 🌸

gh-auth-status — shows you the active account and the authentication state on every known GitHub host. it's giving "who am I and am I even logged in" energy 🫶

---

🦋 SYNOPSIS 🦋

gh auth status [flags]

---

✨ DESCRIPTION ✨

So here's the tea: this command displays the active account and the authentication state on each known GitHub host 💖

For every host, it tests the authentication state of each known account, and any issues it finds get included in the output. Each host section tells you which account is active — that's the one that gets used when you're targeting that host 👑

If an account on any host has authentication issues — or, if you passed --hostname, just the one host you named — the command exits with 1 and writes to stderr. heads up though: when you use the --json option, it always exits with zero no matter what auth issues are lurking, unless there's a fatal error. no cap 😭

Wanna change the active account for a host? That's a whole other vibe — see gh auth switch 🧚

---

🎀 OPTIONS 🎀

• -a, --active — display the active account only. just the main character, nobody else 💅
• -h, --hostname <string> — check only a specific hostname's auth status. one host, one vibe check 🌈
• --jq <expression> — filter the JSON output using a jq expression ✨
• --json <fields> — output JSON with the specified fields 🔥
• -t, --show-token — display the auth token. yes, the actual token, in plain sight 👀
• --template <string> — format the JSON output using a Go template; see gh help formatting 🎀

---

🍓 JSON FIELDS 🍓

• hosts

---

💜 EXIT CODES 💜

• 0: successful execution — slay ✅
• 1: error 😭
• 2: command canceled 🙈
• 4: authentication required 🔐

NOTE: specific commands may have additional exit codes. refer to that command's help for more info, iykyk 💫

---

⭐ EXAMPLE ⭐

# Display authentication status for all accounts on all hosts
$ gh auth status

# Display authentication status for the active account on a specific host
$ gh auth status --active --hostname github.example.com

# Display tokens in plain text
$ gh auth status --show-token

# Format authentication status as JSON
$ gh auth status --json hosts

# Include plain text token in JSON output
$ gh auth status --json hosts --show-token

# Format hosts as a flat JSON array
$ gh auth status --json hosts --jq '.hosts | add'

---

🌈 SEE ALSO 🌈

• gh-auth(1) — go read it, bestie, it's iconic 👑

---

and that's the whole page, periodt 💅 this was GitHub CLI v2.102.0, dated Oct 2026 — mwah, go forth and check your auth status, you gorgeous nerd 🫶✨🎀