Skip to content
4 min read

fj pr

Work with pull requests

fj pr [OPTIONS] <COMMAND>

Every command also accepts the global flags: --host, --debug, --no-pager, --json-fields.

fj pr list

List pull requests

fj pr list [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -s, --state <STATE> — Filter by state [default: open][possible values: open, closed, all]
  • -L, --limit <LIMIT> — Maximum number of pull requests to fetch [default: 30]
  • --page <PAGE> — Page of results to fetch [default: 1]
  • --json — Emit JSON instead of a table
  • --web — Open the pull request list in your browser

fj pr view

View a pull request

fj pr view [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --comments — Include the comment thread
  • --json — Emit JSON instead of a table
  • --web — Open the pull request in your browser

fj pr create

Create a pull request

fj pr create [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Pull request title
  • -B, --base <BASE> — Base branch the PR targets [default: main]
  • -H, --head <HEAD> — Head branch. Either a branch name on the same repo, or owner:branch
  • -b, --body <BODY> — Body. Use - to read from stdin. Omit to open $EDITOR
  • --draft — Mark the PR as draft
  • --web — Open the new PR in your browser after creating

fj pr edit

Edit a pull request

fj pr edit [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Pull request title
  • -b, --body <BODY> — Body (use - for stdin, omit to open $EDITOR)
  • --body-editor — Open $EDITOR for the body (replaces the current body)

fj pr diff

Show the unified diff for a pull request

fj pr diff [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr commits

List commits in a pull request

fj pr commits [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr files

Show the file change list for a pull request

fj pr files [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr checks

Show CI / commit status checks for a pull request’s head SHA

fj pr checks [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr ready

Convert a draft pull request to ready-for-review

fj pr ready [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr comment

Add a comment to a pull request

fj pr comment [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -b, --body <BODY> — Comment body. Use - to read from stdin. Omit to open $EDITOR

fj pr update-branch

Update the PR branch by merging (or rebasing) its base branch in

fj pr update-branch [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --style <STYLE> — Update strategy: merge (default) or rebase [default: merge][possible values: merge, rebase]

fj pr review

Submit a review (approve / request changes / comment)

fj pr review [OPTIONS] --event <EVENT> <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -e, --event <EVENT> — Review action [possible values: approve, request-changes, comment]
  • -b, --body <BODY> — Review body. Use - for stdin. Omit to open $EDITOR (unless the event is approve and you have nothing to say)

fj pr request-review

Request reviews from specific users

fj pr request-review [OPTIONS] <NUMBER> [USERNAME]...

Arguments

  • <NUMBER> — Pull request number
  • [USERNAME]... — Reviewer usernames (repeatable, comma-separated also allowed)

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr unrequest-review

Remove pending reviewer requests

fj pr unrequest-review [OPTIONS] <NUMBER> [USERNAME]...

Arguments

  • <NUMBER> — Pull request number
  • [USERNAME]... — Reviewer usernames (repeatable, comma-separated also allowed)

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr status

Cross-repo dashboard of your PRs: created, review-requested, mentions

fj pr status [OPTIONS]

Options

  • -L, --limit <LIMIT> — Maximum number of pull requests to fetch [default: 20]
  • --json — Emit JSON instead of a table

fj pr checkout

Check out a pull request locally

fj pr checkout [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -b, --branch <BRANCH> — Local branch name to check out into (defaults to pr-<number>)
  • --remote <REMOTE> — Git remote to fetch the PR ref from [default: origin]

fj pr merge

Merge a pull request

fj pr merge [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --style <STYLE> — Merge method to use [default: merge][possible values: merge, rebase, rebase-merge, squash]
  • --title <TITLE> — Title for the merge commit
  • --message <MESSAGE> — Message body for the merge commit
  • --delete-branch — Delete the head branch after the merge succeeds

fj pr close

Close a pull request without merging

fj pr close [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj pr reopen

Reopen a closed pull request

fj pr reopen [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Pull request number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
Contributors
  • Stephen Way