ConfigToml

agcodex_core::config

Struct ConfigToml 

Source 
pub struct ConfigToml {
Show 30 fields
    pub model: Option<String>,
    pub model_provider: Option<String>,
    pub model_context_window: Option<u64>,
    pub model_max_output_tokens: Option<u64>,
    pub approval_policy: Option<AskForApproval>,
    pub shell_environment_policy: ShellEnvironmentPolicyToml,
    pub sandbox_mode: Option<SandboxMode>,
    pub sandbox_workspace_write: Option<SandboxWorkspaceWrite>,
    pub disable_response_storage: Option<bool>,
    pub notify: Option<Vec<String>>,
    pub instructions: Option<String>,
    pub mcp_servers: HashMap<String, McpServerConfig>,
    pub model_providers: HashMap<String, ModelProviderInfo>,
    pub project_doc_max_bytes: Option<usize>,
    pub profile: Option<String>,
    pub profiles: HashMap<String, ConfigProfile>,
    pub history: Option<History>,
    pub file_opener: Option<UriBasedFileOpener>,
    pub tui: Option<Tui>,
    pub hide_agent_reasoning: Option<bool>,
    pub show_raw_agent_reasoning: Option<bool>,
    pub model_reasoning_effort: Option<ReasoningEffort>,
    pub model_reasoning_summary: Option<ReasoningSummary>,
    pub model_supports_reasoning_summaries: Option<bool>,
    pub chatgpt_base_url: Option<String>,
    pub experimental_resume: Option<PathBuf>,
    pub experimental_instructions_file: Option<PathBuf>,
    pub responses_originator_header_internal_override: Option<String>,
    pub projects: Option<HashMap<String, ProjectConfig>>,
    pub preferred_auth_method: Option<AuthMode>,

}
Expand description

Base config deserialized from ~/.agcodex/config.toml.

Fields§

§model: Option<String>

Optional override of model selection.

§model_provider: Option<String>

Provider to use from the model_providers map.

§model_context_window: Option<u64>

Size of the context window for the model, in tokens.

§model_max_output_tokens: Option<u64>

Maximum number of output tokens.

§approval_policy: Option<AskForApproval>

Default approval policy for executing commands.

§shell_environment_policy: ShellEnvironmentPolicyToml§sandbox_mode: Option<SandboxMode>

Sandbox mode to use.

§sandbox_workspace_write: Option<SandboxWorkspaceWrite>

Sandbox configuration to apply if sandbox is WorkspaceWrite.

§disable_response_storage: Option<bool>

Disable server-side response storage (sends the full conversation context with every request). Currently necessary for OpenAI customers who have opted into Zero Data Retention (ZDR).

§notify: Option<Vec<String>>

Optional external command to spawn for end-user notifications.

§instructions: Option<String>

System instructions.

§mcp_servers: HashMap<String, McpServerConfig>

Definition for MCP servers that Codex can reach out to for tool calls.

§model_providers: HashMap<String, ModelProviderInfo>

User-defined provider entries that extend/override the built-in list.

§project_doc_max_bytes: Option<usize>

Maximum number of bytes to include from an AGENTS.md project doc file.

§profile: Option<String>

Profile to use from the profiles map.

§profiles: HashMap<String, ConfigProfile>

Named profiles to facilitate switching between different configurations.

§history: Option<History>

Settings that govern if and what will be written to ~/.agcodex/history.jsonl.

§file_opener: Option<UriBasedFileOpener>

Optional URI-based file opener. If set, citations to files in the model output will be hyperlinked using the specified URI scheme.

§tui: Option<Tui>

Collection of settings that are specific to the TUI.

§hide_agent_reasoning: Option<bool>

When set to true, AgentReasoning events will be hidden from the UI/output. Defaults to false.

§show_raw_agent_reasoning: Option<bool>

When set to true, AgentReasoningRawContentEvent events will be shown in the UI/output. Defaults to false.

§model_reasoning_effort: Option<ReasoningEffort>§model_reasoning_summary: Option<ReasoningSummary>§model_supports_reasoning_summaries: Option<bool>

Override to force-enable reasoning summaries for the configured model.

§chatgpt_base_url: Option<String>

Base URL for requests to ChatGPT (as opposed to the OpenAI API).

§experimental_resume: Option<PathBuf>

Experimental rollout resume path (absolute path to .jsonl; undocumented).

§experimental_instructions_file: Option<PathBuf>

Experimental path to a file whose contents replace the built-in BASE_INSTRUCTIONS.

§responses_originator_header_internal_override: Option<String>

The value for the originator header included with Responses API requests.

§projects: Option<HashMap<String, ProjectConfig>>§preferred_auth_method: Option<AuthMode>

If set to true, the API key will be signed with the originator header.

Implementations§

Source§

impl ConfigToml

Source

pub fn is_cwd_trusted(&self, resolved_cwd: &Path) -> bool

Source

pub fn get_config_profile( &self, override_profile: Option<String>, ) -> Result<ConfigProfile, Error>

Trait Implementations§

Source§

impl Clone for ConfigToml

Source§

fn clone(&self) -> ConfigToml

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 ConfigToml

Source§

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

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

impl Default for ConfigToml

Source§

fn default() -> ConfigToml

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

impl<'de> Deserialize<'de> for ConfigToml

Source§

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

Deserialize this value from the given Serde deserializer. Read more

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Fruit for T
where T: Send + Downcast,