Skip to main content

OpenCodeConfig

Struct OpenCodeConfig 

Source
pub struct OpenCodeConfig {
Show 26 fields pub schema: Option<String>, pub log_level: Option<LogLevel>, pub server: Option<ServerConfig>, pub command: Option<HashMap<String, CommandConfig>>, pub skills: Option<SkillsConfig>, pub watcher: Option<WatcherConfig>, pub snapshot: Option<bool>, pub plugin: Option<Vec<PluginEntry>>, pub share: Option<ShareMode>, pub autoupdate: Option<AutoupdateConfig>, pub disabled_providers: Option<Vec<String>>, pub enabled_providers: Option<Vec<String>>, pub model: Option<String>, pub small_model: Option<String>, pub default_agent: Option<String>, pub username: Option<String>, pub agent: Option<HashMap<String, AgentConfig>>, pub provider: Option<HashMap<String, ProviderConfig>>, pub mcp: Option<HashMap<String, McpConfig>>, pub permission: Option<PermissionConfig>, pub formatter: Option<HashMap<String, FormatterConfig>>, pub instructions: Option<Vec<String>>, pub compaction: Option<CompactionConfig>, pub experimental: Option<Value>, pub tools: Option<HashMap<String, bool>>, pub extra: HashMap<String, Value>,
}
Expand description

Root configuration for opencode.json.

All fields are optional to support partial configs from different layers (global, project, custom) that are merged together.

Fields§

§schema: Option<String>

JSON schema reference for validation.

§log_level: Option<LogLevel>

Log level.

§server: Option<ServerConfig>

Server configuration.

§command: Option<HashMap<String, CommandConfig>>

Custom commands.

§skills: Option<SkillsConfig>

Additional skill folder paths.

§watcher: Option<WatcherConfig>

File watcher ignore patterns.

§snapshot: Option<bool>

Enable or disable snapshot tracking.

§plugin: Option<Vec<PluginEntry>>

Plugin list.

§share: Option<ShareMode>

Sharing behavior.

§autoupdate: Option<AutoupdateConfig>

Auto-update behavior.

§disabled_providers: Option<Vec<String>>

Disabled provider IDs.

§enabled_providers: Option<Vec<String>>

Enabled provider IDs (allowlist).

§model: Option<String>

Default model in provider/model format.

§small_model: Option<String>

Small model for lightweight tasks.

§default_agent: Option<String>

Default agent.

§username: Option<String>

Custom username.

§agent: Option<HashMap<String, AgentConfig>>

Agent configurations.

§provider: Option<HashMap<String, ProviderConfig>>

Provider configurations.

§mcp: Option<HashMap<String, McpConfig>>

MCP server configurations.

§permission: Option<PermissionConfig>

Tool permissions.

§formatter: Option<HashMap<String, FormatterConfig>>

Formatter configurations.

§instructions: Option<Vec<String>>

Instruction file paths/globs.

§compaction: Option<CompactionConfig>

Compaction settings.

§experimental: Option<Value>

Experimental features.

§tools: Option<HashMap<String, bool>>

Tool enable/disable overrides.

§extra: HashMap<String, Value>

Catch-all for fields not explicitly modeled above. Prevents data loss when reading configs with fields our schema doesn’t cover yet (e.g., new OpenCode features).

Trait Implementations§

Source§

impl Clone for OpenCodeConfig

Source§

fn clone(&self) -> OpenCodeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenCodeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OpenCodeConfig

Source§

fn default() -> OpenCodeConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OpenCodeConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OpenCodeConfig

Source§

fn eq(&self, other: &OpenCodeConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for OpenCodeConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OpenCodeConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,