NAME

gt-repo-view - View a repository

SYNOPSIS

gt repo view [<repository>] [flags]

DESCRIPTION

View a repository: its description, state, counts and clone URLs, followed by its README, which is rendered on a terminal.

A repository can be supplied as NAME (one of yours), OWNER/NAME, HOST/OWNER/NAME or a URL.
Without an argument, the repository of the current Git clone is used.

actions_enabled, archived, clone_url, default_branch, description, empty,
fork, forks_count, full_name, id, mirror, mirror_interval, name,
open_issues_count, open_pr_count, original_url, parent, private, ssh_url,
stars_count, template, topics, updated_at, url, website

OPTIONS

-b, --branch="" Show the README of this branch (default: the default branch)

-h, --help[=false] help for view

-w, --web[=false] Open the repository, or with --branch that branch, in the browser

OPTIONS INHERITED FROM PARENT COMMANDS

--csv[=""] Output CSV with the specified comma-separated fields, or all fields

--cwd="" Working directory for repository discovery

--debug[=false] Log the method, URL, status, and duration of each HTTP request to stderr

--host="" Gitea instance URL, including any base path

--interactive[=false] Allow prompts with machine output

-q, --jq="" Filter JSON output using a jq expression; implies --json

--json[=""] Output JSON with the specified comma-separated fields, or all fields

--no-input[=false] Disable prompts and implicit editor/browser interactions

--remote="" Git remote used for repository discovery

-R, --repo="" Select a repository as OWNER/REPO or URL

--sudo="" Perform API requests as this user (requires an administrator account)

--template="" Format JSON output using a Go template; implies --json (see gt help formatting)

--user="" Account name on the selected instance

EXAMPLE

# View the repository of the current clone
$ gt repo view
# View the README of another branch
$ gt repo view alice/project --branch develop
# Open the repository in the browser
$ gt repo view alice/project --web

SEE ALSO

gt-repo(1)