---
title: "overlane onboarding status"
description: "Show the onboarding steps, which one is current, and the command that completes it"
---

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

Prints the six onboarding steps (the same names as the web app), their state, the task and review records behind finished steps, any repair action for a failed step, and the next command an agent runs. A finished step that was skipped, or marked done without the record the activation funnel counts, says so, and `proof` in the JSON tells them apart. An agent with a team token completes every step; a person in the web app is the override.

## Usage

```sh
overlane onboarding status
```

## Examples

```sh
overlane onboarding 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 onboarding 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": {
    "step": {
      "type": "string"
    },
    "complete": {
      "type": "boolean"
    },
    "version": {
      "type": "number"
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "step": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "proof": {
            "type": "string",
            "enum": [
              "recorded",
              "skipped",
              "unrecorded",
              "none"
            ]
          },
          "repair": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "text"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "step",
          "status",
          "proof"
        ],
        "additionalProperties": false
      }
    },
    "evidence": {
      "type": "object",
      "properties": {
        "task": {
          "type": "object",
          "properties": {
            "projectId": {
              "type": "string"
            },
            "taskId": {
              "type": "string"
            },
            "state": {
              "type": "string"
            }
          },
          "required": [
            "projectId",
            "taskId",
            "state"
          ],
          "additionalProperties": false
        },
        "review": {
          "type": "object",
          "properties": {
            "projectId": {
              "type": "string"
            },
            "runId": {
              "type": "string"
            }
          },
          "required": [
            "projectId",
            "runId"
          ],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "next": {
      "type": "string"
    }
  },
  "required": [
    "step",
    "complete",
    "version",
    "steps",
    "evidence",
    "next"
  ],
  "additionalProperties": false
}
```

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

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