---
title: "overlane schema"
description: "Print a command's parameters, safety flags and result shape as JSON"
---

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

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

Prints the machine-readable description of one command: every flag and argument with type, required and description; whether it takes --dry-run or --force; its examples; the JSON Schema of its result; and the exit codes. Give a group name (`task`) to get all its commands.

## Usage

```sh
overlane schema command...
```

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `command...` | yes | The command path, for example: task start |

## Examples

```sh
overlane schema task start
overlane schema run
overlane schema release rollback
```

## Behavior

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

## 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",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    {
      "type": "object",
      "properties": {
        "commands": {
          "type": "array",
          "items": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        }
      },
      "required": [
        "commands"
      ],
      "additionalProperties": false
    }
  ]
}
```

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

Source: https://docs.overlane.app/cli/schema/index.mdx