---
title: "overlane ci validate"
description: "Check the pipeline file and show the line of each error"
---

> 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 ci validate

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

Parses .overlane/ci.yml (or --file) with the parser the service runs before every run, offline (with --remote the service parses it and answers). Errors are printed as path:line: message and the command exits 2; a valid file lists its jobs. Run it before pushing a change to the pipeline.

## Usage

```sh
overlane ci validate [--file PATH] [--remote]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--file` | string | no |  | The pipeline file (default: .overlane/ci.yml) |
| `--remote` | boolean | no |  | Send the file to the service and show its answer, to confirm the service reads it the way this command does |

## Examples

```sh
overlane ci validate
overlane ci validate --file ci/test.yml --json
overlane ci validate --remote
```

## Behavior

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

## 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": {
    "ok": {
      "type": "boolean"
    },
    "file": {
      "type": "string"
    },
    "jobs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "line": {
            "type": "number"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "line",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "ok",
    "file",
    "jobs",
    "issues"
  ],
  "additionalProperties": false
}
```

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

Source: https://docs.overlane.app/cli/ci-validate/index.mdx