Skip to content

overlane project readiness

Show whether this project is set up for agents to work on it, and the numbered list of what is left

Updated View as MarkdownOpen in ChatGPTOpen in Claude

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

overlane project readiness

Examples

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.

{
  "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 for the status the process returns.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.