Claude Code Settings
Configuration file for Claude Code
**/.claude/settings.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/.claude/settings.json and it validates in your browser — nothing is uploaded.
Reference
Fields (first 250)
Generated directly from the schema, following local
$refs, to two levels of nesting. This schema is large — the table is truncated; use the raw schema for the rest.
| Field | Type | Description |
|---|---|---|
$schema | string | JSON Schema reference for Claude Code settings |
apiKeyHelper | string | Path to a script that outputs authentication values. See https://code.claude.com/docs/en/settings#available-settings |
autoMemoryEnabled | boolean | Enable automatic memory saves that capture useful context to ~/.claude/projects/<project>/memory/ (derived from the git repository, shared across worktrees). Also configurable via CLAUDE_CODE_DISABLE_AUTO_MEMORY environment variable (set default: true |
autoUpdatesChannel | string | Release channel to follow for updates. Use "stable" for a version that is typically about one week old and skips versions with major regressions, or "latest" (default) for the most recent release. Set DISABLE_AUTOUPDATER=1 to disable default: "latest"one of: "stable", "latest" |
awsCredentialExport | string | Command that outputs AWS credentials as JSON (in the form {"Credentials": {"AccessKeyId": ..., "SecretAccessKey": ..., "SessionToken": ...}}). The output is captured silently. Use when you cannot modify the .aws directory and must return |
awsAuthRefresh | string | Command to run when AWS credentials are expired or unavailable; its output is shown to the user but interactive input is not supported. Also drives the "Claude Platform on AWS · refresh credentials" option in /login when configured. See |
claudeMdExcludes | array<string> | Glob patterns for CLAUDE.md files to exclude from loading. Useful in monorepos to skip irrelevant instructions from other teams. Patterns match against absolute file paths. Arrays merge across settings layers. Managed policy CLAUDE.md |
cleanupPeriodDays | integer | Number of days to retain sessions, orphaned subagent worktrees, tasks, shell snapshots, and backups. Minimum is 1; setting 0 is rejected with a validation error. See https://code.claude.com/docs/en/settings#available-settings default: 30 |
env | object | Environment variables to set for Claude Code sessions. Many environment variables provide settings dimensions not available as dedicated settings.json properties (e.g., thinking tokens, prompt caching, bash timeouts, shell configuration) default: {} |
env.ANTHROPIC_API_KEY | string | API key for Anthropic API authentication |
env.ANTHROPIC_AUTH_TOKEN | string | Custom Authorization header bearer token for API requests |
env.ANTHROPIC_AWS_API_KEY | string | Workspace API key for Claude Platform on AWS; takes precedence over SigV4 authentication. See https://code.claude.com/docs/en/claude-platform-on-aws#1-configure-aws-credentials |
env.ANTHROPIC_AWS_BASE_URL | string | Override the Claude Platform on AWS endpoint URL. Default is https://aws-external-anthropic.{region}.api.aws. See https://code.claude.com/docs/en/claude-platform-on-aws#route-through-a-corporate-proxy |
env.ANTHROPIC_AWS_WORKSPACE_ID | string | Required workspace ID for Claude Platform on AWS; sent as the anthropic-workspace-id header on every request. See https://code.claude.com/docs/en/claude-platform-on-aws#2-configure-claude-code |
env.ANTHROPIC_BASE_URL | string | Override API endpoint URL for proxy or gateway routing |
env.ANTHROPIC_BEDROCK_BASE_URL | string | Override Amazon Bedrock endpoint URL |
env.ANTHROPIC_BEDROCK_MANTLE_BASE_URL | string | Override Bedrock Mantle endpoint URL |
env.ANTHROPIC_BEDROCK_SERVICE_TIER | string | Select Bedrock service tier; sent as X-Amzn-Bedrock-Service-Tier header. See https://code.claude.com/docs/en/amazon-bedrock#service-tiers one of: "default", "flex", "priority" |
env.ANTHROPIC_BETAS | string | Comma-separated beta header values to include in API requests |
env.ANTHROPIC_CUSTOM_HEADERS | string | Custom HTTP headers for API requests (newline-separated 'Name: Value' pairs) |
env.ANTHROPIC_CUSTOM_MODEL_OPTION | string | Custom model ID to add as an entry in the model picker |
env.ANTHROPIC_CUSTOM_MODEL_OPTION_DESCRIPTION | string | Display description for the custom model in the model picker |
env.ANTHROPIC_CUSTOM_MODEL_OPTION_NAME | string | Display name for the custom model in the model picker |
env.ANTHROPIC_CUSTOM_MODEL_OPTION_SUPPORTED_CAPABILITIES | string | JSON object specifying capability flags for the custom model |
env.ANTHROPIC_DEFAULT_FABLE_MODEL | string | Override the default Fable-class model ID. See https://code.claude.com/docs/en/model-config#environment-variables |
env.ANTHROPIC_DEFAULT_FABLE_MODEL_DESCRIPTION | string | Display description shown for the Fable model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_FABLE_MODEL_NAME | string | Display name shown for the Fable model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_FABLE_MODEL_SUPPORTED_CAPABILITIES | string | Comma-separated list of capabilities the pinned Fable model supports. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_HAIKU_MODEL | string | Override default Haiku model ID |
env.ANTHROPIC_DEFAULT_HAIKU_MODEL_DESCRIPTION | string | Display description shown for the Haiku model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_HAIKU_MODEL_NAME | string | Display name shown for the Haiku model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_HAIKU_MODEL_SUPPORTED_CAPABILITIES | string | Comma-separated list of capabilities the pinned Haiku model supports. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_OPUS_MODEL | string | Override default Opus model ID |
env.ANTHROPIC_DEFAULT_OPUS_MODEL_DESCRIPTION | string | Display description shown for the Opus model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_OPUS_MODEL_NAME | string | Display name shown for the Opus model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_OPUS_MODEL_SUPPORTED_CAPABILITIES | string | Comma-separated list of capabilities the pinned Opus model supports. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_SONNET_MODEL | string | Override default Sonnet model ID |
env.ANTHROPIC_DEFAULT_SONNET_MODEL_DESCRIPTION | string | Display description shown for the Sonnet model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_SONNET_MODEL_NAME | string | Display name shown for the Sonnet model in the model picker. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_DEFAULT_SONNET_MODEL_SUPPORTED_CAPABILITIES | string | Comma-separated list of capabilities the pinned Sonnet model supports. See https://code.claude.com/docs/en/model-config#customize-pinned-model-display-and-capabilities |
env.ANTHROPIC_FOUNDRY_API_KEY | string | Microsoft Foundry authentication key |
env.ANTHROPIC_FOUNDRY_AUTH_TOKEN | string | Bearer token for Microsoft Foundry authentication, such as a Microsoft Entra access token. Claude Code sends it as the Authorization: Bearer header. Takes precedence over ANTHROPIC_FOUNDRY_API_KEY and over the Azure default credential |
env.ANTHROPIC_FOUNDRY_BASE_URL | string | Microsoft Foundry resource URL |
env.ANTHROPIC_FOUNDRY_RESOURCE | string | Microsoft Foundry resource name |
env.ANTHROPIC_MODEL | string | Model to use (e.g., 'claude-opus-4-1', 'claude-sonnet-4-5-20250514', 'opus', 'sonnet', 'haiku') |
env.ANTHROPIC_SMALL_FAST_MODEL | string | DEPRECATED (prefer ANTHROPIC_DEFAULT_HAIKU_MODEL). Haiku-class model to use for background and low-complexity tasks (e.g., 'claude-3-5-haiku-latest') |
env.ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION | string | Override the AWS region for the Haiku-class model on Bedrock and Bedrock Mantle. Has no effect without ANTHROPIC_DEFAULT_HAIKU_MODEL (or the deprecated ANTHROPIC_SMALL_FAST_MODEL) set on Bedrock. See |
env.ANTHROPIC_VERTEX_BASE_URL | string | Override Google Cloud's Agent Platform (formerly Vertex AI) endpoint URL. Use for custom endpoints or when routing through an LLM gateway |
env.ANTHROPIC_VERTEX_PROJECT_ID | string | GCP project ID for Google Cloud's Agent Platform (formerly Vertex AI) requests. Overridden by GCLOUD_PROJECT, GOOGLE_CLOUD_PROJECT, or the project in your GOOGLE_APPLICATION_CREDENTIALS credential file |
env.ANTHROPIC_WORKSPACE_ID | string | Workspace ID for workload identity federation. Scopes the minted token to a specific workspace when the federation rule covers more than one. See https://code.claude.com/docs/en/env-vars |
env.API_FORCE_IDLE_TIMEOUT | string | Override the 5-minute idle timeout for streaming responses (0 disables it). See https://code.claude.com/docs/en/env-vars |
env.API_TIMEOUT_MS | string | Timeout for API requests in milliseconds (default: 600000, or 10 minutes; maximum: 2147483647). Increase this when requests time out on slow networks or when routing through a proxy. Values above the maximum overflow the underlying timer |
env.AWS_BEARER_TOKEN_BEDROCK | string | Bearer token for Bedrock API authentication |
env.AWS_REGION | string | AWS region for Amazon Bedrock and Claude Platform on AWS requests (e.g. us-east-1). See https://code.claude.com/docs/en/amazon-bedrock#3-configure-claude-code |
env.BASH_DEFAULT_TIMEOUT_MS | string | Default bash command timeout in milliseconds (default: 120000) |
env.BASH_MAX_OUTPUT_LENGTH | string | Maximum bash output characters before truncation |
env.BASH_MAX_TIMEOUT_MS | string | Maximum bash command timeout in milliseconds (default: 600000) |
env.BETA_TRACING_ENDPOINT | string | Endpoint that, together with ENABLE_BETA_TRACING_DETAILED=1, activates detailed beta tracing spans (e.g. claude_code.hook). See https://code.claude.com/docs/en/monitoring-usage#traces-beta |
env.CCR_FORCE_BUNDLE | string | Force local repo bundling for --remote invocations one of: "0", "1" |
env.CLAUDECODE | string | Set to 1 in subprocesses Claude Code spawns (Bash and PowerShell tools, tmux sessions, hook commands, status line commands, stdio MCP server subprocesses). IDE extensions also set this in their integrated terminals. To distinguish a direct one of: "0", "1" |
env.CLAUDE_AFK_COUNTDOWN_MS | string | How many milliseconds before auto-continue the on-screen countdown appears on an unanswered AskUserQuestion dialog. Default 20000 (20 seconds). See CLAUDE_AFK_TIMEOUT_MS. Requires Claude Code v2.1.198 or later. See |
env.CLAUDE_AFK_TIMEOUT_MS | string | How many milliseconds of idle time before an unanswered AskUserQuestion dialog auto-continues without you. Default 60000 (60 seconds). Requires Claude Code v2.1.198 or later. See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_AGENT_SDK_DISABLE_BUILTIN_AGENTS | string | Disable built-in subagent types in Agent SDK one of: "0", "1" |
env.CLAUDE_AGENT_SDK_MCP_NO_PREFIX | string | Skip 'mcp__<server>__' prefix on MCP tool names in Agent SDK one of: "0", "1" |
env.CLAUDE_ASYNC_AGENT_STALL_TIMEOUT_MS | string | Stall timeout for background subagents in milliseconds (default 600000). The timer resets on each streaming progress event; if no progress arrives within the window the subagent is aborted and the task is marked failed, surfacing any |
env.CLAUDE_AUTOCOMPACT_PCT_OVERRIDE | string | Context capacity percentage threshold for auto-compaction (1-100) |
env.CLAUDE_AUTO_BACKGROUND_TASKS | string | Force-enable automatic backgrounding of tasks one of: "0", "1" |
env.CLAUDE_AX_SCREEN_READER | string | Set to 1 to render screen-reader friendly output: flat text without decorative borders or animations. Set to 0 to force screen-reader mode off even when axScreenReader is true. The --ax-screen-reader flag takes precedence. Requires Claude one of: "0", "1" |
env.CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR | string | Return to original project directory after each bash command one of: "0", "1" |
env.CLAUDE_CLIENT_PRESENCE_FILE | string | Path to a file whose existence marks the user as present; while it exists, mobile push notifications are skipped (v2.1.181+). See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_ACCESSIBILITY | string | Keep native cursor visible for screen magnifiers and assistive tools one of: "0", "1" |
env.CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD | string | Load CLAUDE.md memory files from additional directories one of: "0", "1" |
env.CLAUDE_CODE_ALT_SCREEN_FULL_REPAINT | string | Force a full-screen repaint on every frame in fullscreen mode. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_ALWAYS_ENABLE_EFFORT | string | Send the effort parameter for all models, not just those with effort enabled by default. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_API_KEY_HELPER_TTL_MS | string | Credential helper refresh interval in milliseconds |
env.CLAUDE_CODE_ARTIFACT_AUTO_OPEN | string | Set to 0 to stop auto-opening the browser when a new artifact is created. See https://code.claude.com/docs/en/artifacts#create-an-artifact one of: "0", "1" |
env.CLAUDE_CODE_ATTRIBUTION_HEADER | string | Include attribution block in the system prompt one of: "0", "1" |
env.CLAUDE_CODE_AUTO_COMPACT_WINDOW | string | Context capacity for compaction calculations in tokens |
env.CLAUDE_CODE_AUTO_CONNECT_IDE | string | Override automatic IDE connection behavior one of: "true", "false" |
env.CLAUDE_CODE_AWS_CHAIN_RESOLVE_TIMEOUT_MS | string | Time in milliseconds Claude Code waits for the AWS default credential provider chain to produce credentials before the request fails with "AWS default-chain credential resolve timed out" (default: 60000). Raise it when a step in your chain |
env.CLAUDE_CODE_BRIDGE_SESSION_ID | string | Set automatically in Bash tool and hook command subprocesses while the session has an active Remote Control connection, and removed when the connection ends. The value is the session's ID in session_ form, the same identifier that appears |
env.CLAUDE_CODE_CERT_STORE | string | CA certificate sources (comma-separated: 'bundled', 'system') |
env.CLAUDE_CODE_CHILD_SESSION | string | Set by Claude Code to 1 in nested subprocesses (Bash, PowerShell, Monitor, hook commands, status-line commands) to distinguish nested sessions from a top-level claude launched in IDE terminals (v2.1.172+). A nested interactive claude TUI one of: "0", "1" |
env.CLAUDE_CODE_CLIENT_CERT | string | Client certificate file path for mutual TLS |
env.CLAUDE_CODE_CLIENT_KEY | string | Client private key file path for mutual TLS |
env.CLAUDE_CODE_CLIENT_KEY_PASSPHRASE | string | Passphrase for encrypted client private key |
env.CLAUDE_CODE_DEBUG_LOGS_DIR | string | Override the debug log file path. Despite the name, this is a file path, not a directory. |
env.CLAUDE_CODE_DEBUG_LOG_LEVEL | string | Debug log verbosity level one of: "verbose", "debug", "info", "warn", "error" |
env.CLAUDE_CODE_DISABLE_1M_CONTEXT | string | Disable 1M context window models one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING | string | Disable adaptive reasoning one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_ADVISOR_TOOL | string | Disable the server-side advisor tool. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_AGENT_VIEW | string | Turn off background agents and agent view (claude agents, --bg, /background, and the on-demand supervisor). Equivalent to the disableAgentView setting. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_ALTERNATE_SCREEN | string | Disable alternate screen buffer rendering. When set to 1, keeps conversation in native scrollback instead of fullscreen renderer one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_ARTIFACT | string | Disable the Artifact tool. Equivalent to setting disableArtifact. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_ATTACHMENTS | string | Disable attachment processing one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_AUTO_MEMORY | string | Disable automatic memory feature one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_BACKGROUND_TASKS | string | Disable all background task functionality one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_BEDROCK_CONTENT_TYPE_GUARD | string | Set to 1 to skip the check that an Amazon Bedrock streaming response carries the application/vnd.amazon.eventstream content-type. Without this variable, a response with a different content-type fails with an error naming that content-type one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_BG_EXIT_HANDOFF | string | Set to 1 to stop a background session's running background shell commands, dynamic workflows, and (as of v2.1.198) background subagents when the supervisor stops, restarts, or updates that session's process, instead of handing them off to one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_BG_SHELL_PRESSURE_REAP | string | UNDOCUMENTED. Disable automatic memory-pressure reaping of idle background shell commands (added v2.1.193). one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_BUNDLED_SKILLS | string | Disable the skills and workflows bundled with Claude Code (plugins and project .claude/skills are unaffected). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_CLAUDE_MDS | string | Prevent loading CLAUDE.md memory files one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_CRON | string | Disable scheduled/cron tasks one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS | string | Strip anthropic-beta headers from API requests. See https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md#21123 one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_EXPLORE_PLAN_AGENTS | string | Set to 1 to disable the built-in Explore and Plan subagents. Requires Claude Code v2.1.198 or later. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_FAST_MODE | string | Disable fast mode toggle one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY | string | Disable session quality feedback surveys one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_FILE_CHECKPOINTING | string | Disable file checkpointing for /rewind one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_GIT_INSTRUCTIONS | string | Remove git commit and PR workflow instructions from the system prompt one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_LEGACY_MODEL_REMAP | string | Prevent automatic remapping of legacy model names one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_MOUSE | string | Disable mouse tracking in fullscreen mode. See https://code.claude.com/docs/en/fullscreen#keep-native-text-selection one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_MOUSE_CLICKS | string | Disable mouse click/drag/hover in fullscreen mode while keeping wheel scroll (requires v2.1.195+). CLAUDE_CODE_DISABLE_MOUSE takes precedence when both variables are set. See one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC | string | Disable auto-update checks, telemetry, and feedback in one setting one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_NONSTREAMING_FALLBACK | string | Disable fallback to non-streaming API mode one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_NOTIFICATION_PRESENCE_CHECK | string | Set to 1 to send desktop notifications from the PushNotification tool even while focused on the terminal. Requires Claude Code v2.1.193 or later. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_OFFICIAL_MARKETPLACE_AUTOINSTALL | string | Skip automatic installation of official marketplace plugins. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_POLICY_SKILLS | string | Skip loading system-wide policy skills. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_TERMINAL_TITLE | string | Disable terminal title updates one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_THINKING | string | Force-disable extended thinking one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_VIRTUAL_SCROLL | string | Disable virtual scrolling in fullscreen mode one of: "0", "1" |
env.CLAUDE_CODE_DISABLE_WORKFLOWS | string | Set to 1 to disable workflows. Equivalent to the disableWorkflows setting. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_EFFORT_LEVEL | string | Reasoning effort level one of: "low", "medium", "high", "xhigh", "max", "auto" |
env.CLAUDE_CODE_ENABLE_APPEND_SUBAGENT_PROMPT | string | Set to 1 to enable appending extra text to the end of every subagent's system prompt. The --append-subagent-system-prompt flag supplies the appended text and sets this variable automatically, so you do not need to set it yourself. Requires one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_AUTO_MODE | string | Set to 1 to make auto mode available on Amazon Bedrock, Google Cloud Vertex AI, and Microsoft Foundry (requires v2.1.158+; no effect on the Anthropic API where auto mode is available by default). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_AWAY_SUMMARY | string | Override session recap/away summary availability one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_BACKGROUND_PLUGIN_REFRESH | string | Refresh plugins at turn boundaries. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_FEEDBACK_SURVEY_FOR_OTEL | string | Enable feedback survey collection via OpenTelemetry for enterprises one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_FINE_GRAINED_TOOL_STREAMING | string | Force fine-grained tool output streaming one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY | string | Enable model discovery from LLM gateway /v1/models endpoint when ANTHROPIC_BASE_URL points at an Anthropic-compatible gateway one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION | string | Enable prompt suggestions one of: "true", "false" |
env.CLAUDE_CODE_ENABLE_SDK_FILE_CHECKPOINTING | string | Enable file checkpointing for a non-interactive CLI run, so `claude -p --resume <session-id> --rewind-files <checkpoint-uuid>` can rewind files. The Agent SDK sets this internally when enable_file_checkpointing (Python) or |
env.CLAUDE_CODE_ENABLE_TASKS | string | Enable task tracking in non-interactive mode one of: "0", "1" |
env.CLAUDE_CODE_ENABLE_TELEMETRY | string | Set to 1 to enable telemetry collection. Required for all OpenTelemetry integration. See https://code.claude.com/docs/en/monitoring-usage#common-configuration-variables one of: "0", "1" |
env.CLAUDE_CODE_ENHANCED_TELEMETRY_BETA | string | Enable the enhanced telemetry (tracing) beta. ENABLE_ENHANCED_TELEMETRY_BETA is also accepted. See https://code.claude.com/docs/en/monitoring-usage#traces-beta one of: "0", "1" |
env.CLAUDE_CODE_EXIT_AFTER_STOP_DELAY | string | Wait time in milliseconds before auto-exit after stop |
env.CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS | string | Enable experimental agent teams feature one of: "0", "1" |
env.CLAUDE_CODE_EXTRA_BODY | string | JSON object to merge into every API request body |
env.CLAUDE_CODE_FILE_READ_MAX_OUTPUT_TOKENS | string | Token limit for file read operations |
env.CLAUDE_CODE_FORCE_SESSION_PERSISTENCE | string | Set to 1 to override the automatic exclusion of nested interactive claude TUI sessions from --resume, --continue, up-arrow history, and the claude agents list (requires v2.1.172+). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_FORCE_STRIKETHROUGH | string | Set to 1 to force strikethrough rendering for ~~text~~ in Claude's responses when the terminal supports it but is not auto-detected, such as over SSH without TERM_PROGRAM forwarded. Without this, undetected terminals show the literal ~~ one of: "0", "1" |
env.CLAUDE_CODE_FORCE_SYNC_OUTPUT | string | Force synchronous output flushing. When set to 1, forces synchronized output on terminals that auto-detection misses (e.g., Emacs eat) one of: "0", "1" |
env.CLAUDE_CODE_FORK_SUBAGENT | string | Fork subagent processes in non-interactive sessions. See https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md#21120 one of: "0", "1" |
env.CLAUDE_CODE_FORWARD_SUBAGENT_TEXT | string | Set to 1 to emit subagent text and thinking blocks in claude -p --output-format stream-json output, the same behavior as the --forward-subagent-text flag. Use the variable when a harness invokes claude and cannot pass the flag itself one of: "0", "1" |
env.CLAUDE_CODE_GIT_BASH_PATH | string | Path to Git Bash executable (Windows only) |
env.CLAUDE_CODE_GLOB_HIDDEN | string | Include dotfiles/hidden files in Glob results one of: "true", "false" |
env.CLAUDE_CODE_GLOB_NO_IGNORE | string | Don't respect .gitignore rules in Glob results one of: "true", "false" |
env.CLAUDE_CODE_GLOB_TIMEOUT_SECONDS | string | Glob tool timeout in seconds (default: 20-60) |
env.CLAUDE_CODE_HIDE_CWD | string | Hide the working directory in the startup logo. See https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md#21126 one of: "0", "1" |
env.CLAUDE_CODE_IDE_HOST_OVERRIDE | string | Override IDE connection address |
env.CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL | string | Skip automatic IDE extension installation one of: "0", "1" |
env.CLAUDE_CODE_IDE_SKIP_VALID_CHECK | string | Skip IDE lockfile validation one of: "0", "1" |
env.CLAUDE_CODE_MAX_CONCURRENT_SUBAGENTS | string | How many subagents can be running in one session before the Agent tool refuses to spawn another (default: 20). Accepts a positive whole number in plain digits; anything else is ignored, so the variable can adjust the cap but cannot disable |
env.CLAUDE_CODE_MAX_CONTEXT_TOKENS | string | Override context window size in tokens |
env.CLAUDE_CODE_MAX_OUTPUT_TOKENS | string | Maximum output tokens per API request |
env.CLAUDE_CODE_MAX_RETRIES | string | Maximum API request retry attempts (default: 10) |
env.CLAUDE_CODE_MAX_SUBAGENTS_PER_SESSION | string | Cap on the number of subagents one session can spawn with the Agent tool (default: 200). When Claude reaches the cap, spawning another subagent fails with an error telling Claude to finish the remaining work directly. Accepts a positive |
env.CLAUDE_CODE_MAX_SUBAGENT_SPAWN_DEPTH | string | Number of subagent layers allowed below the main conversation (default: 1). At the default, subagents cannot spawn their own subagents; set 2 or higher to allow it. Accepts a positive whole number in plain digits; anything else is ignored |
env.CLAUDE_CODE_MAX_TOOL_USE_CONCURRENCY | string | Maximum parallel tool executions (default: 10) |
env.CLAUDE_CODE_MAX_TURNS | string | Cap the number of agentic turns when no explicit limit is passed. Equivalent to --max-turns, which takes precedence. A non-positive integer is rejected at startup. See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_MAX_WEB_SEARCHES_PER_SESSION | string | Cap on the total number of WebSearch calls one session can make (default: 200). When Claude reaches the cap, further WebSearch calls return a notice telling it to continue with the information it already gathered. Accepts a positive whole |
env.CLAUDE_CODE_MCP_ALLOWLIST_ENV | string | Isolate MCP server environments to allowlisted variables one of: "0", "1" |
env.CLAUDE_CODE_MCP_AUTO_BACKGROUND_MS | string | Elapsed time in milliseconds before a still-running MCP tool call moves to a background task (default: 120000, or 2 minutes). Set to 0 to turn automatic backgrounding off. Requires Claude Code v2.1.212 or later. See |
env.CLAUDE_CODE_MCP_TOOL_IDLE_TIMEOUT | string | Idle timeout in milliseconds for MCP tool calls. When a stdio, HTTP, SSE, WebSocket, or claude.ai connector MCP server sends no response and no progress notification for this long, the tool call aborts with an error instead of waiting for |
env.CLAUDE_CODE_NATIVE_CURSOR | string | Set to 1 to show the terminal's own cursor at the input caret instead of a drawn block. The cursor respects the terminal's blink, shape, and focus settings. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_NEW_INIT | string | Use the interactive /init setup flow one of: "0", "1" |
env.CLAUDE_CODE_NO_FLICKER | string | Enable fullscreen rendering mode to reduce flicker one of: "0", "1" |
env.CLAUDE_CODE_OAUTH_REFRESH_TOKEN | string | OAuth refresh token |
env.CLAUDE_CODE_OAUTH_SCOPES | string | OAuth scopes (space-separated) |
env.CLAUDE_CODE_OAUTH_TOKEN | string | OAuth access token |
env.CLAUDE_CODE_OTEL_CONTENT_MAX_LENGTH | string | Maximum length of content-bearing OpenTelemetry attributes (model responses, tool content, system prompts, raw API bodies), truncation marker included, in UTF-16 code units (default: 61440, i.e. 60 KB). Raise it only if your telemetry |
env.CLAUDE_CODE_OTEL_DIAG_STDERR | string | Set to 1 to write OpenTelemetry exporter diagnostic errors to stderr (otherwise shown only with --debug). Requires v2.1.179+. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_OTEL_FLUSH_TIMEOUT_MS | string | OpenTelemetry span flush timeout in milliseconds (default: 5000) |
env.CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS | string | OpenTelemetry header helper refresh interval in milliseconds |
env.CLAUDE_CODE_OTEL_SHUTDOWN_TIMEOUT_MS | string | OpenTelemetry shutdown timeout in milliseconds (default: 2000) |
env.CLAUDE_CODE_PACKAGE_MANAGER_AUTO_UPDATE | string | Enable automatic package manager updates. When set, Claude Code runs the upgrade command in background on Homebrew/WinGet and prompts to restart one of: "0", "1" |
env.CLAUDE_CODE_PERFORCE_MODE | string | Enable Perforce write protection mode one of: "0", "1" |
env.CLAUDE_CODE_PLUGIN_CACHE_DIR | string | Override the plugins root directory. Despite the name, this sets the parent directory, not the cache itself: marketplaces and the plugin cache live in subdirectories under this path. Defaults to ~/.claude/plugins. See |
env.CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS | string | Plugin marketplace git operations timeout in milliseconds (default: 120000). See https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md#2151 |
env.CLAUDE_CODE_PLUGIN_KEEP_MARKETPLACE_ON_FAILURE | string | Keep plugin cache on update failure one of: "0", "1" |
env.CLAUDE_CODE_PLUGIN_PREFER_HTTPS | string | Set to 1 to clone GitHub owner/repo plugin sources over HTTPS instead of SSH. Useful in CI runners, containers, or environments without a configured SSH key for github.com. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_PLUGIN_SEED_DIR | string | Path(s) to pre-populated plugin directories. See https://code.claude.com/docs/en/plugin-marketplaces#pre-populate-plugins-for-containers |
env.CLAUDE_CODE_POWERSHELL_RESPECT_EXECUTION_POLICY | string | Set to 1 to stop Claude Code from passing -ExecutionPolicy Bypass when spawning PowerShell for tool calls, hooks, and status line commands. By default Claude Code bypasses execution policy so .ps1 scripts work on default-Restricted Windows one of: "0", "1" |
env.CLAUDE_CODE_PRINT_BG_WAIT_CEILING_MS | string | Cap, in milliseconds, on how long `claude -p` waits for background subagents at exit (default 10 minutes; set to 0 to wait without limit, added v2.1.182). See https://code.claude.com/docs/en/headless#background-tasks-at-exit |
env.CLAUDE_CODE_PROCESS_WRAPPER | string | Launch the processes Claude Code starts from its own binary, such as the background service that hosts agent view sessions, through a corporate launcher given as an argv prefix like /opt/corp/launcher. Set it in the env block of user or |
env.CLAUDE_CODE_PROPAGATE_TRACEPARENT | string | Propagate the W3C traceparent header on API requests when using a custom ANTHROPIC_BASE_URL. See https://code.claude.com/docs/en/monitoring-usage#traces-beta one of: "0", "1" |
env.CLAUDE_CODE_PROVIDER_MANAGED_BY_HOST | string | Indicate that the host application manages provider routing one of: "0", "1" |
env.CLAUDE_CODE_PROXY_RESOLVES_HOSTS | string | Allow proxy to handle DNS resolution one of: "0", "1" |
env.CLAUDE_CODE_REMOTE | string | Indicates a remote web environment session one of: "true", "false" |
env.CLAUDE_CODE_REMOTE_SESSION_ID | string | Cloud session identifier for remote sessions |
env.CLAUDE_CODE_RESUME_INTERRUPTED_TURN | string | Automatically resume from a mid-turn interruption one of: "0", "1" |
env.CLAUDE_CODE_RESUME_INTERRUPTED_TURN_MAX_AGE_MS | string | Maximum age in milliseconds of the last transcript message for a session that ended mid-turn to continue automatically on resume. When the last message is older than this bound, Claude Code skips both the |
env.CLAUDE_CODE_RESUME_PROMPT | string | Override the continuation message injected when resuming a session that ended mid-turn (default "Continue from where you left off."). An empty string uses the default. See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_RETRY_WATCHDOG | string | Set to 1 for unattended sessions (eval harnesses, CI, remote workers) to retry 429/529 capacity errors indefinitely, backing off up to 5 minutes, instead of failing after CLAUDE_CODE_MAX_RETRIES. Requires v2.1.186+. See one of: "0", "1" |
env.CLAUDE_CODE_SAFE_MODE | string | Set to 1 to start in safe mode: CLAUDE.md, skills, plugins, hooks, MCP servers, custom commands and agents, output styles, workflows, custom themes, custom keybindings, status line and file-suggestion commands, LSP servers, and auto-memory one of: "0", "1" |
env.CLAUDE_CODE_SCRIPT_CAPS | string | Script invocation limits (JSON object) |
env.CLAUDE_CODE_SCROLL_SPEED | string | Set the mouse wheel scroll multiplier in fullscreen rendering. Accepts any positive value up to 20, including fractional values below 1 such as 0.5 to slow accelerated trackpad and wheel scrolling in terminals that already amplify wheel |
env.CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS | string | Override the time budget in milliseconds for SessionEnd hooks (default 1500, raised up to 60000 by the highest configured per-hook timeout). See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_SESSION_ID | string | Set automatically to the current session ID in Bash/PowerShell tool subprocesses, hook command subprocesses, and stdio MCP server subprocesses. Read-only. See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_SHELL | string | Override automatic shell detection (e.g., '/bin/zsh', '/bin/bash') |
env.CLAUDE_CODE_SHELL_PREFIX | string | Command prefix wrapper for shell commands |
env.CLAUDE_CODE_SIMPLE | string | Minimal mode with core tools only one of: "0", "1" |
env.CLAUDE_CODE_SIMPLE_SYSTEM_PROMPT | string | Use a shortened system prompt one of: "0", "1" |
env.CLAUDE_CODE_SKIP_ANTHROPIC_AWS_AUTH | string | Skip client-side SigV4 authentication for Claude Platform on AWS; use when a proxy or gateway adds authentication before forwarding. See https://code.claude.com/docs/en/claude-platform-on-aws#route-through-a-corporate-proxy one of: "0", "1" |
env.CLAUDE_CODE_SKIP_AWS_CRED_CACHE | string | Set to 1 to turn off the in-process cache of credentials resolved from the AWS default credential provider chain, so Claude Code resolves the chain on every API request. With the cache off, an SSO-backed profile requests credentials from one of: "0", "1" |
env.CLAUDE_CODE_SKIP_BEDROCK_AUTH | string | Skip AWS authentication for Bedrock one of: "0", "1" |
env.CLAUDE_CODE_SKIP_FAST_MODE_NETWORK_ERRORS | string | Set to 1 to treat a failed fast mode availability check as available, for networks that block the check's direct request to api.anthropic.com. Claude Code still honors a "disabled by your organization" response. See one of: "0", "1" |
env.CLAUDE_CODE_SKIP_FAST_MODE_ORG_CHECK | string | Set to 1 to skip the client-side fast mode availability check, for proxies that intercept the check's request rather than refuse it. The API still rejects fast mode requests when your organization has fast mode disabled. See one of: "0", "1" |
env.CLAUDE_CODE_SKIP_FOUNDRY_AUTH | string | Skip Azure authentication for Foundry one of: "0", "1" |
env.CLAUDE_CODE_SKIP_MANTLE_AUTH | string | Skip AWS authentication for Bedrock Mantle (for example, when using an LLM gateway). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_SKIP_PROMPT_HISTORY | string | Disable transcript writes entirely. See https://code.claude.com/docs/en/settings#environment-variables one of: "0", "1" |
env.CLAUDE_CODE_SKIP_VERTEX_AUTH | string | Skip Google authentication for Google Cloud's Agent Platform one of: "0", "1" |
env.CLAUDE_CODE_STOP_HOOK_BLOCK_CAP | string | Override the default maximum consecutive Stop hook blocks (default: 8) before the turn ends with a warning. Raise this when a stop hook legitimately needs more than 8 iterations to converge. See https://code.claude.com/docs/en/hooks-guide |
env.CLAUDE_CODE_SUBAGENT_MODEL | string | Override model used by subagents |
env.CLAUDE_CODE_SUBPROCESS_ENV_SCRUB | string | Strip credentials from subprocess environments one of: "0", "1" |
env.CLAUDE_CODE_SYNC_PLUGIN_INSTALL | string | Wait synchronously for plugin installation one of: "0", "1" |
env.CLAUDE_CODE_SYNC_PLUGIN_INSTALL_TIMEOUT_MS | string | Timeout in milliseconds for synchronous plugin installation |
env.CLAUDE_CODE_SYNC_SKILLS | string | Set to 1 to download enabled claude.ai skills into ~/.claude/skills/ before the first query and resync every 10 minutes (non-interactive -p mode only; requires claude.ai auth). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_SYNC_SKILLS_INSTALL_TIMEOUT_MS | string | Timeout in milliseconds for a mid-session skills resync when CLAUDE_CODE_SYNC_SKILLS is set (default 30000). See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_SYNC_SKILLS_WAIT_TIMEOUT_MS | string | Timeout in milliseconds for the first query to wait on the initial skills sync when CLAUDE_CODE_SYNC_SKILLS is set (default 5000). See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_CODE_SYNTAX_HIGHLIGHT | string | UNDOCUMENTED. Enable syntax highlighting in diffs one of: "true", "false" |
env.CLAUDE_CODE_TASK_LIST_ID | string | Shared task list identifier for team collaboration |
env.CLAUDE_CODE_TEAM_NAME | string | Agent team membership name |
env.CLAUDE_CODE_TEAM_TEARDOWN_PARK_TIMEOUT_MS | string | Override, in milliseconds, how long a non-interactive session waits at exit for its agent team to finish tearing down. Accepts 1000 to 60000; an out-of-range value is ignored and the default of 10000 applies. Requires Claude Code v2.1.206 |
env.CLAUDE_CODE_TMPDIR | string | Override temp directory path |
env.CLAUDE_CODE_TMUX_TRUECOLOR | string | Allow 24-bit truecolor rendering in tmux one of: "0", "1" |
env.CLAUDE_CODE_USE_ANTHROPIC_AWS | string | Enable Claude Platform on AWS as the API provider. Bedrock and Foundry take precedence if also set. See https://code.claude.com/docs/en/claude-platform-on-aws#2-configure-claude-code one of: "0", "1" |
env.CLAUDE_CODE_USE_BEDROCK | string | Enable Amazon Bedrock as the API provider. See https://code.claude.com/docs/en/amazon-bedrock#3-configure-claude-code one of: "0", "1" |
env.CLAUDE_CODE_USE_FOUNDRY | string | Enable Microsoft Foundry as the API provider. See https://code.claude.com/docs/en/microsoft-foundry#3-configure-claude-code one of: "0", "1" |
env.CLAUDE_CODE_USE_MANTLE | string | Enable the Mantle endpoint (native Anthropic API shape on Bedrock). See https://code.claude.com/docs/en/amazon-bedrock#enable-mantle one of: "0", "1" |
env.CLAUDE_CODE_USE_NATIVE_FILE_SEARCH | string | Set to 1 to discover custom commands, subagents, and output styles using Node.js file APIs instead of ripgrep (for environments where the bundled ripgrep is unavailable). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_CODE_USE_POWERSHELL_TOOL | string | Enable PowerShell as default shell for interactive commands (Windows) one of: "0", "1" |
env.CLAUDE_CODE_USE_VERTEX | string | Enable Google Cloud's Agent Platform as the API provider. See https://code.claude.com/docs/en/google-vertex-ai#4-configure-claude-code one of: "0", "1" |
env.CLAUDE_CONFIG_DIR | string | Override the configuration directory (default ~/.claude) where settings, credentials, session history, and plugins are stored. Useful for running multiple accounts side by side. See https://code.claude.com/docs/en/env-vars |
env.CLAUDE_DISABLE_ADOPT | string | Set to 1 to stop in-flight background work instead of carrying it over when you background a session by pressing ← or with /background. Claude Code asks you to confirm before backgrounding, then stops the tasks that would otherwise carry one of: "0", "1" |
env.CLAUDE_EFFORT | string | Set automatically in Bash tool subprocesses and hook commands to the active effort level for the turn (low, medium, high, xhigh, or max; ultracode reports as xhigh). Read-only. See https://code.claude.com/docs/en/env-vars one of: "low", "medium", "high", "xhigh", "max" |
env.CLAUDE_ENABLE_BYTE_WATCHDOG | string | Set to 1 to force-enable, or 0 to force-disable, the byte-level streaming idle watchdog that aborts a connection when no bytes arrive within the configured timeout. Enabled by default on direct Anthropic API and Claude Platform on AWS one of: "0", "1" |
env.CLAUDE_ENABLE_BYTE_WATCHDOG_BEDROCK | string | Set to 1 to enable the byte-level streaming idle watchdog on Amazon Bedrock eventstream responses (off by default). Configure the timeout with CLAUDE_STREAM_IDLE_TIMEOUT_MS. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.CLAUDE_ENABLE_STREAM_WATCHDOG | string | Set to 1 to force-enable, or 0 to force-disable, the event-level streaming idle watchdog. When unset, the watchdog is on by default for all providers (as of v2.1.196; before that the unset default was server-controlled on the direct one of: "0", "1" |
env.CLAUDE_ENV_FILE | string | File path for persisting environment variables across Bash commands |
env.CLAUDE_PID | string | Claude Code sets this to its own process ID in the subprocesses it spawns: Bash and PowerShell tool commands and hook commands. On Linux, the Bash tool's shell integration uses it to refuse a pkill pattern that would match the Claude Code |
env.CLAUDE_PROJECT_DIR | string | Project root directory path (also provided to hooks) |
env.CLAUDE_REMOTE_CONTROL_SESSION_NAME_PREFIX | string | Prefix for auto-generated Remote Control session names when no explicit name is set. Defaults to the machine hostname, producing names like myhost-graceful-unicorn. See |
env.CLAUDE_STREAM_IDLE_TIMEOUT_MS | string | Timeout in milliseconds before the streaming idle watchdog closes a stalled connection. When set explicitly the minimum is 300000 (5 minutes); lower values are clamped. See https://code.claude.com/docs/en/env-vars |
env.CLOUD_ML_REGION | string | Google Cloud's Agent Platform region: global, a multi-region location (eu, us), or a specific region (e.g. us-east5). See https://code.claude.com/docs/en/google-vertex-ai#region-configuration |
env.DEBUG | string | Set to a truthy value (1, true, yes, or on) to enable debug mode, equivalent to --debug. Logs are written to ~/.claude/debug/<session-id>.txt. See https://code.claude.com/docs/en/env-vars |
env.DISABLE_AUTOUPDATER | string | Set to 1 to disable automatic background updates. Manual claude update still works; use DISABLE_UPDATES to block both. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.DISABLE_AUTO_COMPACT | string | Set to 1 to disable automatic compaction when approaching the context limit. The manual /compact command remains available. Equivalent to autoCompactEnabled: false. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.DISABLE_COMPACT | string | Set to 1 to disable all compaction: both automatic compaction and the manual /compact command. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.DISABLE_COST_WARNINGS | string | Set to 1 to disable cost warning messages. See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
env.DISABLE_DOCTOR_COMMAND | string | Set to 1 to hide the /doctor command (useful for managed deployments). See https://code.claude.com/docs/en/env-vars one of: "0", "1" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Uses non-standard keywords that generic validators ignore:
annotations. - 741 properties, 100% carrying a description, max nesting depth 17.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
const | JSON Schema Validation, draft 2020-12 | §6.1.3 — "const" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
examples | JSON Schema Validation, draft 2020-12 | §9.5 — "examples" |
exclusiveMinimum | JSON Schema Validation, draft 2020-12 | §6.2.5 — "exclusiveMinimum" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
if | JSON Schema Core, draft 2020-12 | §10.2.2.1 — "if" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
maximum | JSON Schema Validation, draft 2020-12 | §6.2.2 — "maximum" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
minimum | JSON Schema Validation, draft 2020-12 | §6.2.4 — "minimum" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
uniqueItems | JSON Schema Validation, draft 2020-12 | §6.4.3 — "uniqueItems" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.