Schema registry

Aider

Aider configuration file

.aider.conf.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your .aider.conf.yml and it validates in your browser — nothing is uploaded.

Validate a .aider.conf.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`model`	`string`	Specify the model to use for the main chat. Default: None
`openai-api-key`	`string`	Specify the OpenAI API key. Default: None
`anthropic-api-key`	`string`	Specify the Anthropic API key. Default: None
`openai-api-base`	`string`	Specify the api base url. Default: None
`openai-api-type`	`string`	Specify the OpenAI API type. Default: None
`openai-api-version`	`string`	Specify the OpenAI API version. Default: None
`openai-api-deployment-id`	`string`	Specify the OpenAI API deployment ID. Default: None
`openai-organization-id`	`string`	Specify the OpenAI organization ID. Default: None
`set-env`	`array<string>`	Set environment variables. Default: []
`api-key`	`array<string>`	Set an API key for a provider. Default: []
`list-models`	`string`	List known models which match the (partial) MODEL name. Default: None
`model-settings-file`	`string`	Specify a file with aider model settings for unknown models. Default: .aider.model.settings.yml default: `".aider.model.settings.yml"`
`model-metadata-file`	`string`	Specify a file with context window and costs for unknown models. Default: .aider.model.metadata.json default: `".aider.model.metadata.json"`
`alias`	`array<string>`	Add a model alias. Default: []
`reasoning-effort`	`string`	Set the reasoning_effort API parameter. Default: None
`thinking-tokens`	`string`	Set the thinking token budget for models that support it. Default: None
`verify-ssl`	`boolean`	Verify the SSL cert when connecting to models. Default: true default: `true`
`timeout`	`string`	Timeout in seconds for API calls. Default: None
`edit-format`	`string`	Specify what edit format the LLM should use. Default: None
`architect`	`boolean`	Use architect edit format for the main chat. Default: None
`auto-accept-architect`	`boolean`	Enable/disable automatic acceptance of architect changes. Default: true default: `true`
`weak-model`	`string`	Specify the model to use for commit messages and chat history summarization. Default: None
`editor-model`	`string`	Specify the model to use for editor tasks. Default: None
`editor-edit-format`	`string`	Specify the edit format for the editor model. Default: None
`show-model-warnings`	`boolean`	Only work with models that have meta-data available. Default: true default: `true`
`check-model-accepts-settings`	`boolean`	Check if model accepts settings like reasoning_effort/thinking_tokens. Default: true default: `true`
`max-chat-history-tokens`	`string`	Soft limit on tokens for chat history, after which summarization begins. Default: None
`cache-prompts`	`boolean`	Enable caching of prompts. Default: false default: `false`
`cache-keepalive-pings`	`string`	Number of times to ping at 5min intervals to keep prompt cache warm. Default: 0 default: `"0"`
`map-tokens`	`string`	Suggested number of tokens to use for repo map. Default: None
`map-refresh`	`string`	Control how often the repo map is refreshed. Default: auto default: `"auto"`
`map-multiplier-no-files`	`string`	Multiplier for map tokens when no files are specified. Default: 2 default: `"2"`
`input-history-file`	`string`	Specify the chat input history file. Default: .aider.input.history default: `".aider.input.history"`
`chat-history-file`	`string`	Specify the chat history file. Default: .aider.chat.history.md default: `".aider.chat.history.md"`
`restore-chat-history`	`boolean`	Restore the previous chat history messages. Default: false default: `false`
`llm-history-file`	`string`	Log the conversation with the LLM to this file. Default: None
`dark-mode`	`boolean`	Use colors suitable for a dark terminal background. Default: false default: `false`
`light-mode`	`boolean`	Use colors suitable for a light terminal background. Default: false default: `false`
`pretty`	`boolean`	Enable/disable pretty, colorized output. Default: true default: `true`
`stream`	`boolean`	Enable/disable streaming responses. Default: true default: `true`
`user-input-color`	`string`	Set the color for user input. Default: #00cc00 default: `"#00cc00"`
`tool-output-color`	`string`	Set the color for tool output. Default: None
`tool-error-color`	`string`	Set the color for tool error messages. Default: #FF2222 default: `"#FF2222"`
`tool-warning-color`	`string`	Set the color for tool warning messages. Default: #FFA500 default: `"#FFA500"`
`assistant-output-color`	`string`	Set the color for assistant output. Default: #0088ff default: `"#0088ff"`
`completion-menu-color`	`string`	Set the color for the completion menu. Default: None
`completion-menu-bg-color`	`string`	Set the background color for the completion menu. Default: None
`completion-menu-current-color`	`string`	Set the color for the current item in the completion menu. Default: None
`completion-menu-current-bg-color`	`string`	Set the background color for the current item in the completion menu. Default: None
`code-theme`	`string`	Set the markdown code theme. Default: default default: `"default"`
`show-diffs`	`boolean`	Show diffs when committing changes. Default: false default: `false`
`git`	`boolean`	Enable/disable looking for a git repo. Default: true default: `true`
`gitignore`	`boolean`	Enable/disable adding .aider* to .gitignore. Default: true default: `true`
`aiderignore`	`string`	Specify the aider ignore file. Default: .aiderignore default: `".aiderignore"`
`subtree-only`	`boolean`	Only consider files in the current subtree of the git repository. Default: false default: `false`
`auto-commits`	`boolean`	Enable/disable auto commit of LLM changes. Default: true default: `true`
`dirty-commits`	`boolean`	Enable/disable commits when repo is found dirty. Default: true default: `true`
`attribute-author`	`boolean`	Attribute aider code changes in the git author name. Default: None
`attribute-committer`	`boolean`	Attribute aider commits in the git committer name. Default: None
`attribute-commit-message-author`	`boolean`	Prefix commit messages with ‘aider: ‘ if aider authored the changes. Default: false default: `false`
`attribute-commit-message-committer`	`boolean`	Prefix all commit messages with ‘aider: ‘. Default: false default: `false`
`attribute-co-authored-by`	`boolean`	Attribute aider edits using the Co-authored-by trailer in the commit message. Default: false default: `false`
`git-commit-verify`	`boolean`	Enable/disable git pre-commit hooks with –no-verify. Default: false default: `false`
`commit`	`boolean`	Commit all pending changes with a suitable commit message, then exit. Default: false default: `false`
`commit-prompt`	`string`	Specify a custom prompt for generating commit messages. Default: None
`dry-run`	`boolean`	Perform a dry run without modifying files. Default: false default: `false`
`skip-sanity-check-repo`	`boolean`	Skip the sanity check for the git repository. Default: false default: `false`
`watch-files`	`boolean`	Enable/disable watching files for ai coding comments. Default: false default: `false`
`lint`	`boolean`	Lint and fix provided files, or dirty files if none provided. Default: false default: `false`
`lint-cmd`	`array<string>`	Specify lint commands to run for different languages. Default: []
`auto-lint`	`boolean`	Enable/disable automatic linting after changes. Default: true default: `true`
`test-cmd`	`array<string>`	Specify command to run tests. Default: []
`auto-test`	`boolean`	Enable/disable automatic testing after changes. Default: false default: `false`
`test`	`boolean`	Run tests, fix problems found and then exit. Default: false default: `false`
`analytics`	`boolean`	Enable/disable analytics for current session. Default: None
`analytics-log`	`string`	Specify a file to log analytics events. Default: None
`analytics-disable`	`boolean`	Permanently disable analytics. Default: false default: `false`
`just-check-update`	`boolean`	Check for updates and return status in the exit code. Default: false default: `false`
`check-update`	`boolean`	Check for new aider versions on launch. Default: true default: `true`
`show-release-notes`	`boolean`	Show release notes on first run of new version. Default: None
`install-main-branch`	`boolean`	Install the latest version from the main branch. Default: false default: `false`
`upgrade`	`boolean`	Upgrade aider to the latest version from PyPI. Default: false default: `false`
`version`	`boolean`	Show the version number and exit. Default: None
`message`	`string`	Specify a single message to send the LLM, process reply then exit. Default: None
`message-file`	`string`	Specify a file containing the message to send the LLM, process reply, then exit. Default: None
`gui`	`boolean`	Run aider in your browser. Default: false default: `false`
`copy-paste`	`boolean`	Enable automatic copy/paste of chat between aider and web UI. Default: false default: `false`
`apply`	`string`	Apply the changes from the given file instead of running the chat. Default: None
`apply-clipboard-edits`	`boolean`	Apply clipboard contents as edits using the main model’s editor format. Default: false default: `false`
`exit`	`boolean`	Do all startup activities then exit before accepting user input. Default: false default: `false`
`show-repo-map`	`boolean`	Print the repo map and exit. Default: false default: `false`
`show-prompts`	`boolean`	Print the system prompts and exit. Default: false default: `false`
`voice-format`	`string`	Audio format for voice recording. Default: wav default: `"wav"`
`voice-language`	`string`	Specify the language for voice using ISO 639-1 code. Default: en default: `"en"`
`voice-input-device`	`string`	Specify the input device name for voice recording. Default: None
`disable-playwright`	`boolean`	Never prompt for or attempt to install Playwright for web scraping. Default: false default: `false`
`file`	`array<string>`	Specify a file to edit. Default: []
`read`	`array<string>`	Specify a read-only file. Default: []
`vim`	`boolean`	Use VI editing mode in the terminal. Default: false default: `false`
`chat-language`	`string`	Specify the language to use in the chat. Default: None
`yes-always`	`boolean`	Always say yes to every confirmation. Default: None
`verbose`	`boolean`	Enable verbose output. Default: false default: `false`
`load`	`string`	Load and execute /commands from a file on launch. Default: None
`encoding`	`string`	Specify the encoding for input and output. Default: utf-8 default: `"utf-8"`
`line-endings`	`string`	Line endings to use when writing files. Default: platform default: `"platform"`
`config`	`string`	Specify the config file. Default: None
`env-file`	`string`	Specify the .env file to load. Default: .env default: `".env"`
`suggest-shell-commands`	`boolean`	Enable/disable suggesting shell commands. Default: true default: `true`
`fancy-input`	`boolean`	Enable/disable fancy input with history and completion. Default: true default: `true`
`multiline`	`boolean`	Enable/disable multi-line input mode with Meta-Enter to submit. Default: false default: `false`
`notifications`	`boolean`	Enable/disable terminal bell notifications when LLM responses are ready. Default: false default: `false`
`notifications-command`	`string`	Specify a command to run for notifications instead of the terminal bell. Default: None
`detect-urls`	`boolean`	Enable/disable detection and offering to add URLs to chat. Default: true default: `true`
`editor`	`string`	Specify which editor to use for the /editor command. Default: None
`opus`	`boolean`	Use claude-3-opus-20240229 model for the main chat. Default: false default: `false`
`sonnet`	`boolean`	Use anthropic/claude-3-7-sonnet-20250219 model for the main chat. Default: false default: `false`
`haiku`	`boolean`	Use claude-3-5-haiku-20241022 model for the main chat. Default: false default: `false`
`mini`	`boolean`	Use gpt-4o-mini model for the main chat. Default: false default: `false`
`deepseek`	`boolean`	Use deepseek/deepseek-chat model for the main chat. Default: false default: `false`
`o1-mini`	`boolean`	Use o1-mini model for the main chat. Default: false default: `false`
`o1-preview`	`boolean`	Use o1-preview model for the main chat. Default: false default: `false`
`4`	`boolean`	Use gpt-4-0613 model for the main chat. Default: false default: `false`
`4o`	`boolean`	Use gpt-4o model for the main chat. Default: false default: `false`
`4-turbo`	`boolean`	Use gpt-4-1106-preview model for the main chat. Default: false default: `false`
`35turbo`	`boolean`	Use gpt-3.5-turbo model for the main chat. Default: false default: `false`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
125 properties, 100% carrying a description, max nesting depth 4.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas