overlane self-update | Overlane Docs

Installs overlane from npm at the channel’s tag: nightly, beta, stable (the default) or lts. Internal builds are not on npm; they come from the release service after sign-in, which is not available yet, so –channel internal stops with an explanation.

Usage

overlane self-update [--channel CHANNEL] [--dry-run]

Flags

Flag	Type	Required	Default	Description
`--channel`	one of `internal`, `nightly`, `beta`, `stable`, `lts`	no	`stable`	Release channel to follow: internal, nightly, beta, stable or lts
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane self-update
overlane self-update --channel beta
overlane self-update --channel lts --dry-run

Behavior

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

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": {
        "channel": {
          "type": "string",
          "enum": [
            "internal",
            "nightly",
            "beta",
            "stable",
            "lts"
          ]
        },
        "tag": {
          "type": "string"
        },
        "package": {
          "type": "string"
        },
        "command": {
          "type": "string"
        }
      },
      "required": [
        "channel",
        "tag",
        "package",
        "command"
      ],
      "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.