Options reference

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

Usage summary

usage: aider [-h] [--llm-history-file] [--openai-api-key]
             [--anthropic-api-key] [--model] [--opus] [--sonnet]
             [--4] [--4o] [--4-turbo] [--35turbo] [--models]
             [--openai-api-base] [--openai-api-type]
             [--openai-api-version] [--openai-api-deployment-id]
             [--openai-organization-id] [--model-settings-file]
             [--model-metadata-file]
             [--verify-ssl | --no-verify-ssl] [--edit-format]
             [--weak-model]
             [--show-model-warnings | --no-show-model-warnings]
             [--map-tokens] [--max-chat-history-tokens] [--env-file]
             [--input-history-file] [--chat-history-file]
             [--restore-chat-history | --no-restore-chat-history]
             [--dark-mode] [--light-mode] [--pretty | --no-pretty]
             [--stream | --no-stream] [--user-input-color]
             [--tool-output-color] [--tool-error-color]
             [--assistant-output-color] [--code-theme]
             [--show-diffs] [--git | --no-git]
             [--gitignore | --no-gitignore] [--aiderignore]
             [--auto-commits | --no-auto-commits]
             [--dirty-commits | --no-dirty-commits]
             [--attribute-author | --no-attribute-author]
             [--attribute-committer | --no-attribute-committer]
             [--dry-run | --no-dry-run] [--commit] [--lint]
             [--lint-cmd] [--auto-lint | --no-auto-lint]
             [--test-cmd] [--auto-test | --no-auto-test] [--test]
             [--vim] [--voice-language] [--version] [--check-update]
             [--skip-check-update] [--apply] [--yes] [-v]
             [--show-repo-map] [--show-prompts] [--message]
             [--message-file] [--encoding] [-c] [--gui]

options:

--help

show this help message and exit
Aliases:

  • -h
  • --help

Main:

--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

--openai-api-key OPENAI_API_KEY

Specify the OpenAI API key
Environment variable: OPENAI_API_KEY

--anthropic-api-key ANTHROPIC_API_KEY

Specify the Anthropic API key
Environment variable: ANTHROPIC_API_KEY

--model MODEL

Specify the model to use for the main chat (default: gpt-4o)
Default: gpt-4o
Environment variable: AIDER_MODEL

--opus

Use claude-3-opus-20240229 model for the main chat
Environment variable: AIDER_OPUS

--sonnet

Use claude-3-5-sonnet-20240620 model for the main chat
Environment variable: AIDER_SONNET

--4

Use gpt-4-0613 model for the main chat
Environment variable: AIDER_4
Aliases:

  • --4
  • -4

--4o

Use gpt-4o model for the main chat
Environment variable: AIDER_4O

--4-turbo

Use gpt-4-1106-preview model for the main chat
Environment variable: AIDER_4_TURBO

--35turbo

Use gpt-3.5-turbo model for the main chat
Environment variable: AIDER_35TURBO
Aliases:

  • --35turbo
  • --35-turbo
  • --3
  • -3

Model Settings:

--models MODEL

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

--openai-api-base OPENAI_API_BASE

Specify the api base url
Environment variable: OPENAI_API_BASE

--openai-api-type OPENAI_API_TYPE

Specify the api_type
Environment variable: OPENAI_API_TYPE

--openai-api-version OPENAI_API_VERSION

Specify the api_version
Environment variable: OPENAI_API_VERSION

--openai-api-deployment-id OPENAI_API_DEPLOYMENT_ID

Specify the deployment_id
Environment variable: OPENAI_API_DEPLOYMENT_ID

--openai-organization-id OPENAI_ORGANIZATION_ID

Specify the OpenAI organization ID
Environment variable: OPENAI_ORGANIZATION_ID

--model-settings-file MODEL_SETTINGS_FILE

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

--model-metadata-file MODEL_METADATA_FILE

Specify a file with context window and costs for unknown models
Environment variable: AIDER_MODEL_METADATA_FILE

--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

--edit-format EDIT_FORMAT

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

--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

--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

--map-tokens VALUE

Max number of tokens to use for repo map, use 0 to disable (default: 1024)
Default: 1024
Environment variable: AIDER_MAP_TOKENS

--max-chat-history-tokens VALUE

Maximum number of tokens to use for chat history. If not specified, uses the model’s max_chat_history_tokens.
Environment variable: AIDER_MAX_CHAT_HISTORY_TOKENS

--env-file ENV_FILE

Specify the .env file to load (default: .env in git root)
Default: .env
Environment variable: AIDER_ENV_FILE

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

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: red)
Default: #FF2222
Environment variable: AIDER_TOOL_ERROR_COLOR

--assistant-output-color VALUE

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

--code-theme VALUE

Set the markdown code theme (default: default, other options include monokai, solarized-dark, solarized-light)
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

--aiderignore AIDERIGNORE

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

--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)
Default: True
Environment variable: AIDER_ATTRIBUTE_AUTHOR
Aliases:

  • --attribute-author
  • --no-attribute-author

--attribute-committer

Attribute aider commits in the git committer name (default: True)
Default: True
Environment variable: AIDER_ATTRIBUTE_COMMITTER
Aliases:

  • --attribute-committer
  • --no-attribute-committer

--dry-run

Perform a dry run without modifying files (default: False)
Default: False
Environment variable: AIDER_DRY_RUN
Aliases:

  • --dry-run
  • --no-dry-run

Fixing and committing:

--commit

Commit all pending changes with a suitable commit message, then exit
Default: False
Environment variable: AIDER_COMMIT

--lint

Lint and fix provided files, or dirty files if none provided
Default: False
Environment variable: AIDER_LINT

--lint-cmd

Specify lint commands to run for different languages, eg: “python: flake8 –select=…” (can be used multiple times)
Default: []
Environment variable: AIDER_LINT_CMD

--auto-lint

Enable/disable automatic linting after changes (default: True)
Default: True
Environment variable: AIDER_AUTO_LINT
Aliases:

  • --auto-lint
  • --no-auto-lint

--test-cmd

Specify command to run tests
Default: []
Environment variable: AIDER_TEST_CMD

--auto-test

Enable/disable automatic testing after changes (default: False)
Default: False
Environment variable: AIDER_AUTO_TEST
Aliases:

  • --auto-test
  • --no-auto-test

--test

Run tests and fix problems found
Default: False
Environment variable: AIDER_TEST

Other Settings:

--vim

Use VI editing mode in the terminal (default: False)
Default: False
Environment variable: AIDER_VIM

--voice-language VOICE_LANGUAGE

Specify the language for voice using ISO 639-1 code (default: auto)
Default: en
Environment variable: AIDER_VOICE_LANGUAGE

--version

Show the version number and exit

--check-update

Check for updates and return status in the exit code
Default: False
Environment variable: AIDER_CHECK_UPDATE

--skip-check-update

Skips checking for the update when the program runs
Default: False
Environment variable: AIDER_SKIP_CHECK_UPDATE

--apply FILE

Apply the changes from the given file instead of running the chat (debug)
Environment variable: AIDER_APPLY

--yes

Always say yes to every confirmation
Environment variable: AIDER_YES

--verbose

Enable verbose output
Default: False
Environment variable: AIDER_VERBOSE
Aliases:

  • -v
  • --verbose

--show-repo-map

Print the repo map and exit (debug)
Default: False
Environment variable: AIDER_SHOW_REPO_MAP

--show-prompts

Print the system prompts and exit (debug)
Default: False
Environment variable: AIDER_SHOW_PROMPTS

--message COMMAND

Specify a single message to send the LLM, process reply then exit (disables chat mode)
Environment variable: AIDER_MESSAGE
Aliases:

  • --message COMMAND
  • --msg COMMAND
  • -m COMMAND

--message-file MESSAGE_FILE

Specify a file containing the message to send the LLM, process reply, then exit (disables chat mode)
Environment variable: AIDER_MESSAGE_FILE
Aliases:

  • --message-file MESSAGE_FILE
  • -f MESSAGE_FILE

--encoding VALUE

Specify the encoding for input and output (default: utf-8)
Default: utf-8
Environment variable: AIDER_ENCODING

--config CONFIG_FILE

Specify the config file (default: search for .aider.conf.yml in git root, cwd or home directory)
Aliases:

  • -c CONFIG_FILE
  • --config CONFIG_FILE

--gui

Run aider in your browser
Default: False
Environment variable: AIDER_GUI
Aliases:

  • --gui
  • --browser