get-pull-protection

Fetch the protection status of a pull

Auth

Authenticated

Example

pearing-cli get-pull-protection teams/platform/website 42

Expected Response

Prints a JSON object showing all matching branch protection rules, per-check status (ok, pending, or failed), and whether the pull is currently blocked from merging. When no rules match the target branch, status is ok and rules is empty.

Errors

  • 404 Not Found when the referenced resource does not exist.
  • 403 Forbidden when owner/repo access checks fail.

Common auth errors are documented on the CLI overview page.

Help Output

Fetch the protection status of a pull.

Shows all matching branch protection rules, per-check status,
and whether the pull is currently blocked from merging.

Usage: pearing-cli get-pull-protection <REPO> <NUMBER>

Arguments:
  <REPO>    Target repo locator (`teams/<team_slug>/<repo_slug>` or `<username>/<repo_slug>`), or `<repo_slug>` for authenticated user
  <NUMBER>  Pull number in target repo

Options:
  -h, --help  Print help (see more with '--help')