Options reference

{: .no_toc }

You can use aider --help to see all the available options, or review them below.

• TOC {:toc}

{% include keys.md %}

Usage summary

usage: aider [-h] [--model] [--openai-api-key] [--anthropic-api-key]
             [--openai-api-base] [--openai-api-type]
             [--openai-api-version] [--openai-api-deployment-id]
             [--openai-organization-id] [--set-env] [--api-key]
             [--list-models] [--model-settings-file]
             [--model-metadata-file] [--alias] [--reasoning-effort]
             [--thinking-tokens] [--verify-ssl | --no-verify-ssl]
             [--timeout] [--edit-format] [--architect]
             [--auto-accept-architect | --no-auto-accept-architect]
             [--weak-model] [--editor-model] [--editor-edit-format]
             [--show-model-warnings | --no-show-model-warnings]
             [--check-model-accepts-settings | --no-check-model-accepts-settings]
             [--max-chat-history-tokens]
             [--cache-prompts | --no-cache-prompts]
             [--cache-keepalive-pings] [--map-tokens]
             [--map-refresh] [--map-multiplier-no-files]
             [--input-history-file] [--chat-history-file]
             [--restore-chat-history | --no-restore-chat-history]
             [--llm-history-file] [--dark-mode] [--light-mode]
             [--pretty | --no-pretty] [--stream | --no-stream]
             [--user-input-color] [--tool-output-color]
             [--tool-error-color] [--tool-warning-color]
             [--assistant-output-color] [--completion-menu-color]
             [--completion-menu-bg-color]
             [--completion-menu-current-color]
             [--completion-menu-current-bg-color] [--code-theme]
             [--show-diffs] [--git | --no-git]
             [--gitignore | --no-gitignore]
             [--add-gitignore-files | --no-add-gitignore-files]
             [--aiderignore] [--subtree-only]
             [--auto-commits | --no-auto-commits]
             [--dirty-commits | --no-dirty-commits]
             [--attribute-author | --no-attribute-author]
             [--attribute-committer | --no-attribute-committer]
             [--attribute-commit-message-author | --no-attribute-commit-message-author]
             [--attribute-commit-message-committer | --no-attribute-commit-message-committer]
             [--attribute-co-authored-by | --no-attribute-co-authored-by]
             [--git-commit-verify | --no-git-commit-verify]
             [--commit] [--commit-prompt] [--dry-run | --no-dry-run]
             [--skip-sanity-check-repo]
             [--watch-files | --no-watch-files] [--lint]
             [--lint-cmd] [--auto-lint | --no-auto-lint]
             [--test-cmd] [--auto-test | --no-auto-test] [--test]
             [--analytics | --no-analytics] [--analytics-log]
             [--analytics-disable] [--analytics-posthog-host]
             [--analytics-posthog-project-api-key]
             [--just-check-update]
             [--check-update | --no-check-update]
             [--show-release-notes | --no-show-release-notes]
             [--install-main-branch] [--upgrade] [--version]
             [--message] [--message-file]
             [--gui | --no-gui | --browser | --no-browser]
             [--copy-paste | --no-copy-paste] [--apply]
             [--apply-clipboard-edits] [--exit] [--show-repo-map]
             [--show-prompts] [--voice-format] [--voice-language]
             [--voice-input-device] [--disable-playwright] [--file]
             [--read] [--vim] [--chat-language] [--commit-language]
             [--yes-always] [-v] [--load] [--encoding]
             [--line-endings] [-c] [--env-file]
             [--suggest-shell-commands | --no-suggest-shell-commands]
             [--fancy-input | --no-fancy-input]
             [--multiline | --no-multiline]
             [--notifications | --no-notifications]
             [--notifications-command]
             [--detect-urls | --no-detect-urls] [--editor]
             [--shell-completions] [--opus] [--sonnet] [--haiku]
             [--4] [--4o] [--mini] [--4-turbo] [--35turbo]
             [--deepseek] [--o1-mini] [--o1-preview]

options:

--help

show this help message and exit
Aliases:

• -h
• --help

Main model:

--model MODEL

Specify the model to use for the main chat
Environment variable: AIDER_MODEL

API Keys and settings:

--openai-api-key VALUE

Specify the OpenAI API key
Environment variable: AIDER_OPENAI_API_KEY

--anthropic-api-key VALUE

Specify the Anthropic API key
Environment variable: AIDER_ANTHROPIC_API_KEY

--openai-api-base VALUE

Specify the api base url
Environment variable: AIDER_OPENAI_API_BASE

--openai-api-type VALUE

(deprecated, use --set-env OPENAI_API_TYPE=<value>)
Environment variable: AIDER_OPENAI_API_TYPE

--openai-api-version VALUE

(deprecated, use --set-env OPENAI_API_VERSION=<value>)
Environment variable: AIDER_OPENAI_API_VERSION

--openai-api-deployment-id VALUE

(deprecated, use --set-env OPENAI_API_DEPLOYMENT_ID=<value>)
Environment variable: AIDER_OPENAI_API_DEPLOYMENT_ID

--openai-organization-id VALUE

(deprecated, use --set-env OPENAI_ORGANIZATION=<value>)
Environment variable: AIDER_OPENAI_ORGANIZATION_ID

--set-env ENV_VAR_NAME=value

Set an environment variable (to control API settings, can be used multiple times)
Default: []
Environment variable: AIDER_SET_ENV

--api-key PROVIDER=KEY

Set an API key for a provider (eg: --api-key provider=<key> sets PROVIDER_API_KEY=<key>)
Default: []
Environment variable: AIDER_API_KEY

Model settings:

--list-models MODEL

List known models which match the (partial) MODEL name
Environment variable: AIDER_LIST_MODELS
Aliases:

• --list-models MODEL
• --models MODEL

--model-settings-file MODEL_SETTINGS_FILE

Specify a file with aider model settings for unknown models
Default: .aider.model.settings.yml
Environment variable: AIDER_MODEL_SETTINGS_FILE

--model-metadata-file MODEL_METADATA_FILE

Specify a file with context window and costs for unknown models
Default: .aider.model.metadata.json
Environment variable: AIDER_MODEL_METADATA_FILE

--alias ALIAS:MODEL

Add a model alias (can be used multiple times)
Environment variable: AIDER_ALIAS

--reasoning-effort VALUE

Set the reasoning_effort API parameter (default: not set)
Environment variable: AIDER_REASONING_EFFORT

--thinking-tokens VALUE

Set the thinking token budget for models that support it. Use 0 to disable. (default: not set)
Environment variable: AIDER_THINKING_TOKENS

--verify-ssl

Verify the SSL cert when connecting to models (default: True)
Default: True
Environment variable: AIDER_VERIFY_SSL
Aliases:

• --verify-ssl
• --no-verify-ssl

--timeout VALUE

Timeout in seconds for API calls (default: None)
Environment variable: AIDER_TIMEOUT

--edit-format EDIT_FORMAT

Specify what edit format the LLM should use (default depends on model)
Environment variable: AIDER_EDIT_FORMAT
Aliases:

• --edit-format EDIT_FORMAT
• --chat-mode EDIT_FORMAT

--architect

Use architect edit format for the main chat
Environment variable: AIDER_ARCHITECT

--auto-accept-architect

Enable/disable automatic acceptance of architect changes (default: True)
Default: True
Environment variable: AIDER_AUTO_ACCEPT_ARCHITECT
Aliases:

• --auto-accept-architect
• --no-auto-accept-architect

--weak-model WEAK_MODEL

Specify the model to use for commit messages and chat history summarization (default depends on --model)
Environment variable: AIDER_WEAK_MODEL

--editor-model EDITOR_MODEL

Specify the model to use for editor tasks (default depends on --model)
Environment variable: AIDER_EDITOR_MODEL

--editor-edit-format EDITOR_EDIT_FORMAT

Specify the edit format for the editor model (default: depends on editor model)
Environment variable: AIDER_EDITOR_EDIT_FORMAT

--show-model-warnings

Only work with models that have meta-data available (default: True)
Default: True
Environment variable: AIDER_SHOW_MODEL_WARNINGS
Aliases:

• --show-model-warnings
• --no-show-model-warnings

--check-model-accepts-settings

Check if model accepts settings like reasoning_effort/thinking_tokens (default: True)
Default: True
Environment variable: AIDER_CHECK_MODEL_ACCEPTS_SETTINGS
Aliases:

• --check-model-accepts-settings
• --no-check-model-accepts-settings

--max-chat-history-tokens VALUE

Soft limit on tokens for chat history, after which summarization begins. If unspecified, defaults to the model's max_chat_history_tokens.
Environment variable: AIDER_MAX_CHAT_HISTORY_TOKENS

Cache settings:

--cache-prompts

Enable caching of prompts (default: False)
Default: False
Environment variable: AIDER_CACHE_PROMPTS
Aliases:

• --cache-prompts
• --no-cache-prompts

--cache-keepalive-pings VALUE

Number of times to ping at 5min intervals to keep prompt cache warm (default: 0)
Default: 0
Environment variable: AIDER_CACHE_KEEPALIVE_PINGS

Repomap settings:

--map-tokens VALUE

Suggested number of tokens to use for repo map, use 0 to disable
Environment variable: AIDER_MAP_TOKENS

--map-refresh VALUE

Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto)
Default: auto
Environment variable: AIDER_MAP_REFRESH

--map-multiplier-no-files VALUE

Multiplier for map tokens when no files are specified (default: 2)
Default: 2
Environment variable: AIDER_MAP_MULTIPLIER_NO_FILES

History Files:

--input-history-file INPUT_HISTORY_FILE

Specify the chat input history file (default: .aider.input.history)
Default: .aider.input.history
Environment variable: AIDER_INPUT_HISTORY_FILE

--chat-history-file CHAT_HISTORY_FILE

Specify the chat history file (default: .aider.chat.history.md)
Default: .aider.chat.history.md
Environment variable: AIDER_CHAT_HISTORY_FILE

--restore-chat-history

Restore the previous chat history messages (default: False)
Default: False
Environment variable: AIDER_RESTORE_CHAT_HISTORY
Aliases:

• --restore-chat-history
• --no-restore-chat-history

--llm-history-file LLM_HISTORY_FILE

Log the conversation with the LLM to this file (for example, .aider.llm.history)
Environment variable: AIDER_LLM_HISTORY_FILE

Output settings:

--dark-mode

Use colors suitable for a dark terminal background (default: False)
Default: False
Environment variable: AIDER_DARK_MODE

--light-mode

Use colors suitable for a light terminal background (default: False)
Default: False
Environment variable: AIDER_LIGHT_MODE

--pretty

Enable/disable pretty, colorized output (default: True)
Default: True
Environment variable: AIDER_PRETTY
Aliases:

• --pretty
• --no-pretty

--stream

Enable/disable streaming responses (default: True)
Default: True
Environment variable: AIDER_STREAM
Aliases:

• --stream
• --no-stream

--user-input-color VALUE

Set the color for user input (default: #00cc00)
Default: #00cc00
Environment variable: AIDER_USER_INPUT_COLOR

--tool-output-color VALUE

Set the color for tool output (default: None)
Environment variable: AIDER_TOOL_OUTPUT_COLOR

--tool-error-color VALUE

Set the color for tool error messages (default: #FF2222)
Default: #FF2222
Environment variable: AIDER_TOOL_ERROR_COLOR

--tool-warning-color VALUE

Set the color for tool warning messages (default: #FFA500)
Default: #FFA500
Environment variable: AIDER_TOOL_WARNING_COLOR

--assistant-output-color VALUE

Set the color for assistant output (default: #0088ff)
Default: #0088ff
Environment variable: AIDER_ASSISTANT_OUTPUT_COLOR

--completion-menu-color COLOR

Set the color for the completion menu (default: terminal's default text color)
Environment variable: AIDER_COMPLETION_MENU_COLOR

--completion-menu-bg-color COLOR

Set the background color for the completion menu (default: terminal's default background color)
Environment variable: AIDER_COMPLETION_MENU_BG_COLOR

--completion-menu-current-color COLOR

Set the color for the current item in the completion menu (default: terminal's default background color)
Environment variable: AIDER_COMPLETION_MENU_CURRENT_COLOR

--completion-menu-current-bg-color COLOR

Set the background color for the current item in the completion menu (default: terminal's default text color)
Environment variable: AIDER_COMPLETION_MENU_CURRENT_BG_COLOR

--code-theme VALUE

Set the markdown code theme (default: default, other options include monokai, solarized-dark, solarized-light, or a Pygments builtin style, see https://pygments.org/styles for available themes)
Default: default
Environment variable: AIDER_CODE_THEME

--show-diffs

Show diffs when committing changes (default: False)
Default: False
Environment variable: AIDER_SHOW_DIFFS

Git settings:

--git

Enable/disable looking for a git repo (default: True)
Default: True
Environment variable: AIDER_GIT
Aliases:

• --git
• --no-git

--gitignore

Enable/disable adding .aider* to .gitignore (default: True)
Default: True
Environment variable: AIDER_GITIGNORE
Aliases:

• --gitignore
• --no-gitignore

--add-gitignore-files

Enable/disable the addition of files listed in .gitignore to Aider's editing scope.
Default: False
Environment variable: AIDER_ADD_GITIGNORE_FILES
Aliases:

• --add-gitignore-files
• --no-add-gitignore-files

--aiderignore AIDERIGNORE

Specify the aider ignore file (default: .aiderignore in git root)
Default: .aiderignore
Environment variable: AIDER_AIDERIGNORE

--subtree-only

Only consider files in the current subtree of the git repository
Default: False
Environment variable: AIDER_SUBTREE_ONLY

--auto-commits

Enable/disable auto commit of LLM changes (default: True)
Default: True
Environment variable: AIDER_AUTO_COMMITS
Aliases:

• --auto-commits
• --no-auto-commits

--dirty-commits

Enable/disable commits when repo is found dirty (default: True)
Default: True
Environment variable: AIDER_DIRTY_COMMITS
Aliases:

• --dirty-commits
• --no-dirty-commits

--attribute-author

Attribute aider code changes in the git author name (default: True). If explicitly set to True, overrides --attribute-co-authored-by precedence.
Environment variable: AIDER_ATTRIBUTE_AUTHOR
Alias