---
title: "overlane assistant config"
description: "Show what the assistant can do for the team and whether it is read-only"
---

> 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 assistant config

{/* 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 assistant's help text, how long conversations are kept, whether read-only mode is on and the tools it may use for your role, each marked read or write. Any role may read it.

## Usage

```sh
overlane assistant config [--service URL] [--team TENANT_ID]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--team` | string | no |  | The team (tenant) to act on (default: the one your token belongs to) |

## Examples

```sh
overlane assistant config
overlane assistant config --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 assistant config`.

## 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"
    },
    "help": {
      "type": "string"
    },
    "retention": {
      "type": "string"
    },
    "readOnly": {
      "type": "boolean"
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "name": {
            "type": "string",
            "pattern": "^[a-z][A-Za-z0-9]{1,48}$"
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "class": {
            "type": "string",
            "enum": [
              "read",
              "write"
            ]
          },
          "operation": {
            "type": "object",
            "properties": {
              "operationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "method": {
                "type": "string",
                "enum": [
                  "GET",
                  "HEAD",
                  "OPTIONS",
                  "POST",
                  "PUT",
                  "PATCH",
                  "DELETE"
                ]
              },
              "path": {
                "type": "string",
                "minLength": 1,
                "maxLength": 300,
                "format": "starts_with",
                "pattern": "^\\/.*"
              },
              "source": {
                "type": "string",
                "enum": [
                  "openapi",
                  "contract-fixture",
                  "local"
                ]
              }
            },
            "required": [
              "operationId",
              "method",
              "path",
              "source"
            ],
            "additionalProperties": false
          },
          "minRole": {
            "type": "string",
            "enum": [
              "owner",
              "admin",
              "member",
              "viewer",
              "agent"
            ]
          },
          "arguments": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "additionalProperties": {
              "type": "string",
              "maxLength": 200
            }
          }
        },
        "required": [
          "tenantId",
          "name",
          "description",
          "class",
          "operation",
          "minRole",
          "arguments"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "help",
    "retention",
    "readOnly",
    "tools"
  ],
  "additionalProperties": false
}
```

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

Source: https://docs.overlane.app/cli/assistant-config/index.mdx