---
title: "overlane code-map status"
description: "Show, per client, whether the code map is on and why"
---

> 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 code-map status

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

Lists every supported client in its local and cloud setting, and the bots, review service, cross-repository questions and wiki, with two settings each. The code tools (codeLayer): the default follows the latest measurement for that setting, off for a local agent with grep, on where there is no checkout. The map as context (codeMapContext): a ranked map delivered once at session start, on where there is no checkout, on for read-only work for a local agent, and opt-in for edits and when the intent is unknown. The project setting codeMapContext (default, on or off) overrides the default.

## Usage

```sh
overlane code-map status
```

## Examples

```sh
overlane code-map status
overlane code-map status --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 code-map status`.

## 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": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "project identifier"
    },
    "projectCodeLayer": {
      "type": "boolean"
    },
    "projectCodeMapContext": {
      "type": "string",
      "enum": [
        "default",
        "on",
        "off"
      ]
    },
    "clients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "minLength": 1
          },
          "client": {
            "type": "string",
            "minLength": 1
          },
          "setting": {
            "type": "string",
            "enum": [
              "local-agent-with-grep",
              "cloud-session",
              "bot",
              "review-service",
              "cross-repo",
              "wiki"
            ]
          },
          "on": {
            "type": "boolean"
          },
          "basis": {
            "type": "string",
            "enum": [
              "gate-07-failed",
              "gate-07-passed",
              "spec-default-provisional",
              "spec-default",
              "project-setting"
            ]
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "gate07": {
            "type": "string",
            "enum": [
              "passed",
              "failed",
              "pending",
              "not-applicable"
            ]
          },
          "context": {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "on",
                  "read-only",
                  "off"
                ]
              },
              "basis": {
                "type": "string",
                "enum": [
                  "setting-default",
                  "project-setting"
                ]
              },
              "reason": {
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "mode",
              "basis",
              "reason"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "subject",
          "client",
          "setting",
          "on",
          "basis",
          "reason",
          "gate07"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "projectId",
    "projectCodeLayer",
    "clients"
  ],
  "additionalProperties": false
}
```

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

Source: https://docs.overlane.app/cli/code-map-status/index.mdx