cleveragents-core/docs/reference/env_variables.yaml

variables:
  COLUMNS:
    name: COLUMNS
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/utils.go:109
    proposed_cleveragents_name: CLEVERAGENTS_COLUMNS
  EDITOR:
    name: EDITOR
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/cmd/plan_exec_helpers.go:41
    proposed_cleveragents_name: CLEVERAGENTS_EDITOR
  GLAMOUR_STYLE:
    name: GLAMOUR_STYLE
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/format.go:35
    proposed_cleveragents_name: CLEVERAGENTS_GLAMOUR_STYLE
  PLANDEX_COLUMNS:
    name: PLANDEX_COLUMNS
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/utils.go:88
    - app/cli/term/utils.go:89
    proposed_cleveragents_name: CLEVERAGENTS_COLUMNS
  PLANDEX_DISABLE_SUGGESTIONS:
    name: PLANDEX_DISABLE_SUGGESTIONS
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/help.go:180
    proposed_cleveragents_name: CLEVERAGENTS_DISABLE_SUGGESTIONS
  PLANDEX_REPL:
    name: PLANDEX_REPL
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/stream_tui/run.go:102
    - app/cli/term/repl.go:5
    proposed_cleveragents_name: CLEVERAGENTS_REPL
  PLANDEX_REPL_OUTPUT_FILE:
    name: PLANDEX_REPL_OUTPUT_FILE
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/stream_tui/run.go:102
    - app/cli/stream_tui/run.go:104
    proposed_cleveragents_name: CLEVERAGENTS_REPL_OUTPUT_FILE
  PLANDEX_REPL_SESSION_ID:
    name: PLANDEX_REPL_SESSION_ID
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/cmd/load.go:58
    - app/cli/cmd/usage.go:73
    - app/cli/cmd/usage.go:82
    - app/cli/cmd/usage.go:240
    - app/cli/cmd/usage.go:259
    - app/cli/plan_exec/tell.go:150
    proposed_cleveragents_name: CLEVERAGENTS_REPL_SESSION_ID
  PLANDEX_STREAM_FOREGROUND_COLOR:
    name: PLANDEX_STREAM_FOREGROUND_COLOR
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/utils.go:125
    - app/cli/term/utils.go:126
    proposed_cleveragents_name: CLEVERAGENTS_STREAM_FOREGROUND_COLOR
  SHELL:
    name: SHELL
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/term/os.go:15
    proposed_cleveragents_name: CLEVERAGENTS_SHELL
  VISUAL:
    name: VISUAL
    default: ''
    description: ''
    category: CLI
    sources:
    - code
    usage_locations:
    - app/cli/cmd/plan_exec_helpers.go:43
    proposed_cleveragents_name: CLEVERAGENTS_VISUAL
  GOPATH:
    name: GOPATH
    default: ''
    description: This should be already set to your Go folder if you've installed
      Golang.
    category: Development
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_GOPATH
  PLANDEX_DEV_CLI_ALIAS:
    name: PLANDEX_DEV_CLI_ALIAS
    default: pdxd
    description: The alias for the development binary when using dev.sh
    category: Development
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_DEV_CLI_ALIAS
  PLANDEX_DEV_CLI_NAME:
    name: PLANDEX_DEV_CLI_NAME
    default: plandex-dev
    description: The name of the development binary when using dev.sh
    category: Development
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_DEV_CLI_NAME
  PLANDEX_DEV_CLI_OUT_DIR:
    name: PLANDEX_DEV_CLI_OUT_DIR
    default: /usr/local/bin
    description: Where the development binary should be output when using dev.sh
    category: Development
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_DEV_CLI_OUT_DIR
  PLANDEX_OUT_DIR:
    name: PLANDEX_OUT_DIR
    default: /usr/local/bin
    description: Where the development binary should be output when using dev.sh
    category: Development
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_OUT_DIR
  API_HOST:
    name: API_HOST
    default: ''
    description: The host the API server listens on. Defaults to 'http://localhost:$PORT'.
      In production mode, should be a host like 'https://api.your-domain.ai'.
    category: General
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_API_HOST
  DATABASE_URL:
    name: DATABASE_URL
    default: ''
    description: The URL of the PostgreSQL database. Defaults to 'postgres://plandex:plandex@plandex-postgres:5432/plandex?sslmode=disable'
      in development mode
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/db/db.go:27
    proposed_cleveragents_name: CLEVERAGENTS_DATABASE_URL
  GOENV:
    name: GOENV
    default: development
    description: Whether to run in development or production mode. Must be 'development'
      or 'production'
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/db/account_helpers.go:17
    - app/server/db/db.go:57
    - app/server/db/db.go:129
    - app/server/db/db.go:137
    - app/server/db/db.go:150
    - app/server/db/fs.go:20
    - app/server/db/fs.go:21
    - app/server/db/fs.go:28
    - app/server/email/invite.go:12
    - app/server/email/verification.go:14
    - app/server/email/verification.go:31
    - app/server/handlers/accounts.go:29
    - app/server/handlers/accounts.go:123
    - app/server/handlers/auth_helpers.go:98
    - app/server/handlers/auth_helpers.go:108
    - app/server/handlers/auth_helpers.go:145
    - app/server/handlers/auth_helpers.go:152
    - app/server/handlers/auth_helpers.go:201
    - app/server/handlers/auth_helpers.go:209
    - app/server/handlers/auth_helpers.go:260
    - app/server/handlers/auth_helpers.go:300
    - app/server/handlers/auth_helpers.go:436
    - app/server/handlers/invites.go:22
    - app/server/handlers/invites.go:165
    - app/server/handlers/invites.go:223
    - app/server/handlers/invites.go:281
    - app/server/handlers/invites.go:339
    - app/server/handlers/sessions.go:85
    - app/server/handlers/users.go:21
    - app/server/handlers/users.go:96
    - app/server/host/ip.go:16
    - app/server/model/client.go:538
    - app/server/setup/setup.go:67
    proposed_cleveragents_name: CLEVERAGENTS_GOENV
  LOCAL_MODE:
    name: LOCAL_MODE
    default: ''
    description: Whether to run in local mode
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/db/account_helpers.go:17
    - app/server/db/fs.go:21
    - app/server/handlers/accounts.go:29
    - app/server/handlers/accounts.go:123
    - app/server/handlers/auth_helpers.go:300
    - app/server/handlers/auth_helpers.go:436
    - app/server/handlers/invites.go:22
    - app/server/handlers/invites.go:165
    - app/server/handlers/invites.go:223
    - app/server/handlers/invites.go:281
    - app/server/handlers/invites.go:339
    - app/server/handlers/sessions.go:85
    - app/server/handlers/users.go:21
    - app/server/handlers/users.go:96
    proposed_cleveragents_name: CLEVERAGENTS_LOCAL_MODE
  OLLAMA_BASE_URL:
    name: OLLAMA_BASE_URL
    default: ''
    description: "The base URL of the Ollama server\u2014only need when the server\
      \ is running in a Docker container and needs to access Ollama models running\
      \ outside of the container"
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/model/client.go:295
    - app/server/model/client.go:296
    - app/server/model/litellm.go:125
    - app/server/model/litellm.go:128
    proposed_cleveragents_name: CLEVERAGENTS_OLLAMA_BASE_URL
  PLANDEX_API_HOST:
    name: PLANDEX_API_HOST
    default: ''
    description: "Defaults to 'http://localhost:8099' if PLANDEX_ENV is development,\
      \ otherwise it's 'https://api.plandex.ai'\u2014override this to use a different\
      \ host."
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/cli/api/clients.go:25
    proposed_cleveragents_name: CLEVERAGENTS_API_HOST
  PLANDEX_BASE_DIR:
    name: PLANDEX_BASE_DIR
    default: ''
    description: The base directory to read and write files. Defaults to '$HOME/plandex-server'
      in development mode, '/plandex-server' in production.
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/db/fs.go:19
    - app/server/db/fs.go:25
    proposed_cleveragents_name: CLEVERAGENTS_BASE_DIR
  PLANDEX_ENV:
    name: PLANDEX_ENV
    default: development
    description: Set this to 'development' to default to the local development server
      instead of Plandex Cloud when working on Plandex itself.
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/cli/api/clients.go:24
    - app/cli/fs/fs.go:33
    - app/cli/fs/fs.go:73
    - app/cli/fs/fs.go:122
    proposed_cleveragents_name: CLEVERAGENTS_ENV
  PORT:
    name: PORT
    default: '8099'
    description: The port the server listens on. Defaults to 8099.
    category: General
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/handlers/proxy_helper.go:48
    - app/server/setup/setup.go:85
    proposed_cleveragents_name: CLEVERAGENTS_PORT
  ANTHROPIC_API_KEY:
    name: ANTHROPIC_API_KEY
    default: ''
    description: Your Anthropic API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: ANTHROPIC_API_KEY
  AWS_ACCESS_KEY_ID:
    name: AWS_ACCESS_KEY_ID
    default: ''
    description: Your AWS access key ID
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AWS_ACCESS_KEY_ID
  AWS_INFERENCE_PROFILE_ARN:
    name: AWS_INFERENCE_PROFILE_ARN
    default: ''
    description: Your AWS inference profile ARN
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AWS_INFERENCE_PROFILE_ARN
  AWS_REGION:
    name: AWS_REGION
    default: ''
    description: Your AWS region
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AWS_REGION
  AWS_SECRET_ACCESS_KEY:
    name: AWS_SECRET_ACCESS_KEY
    default: ''
    description: Your AWS secret access key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AWS_SECRET_ACCESS_KEY
  AWS_SESSION_TOKEN:
    name: AWS_SESSION_TOKEN
    default: ''
    description: Your AWS session token
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AWS_SESSION_TOKEN
  AZURE_API_BASE:
    name: AZURE_API_BASE
    default: ''
    description: Your Azure OpenAI API base URL
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AZURE_API_BASE
  AZURE_API_VERSION:
    name: AZURE_API_VERSION
    default: ''
    description: Your Azure OpenAI API version
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AZURE_API_VERSION
  AZURE_DEPLOYMENTS_MAP:
    name: AZURE_DEPLOYMENTS_MAP
    default: ''
    description: "Your Azure OpenAI deployments map\u2014a JSON object mapping model\
      \ names to deployment names (only needed if deployment names are different from\
      \ model names)"
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AZURE_DEPLOYMENTS_MAP
  AZURE_OPENAI_API_KEY:
    name: AZURE_OPENAI_API_KEY
    default: ''
    description: Your Azure OpenAI API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: AZURE_OPENAI_API_KEY
  DEEPSEEK_API_KEY:
    name: DEEPSEEK_API_KEY
    default: ''
    description: Your DeepSeek API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: DEEPSEEK_API_KEY
  GEMINI_API_KEY:
    name: GEMINI_API_KEY
    default: ''
    description: Your Google AI Studio API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: GEMINI_API_KEY
  GOOGLE_APPLICATION_CREDENTIALS:
    name: GOOGLE_APPLICATION_CREDENTIALS
    default: ''
    description: Your Google Vertex AI credentials file path
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: GOOGLE_APPLICATION_CREDENTIALS
  OPENAI_API_KEY:
    name: OPENAI_API_KEY
    default: ''
    description: Your OpenAI key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: OPENAI_API_KEY
  OPENAI_ORG_ID:
    name: OPENAI_ORG_ID
    default: ''
    description: Your OpenAI organization ID. Defaults to empty.
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: OPENAI_ORG_ID
  OPENROUTER_API_KEY:
    name: OPENROUTER_API_KEY
    default: ''
    description: Your OpenRouter.ai API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: OPENROUTER_API_KEY
  CLEVERAGENTS_OPENROUTER_ORGANIZATION:
    name: CLEVERAGENTS_OPENROUTER_ORGANIZATION
    default: ''
    description: Optional referrer/title that CleverAgents forwards as HTTP headers when calling OpenRouter.
    category: LLM Providers
    sources:
    - python
    usage_locations:
    - src/cleveragents/config/settings.py:252
    - src/cleveragents/providers/llm/openrouter_provider.py:16
    proposed_cleveragents_name: CLEVERAGENTS_OPENROUTER_ORGANIZATION
  CLEVERAGENTS_DEFAULT_PROVIDER:
    name: CLEVERAGENTS_DEFAULT_PROVIDER
    default: ''
    description: Preferred provider slug (openai, anthropic, google, azure, openrouter, groq, together, cohere, gemini) that overrides auto-detected defaults.
    category: LLM Providers
    sources:
    - python
    usage_locations:
    - src/cleveragents/config/settings.py:160
    - src/cleveragents/providers/registry.py:225
    proposed_cleveragents_name: CLEVERAGENTS_DEFAULT_PROVIDER
  CLEVERAGENTS_DEFAULT_MODEL:
    name: CLEVERAGENTS_DEFAULT_MODEL
    default: ''
    description: Optional global model override applied when CLI flags are omitted.
    category: LLM Providers
    sources:
    - python
    usage_locations:
    - src/cleveragents/config/settings.py:165
    - src/cleveragents/providers/registry.py:222
    proposed_cleveragents_name: CLEVERAGENTS_DEFAULT_MODEL
  PERPLEXITY_API_KEY:
    name: PERPLEXITY_API_KEY
    default: ''
    description: Your Perplexity API key
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: PERPLEXITY_API_KEY
  PLANDEX_AWS_PROFILE:
    name: PLANDEX_AWS_PROFILE
    default: ''
    description: Name of AWS profile in ~/.aws/credentials to use for AWS Bedrock.
      If not set, the credentials file won't be used.
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: CLEVERAGENTS_AWS_PROFILE
  VERTEXAI_LOCATION:
    name: VERTEXAI_LOCATION
    default: ''
    description: Your Google Vertex AI location
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: VERTEXAI_LOCATION
  VERTEXAI_PROJECT:
    name: VERTEXAI_PROJECT
    default: ''
    description: Your Google Vertex AI project ID
    category: LLM Providers
    sources:
    - documentation
    usage_locations: []
    proposed_cleveragents_name: VERTEXAI_PROJECT
  SMTP_HOST:
    name: SMTP_HOST
    default: ''
    description: Your SMTP host.
    category: SMTP
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/email/email.go:56
    proposed_cleveragents_name: CLEVERAGENTS_SMTP_HOST
  SMTP_PASSWORD:
    name: SMTP_PASSWORD
    default: ''
    description: SMTP password.
    category: SMTP
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/email/email.go:59
    proposed_cleveragents_name: CLEVERAGENTS_SMTP_PASSWORD
  SMTP_PORT:
    name: SMTP_PORT
    default: ''
    description: Set this to 1025 e.g. if you are using mailhog.
    category: SMTP
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/email/email.go:57
    proposed_cleveragents_name: CLEVERAGENTS_SMTP_PORT
  SMTP_USER:
    name: SMTP_USER
    default: ''
    description: SMTP username.
    category: SMTP
    sources:
    - documentation
    - code
    usage_locations:
    - app/server/email/email.go:58
    proposed_cleveragents_name: CLEVERAGENTS_SMTP_USER
  APP_SUBDOMAIN:
    name: APP_SUBDOMAIN
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/handlers/auth_helpers.go:99
    - app/server/handlers/auth_helpers.go:146
    - app/server/handlers/auth_helpers.go:202
    proposed_cleveragents_name: CLEVERAGENTS_APP_SUBDOMAIN
  DB_HOST:
    name: DB_HOST
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:29
    - app/server/db/db.go:36
    proposed_cleveragents_name: CLEVERAGENTS_DB_HOST
  DB_NAME:
    name: DB_NAME
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:33
    - app/server/db/db.go:36
    proposed_cleveragents_name: CLEVERAGENTS_DB_NAME
  DB_PASSWORD:
    name: DB_PASSWORD
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:32
    - app/server/db/db.go:34
    proposed_cleveragents_name: CLEVERAGENTS_DB_PASSWORD
  DB_PORT:
    name: DB_PORT
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:30
    - app/server/db/db.go:36
    proposed_cleveragents_name: CLEVERAGENTS_DB_PORT
  DB_USER:
    name: DB_USER
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:31
    - app/server/db/db.go:36
    proposed_cleveragents_name: CLEVERAGENTS_DB_USER
  ECS_CONTAINER_METADATA_URI:
    name: ECS_CONTAINER_METADATA_URI
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/host/ip.go:48
    proposed_cleveragents_name: CLEVERAGENTS_ECS_CONTAINER_METADATA_URI
  HOME:
    name: HOME
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/model/litellm.go:122
    proposed_cleveragents_name: CLEVERAGENTS_HOME
  IP:
    name: IP
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/host/ip.go:31
    - app/server/host/ip.go:32
    proposed_cleveragents_name: CLEVERAGENTS_IP
  IS_CLOUD:
    name: IS_CLOUD
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/email/invite.go:20
    - app/server/email/verification.go:24
    - app/server/handlers/accounts.go:23
    - app/server/handlers/client_helper.go:72
    - app/server/handlers/models.go:39
    - app/server/handlers/models.go:46
    - app/server/handlers/models.go:127
    - app/server/handlers/models.go:213
    - app/server/handlers/models.go:245
    - app/server/handlers/models.go:437
    - app/server/handlers/orgs.go:58
    - app/server/handlers/settings.go:117
    - app/server/handlers/settings.go:137
    - app/server/host/ip.go:21
    - app/server/routes/routes.go:56
    proposed_cleveragents_name: CLEVERAGENTS_IS_CLOUD
  LITELLM_PROXY_DIR:
    name: LITELLM_PROXY_DIR
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/model/litellm.go:115
    - app/server/model/litellm.go:116
    proposed_cleveragents_name: CLEVERAGENTS_LITELLM_PROXY_DIR
  MIGRATIONS_DIR:
    name: MIGRATIONS_DIR
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/db.go:98
    - app/server/db/db.go:99
    proposed_cleveragents_name: CLEVERAGENTS_MIGRATIONS_DIR
  PATH:
    name: PATH
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/model/litellm.go:121
    proposed_cleveragents_name: CLEVERAGENTS_PATH
  PLANDEX_CLOUD:
    name: PLANDEX_CLOUD
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/db/settings_helpers.go:28
    - app/server/db/settings_helpers.go:114
    - app/server/db/settings_helpers.go:148
    proposed_cleveragents_name: CLEVERAGENTS_CLOUD
  SMTP_FROM:
    name: SMTP_FROM
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/email/email.go:60
    proposed_cleveragents_name: CLEVERAGENTS_SMTP_FROM
  VERBOSE_LOGGING:
    name: VERBOSE_LOGGING
    default: ''
    description: ''
    category: Server
    sources:
    - code
    usage_locations:
    - app/server/syntax/file_map/map.go:15
    proposed_cleveragents_name: CLEVERAGENTS_VERBOSE_LOGGING
  PLANDEX_SKIP_UPGRADE:
    name: PLANDEX_SKIP_UPGRADE
    default: ''
    description: Set this to '1' to skip the auto-upgrade check when running the CLI.
    category: Upgrades
    sources:
    - documentation
    - code
    usage_locations:
    - app/cli/upgrade.go:28
    proposed_cleveragents_name: CLEVERAGENTS_SKIP_UPGRADE
conflicts:
- old_name: PLANDEX_ENV
  new_name: CLEVERAGENTS_ENV
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_API_HOST
  new_name: CLEVERAGENTS_API_HOST
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_AWS_PROFILE
  new_name: CLEVERAGENTS_AWS_PROFILE
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_SKIP_UPGRADE
  new_name: CLEVERAGENTS_SKIP_UPGRADE
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_OUT_DIR
  new_name: CLEVERAGENTS_OUT_DIR
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_DEV_CLI_OUT_DIR
  new_name: CLEVERAGENTS_DEV_CLI_OUT_DIR
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_DEV_CLI_OUT_DIR
  new_name: CLEVERAGENTS_DEV_CLI_OUT_DIR
  type: development_only
  description: Development-specific variable, may need reconsideration
- old_name: PLANDEX_DEV_CLI_NAME
  new_name: CLEVERAGENTS_DEV_CLI_NAME
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_DEV_CLI_NAME
  new_name: CLEVERAGENTS_DEV_CLI_NAME
  type: development_only
  description: Development-specific variable, may need reconsideration
- old_name: PLANDEX_DEV_CLI_ALIAS
  new_name: CLEVERAGENTS_DEV_CLI_ALIAS
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_DEV_CLI_ALIAS
  new_name: CLEVERAGENTS_DEV_CLI_ALIAS
  type: development_only
  description: Development-specific variable, may need reconsideration
- old_name: PLANDEX_BASE_DIR
  new_name: CLEVERAGENTS_BASE_DIR
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_CLOUD
  new_name: CLEVERAGENTS_CLOUD
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_REPL_SESSION_ID
  new_name: CLEVERAGENTS_REPL_SESSION_ID
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_REPL
  new_name: CLEVERAGENTS_REPL
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_REPL_OUTPUT_FILE
  new_name: CLEVERAGENTS_REPL_OUTPUT_FILE
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_DISABLE_SUGGESTIONS
  new_name: CLEVERAGENTS_DISABLE_SUGGESTIONS
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_COLUMNS
  new_name: CLEVERAGENTS_COLUMNS
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
- old_name: PLANDEX_STREAM_FOREGROUND_COLOR
  new_name: CLEVERAGENTS_STREAM_FOREGROUND_COLOR
  type: migration_required
  description: Rename from Plandex to CleverAgents namespace
mapping:
  PLANDEX_ENV: CLEVERAGENTS_ENV
  PLANDEX_API_HOST: CLEVERAGENTS_API_HOST
  PLANDEX_AWS_PROFILE: CLEVERAGENTS_AWS_PROFILE
  PLANDEX_SKIP_UPGRADE: CLEVERAGENTS_SKIP_UPGRADE
  PLANDEX_OUT_DIR: CLEVERAGENTS_OUT_DIR
  PLANDEX_DEV_CLI_OUT_DIR: CLEVERAGENTS_DEV_CLI_OUT_DIR
  PLANDEX_DEV_CLI_NAME: CLEVERAGENTS_DEV_CLI_NAME
  PLANDEX_DEV_CLI_ALIAS: CLEVERAGENTS_DEV_CLI_ALIAS
  GOPATH: CLEVERAGENTS_GOPATH
  GOENV: CLEVERAGENTS_GOENV
  PLANDEX_BASE_DIR: CLEVERAGENTS_BASE_DIR
  API_HOST: CLEVERAGENTS_API_HOST
  PORT: CLEVERAGENTS_PORT
  DATABASE_URL: CLEVERAGENTS_DATABASE_URL
  LOCAL_MODE: CLEVERAGENTS_LOCAL_MODE
  OLLAMA_BASE_URL: CLEVERAGENTS_OLLAMA_BASE_URL
  SMTP_HOST: CLEVERAGENTS_SMTP_HOST
  SMTP_PORT: CLEVERAGENTS_SMTP_PORT
  SMTP_USER: CLEVERAGENTS_SMTP_USER
  SMTP_PASSWORD: CLEVERAGENTS_SMTP_PASSWORD
  DB_HOST: CLEVERAGENTS_DB_HOST
  DB_PORT: CLEVERAGENTS_DB_PORT
  DB_USER: CLEVERAGENTS_DB_USER
  DB_PASSWORD: CLEVERAGENTS_DB_PASSWORD
  DB_NAME: CLEVERAGENTS_DB_NAME
  MIGRATIONS_DIR: CLEVERAGENTS_MIGRATIONS_DIR
  PLANDEX_CLOUD: CLEVERAGENTS_CLOUD
  SMTP_FROM: CLEVERAGENTS_SMTP_FROM
  IS_CLOUD: CLEVERAGENTS_IS_CLOUD
  APP_SUBDOMAIN: CLEVERAGENTS_APP_SUBDOMAIN
  IP: CLEVERAGENTS_IP
  ECS_CONTAINER_METADATA_URI: CLEVERAGENTS_ECS_CONTAINER_METADATA_URI
  LITELLM_PROXY_DIR: CLEVERAGENTS_LITELLM_PROXY_DIR
  PATH: CLEVERAGENTS_PATH
  HOME: CLEVERAGENTS_HOME
  VERBOSE_LOGGING: CLEVERAGENTS_VERBOSE_LOGGING
  PLANDEX_REPL_SESSION_ID: CLEVERAGENTS_REPL_SESSION_ID
  EDITOR: CLEVERAGENTS_EDITOR
  VISUAL: CLEVERAGENTS_VISUAL
  PLANDEX_REPL: CLEVERAGENTS_REPL
  PLANDEX_REPL_OUTPUT_FILE: CLEVERAGENTS_REPL_OUTPUT_FILE
  GLAMOUR_STYLE: CLEVERAGENTS_GLAMOUR_STYLE
  PLANDEX_DISABLE_SUGGESTIONS: CLEVERAGENTS_DISABLE_SUGGESTIONS
  SHELL: CLEVERAGENTS_SHELL
  PLANDEX_COLUMNS: CLEVERAGENTS_COLUMNS
  COLUMNS: CLEVERAGENTS_COLUMNS
  PLANDEX_STREAM_FOREGROUND_COLOR: CLEVERAGENTS_STREAM_FOREGROUND_COLOR
statistics:
  total_variables: 69
  documented_variables: 42
  code_only_variables: 27
  migration_required: 16
provider_capabilities:
  description: |
    CleverAgents derives provider behavior from `src/cleveragents/providers/registry.py`.
    This section mirrors the runtime configuration so documentation consumers can see
    which capabilities are available without digging into the code.
  fallback_order:
  - openai
  - anthropic
  - google
  - azure
  - openrouter
  - groq
  - together
  - cohere
  - gemini
  precedence:
    cli_flags: "--provider / --model"
    environment: "CLEVERAGENTS_DEFAULT_PROVIDER / CLEVERAGENTS_DEFAULT_MODEL"
    settings: "Settings.default_provider / Settings.default_model"
    auto: "First configured provider following the fallback order"
  providers:
    openai:
      default_model: gpt-4o
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: true
      max_context_length: 128000
      env_vars:
      - OPENAI_API_KEY
    anthropic:
      default_model: claude-sonnet-4-20250514
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: false
      max_context_length: 200000
      env_vars:
      - ANTHROPIC_API_KEY
    google:
      default_model: gemini-2.0-flash
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: true
      max_context_length: 1000000
      env_vars:
      - GOOGLE_API_KEY
      - GOOGLE_GENAI_API_KEY
    azure:
      default_model: gpt-4o
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: true
      max_context_length: 128000
      env_vars:
      - AZURE_OPENAI_API_KEY
      - AZURE_OPENAI_ENDPOINT
      - AZURE_OPENAI_DEPLOYMENT
    openrouter:
      default_model: anthropic/claude-sonnet-4-20250514
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: true
      max_context_length: 128000
      env_vars:
      - OPENROUTER_API_KEY
      - CLEVERAGENTS_OPENROUTER_ORGANIZATION
    groq:
      default_model: llama-3.1-70b-versatile
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: false
      supports_json_mode: true
      max_context_length: 32000
      env_vars:
      - GROQ_API_KEY
    together:
      default_model: meta-llama/Llama-3.1-70B-Instruct-Turbo
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: false
      supports_json_mode: false
      max_context_length: 32000
      env_vars:
      - TOGETHER_API_KEY
    cohere:
      default_model: command-r-plus
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: false
      supports_json_mode: false
      max_context_length: 128000
      env_vars:
      - COHERE_API_KEY
    gemini:
      default_model: gemini-2.0-flash
      supports_streaming: true
      supports_tool_calls: true
      supports_vision: true
      supports_json_mode: true
      max_context_length: 1000000
      env_vars:
      - GEMINI_API_KEY
      - GOOGLE_GEMINI_API_KEY