Struct VTCodeConfig 

pub struct VTCodeConfig {

    pub default_primary_agent: String,
    pub features: FeaturesConfig,
    pub file_opener: FileOpener,
    pub notify: Vec<String>,
    pub history: HistoryConfig,
    pub tui: TuiConfig,
    pub agent: AgentConfig,
    pub auth: AuthConfig,
    pub tools: ToolsConfig,
    pub commands: CommandsConfig,
    pub permissions: PermissionsConfig,
    pub runtime_agent_permissions: Option<AgentPermissionsConfig>,
    pub workspace_lifecycle_hooks: Option<WorkspaceLifecycleHooks>,
    pub security: SecurityConfig,
    pub sandbox: SandboxConfig,
    pub ui: UiConfig,
    pub chat: ChatConfig,
    pub pty: PtyConfig,
    pub debug: DebugConfig,
    pub context: ContextFeaturesConfig,
    pub telemetry: TelemetryConfig,
    pub optimization: OptimizationConfig,
    pub syntax_highlighting: SyntaxHighlightingConfig,
    pub timeouts: TimeoutsConfig,
    pub automation: AutomationConfig,
    pub subagents: SubagentRuntimeLimits,
    pub prompt_cache: PromptCachingConfig,
    pub mcp: McpClientConfig,
    pub webmcp: WebmcpConfig,
    pub acp: AgentClientProtocolConfig,
    pub hooks: HooksConfig,
    pub model: ModelConfig,
    pub provider: ProviderConfig,
    pub skills: SkillsConfig,
    pub custom_providers: Vec<CustomProviderConfig>,
    pub provider_overrides: BTreeMap<String, ProviderOverrideConfig>,
    pub providers_whitelist: Vec<String>,
    pub output_style: OutputStyleConfig,
    pub dotfile_protection: DotfileProtectionConfig,
    pub workspace: WorkspaceConfig,
}

Main configuration structure for VT Code

Fields

default_primary_agent: String

Primary agent selected at startup when no session override is active.

features: FeaturesConfig

Codex-compatible top-level feature flags ([features] table).

file_opener: FileOpener

Codex-compatible clickable citation URI scheme.

notify: Vec<String>

External notification command invoked for supported events.

history: HistoryConfig

Codex-compatible local history persistence controls.

tui: TuiConfig

Codex-compatible TUI settings.

agent: AgentConfig

Agent-wide settings

auth: AuthConfig

Authentication configuration for OAuth flows

tools: ToolsConfig

Tool execution policies

commands: CommandsConfig

Unix command permissions

permissions: PermissionsConfig

Permission system settings (resolution, audit logging, caching)

runtime_agent_permissions: Option<AgentPermissionsConfig>

Runtime-only agent permission policy supplied by derived child agents.

workspace_lifecycle_hooks: Option<WorkspaceLifecycleHooks>

Runtime-only snapshot of lifecycle hook commands sourced from workspace-controlled configuration layers, populated by ConfigManager at load time. Workspace-controlled hooks require explicit user approval before execution; see WorkspaceLifecycleHooks.

security: SecurityConfig

Security settings

sandbox: SandboxConfig

Sandbox settings for command execution isolation

ui: UiConfig

UI settings

chat: ChatConfig

Chat settings

pty: PtyConfig

PTY settings

debug: DebugConfig

Debug and tracing settings

context: ContextFeaturesConfig

Context features (e.g., Decision Ledger)

telemetry: TelemetryConfig

Telemetry configuration (logging, trajectory)

optimization: OptimizationConfig

Performance optimization settings

syntax_highlighting: SyntaxHighlightingConfig

Syntax highlighting configuration

timeouts: TimeoutsConfig

Timeout ceilings and UI warning thresholds

automation: AutomationConfig

Automation configuration

subagents: SubagentRuntimeLimits

Subagent runtime configuration

prompt_cache: PromptCachingConfig

Prompt cache configuration (local + provider integration)

mcp: McpClientConfig

Model Context Protocol configuration

webmcp: WebmcpConfig

Authenticated browser editor bridge configuration

acp: AgentClientProtocolConfig

Agent Client Protocol configuration

hooks: HooksConfig

Lifecycle hooks configuration

model: ModelConfig

Model-specific behavior configuration

provider: ProviderConfig

Provider-specific configuration

skills: SkillsConfig

Skills system configuration (Agent Skills spec)

custom_providers: Vec<CustomProviderConfig>

Extra OpenAI-compatible endpoints for the model picker. Define in user or system config only.

provider_overrides: BTreeMap<String, ProviderOverrideConfig>

Built-in provider overrides for model lists and endpoint configuration.

Maps provider key (e.g., “opencode-zen”, “opencode-go”) to override config that extends the provider’s hardcoded model list with custom models, and optionally overrides the base URL or API key env var.

providers_whitelist: Vec<String>

Restrict which providers may be used.

When non-empty, only providers listed here are visible in the model picker, selectable at first-run, and instantiable at runtime. Empty (the default) means all built-in and custom providers are available.

output_style: OutputStyleConfig

Output style configuration

dotfile_protection: DotfileProtectionConfig

Dotfile protection configuration

workspace: WorkspaceConfig

Workspace-level configuration controls

Implementations

impl VTCodeConfig

pub fn bootstrap_project<P>( workspace: P, force: bool, ) -> Result<Vec<String>, Error>

where P: AsRef<Path>,

Bootstrap project with config + gitignore

pub fn bootstrap_project_with_options<P>( workspace: P, force: bool, use_home_dir: bool, ) -> Result<Vec<String>, Error>

where P: AsRef<Path>,

Bootstrap project with config + gitignore, with option to create in home directory

pub fn create_sample_config<P>(output: P) -> Result<(), Error>

where P: AsRef<Path>,

Create sample configuration file

impl VTCodeConfig

pub fn validate(&self) -> Result<(), Error>

pub fn persistent_memory_enabled(&self) -> bool

Returns true when the persistent memory subsystem is enabled.

The top-level features.memories flag is the global master switch. agent.persistent_memory.enabled then enables repository-scoped storage.

pub fn memories_enabled(&self) -> bool

Returns true when the memories subsystem is enabled for injection.

Memories are active when the subsystem is enabled and memories.use_memories is true.

pub fn should_generate_memories(&self) -> bool

Returns true when completed threads should be stored as memory inputs.

pub fn custom_provider(&self, name: &str) -> Option<&CustomProviderConfig>

Look up a custom provider by its stable key.

pub fn configured_api_key_env(&self, name: &str) -> Option<String>

Return the explicitly configured credential key for a provider.

Custom-provider identities take precedence over built-in provider overrides. A missing result means callers should use the provider’s built-in default or the agent-wide fallback.

pub fn provider_display_name(&self, provider_key: &str) -> String

Get the display name for any provider key, falling back to the raw key if no custom provider matches.

Trait Implementations

impl Clone for VTCodeConfig

fn clone(&self) -> VTCodeConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VTCodeConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for VTCodeConfig

fn default() -> VTCodeConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VTCodeConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<VTCodeConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for VTCodeConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for VTCodeConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.