overlane agents-md | Overlane Docs

Prints the short block that tells an agent to start with overlane context and overlane search. Paste it into the project’s AGENTS.md or CLAUDE.md. Prints only; it never edits a file.

Usage

overlane agents-md

Examples

overlane agents-md
overlane agents-md >> AGENTS.md

Behavior

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

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "block": {
      "type": "string"
    },
    "line": {
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "block",
    "line",
    "files"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.