zoi-cli 1.25.1

Advanced Package Manager & Environment Orchestrator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! Zoi CLI library.
//!
//! This crate provides the command-line interface logic for Zoi, including
//! command parsing, execution, and utility functions for interacting with Zoi.

/// Command-line argument parsing and definitions.
pub mod cli;
/// Implementation of CLI commands.
pub mod cmd;
/// Package-related CLI logic.
pub mod pkg;
/// Project management.
pub use zoi_project as project;
/// CLI-specific utility functions.
pub mod utils;

use anyhow::Result;
pub use pkg::{local, mini_resolve};
pub use zoi_common::SourceInstallOptions;
pub use zoi_core::types::{self, Scope};
pub use zoi_core::{
    cache, config, hash, lock, offline, pgp, pin, pkgdir, recorder, sysroot,
    upgrade
};
pub use zoi_hooks as hooks;
pub use zoi_lua as lua;
pub use zoi_purl as purl;
pub use zoi_resolver as resolve;
#[cfg(target_os = "linux")]
pub use zoi_sandbox as sandbox;
pub use zoi_telemetry as telemetry;

/// Converts a core `Scope` to a CLI `InstallScope`.
fn to_install_scope(scope: Scope) -> cli::InstallScope {
    match scope {
        Scope::User => cli::InstallScope::User,
        Scope::System => cli::InstallScope::System,
        Scope::Project => cli::InstallScope::Project
    }
}

/// Installs one or more packages from source strings (PURLs or names).
///
/// # Errors
///
/// Returns an error if:
/// - The plugin manager fails to initialize.
/// - The installation process fails.
pub fn install_sources(
    sources: &[String],
    options: &SourceInstallOptions
) -> Result<()> {
    let plugin_manager = if crate::pkg::utils::is_mini_mode() {
        None
    } else {
        let pm = pkg::plugin::PluginManager::new()?;
        let _ = pm.load_all(options.yes);
        Some(pm)
    };

    let pm_ptr = plugin_manager.as_ref();

    cmd::install::run(
        sources,
        options.repo.clone(),
        options.force,
        options.all_optional,
        options.yes,
        options.scope_override.map(to_install_scope),
        false,
        false,
        options.save,
        options.build_type.as_deref(),
        options.dry_run,
        pm_ptr,
        options.build,
        options.frozen,
        false,
        false,
        3,
        false,
        false,
        None
    )
}

/// Uninstalls a package by name.
///
/// # Errors
///
/// Returns an error if the uninstallation process fails.
pub fn uninstall_package(
    package_name: &str,
    scope_override: Option<Scope>
) -> Result<()> {
    zoi_uninstall::run(package_name, scope_override, false, false, false)
        .map(|_| ())
}