---
title: "overlane repo index show"
description: "Show the code index jobs and shard plan"
---

> 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 index 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 index jobs started by pushes, their status, whether the index is stale after a rewrite, and the shard plan of the newest snapshot (a large repository is indexed by shard, each shard checking out only its paths).

## Usage

```sh
overlane repo index show repo
```

## Arguments

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

## Examples

```sh
overlane repo index show app
```

## 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 index 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"
    },
    "repoId": {
      "type": "string",
      "pattern": "^repo_[A-Za-z0-9]{6,40}$"
    },
    "jobs": {
      "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}$"
          },
          "jobId": {
            "type": "string"
          },
          "sequence": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "sha": {
            "type": "string",
            "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
          },
          "shard": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "prefixes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "fileCount": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "id",
                  "prefixes",
                  "fileCount"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "applied",
              "ignored_stale",
              "failed"
            ]
          },
          "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",
          "jobId",
          "sequence",
          "sha",
          "shard",
          "status",
          "at"
        ],
        "additionalProperties": false
      }
    },
    "plan": {
      "anyOf": [
        {
          "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}$"
            },
            "sha": {
              "type": "string",
              "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
            },
            "totalFiles": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "shards": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "prefixes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "fileCount": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "id",
                  "prefixes",
                  "fileCount"
                ],
                "additionalProperties": false
              }
            },
            "partialCheckout": {
              "type": "boolean"
            }
          },
          "required": [
            "tenantId",
            "repoId",
            "sha",
            "totalFiles",
            "shards",
            "partialCheckout"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "stale": {
      "type": "boolean"
    }
  },
  "required": [
    "tenantId",
    "repoId",
    "jobs",
    "plan",
    "stale"
  ],
  "additionalProperties": false
}
```

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

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