Struct CliConfig 

pub struct CliConfig {
    pub config_dir: Option<ConfigDir>,
    pub rpc: RpcConfig,
    pub store_filepath: PathBuf,
    pub secret_keys_directory: PathBuf,
    pub token_symbol_map_filepath: PathBuf,
    pub remote_prover_endpoint: Option<CliEndpoint>,
    pub package_directory: PathBuf,
    pub max_block_number_delta: Option<u32>,
    pub note_transport: Option<NoteTransportConfig>,
    pub remote_prover_timeout: Duration,
}

Fields

config_dir: Option<ConfigDir>

The directory this configuration was loaded from. Not part of the TOML file.

rpc: RpcConfig

Describes settings related to the RPC endpoint.

store_filepath: PathBuf

Path to the SQLite store file.

secret_keys_directory: PathBuf

Path to the directory that contains the secret key files.

token_symbol_map_filepath: PathBuf

Path to the file containing the token symbol map.

remote_prover_endpoint: Option<CliEndpoint>

RPC endpoint for the remote prover. If this isn’t present, a local prover will be used.

package_directory: PathBuf

Path to the directory from where packages will be loaded.

max_block_number_delta: Option<u32>

Maximum number of blocks the client can be behind the network for transactions and account proofs to be considered valid.

note_transport: Option<NoteTransportConfig>

Describes settings related to the note transport endpoint.

remote_prover_timeout: Duration

Timeout for the remote prover requests.

Implementations

impl CliConfig

pub fn is_local(&self) -> bool

Returns true when this config was loaded from the local .miden directory.

This is typically set when loading via CliConfig::from_local_dir or CliConfig::load (when local takes precedence).

pub fn is_global(&self) -> bool

Returns true when this config was loaded from the global .miden directory.

This is typically set when loading via CliConfig::from_global_dir or CliConfig::load (when local config is not available).

pub fn from_dir(miden_dir: &Path) -> Result<Self, CliError>

Loads configuration from a specific .miden directory.

⚠️ WARNING: Advanced Use Only

This method bypasses the standard CLI configuration discovery logic.

This method loads config from an explicitly specified directory, which means:

• It does NOT check for local .miden directory first
• It does NOT fall back to global ~/.miden directory
• It does NOT follow CLI priority logic

Recommended Alternative

For standard CLI-like configuration loading, use:

CliConfig::load()  // Respects local → global priority

Or for client initialization:

CliClient::new(debug_mode).await?

When to use this method

• Testing: When you need to test with config from a specific directory
• Explicit Control: When you must load from a non-standard location

Arguments

• miden_dir - Path to the .miden directory containing miden-client.toml

Returns

A configured CliConfig instance with resolved paths.

Errors

Returns a CliError:

• CliError::ConfigNotFound if the config file doesn’t exist in the specified directory
• CliError::Config if configuration file parsing fails

Examples

use std::path::PathBuf;

use miden_client_cli::config::CliConfig;

// ⚠️ This bypasses standard config discovery!
let config = CliConfig::from_dir(&PathBuf::from("/path/to/.miden"))?;

// ✅ Prefer this for CLI-like behavior:
let config = CliConfig::load()?;

pub fn from_local_dir() -> Result<Self, CliError>

Loads configuration from the local .miden directory (current working directory).

⚠️ WARNING: Advanced Use Only

This method bypasses the standard CLI configuration discovery logic.

This method ONLY checks the local directory and does NOT fall back to the global configuration if the local config doesn’t exist. This differs from CLI behavior.

Recommended Alternative

For standard CLI-like behavior:

CliConfig::load()  // Respects local → global fallback
CliClient::new(debug_mode).await?

When to use this method

• Testing: When you need to ensure only local config is used
• Explicit Control: When you must avoid global config

Returns

A configured CliConfig instance.

Errors

Returns a CliError if:

• Cannot determine current working directory
• The config file doesn’t exist locally
• Configuration file parsing fails

pub fn from_global_dir() -> Result<Self, CliError>

Loads configuration from the global .miden directory (user’s home directory).

⚠️ WARNING: Advanced Use Only

This method bypasses the standard CLI configuration discovery logic.

This method ONLY checks the global directory and does NOT check for local config first. This differs from CLI behavior which prioritizes local config over global.

Recommended Alternative

For standard CLI-like behavior:

CliConfig::load()  // Respects local → global priority
CliClient::new(debug_mode).await?

When to use this method

• Testing: When you need to ensure only global config is used
• Explicit Control: When you must bypass local config

Returns

A configured CliConfig instance.

Errors

Returns a CliError if:

• Cannot determine home directory
• The config file doesn’t exist globally
• Configuration file parsing fails

pub fn load() -> Result<Self, CliError>

Loads configuration from system directories with priority: local first, then global fallback.

✅ Recommended Method

This is the recommended method for loading CLI configuration as it follows the same discovery logic as the CLI tool itself.

This method searches for configuration files in the following order:

1. Local .miden/miden-client.toml in the current working directory
2. Global .miden/miden-client.toml in the home directory (fallback)

This matches the CLI’s configuration priority logic. For most use cases, you should use CliClient::new() instead, which uses this method internally.

Returns

A configured CliConfig instance.

Errors

Returns a CliError:

• CliError::ConfigNotFound if neither local nor global config file exists
• CliError::Config if configuration file parsing fails

Note: If a local config file exists but has parse errors, the error is returned immediately without falling back to global config.

Examples

use miden_client_cli::config::CliConfig;

// ✅ Recommended: Loads from local .miden dir if it exists, otherwise from global
let config = CliConfig::load()?;

// Or even better, use CliClient directly:
// let client = CliClient::new(DebugMode::Disabled).await?;

Trait Implementations

impl Debug for CliConfig

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

Formats the value using the given formatter.

impl Default for CliConfig

Default implementation for CliConfig.

Note: This implementation is primarily used by the figment Provider trait (see CliConfig::data()) to provide default values during configuration merging. The paths returned are relative and intended to be resolved against a .miden directory.

For loading configuration from the filesystem, use CliConfig::load() instead.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CliConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Provider for CliConfig

fn metadata(&self) -> Metadata

Returns the Metadata for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for CliConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.