Struct InstallArgs 

pub struct InstallArgs {
    pub source_root: Option<PathBuf>,
    pub product: String,
    pub live_home: PathBuf,
    pub state_home: PathBuf,
    pub tag: Option<String>,
    pub no_overlay: bool,
    pub overlay_path: Option<PathBuf>,
    pub dry_run: bool,
    pub apply: bool,
}

Fields

source_root: Option<PathBuf>

Source root containing manifests/, core/, targets/, build/. Defaults to the current working directory.

product: String

Product to install (codex or claude).

live_home: PathBuf

Absolute path of the runtime home (e.g. ~/.codex / ~/.claude). Relative paths are rejected so install never writes outside an explicitly-chosen directory.

state_home: PathBuf

Absolute path of the state home (where backups land).

tag: Option<String>

Tag the backup-run root with a tag-<name> marker file so gc-backups (Plan 04 Sprint 2 Task 2.4) can preserve it across retention sweeps. Tag must be ASCII alphanumeric / - / _.

no_overlay: bool

Skip the optional .private/link-map.overrides.yaml overlay merge. Default: merge if file exists.

overlay_path: Option<PathBuf>

Override the overlay file location. When set, the conventional <source-root>/.private/link-map.overrides.yaml is ignored.

dry_run: bool

Print the resolved plan; do not mutate the filesystem.

apply: bool

Reconcile the runtime home to the plan. Idempotent on the second run.

Trait Implementations

impl Args for InstallArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for InstallArgs

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

Formats the value using the given formatter.

impl FromArgMatches for InstallArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.