---
title: "overlane release status"
description: "Show the installed release against the project's pin"
---

> 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 status

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

Compares the installed release (.overlane/state/release.json) with the project binding and the service's pin, and lists approvals recorded on this machine. Works when the service is down (the pin then reads "unreachable").

## Usage

```sh
overlane release status
```

## Examples

```sh
overlane release status
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema release status`.

## Result

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

```json
{
  "type": "object",
  "properties": {
    "installed": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "version": {
              "type": "string"
            },
            "digest": {
              "type": "string"
            }
          },
          "required": [
            "version",
            "digest"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "binding": {
      "type": "string"
    },
    "pin": {
      "type": "string"
    },
    "inSync": {
      "type": "boolean"
    },
    "taskRunning": {
      "type": "boolean"
    },
    "approvals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "digest": {
            "type": "string"
          },
          "changeKinds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "approvedAt": {
            "type": "string"
          },
          "machine": {
            "type": "string"
          }
        },
        "required": [
          "digest",
          "changeKinds",
          "approvedAt",
          "machine"
        ],
        "additionalProperties": false
      }
    },
    "next": {
      "type": "string"
    }
  },
  "required": [
    "installed",
    "binding",
    "pin",
    "inSync",
    "taskRunning",
    "approvals",
    "next"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/release-status/index.mdx