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

FreeBSD Manual Pages

  
 
  

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 dis-
       played.

       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, fork-
       Count, fundingLinks, hasDiscussionsEnabled,  hasIssuesEnabled,  hasPro-
       jectsEnabled,   hasWikiEnabled,	 homepageUrl,	id,   isArchived,  is-
       BlankIssuesEnabled, isEmpty, isFork, isInOrganization, isMirror,	isPri-
       vate, isSecurityPolicyEnabled,  isTemplate,  isUserConfigurationReposi-
       tory,  issueTemplates, issues, labels, languages, latestRelease,	licen-
       seInfo, mentionableUsers,  mergeCommitAllowed,  milestones,  mirrorUrl,
       name, nameWithOwner, openGraphImageUrl, owner, parent, primaryLanguage,
       projects, projectsV2, pullRequestTemplates, pullRequests, pushedAt, re-
       baseMergeAllowed,  repositoryTopics,  securityPolicyUrl,	squashMergeAl-
       lowed, sshUrl, stargazerCount, templateRepository, updatedAt, url,  us-
       esCustomOpenGraphImage,	viewerCanAdminister, viewerDefaultCommitEmail,
       viewerDefaultMergeMethod, viewerHasStarred,  viewerPermission,  viewer-
       PossibleCommitEmails, 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)

				   Apr 2025		       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+14.3.quarterly>

home | help