overlane repo token | Overlane Docs

Mints a token bound to this repository, a scope (read or write), your principal and an expiry. It is shown once. Hand it to a git credential helper or an Authorization header; never put it in a remote URL or a file in the working copy. Revoke it with overlane repo token revoke.

Usage

overlane repo token repo [--scope read|write] [--ttl SECONDS] [--dry-run]

Arguments

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

Flags

Flag	Type	Required	Description
`--scope`	one of `read`, `write`	no	What the token may do (default: write)
`--ttl`	string	no	Lifetime in seconds, 60 to 86400 (default 3600)
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane repo token app --scope read
overlane repo token app --scope write --ttl 600 --dry-run

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema repo token.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "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}$"
        },
        "tokenId": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "enum": [
            "read",
            "write"
          ]
        },
        "expiresAt": {
          "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)))$"
        },
        "remote": {
          "type": "string",
          "maxLength": 500
        },
        "token": {
          "type": "string",
          "minLength": 20
        },
        "usage": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "repoId",
        "tokenId",
        "scope",
        "expiresAt",
        "remote",
        "token",
        "usage"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.