---
title: "overlane channel list"
description: "Show each release channel with its build, hold and recent promotions"
---

> 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 channel list

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

Lists the internal, nightly, beta, stable and LTS channels: the version and commit each runs, how long it has been there, whether it is held, whether the schedule is on, and the latest promotions with the reasons any were refused.

## Usage

```sh
overlane channel list
```

## Examples

```sh
overlane channel list
overlane channel list --json
```

## Behavior

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

## 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": {
    "tenantId": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    },
    "schedule": {
      "type": "object",
      "properties": {
        "schedule": {
          "type": "boolean"
        }
      },
      "required": [
        "schedule"
      ],
      "additionalProperties": {}
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "channel": {
            "type": "string",
            "enum": [
              "internal",
              "nightly",
              "beta",
              "stable",
              "lts"
            ]
          },
          "build": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "commitSha": {
                    "type": "string"
                  },
                  "version": {
                    "type": "string"
                  },
                  "enteredAt": {
                    "type": "string"
                  }
                },
                "required": [
                  "commitSha",
                  "version",
                  "enteredAt"
                ],
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ]
          },
          "held": {
            "type": "boolean"
          },
          "holdReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "heldBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "channel",
          "build",
          "held",
          "holdReason",
          "heldBy",
          "updatedAt"
        ],
        "additionalProperties": {}
      }
    },
    "plans": {
      "default": [],
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "channel": {
            "type": "string",
            "enum": [
              "internal",
              "nightly",
              "beta",
              "stable",
              "lts"
            ]
          },
          "schedule": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "channel",
          "schedule"
        ],
        "additionalProperties": {}
      }
    },
    "history": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "promotionId": {
            "type": "string"
          },
          "from": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "internal",
                  "nightly",
                  "beta",
                  "stable",
                  "lts"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "to": {
            "type": "string",
            "enum": [
              "internal",
              "nightly",
              "beta",
              "stable",
              "lts"
            ]
          },
          "version": {
            "type": [
              "string",
              "null"
            ]
          },
          "commitSha": {
            "type": [
              "string",
              "null"
            ]
          },
          "at": {
            "type": "string"
          },
          "actor": {
            "type": "string"
          },
          "outcome": {
            "type": "string",
            "enum": [
              "promoted",
              "refused",
              "rolled_back"
            ]
          },
          "gates": {
            "type": "object",
            "properties": {
              "failed": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "gate": {
                      "type": "string"
                    },
                    "reason": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "gate",
                    "reason"
                  ],
                  "additionalProperties": {}
                }
              }
            },
            "required": [
              "failed"
            ],
            "additionalProperties": {}
          }
        },
        "required": [
          "promotionId",
          "from",
          "to",
          "version",
          "commitSha",
          "at",
          "actor",
          "outcome",
          "gates"
        ],
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "tenantId",
    "projectId",
    "schedule",
    "channels",
    "plans",
    "history"
  ],
  "additionalProperties": {}
}
```

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

Source: https://docs.overlane.app/cli/channel-list/index.mdx