Files
docs/cli-docs/reference/repo/view.md
T
bircni 55c3a392a1 feat: generate the gt command reference from gitea/cli
update_cli_docs.sh runs gt's own generator and lays the pages out for the
site: one directory per command group, front matter, titles, sidebar
order, fenced help text and rewritten links. --released succeeds while no
series is documented. A weekly workflow proposes updates like the runner's.

Signed-off-by: bircni <[email protected]>
2026-10-22 11:28:15 +02:00

1.9 KiB

sidebar_position, description
sidebar_position description
14 View a repository

gt repo view

View a repository

Synopsis

View a repository: its description, state, counts and clone URLs, followed by its README, which
is rendered on a terminal.
gt repo view [<repository>] [flags]

Examples

# 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

Options

  -b, --branch string   Show the README of this branch (default: the default branch)
  -h, --help            help for view
  -w, --web             Open the repository, or with --branch that branch, in the browser

Options inherited from parent commands

      --cwd directory       Working directory for repository discovery
      --debug               Log the method, URL, status, and duration of each HTTP request to stderr
      --host URL            Gitea instance URL, including any base path
      --interactive         Allow prompts with machine output
  -q, --jq expression       Filter JSON output using a jq expression; implies --json
      --json fields[="*"]   Output JSON with the specified comma-separated fields, or all fields
      --no-input            Disable prompts and implicit editor/browser interactions
      --remote remote       Git remote used for repository discovery
  -R, --repo OWNER/REPO     Select a repository as OWNER/REPO or URL
      --sudo user           Perform API requests as this user (requires an administrator account)
      --user name           Account name on the selected instance
  -y, --yes                 Accept confirmations without prompting

SEE ALSO

  • gt repo: Work with Gitea repositories