Skip to main content

Module config

Module config 

Source
Expand description

Configuration facade for vtcode-core.

This module re-exports the extracted vtcode-config crate so existing call sites continue to access configuration types and helpers through vtcode_core::config.

Re-exports§

pub use api::ConfigLayerView;
pub use api::ConfigReadRequest;
pub use api::ConfigReadResponse;
pub use api::ConfigService;
pub use api::ConfigWriteRequest;
pub use api::ConfigWriteResponse;
pub use api::ConfigWriteStrategy;
pub use api::ConfigWriteTarget;
pub use api::OverrideMetadata;
pub use validation::ValidationResult;
pub use validation::validate_config;
pub use validation::validate_model_exists;
pub use validator::ConfigValidator;

Modules§

acp
api
api_keys
constants
context
core
defaults
hooks
ide_context
loader
Re-export the shared configuration loader implementation from the vtcode-config crate so downstream consumers can continue importing it through vtcode_core::config::loader while the logic lives in the dedicated configuration crate.
mcp
models
Model configuration and identification module
output_styles
telemetry
types
validation
validator
Configuration validation utilities

Structs§

AgentClientProtocolConfig
Agent Client Protocol configuration root
AgentClientProtocolZedConfig
Zed-specific configuration
AgentClientProtocolZedToolsConfig
Zed bridge tool configuration flags
AgentConfig
Agent-wide configuration
AgentOnboardingConfig
AgentPromptSuggestionsConfig
Inline prompt suggestion configuration for the chat composer.
ApiKeySources
API key sources for different providers
AutoModeConfig
Classifier-backed auto mode configuration.
AutoModeEnvironmentConfig
Trust-boundary configuration for auto mode.
AutomationConfig
Automation-specific configuration toggles.
CommandsConfig
Command execution configuration
ConfigManager
Configuration manager for loading and validating configurations
ContextFeaturesConfig
ContextStoreDefaults
Context store defaults
EditorToolConfig
External editor integration configuration
FullAutoConfig
Controls for running the agent without interactive approvals.
GatekeeperConfig
Gatekeeper mitigation configuration (macOS only)
HistoryConfig
Codex-compatible history persistence settings.
HookCommandConfig
Configuration for a single shell command hook
HookGroupConfig
A group of hooks sharing a common execution matcher
HooksConfig
Top-level configuration for automation hooks and lifecycle events
IdeContextConfig
IdeContextProviderConfig
IdeContextProvidersConfig
KeyboardProtocolConfig
Kitty keyboard protocol configuration Reference: https://sw.kovidgoyal.net/kitty/keyboard-protocol/
LedgerConfig
LifecycleHooksConfig
Configuration for hooks triggered during distinct agent lifecycle events. Each event supports a list of groups with optional matchers.
McpAllowListConfig
Allow list configuration for MCP providers
McpAllowListRules
Allow list rules for a provider or default configuration
McpClientConfig
Top-level MCP configuration
McpHttpServerConfig
Configuration for HTTP-based MCP servers
McpProviderConfig
Configuration for a single MCP provider
McpStdioServerConfig
Configuration for stdio-based MCP servers
McpUiConfig
UI configuration for MCP display
ModelConfig
Model-specific behavior configuration
OpenRouterMetadata
PerformanceDefaults
Performance defaults
PermissionsConfig
Permission system configuration - Controls command resolution, audit logging, and caching
PersistentMemoryConfig
PluginRuntimeConfig
Runtime configuration for dynamic plugin loading.
PromptCachingConfig
Global prompt caching configuration loaded from vtcode.toml
ProviderPromptCachingConfig
Per-provider configuration overrides
PtyConfig
PTY configuration
ScenarioDefaults
Scenario defaults
ScheduledTasksConfig
Controls for the built-in scheduled task subsystem.
SecurityConfig
Security configuration
StatusLineConfig
SyntaxHighlightingConfig
Syntax highlighting configuration
SyntaxHighlightingDefaults
Shared defaults for syntax highlighting configuration.
TelemetryConfig
TerminalTitleConfig
TimeoutsConfig
ToolsConfig
Tools configuration
TuiConfig
Codex-compatible TUI settings.
UiConfig
VTCodeConfig
Main configuration structure for VT Code
WorkspacePathsDefaults
Adapter that maps an existing WorkspacePaths implementation into a ConfigDefaultsProvider.

Enums§

AgentClientProtocolTransport
Transport options supported by the ACP bridge
AgentClientProtocolZedWorkspaceTrustMode
Workspace trust configuration for the Zed ACP bridge
FileOpener
Editor URI scheme for clickable file citations.
HistoryPersistence
Local history persistence mode.
HookCommandKind
IdeContextProviderFamily
IdeContextProviderMode
LayoutModeOverride
Layout mode override for responsive UI
McpTransportConfig
Transport configuration for MCP providers
McpUiMode
UI mode for MCP event display
ModelId
Centralized enum for all supported model identifiers
NotificationCondition
When to deliver desktop notifications relative to terminal focus.
OpenAIPromptCacheKeyMode
OpenAI prompt cache key derivation mode.
PermissionMode
Unified permission mode for authored policy evaluation.
PluginTrustLevel
Trust model for third-party plugins.
ReasoningDisplayMode
ReasoningEffortLevel
Supported reasoning effort levels configured via vtcode.toml These map to different provider-specific parameters:
StatusLineMode
SystemPromptMode
System prompt mode (inspired by pi-coding-agent philosophy) Controls verbosity and complexity of system prompts sent to models
TerminalNotificationMethod
Built-in TUI notification delivery method.
ToolDocumentationMode
Tool documentation mode (inspired by pi-coding-agent progressive disclosure) Controls how much tool documentation is loaded upfront vs on-demand
ToolOutputMode
ToolPolicy
Tool execution policy
TuiAlternateScreen
Alternate-screen preference for the TUI.
TuiNotificationEvent
TUI notification filters compatible with Codex config.
TuiNotificationsConfig
Accept either true/false or an allowlist of event names.
UiDisplayMode
UI display mode variants for quick presets
UiSurfacePreference
Preferred rendering surface for the interactive chat UI
VerbosityLevel
Verbosity level for model output (GPT-5.4-family and compatible models)
WorkspaceTrustLevel
Workspace trust levels exposed through the Agent Client Protocol configuration.

Constants§

DEFAULT_TERMINAL_TITLE_ITEMS

Traits§

ConfigDefaultsProvider
Provides access to filesystem and syntax defaults used by the configuration loader.

Functions§

build_openai_prompt_cache_key
Build a stable OpenAI prompt_cache_key for requests that should share provider-side cache routing.
current_config_defaults
Returns the currently installed provider as an Arc.
get_config_dir
Get the XDG-compliant configuration directory for vtcode.
get_data_dir
Get the XDG-compliant data directory for vtcode.
install_config_defaults_provider
Installs a new ConfigDefaultsProvider, returning the previous provider.
keyboard_protocol_to_flags
Convert KeyboardProtocolConfig to KeyboardEnhancementFlags.
reset_to_default_config_defaults
Restores the built-in defaults provider.
resolve_timeout
Resolve a user-supplied timeout into a bounded, non-zero value.
tool_call_delay_for_rate
tool_loop_limit_reached
with_config_defaults
Executes the provided function with the currently installed provider.