Files
docs/cli-docs/reference/pr/checkout.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
2 Check out a pull request

gt pr checkout

Check out a pull request

Synopsis

Check out the head of a pull request in a local branch that tracks the head branch, so
that git push updates it and pr commands without an argument select the pull request.
gt pr checkout {<number> | <url> | <branch>} [flags]

Examples

$ gt pr checkout 13
$ gt pr co feature/login
$ gt pr checkout 13 --update

Options

  -b, --branch string   Local branch name (default: the head branch name when free, else OWNER/BRANCH or pr/NUMBER)
      --detach          Check out the PR commit without creating or changing a branch
  -h, --help            help for checkout
      --update          Fast-forward an existing branch to the PR head; reject divergence

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 pr: Manage pull requests