overlane wiki show | Overlane Docs

Prints one wiki page by its slug (see overlane wiki list): what the package or app holds, its entry points, its main symbols, what it depends on and what uses it, and the files and commit it cites. A page holds only what the code map stores: paths and declarations, never source text.

Usage

overlane wiki show slug

Arguments

Argument	Required	Description
`slug`	yes	The page name from `overlane wiki list`, for example overview or apps-api-worker

Examples

overlane wiki show overview
overlane wiki show packages-cli --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 show.

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"
    },
    "slug": {
      "type": "string",
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "overview",
        "unit"
      ]
    },
    "path": {
      "type": "string"
    },
    "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)))$"
    },
    "summary": {
      "type": "string",
      "minLength": 1
    },
    "fileCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "symbolCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string",
            "minLength": 1
          },
          "files": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "language",
          "files"
        ],
        "additionalProperties": false
      }
    },
    "entryPoints": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "symbols": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "module",
              "namespace",
              "class",
              "interface",
              "type",
              "enum",
              "function",
              "method",
              "property",
              "variable",
              "constant",
              "parameter",
              "unknown"
            ]
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "line": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "name",
          "kind",
          "path",
          "line"
        ],
        "additionalProperties": false
      }
    },
    "dependsOn": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "references": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "slug",
          "title",
          "references"
        ],
        "additionalProperties": false
      }
    },
    "dependents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "references": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "slug",
          "title",
          "references"
        ],
        "additionalProperties": false
      }
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "sourcesTruncated": {
      "type": "boolean"
    },
    "markdown": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "tenantId",
    "projectId",
    "slug",
    "title",
    "kind",
    "path",
    "commitSha",
    "generatedAt",
    "summary",
    "fileCount",
    "symbolCount",
    "languages",
    "entryPoints",
    "symbols",
    "dependsOn",
    "dependents",
    "sources",
    "sourcesTruncated",
    "markdown"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.