---
title: "overlane project readiness"
description: "Show whether this project is set up for agents to work on it, and the numbered list of what is left"
---

> 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 project readiness

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

Checks this project, not the whole team: agent instructions in the repository, the GitHub App on its repository, an Overlane mirror, registered checks, tasks or an intent to work from, a client allowed to take work, one verified task, guardrails, autonomy and the claude.ai connector. Each item is read from the project's own records or files, never from an onboarding step marked done. `missing` items name the command that fixes them; `review` items work as they are but nobody has chosen them yet. Ends with a numbered setup list. Exits 0 either way; `ready` in the JSON is true when nothing is missing.

## Usage

```sh
overlane project readiness
```

## Examples

```sh
overlane project readiness
overlane project readiness --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 project readiness`.

## 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": {
    "projectId": {
      "type": "string"
    },
    "ready": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "ready",
              "missing",
              "review"
            ]
          },
          "detail": {
            "type": "string"
          },
          "action": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "label",
          "state",
          "detail",
          "action"
        ],
        "additionalProperties": false
      }
    },
    "setup": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "projectId",
    "ready",
    "items",
    "setup"
  ],
  "additionalProperties": false
}
```

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

Source: https://docs.overlane.app/cli/project-readiness/index.mdx