---
title: "overlane init"
description: "Start here: connect this project to your coding agents in one step, with nothing to install first (npx overlane init)"
---

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

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

Runs the connect flow without asking, as `connect --yes` does: detects the installed agents, signs in through the browser (no token to paste), creates or looks up the project, registers the plugin with each agent's own commands, writes the no-prompt permission preset, and copies the Overlane skills into .agents/skills for agents that read that folder (an existing skill folder is left alone). It ends by printing one prompt to try first: "Use the overlane-context skill to summarise this project and suggest the first task to take on.". Safe to repeat. `overlane disconnect` removes everything it added. Use --dry-run to preview.

## Usage

```sh
overlane init [--service URL] [--marketplace-root DIR] [--agents claude,codex] [--dry-run] [--name NAME] [--provider overlane|github] [--no-preset]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | Service address (https); default is the hosted service or OVERLANE_SERVICE_URL |
| `--marketplace-root` | string | no |  | Folder holding the built claude/ and codex/ plugin marketplaces |
| `--agents` | string | no |  | Which agents to set up or check (default: both) |
| `--dry-run` | boolean | no |  | Print the plan, the requests it would send and the files it would write; change nothing. Needs no credentials. |
| `--name` | string | no |  | The project name (default: the GitHub repository name, else this folder's name) |
| `--provider` | one of `overlane`, `github` | no |  | Where the project lives: overlane (native, the default without a GitHub origin) or github (needs a github.com origin) |
| `--no-preset` | boolean | no |  | Skip the no-prompt permission preset and the attribution-off setting for Claude Code and Codex |

## Examples

```sh
overlane init
overlane init --dry-run
overlane init --agents claude
overlane init --name my-app
```

## Behavior

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

## 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": {
        "project": {
          "type": "object",
          "properties": {
            "provider": {
              "type": "string",
              "enum": [
                "overlane",
                "github",
                "gitlab"
              ]
            },
            "owner": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "root": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "root"
          ],
          "additionalProperties": false
        },
        "serviceUrl": {
          "type": "string"
        },
        "tenantId": {
          "type": "string"
        },
        "projectId": {
          "type": "string"
        },
        "releaseDigest": {
          "type": "string"
        },
        "credentials": {
          "type": "string"
        },
        "agents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "agent": {
                "type": "string"
              },
              "installed": {
                "type": "boolean"
              },
              "detail": {
                "type": "string"
              }
            },
            "required": [
              "agent",
              "installed",
              "detail"
            ],
            "additionalProperties": false
          }
        },
        "applied": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "skipped": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "wrote": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "readiness": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "agent": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "detail": {
                "type": "string"
              },
              "action": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "agent",
              "state",
              "detail",
              "action"
            ],
            "additionalProperties": false
          }
        },
        "cancelled": {
          "type": "boolean"
        },
        "skills": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "firstPrompt": {
          "type": "string"
        },
        "checks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "ok": {
                "type": "boolean"
              },
              "detail": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "ok",
              "detail"
            ],
            "additionalProperties": false
          }
        },
        "setup": {
          "type": "object",
          "properties": {
            "found": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "suggestions": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "found",
            "suggestions"
          ],
          "additionalProperties": false
        },
        "setupLeft": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "project",
        "serviceUrl",
        "credentials",
        "agents",
        "applied",
        "skipped",
        "wrote",
        "readiness",
        "skills",
        "firstPrompt",
        "checks",
        "setup",
        "setupLeft"
      ],
      "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/init/index.mdx