ClaudeAgentSDK.Config.Env (claude_agent_sdk v0.17.2)

Copy Markdown View Source

Canonical registry of all environment variable names the SDK reads.

Using this module instead of bare string literals eliminates typo risk and provides a single grep-able registry:

System.get_env(ClaudeAgentSDK.Config.Env.anthropic_api_key())

Summary

Functions

Anthropic API key env var ("ANTHROPIC_API_KEY").

Anthropic auth token env var ("ANTHROPIC_AUTH_TOKEN").

Anthropic-compatible base URL env var ("ANTHROPIC_BASE_URL").

Anthropic model env var ("ANTHROPIC_MODEL").

"AWS_ACCESS_KEY_ID"

"AWS_PROFILE"

"CI"

SDK entrypoint identifier ("CLAUDE_CODE_ENTRYPOINT").

SDK external model overrides JSON ("CLAUDE_AGENT_EXTERNAL_MODEL_OVERRIDES").

File checkpointing flag ("CLAUDE_CODE_ENABLE_SDK_FILE_CHECKPOINTING").

"GOOGLE_APPLICATION_CREDENTIALS"

"GOOGLE_CLOUD_PROJECT"

"LIVE_MODE"

"LIVE_TESTS"

OAuth token env var ("CLAUDE_AGENT_OAUTH_TOKEN").

Environment variables automatically forwarded to CLI subprocesses.

SDK model backend selector ("CLAUDE_AGENT_PROVIDER_BACKEND").

SDK version injection ("CLAUDE_AGENT_SDK_VERSION").

Skip version check flag ("CLAUDE_AGENT_SDK_SKIP_VERSION_CHECK").

Stream close timeout override ("CLAUDE_CODE_STREAM_CLOSE_TIMEOUT").

Bedrock provider flag ("CLAUDE_AGENT_USE_BEDROCK").

Vertex AI provider flag ("CLAUDE_AGENT_USE_VERTEX").

Functions

anthropic_api_key()

@spec anthropic_api_key() :: String.t()

Anthropic API key env var ("ANTHROPIC_API_KEY").

anthropic_auth_token()

@spec anthropic_auth_token() :: String.t()

Anthropic auth token env var ("ANTHROPIC_AUTH_TOKEN").

anthropic_base_url()

@spec anthropic_base_url() :: String.t()

Anthropic-compatible base URL env var ("ANTHROPIC_BASE_URL").

anthropic_model()

@spec anthropic_model() :: String.t()

Anthropic model env var ("ANTHROPIC_MODEL").

aws_access_key_id()

@spec aws_access_key_id() :: String.t()

"AWS_ACCESS_KEY_ID"

aws_profile()

@spec aws_profile() :: String.t()

"AWS_PROFILE"

ci()

@spec ci() :: String.t()

"CI"

entrypoint()

@spec entrypoint() :: String.t()

SDK entrypoint identifier ("CLAUDE_CODE_ENTRYPOINT").

external_model_overrides()

@spec external_model_overrides() :: String.t()

SDK external model overrides JSON ("CLAUDE_AGENT_EXTERNAL_MODEL_OVERRIDES").

file_checkpointing()

@spec file_checkpointing() :: String.t()

File checkpointing flag ("CLAUDE_CODE_ENABLE_SDK_FILE_CHECKPOINTING").

gcp_credentials()

@spec gcp_credentials() :: String.t()

"GOOGLE_APPLICATION_CREDENTIALS"

gcp_project()

@spec gcp_project() :: String.t()

"GOOGLE_CLOUD_PROJECT"

live_mode()

@spec live_mode() :: String.t()

"LIVE_MODE"

live_tests()

@spec live_tests() :: String.t()

"LIVE_TESTS"

oauth_token()

@spec oauth_token() :: String.t()

OAuth token env var ("CLAUDE_AGENT_OAUTH_TOKEN").

passthrough_vars()

@spec passthrough_vars() :: [String.t()]

Environment variables automatically forwarded to CLI subprocesses.

Returns ["CLAUDE_AGENT_OAUTH_TOKEN", "ANTHROPIC_API_KEY", "PATH", "HOME"].

provider_backend()

@spec provider_backend() :: String.t()

SDK model backend selector ("CLAUDE_AGENT_PROVIDER_BACKEND").

sdk_version()

@spec sdk_version() :: String.t()

SDK version injection ("CLAUDE_AGENT_SDK_VERSION").

skip_version_check()

@spec skip_version_check() :: String.t()

Skip version check flag ("CLAUDE_AGENT_SDK_SKIP_VERSION_CHECK").

stream_close_timeout()

@spec stream_close_timeout() :: String.t()

Stream close timeout override ("CLAUDE_CODE_STREAM_CLOSE_TIMEOUT").

use_bedrock()

@spec use_bedrock() :: String.t()

Bedrock provider flag ("CLAUDE_AGENT_USE_BEDROCK").

use_vertex()

@spec use_vertex() :: String.t()

Vertex AI provider flag ("CLAUDE_AGENT_USE_VERTEX").