Skip to main content

vtcode_config/
lib.rs

1//! Shared configuration loader utilities for VT Code and downstream integrations.
2//!
3//! This crate exposes [`VTCodeConfig`] and [`ConfigManager`] for reading and
4//! validating `vtcode.toml` files while allowing applications to customize the
5//! filesystem layout via [`ConfigDefaultsProvider`]. Consumers can opt into the
6//! [`bootstrap`](index.html#features) feature (enabled by default) to scaffold
7//! configuration directories with project-specific defaults.
8//! Disable default features when you only need parsing/validation to omit the
9//! filesystem bootstrap helpers and reduce dependencies.
10//!
11//! # Examples
12//! ```no_run
13//! use vtcode_config::ConfigManager;
14//!
15//! # fn main() -> anyhow::Result<()> {
16//! let manager = ConfigManager::load_from_workspace(".")?;
17//! println!("Active provider: {}", manager.config().agent.provider);
18//! # Ok(())
19//! # }
20//! ```
21//!
22//! Install a custom [`ConfigDefaultsProvider`] with
23//! [`install_config_defaults_provider`] when you need to override search paths
24//! or syntax highlighting defaults exposed by the loader.
25
26pub mod acp;
27pub mod api_keys;
28pub mod auth;
29pub mod codex;
30pub mod constants;
31pub mod context;
32pub mod core;
33pub mod debug;
34pub mod defaults;
35pub mod hooks;
36pub mod ide_context;
37pub mod loader;
38pub mod mcp;
39pub mod models;
40pub mod optimization;
41pub mod output_styles;
42pub mod root;
43#[cfg(feature = "schema")]
44pub mod schema;
45pub mod status_line;
46pub mod telemetry;
47pub mod timeouts;
48pub mod types;
49pub mod update;
50pub mod workspace_env;
51
52pub use acp::{
53    AgentClientProtocolConfig, AgentClientProtocolTransport, AgentClientProtocolZedConfig,
54    AgentClientProtocolZedToolsConfig, AgentClientProtocolZedWorkspaceTrustMode,
55    WorkspaceTrustLevel,
56};
57pub use api_keys::ApiKeySources;
58pub use context::{ContextFeaturesConfig, DynamicContextConfig, LedgerConfig};
59pub use core::{
60    AgentConfig, AgentOnboardingConfig, AuthConfig, AutomationConfig, BundledSkillsConfig,
61    CommandsConfig, CopilotAuthConfig, DockerSandboxConfig, EditorToolConfig,
62    ExternalSandboxConfig, ExternalSandboxType, FullAutoConfig, GatekeeperConfig,
63    MicroVMSandboxConfig, ModelConfig, NetworkAllowlistEntryConfig, NetworkConfig,
64    OpenAIAuthConfig, OpenAIConfig, OpenAIHostedShellConfig, OpenAIHostedShellEnvironment,
65    OpenAIHostedSkill, OpenAIPreferredMethod, OpenAIServiceTier, OpenResponsesConfig,
66    OpenRouterAuthConfig, PluginRuntimeConfig, PluginTrustLevel, PromptCachingConfig,
67    ProviderPromptCachingConfig, ResourceLimitsConfig, ResourceLimitsPreset, SandboxConfig,
68    SandboxMode, SeccompConfig, SeccompProfilePreset, SecurityConfig, SensitivePathsConfig,
69    SkillsConfig, SkillsRenderMode, ToolPolicy, ToolsConfig, WebFetchConfig,
70};
71pub use debug::{DebugConfig, TraceLevel};
72pub use defaults::{
73    ConfigDefaultsProvider, ContextStoreDefaults, PerformanceDefaults, ScenarioDefaults,
74    SyntaxHighlightingDefaults, WorkspacePathsDefaults, current_config_defaults, get_config_dir,
75    get_data_dir, install_config_defaults_provider, reset_to_default_config_defaults,
76    with_config_defaults,
77};
78pub use hooks::{
79    HookCommandConfig, HookCommandKind, HookGroupConfig, HooksConfig, LifecycleHooksConfig,
80};
81pub use ide_context::{
82    IdeContextConfig, IdeContextProviderConfig, IdeContextProviderFamily, IdeContextProviderMode,
83    IdeContextProvidersConfig,
84};
85pub use loader::layers::{
86    ConfigLayerEntry, ConfigLayerLoadError, ConfigLayerMetadata, ConfigLayerSource,
87    ConfigLayerStack, LayerDisabledReason,
88};
89pub use loader::{
90    ConfigBuilder, ConfigManager, ConfigWatcher, SimpleConfigWatcher, SyntaxHighlightingConfig,
91    VTCodeConfig, fingerprint_str, fingerprint_toml_value, merge_toml_values,
92    merge_toml_values_with_origins,
93};
94pub use mcp::{
95    McpAllowListConfig, McpAllowListRules, McpClientConfig, McpHttpServerConfig, McpProviderConfig,
96    McpStdioServerConfig, McpTransportConfig, McpUiConfig, McpUiMode,
97};
98pub use models::{ModelId, OpenRouterMetadata};
99pub use optimization::{
100    AgentExecutionConfig, AsyncPipelineConfig, CommandCacheConfig, FileReadCacheConfig,
101    LLMClientConfig, MemoryPoolConfig, OptimizationConfig, ProfilingConfig, ToolRegistryConfig,
102};
103pub use output_styles::{OutputStyle, OutputStyleConfig, OutputStyleManager};
104pub use root::{
105    AskQuestionsConfig, ChatConfig, LayoutModeOverride, NotificationDeliveryMode, PtyConfig,
106    ReasoningDisplayMode, ToolOutputMode, UiConfig, UiDisplayMode, UiNotificationsConfig,
107};
108#[cfg(feature = "schema")]
109pub use schema::{vtcode_config_schema, vtcode_config_schema_json, vtcode_config_schema_pretty};
110pub use status_line::{StatusLineConfig, StatusLineMode};
111pub use telemetry::TelemetryConfig;
112pub use timeouts::{TimeoutsConfig, resolve_timeout};
113pub use types::{
114    EditingMode, ReasoningEffortLevel, SystemPromptMode, ToolDocumentationMode,
115    UiSurfacePreference, VerbosityLevel,
116};
117pub use workspace_env::{read_workspace_env_value, write_workspace_env_value};
118
119// Re-export auth module types
120pub use auth::{
121    AuthStatus, CopilotAuthConfig as AuthCopilotConfig, OpenAIChatGptAuthHandle,
122    OpenAIChatGptAuthStatus, OpenAIChatGptSession, OpenRouterOAuthConfig, OpenRouterToken,
123    PkceChallenge, clear_oauth_token, clear_openai_chatgpt_session, generate_pkce_challenge,
124    get_auth_status, get_auth_url, get_openai_chatgpt_auth_status, get_openai_chatgpt_auth_url,
125    load_oauth_token, load_openai_chatgpt_session, resolve_openai_auth, save_oauth_token,
126    save_openai_chatgpt_session,
127};
128pub use codex::{
129    FileOpener, HistoryConfig, HistoryPersistence, TerminalNotificationMethod, TuiAlternateScreen,
130    TuiConfig, TuiNotificationEvent, TuiNotificationsConfig,
131};