Struct Config 

pub struct Config {

    pub settings_dir: PathBuf,
    pub soul_path: Option<PathBuf>,
    pub skills_dir: Option<PathBuf>,
    pub workspace_dir: Option<PathBuf>,
    pub credentials_dir: Option<PathBuf>,
    pub messengers: Vec<MessengerConfig>,
    pub use_secrets: bool,
    pub gateway_url: Option<String>,
    pub model: Option<ModelProvider>,
    pub secrets_password_protected: bool,
    pub totp_enabled: bool,
    pub agent_access: bool,
    pub agent_name: String,
    pub message_spacing: u16,
    pub tab_width: u16,
    pub sandbox: SandboxConfig,
    pub clawhub_url: Option<String>,
    pub clawhub_token: Option<String>,
    pub system_prompt: Option<String>,
    pub messenger_poll_interval_ms: Option<u32>,
    pub tool_permissions: HashMap<String, ToolPermission>,
    pub tls_cert: Option<PathBuf>,
    pub tls_key: Option<PathBuf>,
    pub memory_flush: MemoryFlushConfig,
    pub workspace_context: WorkspaceContextConfig,
}

Fields

settings_dir: PathBuf

Root state directory (e.g. ~/.rustyclaw). All other paths are derived from this unless explicitly overridden.

soul_path: Option<PathBuf>

Path to SOUL.md file (default: <workspace_dir>/SOUL.md)

skills_dir: Option<PathBuf>

Skills directory (default: <workspace_dir>/skills)

workspace_dir: Option<PathBuf>

Agent workspace directory (default: <settings_dir>/workspace)

credentials_dir: Option<PathBuf>

Credentials directory (default: <settings_dir>/credentials)

messengers: Vec<MessengerConfig>

Messenger configurations

use_secrets: bool

Whether to use secrets storage

gateway_url: Option<String>

Gateway WebSocket URL for the TUI to connect to

model: Option<ModelProvider>

Selected model provider and default model

secrets_password_protected: bool

Whether the secrets vault is encrypted with a user password (as opposed to an auto-generated key file).

totp_enabled: bool

Whether TOTP two-factor authentication is enabled for the vault.

agent_access: bool

Whether the agent is allowed to access secrets on behalf of the user.

agent_name: String

User-chosen name for this agent instance (shown in TUI title, authenticator app labels, etc.). Defaults to “RustyClaw”.

message_spacing: u16

Number of blank lines inserted between messages in the TUI. Set to 0 for compact output, 1 (default) for comfortable spacing.

tab_width: u16

Number of spaces a tab character occupies in the TUI. Defaults to 5.

sandbox: SandboxConfig

Sandbox configuration for agent isolation.

clawhub_url: Option<String>

ClawHub registry URL (default: https://registry.clawhub.dev/api/v1).

clawhub_token: Option<String>

ClawHub API token for publishing / authenticated downloads.

system_prompt: Option<String>

System prompt for the agent (used for messenger conversations).

messenger_poll_interval_ms: Option<u32>

Messenger polling interval in milliseconds (default: 2000).

tool_permissions: HashMap<String, ToolPermission>

Per-tool permission overrides. Tools not listed here default to Allow.

tls_cert: Option<PathBuf>

Path to TLS certificate file (PEM) for WSS gateway connections.

tls_key: Option<PathBuf>

Path to TLS private key file (PEM) for WSS gateway connections.

memory_flush: MemoryFlushConfig

Pre-compaction memory flush configuration.

workspace_context: WorkspaceContextConfig

Workspace context injection configuration.

Implementations

impl Config

pub fn workspace_dir(&self) -> PathBuf

Agent workspace directory — holds SOUL.md, skills/, etc. Default: <settings_dir>/workspace

pub fn credentials_dir(&self) -> PathBuf

Credentials directory — holds secrets vault, key file, OAuth tokens. Default: <settings_dir>/credentials

pub fn agent_dir(&self) -> PathBuf

Default agent directory — per-agent state (sessions, etc.). Default: <settings_dir>/agents/main

pub fn sessions_dir(&self) -> PathBuf

Sessions directory for the default agent.

pub fn soul_path(&self) -> PathBuf

Path to SOUL.md — inside the workspace.

pub fn skills_dir(&self) -> PathBuf

Skills directory — inside the workspace.

pub fn skills_dirs(&self) -> Vec<PathBuf>

Returns all skills directories in priority order (lowest to highest). Order: bundled OpenClaw → user OpenClaw → user RustyClaw

pub fn logs_dir(&self) -> PathBuf

Logs directory.

pub fn ensure_dirs(&self) -> Result<()>

Ensure the entire directory skeleton exists on disk.

pub fn load(path: Option<PathBuf>) -> Result<Self>

Load configuration from file, with OpenClaw compatibility

pub fn save(&self, path: Option<PathBuf>) -> Result<()>

Save configuration to file

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.