overlane wiki list | Overlane Docs

The wiki is private to the team and built from the code map with no model: one page per top-level package or app, plus an overview. Each page cites the files it was built from and the commit of the snapshot. It is rebuilt when a new snapshot of the main line is published. When the team has turned the wiki off, or no snapshot has been published yet, the command says so.

Usage

overlane wiki list

Examples

overlane wiki list
overlane wiki list --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 wiki list.

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"
    },
    "commitSha": {
      "type": "string",
      "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
    },
    "generatedAt": {
      "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)))$"
    },
    "truncated": {
      "type": "boolean"
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "overview",
              "unit"
            ]
          },
          "summary": {
            "type": "string",
            "minLength": 1
          },
          "fileCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "symbolCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "slug",
          "title",
          "kind",
          "summary",
          "fileCount",
          "symbolCount"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "projectId",
    "commitSha",
    "generatedAt",
    "truncated",
    "pages"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.