---
title: "overlane onboarding advance"
description: "Mark an onboarding step done (or failed, with its repair action) and move to the next"
---

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

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

Idempotent: a repeat, or a person finishing the same step in the web app, produces one transition. Choices (agents, bots, repository) are recorded as identifiers only; no token or key is ever stored. first-task and first-review finish only when the server finds a real task or review of this team. Only payments and legal terms need a person.

## Usage

```sh
overlane onboarding advance step [--failed CODE] [--agents a,b] [--bots a,b] [--repo OWNER/NAME] [--provider NAME] [--dry-run]
```

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `step` | yes | One of sign-up, agents, repo, first-task, first-review, invite |

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--failed` | string | no |  | Record a failure instead; one of sign-in-cancelled, agent-not-connected, agent-oauth-denied, install-cancelled, repo-unreachable, task-failed, review-unavailable, invite-failed |
| `--agents` | string | no |  | Agents connected (for the agents step) |
| `--bots` | string | no |  | Bots connected (for the agents step) |
| `--repo` | string | no |  | The repository connected (for the repo step) |
| `--provider` | one of `overlane`, `github`, `gitlab` | no | `overlane` | Where the repository lives (for the repo step); overlane is a native project |
| `--dry-run` | boolean | no |  | Print the requests and file changes this command would make, then stop. Needs no credentials. |

## Examples

```sh
overlane onboarding advance agents --agents claude-code
overlane onboarding advance repo --repo acme/widgets
overlane onboarding advance first-task
overlane onboarding advance invite
```

## Behavior

- Effect: `write` (changes local or hosted state).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: yes. Accepts `--force`: no.
- Machine-readable description: `overlane schema onboarding advance`.

## 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",
      "properties": {
        "applied": {
          "type": "boolean"
        },
        "step": {
          "type": "string"
        },
        "complete": {
          "type": "boolean"
        },
        "version": {
          "type": "number"
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "applied",
        "step",
        "complete",
        "version",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}
```

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

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