8.7 KiB
8.7 KiB
Environment Variable Migration Guide
Overview
Total variables: 66 Variables requiring migration: 16 Documented variables: 39 Code-only variables: 27
Variable Mappings
| Old Name | New Name | Category | Default | Description |
|---|---|---|---|---|
| COLUMNS | CLEVERAGENTS_COLUMNS | CLI | (none) | |
| EDITOR | CLEVERAGENTS_EDITOR | CLI | (none) | |
| GLAMOUR_STYLE | CLEVERAGENTS_GLAMOUR_STYLE | CLI | (none) | |
| PLANDEX_COLUMNS | CLEVERAGENTS_COLUMNS | CLI | (none) | |
| PLANDEX_DISABLE_SUGGESTIONS | CLEVERAGENTS_DISABLE_SUGGESTIONS | CLI | (none) | |
| PLANDEX_REPL | CLEVERAGENTS_REPL | CLI | (none) | |
| PLANDEX_REPL_OUTPUT_FILE | CLEVERAGENTS_REPL_OUTPUT_FILE | CLI | (none) | |
| PLANDEX_REPL_SESSION_ID | CLEVERAGENTS_REPL_SESSION_ID | CLI | (none) | |
| PLANDEX_STREAM_FOREGROUND_COLOR | CLEVERAGENTS_STREAM_FOREGROUND_COLOR | CLI | (none) | |
| SHELL | CLEVERAGENTS_SHELL | CLI | (none) | |
| VISUAL | CLEVERAGENTS_VISUAL | CLI | (none) | |
| GOPATH | CLEVERAGENTS_GOPATH | Development | (none) | This should be already set to your Go folder if yo... |
| PLANDEX_DEV_CLI_ALIAS | CLEVERAGENTS_DEV_CLI_ALIAS | Development | pdxd | The alias for the development binary when using de... |
| PLANDEX_DEV_CLI_NAME | CLEVERAGENTS_DEV_CLI_NAME | Development | plandex-dev | The name of the development binary when using dev.... |
| PLANDEX_DEV_CLI_OUT_DIR | CLEVERAGENTS_DEV_CLI_OUT_DIR | Development | /usr/local/bin | Where the development binary should be output when... |
| PLANDEX_OUT_DIR | CLEVERAGENTS_OUT_DIR | Development | /usr/local/bin | Where the development binary should be output when... |
| API_HOST | CLEVERAGENTS_API_HOST | General | (none) | The host the API server listens on. Defaults to 'h... |
| DATABASE_URL | CLEVERAGENTS_DATABASE_URL | General | (none) | The URL of the PostgreSQL database. Defaults to 'p... |
| GOENV | CLEVERAGENTS_GOENV | General | development | Whether to run in development or production mode. ... |
| LOCAL_MODE | CLEVERAGENTS_LOCAL_MODE | General | (none) | Whether to run in local mode |
| OLLAMA_BASE_URL | CLEVERAGENTS_OLLAMA_BASE_URL | General | (none) | The base URL of the Ollama server—only need when t... |
| PLANDEX_API_HOST | CLEVERAGENTS_API_HOST | General | (none) | Defaults to 'http://localhost:8099' if PLANDEX_ENV... |
| PLANDEX_BASE_DIR | CLEVERAGENTS_BASE_DIR | General | (none) | The base directory to read and write files. Defaul... |
| PLANDEX_ENV | CLEVERAGENTS_ENV | General | development | Set this to 'development' to default to the local ... |
| PORT | CLEVERAGENTS_PORT | General | 8099 | The port the server listens on. Defaults to 8099. |
| ANTHROPIC_API_KEY | ANTHROPIC_API_KEY | LLM Providers | (none) | Your Anthropic API key |
| AWS_ACCESS_KEY_ID | AWS_ACCESS_KEY_ID | LLM Providers | (none) | Your AWS access key ID |
| AWS_INFERENCE_PROFILE_ARN | AWS_INFERENCE_PROFILE_ARN | LLM Providers | (none) | Your AWS inference profile ARN |
| AWS_REGION | AWS_REGION | LLM Providers | (none) | Your AWS region |
| AWS_SECRET_ACCESS_KEY | AWS_SECRET_ACCESS_KEY | LLM Providers | (none) | Your AWS secret access key |
| AWS_SESSION_TOKEN | AWS_SESSION_TOKEN | LLM Providers | (none) | Your AWS session token |
| AZURE_API_BASE | AZURE_API_BASE | LLM Providers | (none) | Your Azure OpenAI API base URL |
| AZURE_API_VERSION | AZURE_API_VERSION | LLM Providers | (none) | Your Azure OpenAI API version |
| AZURE_DEPLOYMENTS_MAP | AZURE_DEPLOYMENTS_MAP | LLM Providers | (none) | Your Azure OpenAI deployments map—a JSON object ma... |
| AZURE_OPENAI_API_KEY | AZURE_OPENAI_API_KEY | LLM Providers | (none) | Your Azure OpenAI API key |
| DEEPSEEK_API_KEY | DEEPSEEK_API_KEY | LLM Providers | (none) | Your DeepSeek API key |
| GEMINI_API_KEY | GEMINI_API_KEY | LLM Providers | (none) | Your Google AI Studio API key |
| GOOGLE_APPLICATION_CREDENTIALS | GOOGLE_APPLICATION_CREDENTIALS | LLM Providers | (none) | Your Google Vertex AI credentials file path |
| OPENAI_API_KEY | OPENAI_API_KEY | LLM Providers | (none) | Your OpenAI key |
| OPENAI_ORG_ID | OPENAI_ORG_ID | LLM Providers | (none) | Your OpenAI organization ID. Defaults to empty. |
| OPENROUTER_API_KEY | OPENROUTER_API_KEY | LLM Providers | (none) | Your OpenRouter.ai API key |
| PERPLEXITY_API_KEY | PERPLEXITY_API_KEY | LLM Providers | (none) | Your Perplexity API key |
| PLANDEX_AWS_PROFILE | CLEVERAGENTS_AWS_PROFILE | LLM Providers | (none) | Name of AWS profile in ~/.aws/credentials to use f... |
| VERTEXAI_LOCATION | VERTEXAI_LOCATION | LLM Providers | (none) | Your Google Vertex AI location |
| VERTEXAI_PROJECT | VERTEXAI_PROJECT | LLM Providers | (none) | Your Google Vertex AI project ID |
| SMTP_HOST | CLEVERAGENTS_SMTP_HOST | SMTP | (none) | Your SMTP host. |
| SMTP_PASSWORD | CLEVERAGENTS_SMTP_PASSWORD | SMTP | (none) | SMTP password. |
| SMTP_PORT | CLEVERAGENTS_SMTP_PORT | SMTP | (none) | Set this to 1025 e.g. if you are using mailhog. |
| SMTP_USER | CLEVERAGENTS_SMTP_USER | SMTP | (none) | SMTP username. |
| APP_SUBDOMAIN | CLEVERAGENTS_APP_SUBDOMAIN | Server | (none) | |
| DB_HOST | CLEVERAGENTS_DB_HOST | Server | (none) | |
| DB_NAME | CLEVERAGENTS_DB_NAME | Server | (none) | |
| DB_PASSWORD | CLEVERAGENTS_DB_PASSWORD | Server | (none) | |
| DB_PORT | CLEVERAGENTS_DB_PORT | Server | (none) | |
| DB_USER | CLEVERAGENTS_DB_USER | Server | (none) | |
| ECS_CONTAINER_METADATA_URI | CLEVERAGENTS_ECS_CONTAINER_METADATA_URI | Server | (none) | |
| HOME | CLEVERAGENTS_HOME | Server | (none) | |
| IP | CLEVERAGENTS_IP | Server | (none) | |
| IS_CLOUD | CLEVERAGENTS_IS_CLOUD | Server | (none) | |
| LITELLM_PROXY_DIR | CLEVERAGENTS_LITELLM_PROXY_DIR | Server | (none) | |
| MIGRATIONS_DIR | CLEVERAGENTS_MIGRATIONS_DIR | Server | (none) | |
| PATH | CLEVERAGENTS_PATH | Server | (none) | |
| PLANDEX_CLOUD | CLEVERAGENTS_CLOUD | Server | (none) | |
| SMTP_FROM | CLEVERAGENTS_SMTP_FROM | Server | (none) | |
| VERBOSE_LOGGING | CLEVERAGENTS_VERBOSE_LOGGING | Server | (none) | |
| PLANDEX_SKIP_UPGRADE | CLEVERAGENTS_SKIP_UPGRADE | Upgrades | (none) | Set this to '1' to skip the auto-upgrade check whe... |
Conflicts and Warnings
-
PLANDEX_ENV: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_ENV
-
PLANDEX_API_HOST: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_API_HOST
-
PLANDEX_AWS_PROFILE: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_AWS_PROFILE
-
PLANDEX_SKIP_UPGRADE: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_SKIP_UPGRADE
-
PLANDEX_OUT_DIR: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_OUT_DIR
-
PLANDEX_DEV_CLI_OUT_DIR: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_DEV_CLI_OUT_DIR
-
PLANDEX_DEV_CLI_OUT_DIR: Development-specific variable, may need reconsideration
- Type: development_only
- Suggested: CLEVERAGENTS_DEV_CLI_OUT_DIR
-
PLANDEX_DEV_CLI_NAME: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_DEV_CLI_NAME
-
PLANDEX_DEV_CLI_NAME: Development-specific variable, may need reconsideration
- Type: development_only
- Suggested: CLEVERAGENTS_DEV_CLI_NAME
-
PLANDEX_DEV_CLI_ALIAS: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_DEV_CLI_ALIAS
-
PLANDEX_DEV_CLI_ALIAS: Development-specific variable, may need reconsideration
- Type: development_only
- Suggested: CLEVERAGENTS_DEV_CLI_ALIAS
-
PLANDEX_BASE_DIR: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_BASE_DIR
-
PLANDEX_CLOUD: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_CLOUD
-
PLANDEX_REPL_SESSION_ID: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_REPL_SESSION_ID
-
PLANDEX_REPL: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_REPL
-
PLANDEX_REPL_OUTPUT_FILE: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_REPL_OUTPUT_FILE
-
PLANDEX_DISABLE_SUGGESTIONS: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_DISABLE_SUGGESTIONS
-
PLANDEX_COLUMNS: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_COLUMNS
-
PLANDEX_STREAM_FOREGROUND_COLOR: Rename from Plandex to CleverAgents namespace
- Type: migration_required
- Suggested: CLEVERAGENTS_STREAM_FOREGROUND_COLOR