Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
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, de-
     faultBranchRef,  deleteBranchOnMerge,  description,  diskUsage,  forkCount,
     fundingLinks,  hasDiscussionsEnabled, hasIssuesEnabled, hasProjectsEnabled,
     hasWikiEnabled, homepageUrl, id, isArchived, isBlankIssuesEnabled, isEmpty,
     isFork, isInOrganization, isMirror, isPrivate, isSecurityPolicyEnabled, is-
     Template, isUserConfigurationRepository,  issueTemplates,	issues,  labels,
     languages,  latestRelease,  licenseInfo,  mentionableUsers,  mergeCommitAl-
     lowed,  milestones,  mirrorUrl,  name,  nameWithOwner,   openGraphImageUrl,
     owner, parent, primaryLanguage, projects, projectsV2, pullRequestTemplates,
     pullRequests, pushedAt, rebaseMergeAllowed, repositoryTopics, securityPoli-
     cyUrl,  squashMergeAllowed, sshUrl, stargazerCount, templateRepository, up-
     datedAt, url, usesCustomOpenGraphImage, viewerCanAdminister, viewerDefault-
     CommitEmail, 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 com-
     mand's help for more information.

SEE ALSO
     gh-repo(1)

				    Aug 2026			 GH-REPO-VIEW(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gh-repo-view&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help