---
title: "overlane agents-md"
description: "Print the block to paste into AGENTS.md or CLAUDE.md"
---

> 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 agents-md

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

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

```sh
overlane agents-md
```

## Examples

```sh
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.

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

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

Source: https://docs.overlane.app/cli/agents-md/index.mdx