Shows whether review posts comments or is log-only, the token cap, the latest runs and the number of open findings. States the data-use terms: diffs go to model providers only under terms that exclude training.
Usage
overlane review statusExamples
overlane review status
overlane review status --jsonBehavior
- Effect:
read(changes nothing). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: no. Accepts--force: no. - Machine-readable description:
overlane schema review status.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"type": "object",
"properties": {
"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"
},
"settings": {
"type": "object",
"properties": {
"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"
},
"mode": {
"type": "string",
"enum": [
"log_only",
"comments"
]
},
"tokenCap": {
"type": "integer",
"minimum": 1000,
"maximum": 2000000
},
"skipPatterns": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"privacy": {
"type": "string",
"const": "Review sends the diff of a pull request, the code-map context around it and your review rules to a model provider only under terms that exclude training on that data. A fork pull request never receives your secrets."
},
"updatedAt": {
"anyOf": [
{
"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)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"tenantId",
"projectId",
"mode",
"tokenCap",
"skipPatterns",
"privacy",
"updatedAt"
],
"additionalProperties": false
},
"runs": {
"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"
},
"id": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "project identifier"
},
"provider": {
"type": "string",
"enum": [
"overlane",
"github",
"gitlab"
]
},
"repository": {
"type": "string",
"minLength": 1
},
"pullNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"headSha": {
"type": "string",
"pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
},
"trigger": {
"type": "string",
"enum": [
"opened",
"push",
"manual"
]
},
"fork": {
"type": "boolean"
},
"mode": {
"type": "string",
"enum": [
"log_only",
"comments"
]
},
"status": {
"type": "string",
"enum": [
"completed",
"partial",
"failed"
]
},
"tokensUsed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"tokenCap": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"model": {
"type": "string",
"minLength": 1
},
"posted": {
"type": "boolean"
},
"findings": {
"type": "object",
"properties": {
"open": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fixed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"dismissed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"open",
"fixed",
"dismissed"
],
"additionalProperties": false
},
"startedAt": {
"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)))$"
},
"completedAt": {
"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",
"id",
"projectId",
"provider",
"repository",
"pullNumber",
"headSha",
"trigger",
"fork",
"mode",
"status",
"tokensUsed",
"tokenCap",
"model",
"posted",
"findings",
"startedAt",
"completedAt"
],
"additionalProperties": false
}
},
"openFindings": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"tenantId",
"projectId",
"settings",
"runs",
"openFindings"
],
"additionalProperties": false
}See exit codes for the status the process returns.