GH-REPO-VIEW(1)                GitHub CLI manual               GH-REPO-VIEW(1)



NAME
       gh-repo-view - View a repository



SYNOPSIS
       gh repo view [<repository>] [flags]



DESCRIPTION
       Display the description and the README of a GitHub repository.


       With no argument, the repository for the current directory is
       displayed.


       With --web, open the repository in a web browser instead.


       With --branch, view a specific branch of the repository.



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
       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



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)

                                   Mar 2026                    GH-REPO-VIEW(1)