Struct Config 

pub struct Config {

    pub home_dir: PathBuf,
    pub schema_version: u32,
    pub last_cleared_schema_version: Option<u32>,
    pub shell_type: ShellType,
    pub presets_dir_override: Option<PathBuf>,
    pub external_shell_mode: ExternalShellMode,
    pub presets_overlay_dir_override: Option<PathBuf>,
    pub presets_overlay_git: Option<String>,
    pub presets_overlay_git_branch: Option<String>,
    pub app_default_dest_root_override: Option<PathBuf>,
    pub is_external_presets: bool,
    pub allow_app_hooks: bool,
    pub sync_terminal_theme: bool,
    pub self_install_dest: Option<PathBuf>,
    pub gpg_key_id: Option<String>,
    pub secret_backend: Option<String>,
    pub age_recipients: Vec<String>,
    pub age_identity: Option<String>,
    pub env: BTreeMap<String, String>,
    pub env_proxy: Vec<EnvProxyRule>,
    pub env_descriptions: BTreeMap<String, String>,
    pub env_override_sources: BTreeMap<String, EnvOverrideSource>,
    /* private fields */
}

Fields

home_dir: PathBuf

schema_version: u32

last_cleared_schema_version: Option<u32>

shell_type: ShellType

presets_dir_override: Option<PathBuf>

Optional persistent presets_dir override stored in the active config. Takes effect when neither SHINE_CONFIG_DIR nor SHINE_PRESETS is set.

external_shell_mode: ExternalShellMode

Deployment policy for shell commands sourced from an external presets directory. Snapshot mode is the safe default; live mode is an explicit preset-development opt-in.

presets_overlay_dir_override: Option<PathBuf>

Optional overlay directory merged over the active presets source.

presets_overlay_git: Option<String>

Optional Git URL for a shine-managed overlay. When set (and no explicit presets_overlay_dir is configured), shine owns the overlay checkout at <shine_dir>/overlay, cloning it --depth 1 on shine preset pull and keeping it as an always-latest mirror of the remote tip.

presets_overlay_git_branch: Option<String>

Optional branch to track for presets_overlay_git. When unset, the remote’s default branch is used.

app_default_dest_root_override: Option<PathBuf>

Optional override for the default destination root used by shine app install when a preset file carries no shine-dest: annotation. Defaults to ~/.config when not set.

is_external_presets: bool

true when the presets directory is provided by the user (via env var or config presets_dir key) rather than the default ~/.shine/presets/. When true, commands resolve desired presets from disk without extracting embedded assets. Shell deployment then follows external_shell_mode.

allow_app_hooks: bool

Allows app presets loaded from external preset directories to run post-upgrade hooks. Embedded presets may run hooks without this opt-in.

sync_terminal_theme: bool

Whether the managed sys pre profile auto-syncs the terminal theme (shine theme sync --auto) on interactive shell startup. Defaults to true. The SHINE_SYNC_TERMINAL_THEME env var overrides this at runtime regardless of value (docs/terminal-theme-sync-prd.md §5). Deliberately not project-overridable: this is a terminal/session-level toggle, not something that varies per project.

self_install_dest: Option<PathBuf>

Path where shine self install last copied the binary. When set, shine self upgrade will try to sync the new binary there automatically.

gpg_key_id: Option<String>

Default GPG recipient key used by shine env secret encrypt when the command does not provide -r/--recipient.

secret_backend: Option<String>

Selects the default crate::secret::BackendKind used by shine env encrypt/seal when neither -r/--recipient nor a workspace backend override is given. Absent means GPG. Decryption never consults this field — it is resolved purely from the ciphertext’s backend tag.

age_recipients: Vec<String>

Default age recipients (age1... / age1se1...) used by shine env encrypt/seal when the age backend is active and no -r/--recipient is given. Encrypting to every team member’s recipient lets any of them decrypt the resulting ciphertext with their own identity.

age_identity: Option<String>

Path to the age identity file used to decrypt age:-tagged secrets. May contain multiple identities (e.g. a Secure Enclave identity plus a plain fallback), one per line. Defaults to <shine_dir>/age/identity.txt when unset and that file exists.

env: BTreeMap<String, String>

Environment variables substituted into template-enabled presets.

env_proxy: Vec<EnvProxyRule>

Command-specific, explicitly allow-listed secret injection rules.

env_descriptions: BTreeMap<String, String>

Per-variable descriptions read from detailed [env] entries.

env_override_sources: BTreeMap<String, EnvOverrideSource>

Which env override file (if any) currently supplies each key’s effective value. Only override files populate this — config.toml [env] layers never do, since a plain write there is always effective unless shadowed by one of these. Used to detect when env set/encrypt/delete would otherwise silently write a value that an override file keeps shadowing.

Implementations

impl Config

pub async fn init_current_dir_config() -> Result<PathBuf>

pub async fn load_or_init() -> Result<Self>

pub async fn load_global_runtime_or_init() -> Result<Self>

pub async fn load_global_runtime_for_dry_run() -> Result<Self>

pub async fn read_global_runtime_schema_version() -> Result<u32>

impl Config

pub async fn save(&self) -> Result<()>

impl Config

pub fn presets_dir(&self) -> &Path

pub fn bin_dir(&self) -> &Path

pub fn shine_dir(&self) -> &Path

pub fn config_path(&self) -> &Path

pub fn is_project_config(&self) -> bool

Whether configuration was discovered from a project shine.config.toml.

pub fn rendered_dir(&self) -> PathBuf

Directory where template-rendered shell scripts are written. Always inside shine_dir so it is never confused with user-owned presets.

pub fn installed_shell_dir(&self) -> PathBuf

Shine-owned snapshots of external shell categories.

pub fn app_default_dest_root(&self) -> PathBuf

pub fn new_for_test(dir: &Path) -> Self

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

Age identity file(s) used to decrypt age:-tagged secrets, resolved from age_identity (tilde-expanded) or, when unset, the default path under shine_dir if it exists.

pub fn with_presets_dir_override(self, value: Option<PathBuf>) -> Self

Return a clone of this config with presets_dir_override replaced.

pub fn with_external_shell_mode(self, value: ExternalShellMode) -> Self

pub fn with_presets_overlay_git( self, url: Option<String>, branch: Option<String>, ) -> Self

Return a clone of this config with the Git-managed overlay source replaced. Setting a URL clears any manual presets_overlay_dir override so the two overlay modes never coexist; clearing the URL leaves the managed checkout on disk untouched.

pub fn with_presets_overlay_dir_override(self, value: Option<PathBuf>) -> Self

Return a clone of this config with presets_overlay_dir_override replaced.

pub fn env_override_source(&self, key: &str) -> Option<&EnvOverrideSource>

Which override file (if any) currently supplies key’s effective value. None means the key resolves purely from config.toml [env] (global or project), so writing there via env set/encrypt/delete is effective.

pub fn active_presets_overlay_dir(&self) -> Option<&Path>

pub fn overlay_git_source(&self) -> Option<(&str, Option<&str>, &Path)>

Git source for a shine-managed overlay, if configured: (url, branch, managed_dir). Returned regardless of whether the checkout exists yet, so shine preset pull can clone it on first use.

pub fn preset_path(&self, relative: impl AsRef<Path>) -> PathBuf

Resolve a preset file with the overlay taking precedence over the base source.

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.