---
title: "overlane release update"
description: "Install the project's pinned release (or --to a digest), verified against the signed manifest"
---

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

Verifies the release signature, shows the file diff, and runs the agents' native update commands. A release that changes executable files or policy needs --approve with its digest, and an update never changes files under a running task. With --dry-run it previews the diff and what would be refused (using a credential when one exists).

## Usage

```sh
overlane release update [--to DIGEST] [--approve DIGEST] [--dry-run]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--to` | string | no |  | Install this release instead of the project's pin |
| `--approve` | string | no |  | Approve this exact release digest when it changes executable files or policy |
| `--dry-run` | boolean | no |  | Print the requests and file changes this command would make, then stop. Needs no credentials. |

## Examples

```sh
overlane release update --dry-run
overlane release update
overlane release update --approve sha256:...
```

## 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 release 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": {
        "version": {
          "type": "string"
        },
        "digest": {
          "type": "string"
        },
        "alreadyInstalled": {
          "type": "boolean"
        },
        "changeKinds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "restart": {
          "type": "string"
        },
        "files": {
          "type": "object",
          "properties": {
            "added": {
              "type": "number"
            },
            "changed": {
              "type": "number"
            },
            "removed": {
              "type": "number"
            }
          },
          "required": [
            "added",
            "changed",
            "removed"
          ],
          "additionalProperties": false
        },
        "approvalRecorded": {
          "type": "boolean"
        },
        "restartNote": {
          "type": "string"
        }
      },
      "required": [
        "version",
        "digest",
        "alreadyInstalled",
        "changeKinds",
        "restart",
        "files",
        "approvalRecorded"
      ],
      "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"
          }
        },
        "release": {
          "type": "object",
          "properties": {
            "version": {
              "type": "string"
            },
            "digest": {
              "type": "string"
            },
            "changeKinds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "restart": {
              "type": "string"
            },
            "files": {
              "type": "object",
              "properties": {
                "added": {
                  "type": "number"
                },
                "changed": {
                  "type": "number"
                },
                "removed": {
                  "type": "number"
                }
              },
              "required": [
                "added",
                "changed",
                "removed"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "version",
            "digest",
            "changeKinds",
            "restart",
            "files"
          ],
          "additionalProperties": false
        },
        "wouldInstall": {
          "type": "boolean"
        },
        "wouldRefuse": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes",
        "release",
        "wouldInstall",
        "wouldRefuse"
      ],
      "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/release-update/index.mdx