GH-REPO-VIEW(1)

πŸ¦‹ GH-REPO-VIEW(1) β€” bestie's guide to gh repo view πŸ’…

okay so real quick β€” this is straight out of the GitHub CLI manual, and it's the page for gh-repo-view, which lowkey does exactly what it says on the tin: it lets you look at a repository. that's it. that's the vibe. ✨


✨ NAME ✨

gh-repo-view β€” view a repository πŸ‘€


πŸŽ€ SYNOPSIS πŸŽ€

gh repo view [<repository>] [flags]

🌸 DESCRIPTION 🌸

so what this does is display the description and the README of a GitHub repository. that's the whole main character move. 🫢

With no argument, the repository for the current directory is displayed. no cap β€” you just run it and it knows where you are. πŸ’–

With --web, open the repository in a web browser instead. like, take it to the browser. slay. 🌈

With --branch, view a specific branch of the repository. because sometimes you want a specific branch, iykyk. 🌿


πŸ’œ OPTIONS πŸ’œ

  • -b, --branch <string> β€” View a specific branch of the repository ✨
  • -q, --jq <expression> β€” Filter JSON output using a jq expression πŸ”
  • --json <fields> β€” Output JSON with the specified fields 🧾
  • -t, --template <string> β€” Format JSON output using a Go template; see "gh help formatting" πŸŽ€
  • -w, --web β€” Open a repository in the browser 🌐

🧚 JSON FIELDS 🧚

okay so this is the big list β€” these are literally all the fields you can ask for. no skipping, bestie, here's every single one fr fr:

archivedAt, assignableUsers, codeOfConduct, contactLinks, createdAt, defaultBranchRef, deleteBranchOnMerge, description, diskUsage, forkCount, fundingLinks, hasDiscussionsEnabled, hasIssuesEnabled, hasProjectsEnabled, hasWikiEnabled, homepageUrl, id, isArchived, isBlankIssuesEnabled, isEmpty, isFork, isInOrganization, isMirror, isPrivate, isSecurityPolicyEnabled, isTemplate, isUserConfigurationRepository, issueTemplates, issues, labels, languages, latestRelease, licenseInfo, mentionableUsers, mergeCommitAllowed, milestones, mirrorUrl, name, nameWithOwner, openGraphImageUrl, owner, parent, primaryLanguage, projects, projectsV2, pullRequestTemplates, pullRequests, pushedAt, rebaseMergeAllowed, repositoryTopics, securityPolicyUrl, squashMergeAllowed, sshUrl, stargazerCount, templateRepository, updatedAt, url, usesCustomOpenGraphImage, viewerCanAdminister, viewerDefaultCommitEmail, viewerDefaultMergeMethod, viewerHasStarred, viewerPermission, viewerPossibleCommitEmails, viewerSubscription, visibility, watchers

that's the list. all of it. go wild. πŸ”₯πŸ‘‘


πŸ’€ EXIT CODES πŸ’€

  • 0 β€” Successful execution βœ…
  • 1 β€” Error 😭
  • 2 β€” Command canceled πŸ™ˆ
  • 4 β€” Authentication required πŸ”
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. 🫑

🌟 SEE ALSO 🌟

  • gh-repo(1) β€” go check that one out too, bestie πŸ’–

okay and one last thing β€” the official deets so you know this is legit: this is GitHub CLI v2.102.0, dated Oct 2026. πŸŽ€βœ¨ that's the sign-off, mwah, go view some repos πŸ’…

πŸ“¦ where this page comes from