Struct ClaudeSettings 

pub struct ClaudeSettings {

    pub env: Option<HashMap<String, String>>,
    pub model: Option<String>,
    pub output_style: Option<String>,
    pub include_co_authored_by: Option<bool>,
    pub permissions: Option<Permissions>,
    pub hooks: Option<Hooks>,
    pub api_key_helper: Option<String>,
    pub cleanup_period_days: Option<u32>,
    pub disable_all_hooks: Option<bool>,
    pub force_login_method: Option<String>,
    pub force_login_org_uuid: Option<String>,
    pub enable_all_project_mcp_servers: Option<bool>,
    pub enabled_mcpjson_servers: Option<Vec<String>>,
    pub disabled_mcpjson_servers: Option<Vec<String>>,
    pub aws_auth_refresh: Option<String>,
    pub aws_credential_export: Option<String>,
    pub status_line: Option<StatusLine>,
    pub subagent_model: Option<String>,
}

Main Claude Code settings structure

Fields

env: Option<HashMap<String, String>>

model: Option<String>

output_style: Option<String>

include_co_authored_by: Option<bool>

permissions: Option<Permissions>

hooks: Option<Hooks>

api_key_helper: Option<String>

cleanup_period_days: Option<u32>

disable_all_hooks: Option<bool>

force_login_method: Option<String>

force_login_org_uuid: Option<String>

enable_all_project_mcp_servers: Option<bool>

enabled_mcpjson_servers: Option<Vec<String>>

disabled_mcpjson_servers: Option<Vec<String>>

aws_auth_refresh: Option<String>

aws_credential_export: Option<String>

status_line: Option<StatusLine>

subagent_model: Option<String>

Implementations

impl ClaudeSettings

pub fn new() -> Self

Create empty settings

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Read settings from file

pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Write settings to file

pub fn capture_environment() -> HashMap<String, String>

Capture environment variables relevant to Claude Code

pub fn capture_template_environment( template_type: &TemplateType, ) -> HashMap<String, String>

Capture environment variables for a specific template type

pub fn mask_api_keys(&self) -> Self

Mask API keys in settings for display

pub fn get_api_key(&self) -> Option<String>

Get API key from settings or environment

impl ClaudeSettings

pub fn get_environment(&self) -> Option<&HashMap<String, String>>

Get environment variables (backward compatibility)

pub fn set_environment(&mut self, env: HashMap<String, String>)

Set environment variables (backward compatibility)

impl ClaudeSettings

pub fn environment(&self) -> Option<&HashMap<String, String>>

Backward compatibility property for environment

Trait Implementations

impl Clone for ClaudeSettings

fn clone(&self) -> ClaudeSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for ClaudeSettings

fn merge_with(self, other: Self) -> Self

Merge this configuration with another, with priority given to self

fn filter_by_scope(self, scope: &SnapshotScope) -> Self

Filter settings by the specified scope

fn mask_sensitive_data(self) -> Self

Mask sensitive data for display purposes

impl Debug for ClaudeSettings

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

Formats the value using the given formatter.

impl Default for ClaudeSettings

fn default() -> ClaudeSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClaudeSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClaudeSettings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ClaudeSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClaudeSettings