Skip to content

overlane model remove

Remove a model executor and destroy its stored key

Updated View as MarkdownOpen in ChatGPTOpen in Claude

This cannot be undone: the key is deleted, and a run policy that names model:<alias> skips it until a model with that alias is added again.

Usage

overlane model remove [alias] [--dry-run] [--force]

Arguments

Argument Required Description
alias no The model’s alias (required)

Flags

Flag Type Required Default Description
--dry-run boolean no Print the requests and file changes this command would make, then stop. Needs no credentials.
--force boolean no Confirm a destructive action when there is no terminal to ask on. Without it, exit 2.

Examples

overlane model remove free-llama

Behavior

  • Effect: destructive (deletes or reverts; needs --force without a terminal).
  • Needs credentials: yes. Uses the network: yes.
  • Supports --dry-run: yes. Accepts --force: yes.
  • Machine-readable description: overlane schema model remove.

Result

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

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "executor": {
          "type": "object",
          "properties": {
            "tenantId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128,
              "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
              "description": "tenant identifier"
            },
            "alias": {
              "type": "string",
              "minLength": 1,
              "maxLength": 60,
              "pattern": "^[a-z0-9][a-z0-9-]*$"
            },
            "ref": {
              "type": "string",
              "pattern": "^model:"
            },
            "kind": {
              "type": "string",
              "enum": [
                "openai-compatible",
                "workers-ai",
                "provider"
              ]
            },
            "provider": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "anthropic",
                    "openai",
                    "google",
                    "mistral",
                    "xai"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "baseUrl": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "null"
                }
              ]
            },
            "model": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[A-Za-z0-9@._:/-]+$"
            },
            "keyStatus": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "untested",
                    "active",
                    "failed",
                    "revoked"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "budget": {
              "type": "object",
              "properties": {
                "maxTokensPerRun": {
                  "default": null,
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 100000000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "maxCostMicrosPerRun": {
                  "default": null,
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 10000000000
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "maxTokensPerRun",
                "maxCostMicrosPerRun"
              ],
              "additionalProperties": false
            },
            "prices": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "inputMicrosPerM": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 1000000000
                    },
                    "outputMicrosPerM": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 1000000000
                    }
                  },
                  "required": [
                    "inputMicrosPerM",
                    "outputMicrosPerM"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ]
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          "required": [
            "tenantId",
            "alias",
            "ref",
            "kind",
            "provider",
            "baseUrl",
            "model",
            "keyStatus",
            "budget",
            "prices",
            "createdAt"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "executor"
      ],
      "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 for the status the process returns.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.