---
title: "overlane commands"
description: "List every command"
---

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

{/* 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 every command with its effect (read, write, destructive) and whether it needs credentials or the network. Add --effect to filter. Use `overlane search` to find one by task.

## Usage

```sh
overlane commands [--effect read|write|destructive]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--effect` | one of `read`, `write`, `destructive` | no |  | Only commands with this effect |

## Examples

```sh
overlane commands
overlane commands --effect destructive
```

## Behavior

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

## 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": {
    "count": {
      "type": "number"
    },
    "commands": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "command": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "effect": {
            "type": "string",
            "enum": [
              "read",
              "write",
              "destructive"
            ]
          },
          "needsAuth": {
            "type": "boolean"
          },
          "needsNetwork": {
            "type": "boolean"
          },
          "usage": {
            "type": "string"
          }
        },
        "required": [
          "command",
          "summary",
          "effect",
          "needsAuth",
          "needsNetwork",
          "usage"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "count",
    "commands"
  ],
  "additionalProperties": false
}
```

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

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