Struct CommandContext 

pub struct CommandContext {
    pub manifest: Manifest,
    pub manifest_path: PathBuf,
    pub project_dir: PathBuf,
    pub lockfile_path: PathBuf,
}

Common context for CLI commands that need manifest and project information

Fields

manifest: Manifest

Parsed project manifest (agpm.toml)

manifest_path: PathBuf

Path to the manifest file

project_dir: PathBuf

Project root directory (containing agpm.toml)

lockfile_path: PathBuf

Path to the lockfile (agpm.lock)

Implementations

impl CommandContext

pub fn new(manifest: Manifest, project_dir: PathBuf) -> Result<Self>

Create a new command context from a manifest and project directory

pub fn from_manifest_path(manifest_path: impl AsRef<Path>) -> Result<Self>

Create a new command context from a manifest path

Errors

Returns an error if the manifest file doesn’t exist or cannot be read

pub fn load_lockfile(&self) -> Result<Option<LockFile>>

Load an existing lockfile if it exists

Errors

Returns an error if the lockfile exists but cannot be parsed

pub fn load_lockfile_with_regeneration( &self, can_regenerate: bool, operation_name: &str, ) -> Result<Option<LockFile>>

Load an existing lockfile with automatic regeneration for invalid files

If the lockfile exists but is invalid or corrupted, this method will offer to automatically regenerate it. This provides a better user experience by recovering from common lockfile issues.

Arguments

• can_regenerate - Whether automatic regeneration should be offered
• operation_name - Name of the operation for error messages (e.g., “list”)

Returns

• Ok(Some(lockfile)) - Successfully loaded or regenerated lockfile
• Ok(None) - No lockfile exists (not an error)
• Err - Critical error that cannot be recovered from

Behavior

• Interactive mode (TTY): Prompts user with Y/n confirmation
• Non-interactive mode (CI/CD): Fails with helpful error message
• Backup strategy: Copies invalid lockfile to agpm.lock.invalid before regeneration

Examples

let manifest = Manifest::load(&PathBuf::from("agpm.toml"))?;
let project_dir = PathBuf::from(".");
let ctx = CommandContext::new(manifest, project_dir)?;
match ctx.load_lockfile_with_regeneration(true, "list") {
    Ok(Some(lockfile)) => println!("Loaded lockfile"),
    Ok(None) => println!("No lockfile found"),
    Err(e) => eprintln!("Error: {}", e),
}

pub fn save_lockfile(&self, lockfile: &LockFile) -> Result<()>

Save a lockfile to the project directory

Errors

Returns an error if the lockfile cannot be written

Trait Implementations

impl Debug for CommandContext

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

Formats the value using the given formatter.