Aider · Schema

EditRequest

EditRequest schema from Aider CLI

AIAI Pair ProgrammingDeveloper ToolsCLICommand LineCoding AssistantCode GenerationOpen SourcePythonApache 2.0LLMGitBYO LLMTerminalPolyglotTree SitterRepository MapPair Programming

Properties

Name Type Description
prompt string Natural-language instruction to apply to the in-chat files.
edit_format string Edit format the LLM should produce.
auto_commit boolean Whether to auto-commit edits via Git. Defaults to the launch-time setting.
View JSON Schema on GitHub

JSON Schema

aider-cli-edit-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aider/refs/heads/main/json-schema/aider-cli-edit-request-schema.json",
  "title": "EditRequest",
  "description": "EditRequest schema from Aider CLI",
  "type": "object",
  "properties": {
    "prompt": {
      "type": "string",
      "description": "Natural-language instruction to apply to the in-chat files.",
      "example": "Refactor the cache layer to use an LRU eviction policy and add unit tests."
    },
    "edit_format": {
      "type": "string",
      "description": "Edit format the LLM should produce.",
      "enum": [
        "diff",
        "whole",
        "udiff",
        "editor-diff"
      ],
      "example": "diff"
    },
    "auto_commit": {
      "type": "boolean",
      "description": "Whether to auto-commit edits via Git. Defaults to the launch-time setting.",
      "default": true,
      "example": true
    }
  },
  "required": [
    "prompt"
  ]
}