---
title: "overlane docs libraries"
description: "List the library versions this team has indexed, with their age"
---

> 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 docs libraries

{/* 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`. */}

Lists the public library versions the team asked for and the team's private docs, each with the date it was fetched and a stale flag past 30 days.

## Usage

```sh
overlane docs libraries [--service URL] [--team TENANT_ID]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--team` | string | no |  | The team (tenant) to act on (default: the one your token belongs to) |

## Examples

```sh
overlane docs libraries
overlane docs libraries --json
```

## Behavior

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

## 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"
    },
    "operation": {
      "type": "string",
      "const": "libraries"
    },
    "versions": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "libraryId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "ecosystem": {
                "type": "string",
                "enum": [
                  "npm",
                  "pypi",
                  "cargo",
                  "go"
                ]
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 214,
                "pattern": "^[@A-Za-z0-9][@A-Za-z0-9._/~-]*$"
              },
              "version": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "pattern": "^[0-9A-Za-z][0-9A-Za-z.+_~-]*$"
              },
              "status": {
                "type": "string",
                "enum": [
                  "indexing",
                  "ready",
                  "failed",
                  "blocked"
                ]
              },
              "chunkCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "pageCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "fetchedAt": {
                "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)))$"
              },
              "checkedAt": {
                "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)))$"
              },
              "ageDays": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "ageLabel": {
                "type": "string",
                "maxLength": 60
              },
              "stale": {
                "type": "boolean"
              },
              "contentHash": {
                "type": "string",
                "maxLength": 80
              },
              "visibility": {
                "type": "string",
                "const": "public"
              },
              "tenantId": {
                "type": "null"
              }
            },
            "required": [
              "libraryId",
              "ecosystem",
              "name",
              "version",
              "status",
              "chunkCount",
              "pageCount",
              "fetchedAt",
              "checkedAt",
              "ageDays",
              "ageLabel",
              "stale",
              "contentHash",
              "visibility",
              "tenantId"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "libraryId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "ecosystem": {
                "type": "string",
                "enum": [
                  "npm",
                  "pypi",
                  "cargo",
                  "go"
                ]
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 214,
                "pattern": "^[@A-Za-z0-9][@A-Za-z0-9._/~-]*$"
              },
              "version": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "pattern": "^[0-9A-Za-z][0-9A-Za-z.+_~-]*$"
              },
              "status": {
                "type": "string",
                "enum": [
                  "indexing",
                  "ready",
                  "failed",
                  "blocked"
                ]
              },
              "chunkCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "pageCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "fetchedAt": {
                "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)))$"
              },
              "checkedAt": {
                "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)))$"
              },
              "ageDays": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "ageLabel": {
                "type": "string",
                "maxLength": 60
              },
              "stale": {
                "type": "boolean"
              },
              "contentHash": {
                "type": "string",
                "maxLength": 80
              },
              "visibility": {
                "type": "string",
                "const": "private"
              },
              "tenantId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128,
                "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
                "description": "tenant identifier"
              }
            },
            "required": [
              "libraryId",
              "ecosystem",
              "name",
              "version",
              "status",
              "chunkCount",
              "pageCount",
              "fetchedAt",
              "checkedAt",
              "ageDays",
              "ageLabel",
              "stale",
              "contentHash",
              "visibility",
              "tenantId"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "tenantId",
    "operation",
    "versions"
  ],
  "additionalProperties": false
}
```

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

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