---
title: "overlane self-update"
description: "Update the overlane command line to the newest build of a release channel"
---

> 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 self-update

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

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

```sh
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

```sh
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.

```json
{
  "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](/cli/#exit-codes) for the status the process returns.

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