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-configcrate so downstream consumers can continue importing it throughvtcode_core::config::loaderwhile 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§
- Agent
Client Protocol Config - Agent Client Protocol configuration root
- Agent
Client Protocol ZedConfig - Zed-specific configuration
- Agent
Client Protocol ZedTools Config - Zed bridge tool configuration flags
- Agent
Config - Agent-wide configuration
- Agent
Onboarding Config - Agent
Prompt Suggestions Config - Inline prompt suggestion configuration for the chat composer.
- ApiKey
Sources - API key sources for different providers
- Auto
Mode Config - Classifier-backed auto mode configuration.
- Auto
Mode Environment Config - Trust-boundary configuration for auto mode.
- Automation
Config - Automation-specific configuration toggles.
- Commands
Config - Command execution configuration
- Config
Manager - Configuration manager for loading and validating configurations
- Context
Features Config - Context
Store Defaults - Context store defaults
- Editor
Tool Config - External editor integration configuration
- Full
Auto Config - Controls for running the agent without interactive approvals.
- Gatekeeper
Config - Gatekeeper mitigation configuration (macOS only)
- History
Config - Codex-compatible history persistence settings.
- Hook
Command Config - Configuration for a single shell command hook
- Hook
Group Config - A group of hooks sharing a common execution matcher
- Hooks
Config - Top-level configuration for automation hooks and lifecycle events
- IdeContext
Config - IdeContext
Provider Config - IdeContext
Providers Config - Keyboard
Protocol Config - Kitty keyboard protocol configuration Reference: https://sw.kovidgoyal.net/kitty/keyboard-protocol/
- Ledger
Config - Lifecycle
Hooks Config - Configuration for hooks triggered during distinct agent lifecycle events. Each event supports a list of groups with optional matchers.
- McpAllow
List Config - Allow list configuration for MCP providers
- McpAllow
List Rules - Allow list rules for a provider or default configuration
- McpClient
Config - Top-level MCP configuration
- McpHttp
Server Config - Configuration for HTTP-based MCP servers
- McpProvider
Config - Configuration for a single MCP provider
- McpStdio
Server Config - Configuration for stdio-based MCP servers
- McpUi
Config - UI configuration for MCP display
- Model
Config - Model-specific behavior configuration
- Open
Router Metadata - Performance
Defaults - Performance defaults
- Permissions
Config - Permission system configuration - Controls command resolution, audit logging, and caching
- Persistent
Memory Config - Plugin
Runtime Config - Runtime configuration for dynamic plugin loading.
- Prompt
Caching Config - Global prompt caching configuration loaded from vtcode.toml
- Provider
Prompt Caching Config - Per-provider configuration overrides
- PtyConfig
- PTY configuration
- Scenario
Defaults - Scenario defaults
- Scheduled
Tasks Config - Controls for the built-in scheduled task subsystem.
- Security
Config - Security configuration
- Status
Line Config - Syntax
Highlighting Config - Syntax highlighting configuration
- Syntax
Highlighting Defaults - Shared defaults for syntax highlighting configuration.
- Telemetry
Config - Terminal
Title Config - Timeouts
Config - Tools
Config - Tools configuration
- TuiConfig
- Codex-compatible TUI settings.
- UiConfig
- VTCode
Config - Main configuration structure for VT Code
- Workspace
Paths Defaults - Adapter that maps an existing
WorkspacePathsimplementation into aConfigDefaultsProvider.
Enums§
- Agent
Client Protocol Transport - Transport options supported by the ACP bridge
- Agent
Client Protocol ZedWorkspace Trust Mode - Workspace trust configuration for the Zed ACP bridge
- File
Opener - Editor URI scheme for clickable file citations.
- History
Persistence - Local history persistence mode.
- Hook
Command Kind - IdeContext
Provider Family - IdeContext
Provider Mode - Layout
Mode Override - Layout mode override for responsive UI
- McpTransport
Config - Transport configuration for MCP providers
- McpUi
Mode - UI mode for MCP event display
- ModelId
- Centralized enum for all supported model identifiers
- Notification
Condition - When to deliver desktop notifications relative to terminal focus.
- OpenAI
Prompt Cache KeyMode - OpenAI prompt cache key derivation mode.
- Permission
Mode - Unified permission mode for authored policy evaluation.
- Plugin
Trust Level - Trust model for third-party plugins.
- Reasoning
Display Mode - Reasoning
Effort Level - Supported reasoning effort levels configured via vtcode.toml These map to different provider-specific parameters:
- Status
Line Mode - System
Prompt Mode - System prompt mode (inspired by pi-coding-agent philosophy) Controls verbosity and complexity of system prompts sent to models
- Terminal
Notification Method - Built-in TUI notification delivery method.
- Tool
Documentation Mode - Tool documentation mode (inspired by pi-coding-agent progressive disclosure) Controls how much tool documentation is loaded upfront vs on-demand
- Tool
Output Mode - Tool
Policy - Tool execution policy
- TuiAlternate
Screen - Alternate-screen preference for the TUI.
- TuiNotification
Event - TUI notification filters compatible with Codex config.
- TuiNotifications
Config - Accept either
true/falseor an allowlist of event names. - UiDisplay
Mode - UI display mode variants for quick presets
- UiSurface
Preference - Preferred rendering surface for the interactive chat UI
- Verbosity
Level - Verbosity level for model output (GPT-5.4-family and compatible models)
- Workspace
Trust Level - Workspace trust levels exposed through the Agent Client Protocol configuration.
Constants§
Traits§
- Config
Defaults Provider - Provides access to filesystem and syntax defaults used by the configuration loader.
Functions§
- build_
openai_ prompt_ cache_ key - Build a stable OpenAI
prompt_cache_keyfor 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.