Struct Settings 

pub struct Settings {

    pub default_provider: Option<String>,
    pub default_model: Option<String>,
    pub default_thinking_level: Option<String>,
    pub transport: Transport,
    pub hide_thinking_block: bool,
    pub theme: Option<String>,
    pub quiet_startup: bool,
    pub desktop_notifications: bool,
    pub self_update_command: Option<Vec<String>>,
    pub default_project_trust: ProjectTrustDefault,
    pub compaction: CompactionSettings,
    pub experimental_context_file: bool,
    pub reasoning_effort: ReasoningEffortSettings,
    pub retry: RetrySettings,
    pub cache_warming: CacheWarmingMode,
    pub subagents: SubagentSettings,
    pub advisor_model: Option<String>,
    pub advisor_max_uses: Option<u32>,
    pub workflows: WorkflowSettings,
    pub steering_mode: QueueMode,
    pub follow_up_mode: QueueMode,
    pub shell_path: Option<String>,
    pub shell_command_prefix: Option<String>,
    pub session_dir: Option<String>,
    pub session_share_destination: SessionShareDestination,
    pub enabled_models: Option<Vec<String>>,
    pub default_tools: Option<Vec<String>>,
    pub external_editor: Option<String>,
    pub skills: Vec<String>,
    pub prompts: Vec<String>,
    pub themes: Vec<String>,
    pub enable_skill_commands: Option<bool>,
    pub auto_recap: Option<bool>,
    pub voice_language: Option<String>,
    pub voice_backend: Option<String>,
    pub markdown: MarkdownSettings,
    pub webmcp: WebMcpSettings,
    pub status_line: Option<StatusLineSettings>,
    pub extra: Map<String, Value>,
    /* private fields */
}

Fields

default_provider: Option<String>

default_model: Option<String>

default_thinking_level: Option<String>

transport: Transport

hide_thinking_block: bool

theme: Option<String>

quiet_startup: bool

desktop_notifications: bool

User-only opt-in for interactive prompt-completion desktop notifications.

self_update_command: Option<Vec<String>>

User-only argv that kiss update runs instead of the KISS installer.

default_project_trust: ProjectTrustDefault

compaction: CompactionSettings

experimental_context_file: bool

Let the model edit its live conversation through a private JSON file.

reasoning_effort: ReasoningEffortSettings

retry: RetrySettings

cache_warming: CacheWarmingMode

subagents: SubagentSettings

advisor_model: Option<String>

provider/model[:thinking] the advisor tool asks. User settings only.

advisor_max_uses: Option<u32>

Advisor calls allowed per user prompt (default 3). User settings only.

workflows: WorkflowSettings

steering_mode: QueueMode

follow_up_mode: QueueMode

shell_path: Option<String>

shell_command_prefix: Option<String>

session_dir: Option<String>

session_share_destination: SessionShareDestination

enabled_models: Option<Vec<String>>

default_tools: Option<Vec<String>>

external_editor: Option<String>

skills: Vec<String>

prompts: Vec<String>

themes: Vec<String>

enable_skill_commands: Option<bool>

auto_recap: Option<bool>

None preserves the default-on behavior for existing settings files.

voice_language: Option<String>

voice_backend: Option<String>

markdown: MarkdownSettings

webmcp: WebMcpSettings

status_line: Option<StatusLineSettings>

Replace the footer with the output of an external command.

extra: Map<String, Value>

Unknown keys survive load/save.

Implementations

impl Settings

pub fn get_or_create_device_id() -> Result<String>

Read only user settings when creating the installation ID.

pub fn auto_recap_enabled(&self) -> bool

pub fn load(cwd: &Path, project_trusted: bool) -> Settings

Load global settings, overlaying project settings when trusted.

pub fn override_for_run(&mut self, change: impl Fn(&mut Settings))

Change a setting for this run only, for example from a CLI flag. save_global does not write it.

pub fn save_global(&mut self) -> Result<()>

Write the settings changed since load (or the last save) into the user’s settings file, leaving every other key in that file as it is.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

where Settings: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Settings

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Settings

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 Settings