Struct Config 

pub struct Config { /* private fields */ }

Configuration management for aster.

This module provides a flexible configuration system that supports:

• Dynamic configuration keys
• Multiple value types through serde deserialization
• Environment variable overrides
• YAML-based configuration file storage
• Hot reloading of configuration changes
• Secure secret storage in system keyring

Configuration values are loaded with the following precedence:

1. Environment variables (exact key match)
2. Configuration file (~/.config/aster/config.yaml by default)

Secrets are loaded with the following precedence:

1. Environment variables (exact key match)
2. System keyring (which can be disabled with ASTER_DISABLE_KEYRING)
3. If the keyring is disabled, secrets are stored in a secrets file (~/.config/aster/secrets.yaml by default)

Examples

use aster::config::Config;
use serde::Deserialize;

// Get a string value
let config = Config::global();
let api_key: String = config.get_param("OPENAI_API_KEY").unwrap();

// Get a complex type
#[derive(Deserialize)]
struct ServerConfig {
    host: String,
    port: u16,
}

let server_config: ServerConfig = config.get_param("server").unwrap();

Naming Convention

we recommend snake_case for keys, and will convert to UPPERCASE when checking for environment overrides. e.g. openai_api_key will check for an environment variable OPENAI_API_KEY

For aster-specific configuration, consider prefixing with “aster_” to avoid conflicts.

Implementations

impl Config

pub fn global() -> &'static Config

Get the global configuration instance.

This will initialize the configuration with the default path (~/.config/aster/config.yaml) if it hasn’t been initialized yet.

pub fn new<P: AsRef<Path>>( config_path: P, service: &str, ) -> Result<Self, ConfigError>

Create a new configuration instance with custom paths

This is primarily useful for testing or for applications that need to manage multiple configuration files.

pub fn new_with_file_secrets<P1: AsRef<Path>, P2: AsRef<Path>>( config_path: P1, secrets_path: P2, ) -> Result<Self, ConfigError>

Create a new configuration instance with custom paths

This is primarily useful for testing or for applications that need to manage multiple configuration files.

pub fn exists(&self) -> bool

pub fn clear(&self) -> Result<(), ConfigError>

pub fn path(&self) -> String

pub fn all_values(&self) -> Result<HashMap<String, Value>, ConfigError>

pub fn initialize_if_empty(&self, values: Mapping) -> Result<(), ConfigError>

pub fn all_secrets(&self) -> Result<HashMap<String, Value>, ConfigError>

pub fn get(&self, key: &str, is_secret: bool) -> Result<Value, ConfigError>

pub fn set<V>( &self, key: &str, value: &V, is_secret: bool, ) -> Result<(), ConfigError>

where V: Serialize,

pub fn get_param<T: for<'de> Deserialize<'de>>( &self, key: &str, ) -> Result<T, ConfigError>

Get a configuration value (non-secret).

This will attempt to get the value from:

1. Environment variable with the exact key name
2. Configuration file

The value will be deserialized into the requested type. This works with both simple types (String, i32, etc.) and complex types that implement serde::Deserialize.

Errors

Returns a ConfigError if:

• The key doesn’t exist in either environment or config file
• The value cannot be deserialized into the requested type
• There is an error reading the config file

pub fn set_param<V: Serialize>( &self, key: &str, value: V, ) -> Result<(), ConfigError>

Set a configuration value in the config file (non-secret).

This will immediately write the value to the config file. The value can be any type that can be serialized to JSON/YAML.

Note that this does not affect environment variables - those can only be set through the system environment.

Errors

Returns a ConfigError if:

• There is an error reading or writing the config file
• There is an error serializing the value

pub fn delete(&self, key: &str) -> Result<(), ConfigError>

Delete a configuration value in the config file.

This will immediately write the value to the config file. The value can be any type that can be serialized to JSON/YAML.

Note that this does not affect environment variables - those can only be set through the system environment.

Errors

Returns a ConfigError if:

• There is an error reading or writing the config file
• There is an error serializing the value

pub fn get_secret<T: for<'de> Deserialize<'de>>( &self, key: &str, ) -> Result<T, ConfigError>

Get a secret value.

This will attempt to get the value from:

1. Environment variable with the exact key name
2. System keyring

The value will be deserialized into the requested type. This works with both simple types (String, i32, etc.) and complex types that implement serde::Deserialize.

Errors

Returns a ConfigError if:

• The key doesn’t exist in either environment or keyring
• The value cannot be deserialized into the requested type
• There is an error accessing the keyring

pub fn get_secrets( &self, primary: &str, maybe_secret: &[&str], ) -> Result<HashMap<String, String>, ConfigError>

Get secrets. If primary is in env, use env for all keys. Otherwise use secret storage.

pub fn set_secret<V>(&self, key: &str, value: &V) -> Result<(), ConfigError>

where V: Serialize,

Set a secret value in the system keyring.

This will store the value in a single JSON object in the system keyring, alongside any other secrets. The value can be any type that can be serialized to JSON.

Note that this does not affect environment variables - those can only be set through the system environment.

Errors

Returns a ConfigError if:

• There is an error accessing the keyring
• There is an error serializing the value

pub fn delete_secret(&self, key: &str) -> Result<(), ConfigError>

Delete a secret from the system keyring.

This will remove the specified key from the JSON object in the system keyring. Other secrets will remain unchanged.

Errors

Returns a ConfigError if:

• There is an error accessing the keyring
• There is an error serializing the remaining values

impl Config

pub fn get_claude_code_command(&self) -> Result<ClaudeCodeCommand, ConfigError>

pub fn set_claude_code_command( &self, v: impl Into<ClaudeCodeCommand>, ) -> Result<(), ConfigError>

impl Config

pub fn get_gemini_cli_command(&self) -> Result<GeminiCliCommand, ConfigError>

pub fn set_gemini_cli_command( &self, v: impl Into<GeminiCliCommand>, ) -> Result<(), ConfigError>

impl Config

pub fn get_cursor_agent_command( &self, ) -> Result<CursorAgentCommand, ConfigError>

pub fn set_cursor_agent_command( &self, v: impl Into<CursorAgentCommand>, ) -> Result<(), ConfigError>

impl Config

pub fn get_codex_command(&self) -> Result<CodexCommand, ConfigError>

pub fn set_codex_command( &self, v: impl Into<CodexCommand>, ) -> Result<(), ConfigError>

impl Config

pub fn get_codex_reasoning_effort( &self, ) -> Result<CodexReasoningEffort, ConfigError>

pub fn set_codex_reasoning_effort( &self, v: impl Into<CodexReasoningEffort>, ) -> Result<(), ConfigError>

impl Config

pub fn get_codex_enable_skills(&self) -> Result<CodexEnableSkills, ConfigError>

pub fn set_codex_enable_skills( &self, v: impl Into<CodexEnableSkills>, ) -> Result<(), ConfigError>

impl Config

pub fn get_codex_skip_git_check(&self) -> Result<CodexSkipGitCheck, ConfigError>

pub fn set_codex_skip_git_check( &self, v: impl Into<CodexSkipGitCheck>, ) -> Result<(), ConfigError>

impl Config

pub fn get_codex_use_app_server(&self) -> Result<CodexUseAppServer, ConfigError>

pub fn set_codex_use_app_server( &self, v: impl Into<CodexUseAppServer>, ) -> Result<(), ConfigError>

impl Config

pub fn get_aster_search_paths(&self) -> Result<Vec<String>, ConfigError>

pub fn set_aster_search_paths( &self, v: impl Into<Vec<String>>, ) -> Result<(), ConfigError>

impl Config

pub fn get_aster_mode(&self) -> Result<AsterMode, ConfigError>

pub fn set_aster_mode(&self, v: impl Into<AsterMode>) -> Result<(), ConfigError>

impl Config

pub fn get_aster_provider(&self) -> Result<String, ConfigError>

pub fn set_aster_provider( &self, v: impl Into<String>, ) -> Result<(), ConfigError>

impl Config

pub fn get_aster_model(&self) -> Result<String, ConfigError>

pub fn set_aster_model(&self, v: impl Into<String>) -> Result<(), ConfigError>

impl Config

pub fn get_aster_max_active_agents(&self) -> Result<usize, ConfigError>

pub fn set_aster_max_active_agents( &self, v: impl Into<usize>, ) -> Result<(), ConfigError>

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.