GH-PROJECT-FIELD-LIST(1)

📦
version 2.102.0 · 11 versions
, in opensuse-leap 16.0

💅 gh-project-field-list — bestie edition 💅

okay so this is the gh manual page for gh-project-field-list, straight out of the GitHub CLI manual (yes, that GitHub CLI, the one you already have installed, slay). It's a subcommand situation — it lives under the gh project family, and it does exactly one iconic thing: it lists the fields in a project. That's it. That's the whole vibe. 🎀

✨ NAME ✨

gh-project-field-list — List the fields in a project 💜

Like, all the fields. The custom ones, the built-in ones, the ones somebody on your team added at 2am and then forgot about. It's giving inventory check, honestly.

🌸 SYNOPSIS 🌸

gh project field-list [<number>] [flags]

See that <number> in italics? That's the project number, and it's optional (square brackets, bestie, square brackets mean optional 🫶). And [flags] means you can pile on the options below. Go off.

🔥 OPTIONS 🔥

  • --format <string> — Output format. The documented value here is {json}. So… json. That's the format. That's the whole menu. 🍓
  • -q, --jq <expression> — Filter JSON output using a jq expression. You know jq, you love jq, you've cried over jq — now use it right here on the JSON output. iykyk. 💅
  • -L, --limit <int> (default 30) — Maximum number of fields to fetch. Defaults to 30, so if your project has a truly unhinged number of fields you gotta raise it yourself. no cap. 🌈
  • --owner <string> — Login of the owner. And here's the cute part: use "@me" for the current user. Very main character energy of you. ✨
  • -t, --template <string> — Format JSON output using a Go template. And for the lore, it says: see "gh help formatting". Go read that, it's literally right there. 🦋
ngl if you mix --format, --jq and --template without thinking, that's a you problem — this page doesn't promise anything about that, and neither do I. 🙈

⭐ EXIT CODES ⭐

okay so exit codes, the vibe check of any command:

  1. 0 — Successful execution — ate and left no crumbs 👑
  2. 1 — Error — something went sideways 💀
  3. 2 — Command canceled — you hit Ctrl+C, no judgment
  4. 4 — Authentication required — go log in, bestie 😭
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. (fr fr, always check the command's own help. there may be extra codes lurking.)

🧚 EXAMPLE 🧚

Here's the actual example, verbatim, because I would never mess with your copy-paste:

# List fields in the current user's project "1"
$ gh project field-list 1 --owner "@me"

Look at that. Project 1, owner "@me", fields listed. Chef's kiss. Obsessed. 🍓

🎀 SEE ALSO 🎀

  • gh-project(1) — the parent page, go read it too, it's the whole family 💖

and that's the page!! GitHub CLI v2.102.0, dated Oct 2026, from the GitHub CLI manual — ty for reading my whole essay, ily, go list some fields 💜✨🫶

📦 where this page comes from