GH-PR-CHECKOUT(1) GitHub CLI manual GH-PR-CHECKOUT(1)

# [NAME](#NAME)

gh-pr-checkout - Check out a pull request in git

# [SYNOPSIS](#SYNOPSIS)

**gh pr checkout \[<number> | <url> | <branch>] \[flags]**

# [OPTIONS](#OPTIONS)

[**-b**, **--branch** **<string>**](#b)

Local branch name to use (default \[the name of the head branch])

[**--detach**](#detach)

Checkout PR with a detached HEAD

[**-f**, **--force**](#f)

Reset the existing local branch to the latest state of the pull request

[**--recurse-submodules**](#recurse_submodules)

Update all submodules after checkout

[**--worktree** **<path>**](#worktree)

Check out the pull request into a worktree at the given path

# [OPTIONS INHERITED FROM PARENT COMMANDS](#OPTIONS_INHERITED_FROM_PARENT_COMMANDS)

[**-R**, **--repo** **<\[HOST/\]OWNER/REPO>**](#R)

Select another repository using the \[HOST/]OWNER/REPO format

# [ALIASES](#ALIASES)

gh pr co

# [EXIT CODES](#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.

# [EXAMPLE](#EXAMPLE)

```
# Interactively select a PR from the 10 most recent to check out
$ gh pr checkout
# Checkout a specific PR
$ gh pr checkout 32
$ gh pr checkout https://github.com/OWNER/REPO/pull/32
$ gh pr checkout feature
$ gh pr checkout 32 --branch feature --worktree /path/to/wt-feature
```

# [SEE ALSO](#SEE_ALSO)

[**gh-pr(1)**](/man/os/gh/gh-pr.1)

Sep 2026

---

Document: gh-pr-checkout(1) from gh 2.102.0-r0 (Chainguard OS)
Source: https://github.com/cli/cli