---
title: "overlane repo pr show"
description: "Show a pull request: reviews, checks and what blocks the merge"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane repo pr show

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Shows the pull request with its reviews, required checks, approvals counted against the current head, and each blocker with a plain reason.

## Usage

```sh
overlane repo pr show repo number
```

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `repo` | yes | The repository name or ID |
| `number` | yes | The pull request number |

## Examples

```sh
overlane repo pr show app 7
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema repo pr show`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "pull": {
      "type": "object",
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "1"
        },
        "tenantId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "tenant identifier"
        },
        "projectId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "project identifier"
        },
        "repoId": {
          "type": "string",
          "pattern": "^repo_[A-Za-z0-9]{6,40}$"
        },
        "provider": {
          "type": "string",
          "enum": [
            "overlane",
            "github",
            "gitlab"
          ]
        },
        "number": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "body": {
          "type": "string",
          "maxLength": 60000
        },
        "state": {
          "type": "string",
          "enum": [
            "open",
            "merged",
            "closed"
          ]
        },
        "draft": {
          "type": "boolean"
        },
        "head": {
          "type": "object",
          "properties": {
            "branch": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[A-Za-z0-9._/-]+$"
            },
            "sha": {
              "type": "string",
              "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
            }
          },
          "required": [
            "branch",
            "sha"
          ],
          "additionalProperties": false
        },
        "base": {
          "type": "object",
          "properties": {
            "branch": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[A-Za-z0-9._/-]+$"
            },
            "sha": {
              "type": "string",
              "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
            }
          },
          "required": [
            "branch",
            "sha"
          ],
          "additionalProperties": false
        },
        "author": {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "user",
                "agent"
              ]
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "required": [
            "kind",
            "id"
          ],
          "additionalProperties": false
        },
        "fork": {
          "type": "boolean"
        },
        "mergeMethod": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "merge",
                "squash",
                "rebase"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "mergedSha": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
            },
            {
              "type": "null"
            }
          ]
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "schemaVersion",
        "tenantId",
        "projectId",
        "repoId",
        "provider",
        "number",
        "title",
        "body",
        "state",
        "draft",
        "head",
        "base",
        "author",
        "fork",
        "mergeMethod",
        "mergedSha",
        "createdAt",
        "updatedAt"
      ],
      "additionalProperties": false
    },
    "reviews": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "repoId": {
            "type": "string",
            "pattern": "^repo_[A-Za-z0-9]{6,40}$"
          },
          "number": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "reviewId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "reviewer": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "user",
                  "agent"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            },
            "required": [
              "kind",
              "id"
            ],
            "additionalProperties": false
          },
          "state": {
            "type": "string",
            "enum": [
              "approved",
              "changes_requested",
              "commented"
            ]
          },
          "headSha": {
            "type": "string",
            "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
          },
          "body": {
            "type": "string",
            "maxLength": 20000
          },
          "at": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "tenantId",
          "repoId",
          "number",
          "reviewId",
          "reviewer",
          "state",
          "headSha",
          "body",
          "at"
        ],
        "additionalProperties": false
      }
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "pending",
              "success",
              "failure"
            ]
          },
          "runId": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "name",
          "state",
          "runId"
        ],
        "additionalProperties": false
      }
    },
    "approvals": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "mergeable": {
      "type": "boolean"
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "checks_missing",
              "checks_failed",
              "approvals_missing",
              "changes_requested",
              "stale_approval",
              "not_open",
              "draft",
              "method_not_allowed",
              "conflict",
              "approval_required"
            ]
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "pull",
    "reviews",
    "checks",
    "approvals",
    "mergeable",
    "blockers"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/repo-pr-show/index.mdx