crabcode.schema.json

{
  "$defs": {
    "ImageOpenCommandConfigFile": {
      "additionalProperties": false,
      "properties": {
        "args": {
          "default": [
            "{path}"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "command": {
          "type": "string"
        }
      },
      "required": [
        "command"
      ],
      "type": "object"
    },
    "ImageOpenWith": {
      "anyOf": [
        {
          "enum": [
            "auto",
            "system",
            "editor"
          ],
          "type": "string"
        },
        {
          "$ref": "#/$defs/ImageOpenCommandConfigFile"
        }
      ]
    },
    "ImagesConfigFile": {
      "additionalProperties": false,
      "properties": {
        "openWith": {
          "$ref": "#/$defs/ImageOpenWith",
          "default": "auto"
        },
        "open_with": {
          "$ref": "#/$defs/ImageOpenWith",
          "default": "auto"
        }
      },
      "type": "object"
    },
    "ReasoningEffort": {
      "enum": [
        "none",
        "off",
        "minimal",
        "low",
        "medium",
        "high",
        "xhigh",
        "extra-high",
        "max"
      ],
      "type": "string"
    },
    "AgentConfigFile": {
      "additionalProperties": true,
      "properties": {
        "reasoningEffort": {
          "description": "Subagent reasoning effort override. Use null/false/none/off or omit to send no reasoning_effort parameter; use an effort string to send that explicit value.",
          "anyOf": [
            {
              "$ref": "#/$defs/ReasoningEffort"
            },
            {
              "const": false
            },
            {
              "type": "null"
            }
          ]
        },
        "reasoning_effort": {
          "description": "Alias for reasoningEffort.",
          "anyOf": [
            {
              "$ref": "#/$defs/ReasoningEffort"
            },
            {
              "const": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "AgentConfigMap": {
      "additionalProperties": {
        "$ref": "#/$defs/AgentConfigFile"
      },
      "type": "object"
    },
    "TerminalNotificationMode": {
      "anyOf": [
        {
          "enum": [
            "auto",
            "enabled",
            "disabled",
            "on",
            "off",
            "true",
            "false"
          ],
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "TerminalNotificationCondition": {
      "enum": [
        "unfocused",
        "always"
      ],
      "type": "string"
    },
    "MacosNotificationBackend": {
      "enum": [
        "crabcode",
        "osascript"
      ],
      "type": "string"
    },
    "NotificationEventConfigFile": {
      "additionalProperties": false,
      "properties": {
        "terminal": {
          "$ref": "#/$defs/TerminalNotificationMode"
        },
        "soundEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "sound_enabled": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "soundFile": {
          "type": [
            "string",
            "null"
          ]
        },
        "sound_file": {
          "type": [
            "string",
            "null"
          ]
        },
        "desktop": {
          "default": false,
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "NotificationsConfigFile": {
      "additionalProperties": false,
      "properties": {
        "complete": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "subagentComplete": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "subagent_complete": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "error": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "permission": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "question": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationEventConfigFile"
            },
            {
              "type": "null"
            }
          ]
        },
        "terminalCondition": {
          "$ref": "#/$defs/TerminalNotificationCondition",
          "default": "unfocused"
        },
        "terminal_condition": {
          "$ref": "#/$defs/TerminalNotificationCondition",
          "default": "unfocused"
        },
        "macosBackend": {
          "$ref": "#/$defs/MacosNotificationBackend",
          "default": "crabcode"
        },
        "macos_backend": {
          "$ref": "#/$defs/MacosNotificationBackend",
          "default": "crabcode"
        }
      },
      "type": "object"
    },
    "WebsearchProvider": {
      "enum": [
        "exa-hosted-mcp",
        "firecrawl-hosted-mcp",
        "exa",
        "tavily",
        "perplexity",
        "brave",
        "ollama-cloud",
        "serpapi",
        "keiro"
      ],
      "type": "string"
    },
    "WebsearchConfigFile": {
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "provider": {
          "$ref": "#/$defs/WebsearchProvider",
          "default": "exa-hosted-mcp"
        },
        "endpoint": {
          "type": [
            "string",
            "null"
          ]
        },
        "apiKey": {
          "description": "Optional API key value. Use placeholders like {env:EXA_API_KEY} or {file:~/.keys/exa}. Required for keyed providers; optional for exa-hosted-mcp and firecrawl-hosted-mcp.",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "const": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "$id": "https://raw.githubusercontent.com/blankeos/crabcode/main/crabcode.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": [
        "string",
        "null"
      ]
    },
    "agent": {
      "anyOf": [
        {
          "$ref": "#/$defs/AgentConfigMap"
        },
        {
          "type": "null"
        }
      ]
    },
    "command": true,
    "compaction": true,
    "default_agent": true,
    "disabled_providers": true,
    "enabled_providers": true,
    "formatter": true,
    "instructions": true,
    "images": {
      "anyOf": [
        {
          "$ref": "#/$defs/ImagesConfigFile"
        },
        {
          "type": "null"
        }
      ]
    },
    "mcp": true,
    "model": {
      "type": [
        "string",
        "null"
      ]
    },
    "small_model": {
      "description": "Optional lightweight model used for background tasks like session title generation. Title generation is disabled unless this is configured.",
      "type": [
        "string",
        "null"
      ]
    },
    "smallModel": {
      "description": "Alias for small_model.",
      "type": [
        "string",
        "null"
      ]
    },
    "notifications": {
      "anyOf": [
        {
          "$ref": "#/$defs/NotificationsConfigFile"
        },
        {
          "type": "null"
        }
      ]
    },
    "permission": true,
    "provider": true,
    "theme": {
      "type": [
        "string",
        "null"
      ]
    },
    "tui": {
      "description": "Crabcode terminal UI settings. compactMode takes precedence over the saved /compact-mode preference.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "compactMode": {
          "description": "Enable sticky headers for compact mode. Alias: compact_mode.",
          "type": "boolean"
        },
        "compact_mode": {
          "description": "Alias for compactMode.",
          "type": "boolean"
        }
      }
    },
    "tools": true,
    "websearch": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "$ref": "#/$defs/WebsearchConfigFile"
        },
        {
          "type": "null"
        }
      ]
    },
    "watcher": true
  },
  "title": "CrabcodeConfigFile",
  "type": "object"
}