zoi_cli/
cli.rs

1use std::io::{self};
2use std::path::PathBuf;
3
4use clap::builder::styling;
5use clap::{
6    ColorChoice, CommandFactory, FromArgMatches, Parser, Subcommand, ValueHint
7};
8use clap_complete::{Shell, generate};
9use colored::Colorize;
10use zoi_common::Runnable;
11
12use crate::pkg::lock;
13use crate::{cmd, utils};
14
15// Development, Special, Public or Production
16/// The release branch of the current build.
17const BRANCH: &str = "Production";
18/// The release status of the current build.
19const STATUS: &str = "Release";
20/// The version number of the current build.
21const NUMBER: &str = "1.27.0";
22/// Help text for package source identifiers.
23const PKG_SOURCE_HELP: &str =
24    "Package identifier (e.g. @repo/name, #git@repo/name, path, or URL)";
25
26/// Zoi - The Advanced Package Manager & Environment Orchestrator.
27///
28/// Part of the Zillowe Development Suite (ZDS), Zoi is designed to streamline
29/// your development workflow by managing tools and project environments.
30#[derive(Parser)]
31#[command(name = "zoi", author, about, long_about = None, disable_version_flag = true,
32    trailing_var_arg = true,
33    color = ColorChoice::Auto,
34    arg_required_else_help = true,
35)]
36pub struct Cli {
37    /// The subcommand to execute.
38    #[command(subcommand)]
39    command: Option<Commands>,
40
41    /// Print detailed version information.
42    #[arg(
43        short = 'v',
44        long = "version",
45        help = "Print detailed version information"
46    )]
47    version_flag: bool,
48
49    /// Automatically answer yes to all prompts.
50    #[arg(
51        short = 'y',
52        long,
53        help = "Automatically answer yes to all prompts",
54        global = true
55    )]
56    yes: bool,
57
58    /// Operate on a different root directory.
59    #[arg(
60        long = "root",
61        help = "Operate on a different root directory",
62        global = true,
63        value_hint = ValueHint::DirPath
64    )]
65    pub root: Option<std::path::PathBuf>,
66
67    /// Do not attempt to connect to the network.
68    #[arg(
69        long = "offline",
70        help = "Do not attempt to connect to the network",
71        global = true
72    )]
73    pub offline: bool,
74
75    /// Additional directory to search for .zpa archives.
76    #[arg(
77        long = "pkg-dir",
78        help = "Additional directory to search for .zpa archives",
79        global = true,
80        value_hint = ValueHint::DirPath
81    )]
82    /// Additional directory to search for .zpa archives.
83    pub pkg_dirs: Vec<std::path::PathBuf>
84}
85
86/// The target scope for system-level operations.
87#[derive(clap::ValueEnum, Clone, Debug, Copy, PartialEq, Eq)]
88pub enum SetupScope {
89    /// The current user's scope.
90    User,
91    /// The system-wide scope.
92    System
93}
94
95/// The target scope for package installation.
96#[derive(clap::ValueEnum, Clone, Debug, Copy)]
97pub enum InstallScope {
98    /// The current user's scope.
99    User,
100    /// The system-wide scope.
101    System,
102    /// The current project's scope.
103    Project
104}
105
106/// The available subcommands for Zoi.
107#[derive(Subcommand)]
108enum Commands {
109    /// Generates shell completion scripts
110    #[command(hide = true)]
111    GenerateCompletions {
112        /// The shell to generate completions for
113        #[arg(value_enum)]
114        shell: Shell
115    },
116
117    /// Dynamic shell completions (internal use)
118    #[command(hide = true)]
119    Complete {
120        /// The shell to complete for
121        #[arg(value_enum)]
122        shell: Shell,
123        /// Current word index (1-based)
124        index: usize,
125        /// All words in the command line
126        words: Vec<String>
127    },
128
129    /// Prints concise version and build information
130    #[command(
131        alias = "v",
132        long_about = "Displays the version number, build status, branch, and \
133                      commit hash. This is the same output provided by the -v \
134                      and --version flags."
135    )]
136    Version,
137
138    /// Shows detailed application information and credits
139    #[command(long_about = "Displays the full application name, description, \
140                            author, license, and homepage information.")]
141    About,
142
143    /// Displays detected operating system and architecture information
144    #[command(long_about = "Detects and displays key system details, \
145                            including the OS, CPU architecture, Linux \
146                            distribution (if applicable), and available \
147                            package managers.")]
148    Info,
149
150    /// Downloads a package archive or source bundle
151    #[command(
152        alias = "dl",
153        long_about = "Downloads the binary archive (.zpa) or source bundle \
154                      (.zsa) for a package to the local cache or a specified \
155                      directory."
156    )]
157    Download {
158        /// Package identifier (e.g. @repo/name, path, or URL)
159        #[arg(value_name = "PACKAGE", required = true, help = PKG_SOURCE_HELP)]
160        package: String,
161
162        /// Download the binary archive (.zpa) [default]
163        #[arg(long, group = "type")]
164        archive: bool,
165
166        /// Download the source bundle (.zsa)
167        #[arg(long, group = "type")]
168        source: bool,
169
170        /// Directory to output the downloaded file to
171        #[arg(short, long)]
172        output_dir: Option<PathBuf>
173    },
174
175    /// Downloads or updates the package database from the remote repository
176    #[command(
177        alias = "sy",
178        long_about = "Clones the official package database from GitLab to \
179                      Zoi's user data directory. If the database already \
180                      exists, it verifies the remote URL and pulls the latest \
181                      changes."
182    )]
183    Sync {
184        /// The sync subcommand to execute.
185        #[command(subcommand)]
186        command: Option<SyncCommands>,
187
188        /// Show the full git output
189        #[arg(short, long)]
190        verbose: bool,
191
192        /// Fallback to other mirrors if the default one fails
193        #[arg(long)]
194        fallback: bool,
195
196        /// Do not check for installed package managers
197        #[arg(long = "no-pm")]
198        no_package_managers: bool,
199
200        /// Force re-sync by removing existing databases and re-cloning from
201        /// scratch
202        #[arg(long)]
203        force: bool,
204
205        /// Sync registries to the project's local .zoi/pkgs/db/ using
206        /// revisions from zoi.lua
207        #[arg(long)]
208        local: bool,
209
210        /// When used with --local, sync using revisions from zoi.lock instead
211        /// of zoi.lua
212        #[arg(long)]
213        frozen: bool,
214
215        /// The scope to sync the registries to
216        #[arg(long, value_enum, conflicts_with = "local")]
217        scope: Option<SetupScope>
218    },
219
220    /// Migration helpers for converting external manifests to Zoi package files
221    Migrate(cmd::migrate::MigrateCommand),
222
223    /// Lists installed or all available packages
224    #[command(alias = "ls")]
225    List {
226        /// List all packages from the database, not just installed ones
227        #[arg(short, long)]
228        all: bool,
229        /// List only installed packages that have updates available
230        #[arg(short, long)]
231        outdated: bool,
232        /// Filter by registry handle (e.g. 'zoidberg')
233        #[arg(long)]
234        registry: Option<String>,
235        /// Filter by repository (e.g. 'main', 'extra')
236        #[arg(long)]
237        repo: Option<String>,
238        /// Filter by package type (package, app, collection, extension)
239        #[arg(short = 't', long = "type")]
240        package_type: Option<String>,
241        /// List packages not found in any configured registry
242        #[arg(short = 'm', long)]
243        foreign: bool,
244        /// List only package names (internal use for completions)
245        #[arg(long, hide = true)]
246        names: bool,
247        /// List packages with descriptions for completion
248        #[arg(long, hide = true)]
249        completion: bool
250    },
251
252    /// Shows detailed information about a package
253    Show {
254        /// The package identifier.
255        #[arg(value_name = "ALL_PACKAGES", help = PKG_SOURCE_HELP)]
256        package_name: String,
257        /// Display the raw, unformatted package file
258        #[arg(long)]
259        raw: bool,
260        /// Use PURL (Package URL) specification for resolving package
261        #[arg(long)]
262        purl: bool
263    },
264
265    /// Pin a package to a specific version
266    Pin {
267        /// The package identifier.
268        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
269        package: String,
270        /// The version to pin the package to
271        version: String
272    },
273
274    /// Find which package provides a specific command or file
275    Provides {
276        /// The command or file path to search for
277        term: String
278    },
279
280    /// Visualize the dependency tree of a package
281    Tree {
282        /// The package identifier(s).
283        #[arg(value_name = "ALL_PACKAGES", required = true, help = PKG_SOURCE_HELP)]
284        packages: Vec<String>
285    },
286
287    /// Unpin a package, allowing it to be updated
288    Unpin {
289        /// The package identifier.
290        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
291        package: String
292    },
293
294    /// Modify the installation reason of a package
295    #[command(
296        alias = "m",
297        long_about = "Changes whether a package is considered explicitly installed or a dependency. Explicit packages are not removed by 'autoremove', while dependencies are if no other package requires them.",
298        group(clap::ArgGroup::new("mode").required(true).args(["as_dependency", "as_explicit"]))
299    )]
300    Mark {
301        /// The package identifier(s).
302        #[arg(value_name = "INST_PACKAGES", required = true, help = PKG_SOURCE_HELP)]
303        packages: Vec<String>,
304
305        /// Mark packages as dependencies
306        #[arg(long, aliases = ["asdeps"])]
307        as_dependency: bool,
308
309        /// Mark packages as explicitly installed
310        #[arg(long, aliases = ["asexpl"], conflicts_with = "as_dependency")]
311        as_explicit: bool
312    },
313
314    /// Updates one or more packages to their latest versions
315    #[command(
316        alias = "up",
317        arg_required_else_help = true,
318        group(clap::ArgGroup::new("target").required(true).args(["package_names", "all"]))
319    )]
320    Update {
321        /// The package names to update.
322        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
323        package_names: Vec<String>,
324
325        /// Update all installed packages
326        #[arg(long, conflicts_with = "package_names")]
327        all: bool,
328
329        /// Do not actually perform the update, just show what would be done
330        #[arg(long)]
331        dry_run: bool,
332        /// Explain why each selected update is included or skipped
333        #[arg(long)]
334        explain: bool,
335        /// Emit machine-readable update plan JSON
336        #[arg(long, requires = "dry_run")]
337        plan_json: bool,
338        /// Show additional update details
339        #[arg(long, short)]
340        verbose: bool,
341        /// Interactively choose which upgradable packages to update (with
342        /// --all)
343        #[arg(long, requires = "all")]
344        interactive: bool
345    },
346
347    /// Installs one or more packages from a name, local file, URL, or git
348    /// repository
349    #[command(aliases = ["i", "in", "add"])]
350    Install(cmd::install::args::InstallArgs),
351
352    /// Add a tool to the current project or global configuration and install it
353    #[command(alias = "u")]
354    Use {
355        /// Package(s) to use (e.g. node@20)
356        #[arg(value_name = "ALL_PACKAGES", required = true, help = PKG_SOURCE_HELP)]
357        packages: Vec<String>,
358
359        /// Add to global configuration instead of project
360        #[arg(short, long)]
361        global: bool
362    },
363
364    /// Uninstalls one or more packages previously installed by Zoi
365    #[command(
366        aliases = ["un", "rm", "remove"],
367        long_about = "Removes one or more packages' files from the Zoi store and deletes their symlinks from the bin directory. This command will fail if a package was not installed by Zoi."
368    )]
369    Uninstall(cmd::uninstall::args::UninstallArgs),
370
371    /// Execute a command defined in a local zoi.yaml file
372    #[command(long_about = "Execute a command from zoi.yaml. If no command \
373                            is specified, it will launch an interactive \
374                            prompt to choose one.")]
375    Run {
376        /// The alias of the command to execute
377        cmd_alias: Option<String>,
378        /// Arguments to pass to the command
379        args: Vec<String>
380    },
381
382    /// Manage and set up project environments from a local zoi.yaml file
383    #[command(long_about = "Checks for required packages and runs setup \
384                            commands for a defined environment. If no \
385                            environment is specified, it launches an \
386                            interactive prompt.")]
387    Env {
388        /// The alias of the environment to set up
389        env_alias: Option<String>,
390
391        /// Export environment variables for the current shell
392        #[arg(long, value_enum, hide = true)]
393        export_shell: Option<Shell>
394    },
395
396    /// Enter a development shell for the current project
397    #[command(
398        alias = "develop",
399        long_about = "Loads the project configuration from zoi.yaml, ensures \
400                      all required packages are installed locally, sets up \
401                      environment variables (PATH, LD_LIBRARY_PATH, etc.), \
402                      and drops you into a subshell."
403    )]
404    Dev {
405        /// Command to run in the dev shell instead of an interactive shell
406        #[arg(short, long)]
407        run: Option<String>,
408        /// Temporary clone a repository and enter its development shell
409        #[arg(long)]
410        repo: Option<String>
411    },
412
413    /// Upgrades the Zoi binary to the latest version
414    #[command(
415        alias = "ug",
416        long_about = "Upgrades Zoi to the latest version. By default, it \
417                      attempts a delta upgrade (bsdiff) to minimize download \
418                      size. If the delta upgrade is unavailable or fails, it \
419                      automatically falls back to a full download."
420    )]
421    Upgrade {
422        /// Force a full download instead of a delta upgrade
423        #[arg(long)]
424        force: bool,
425
426        /// Upgrade to a specific git tag
427        #[arg(long)]
428        tag: Option<String>,
429
430        /// Upgrade to the latest release of a specific branch (e.g. Prod, Pub)
431        #[arg(long)]
432        branch: Option<String>
433    },
434
435    /// Removes packages that were installed as dependencies but are no longer
436    /// needed
437    Autoremove {
438        /// Do not actually remove packages, just show what would be done
439        #[arg(long)]
440        dry_run: bool
441    },
442
443    /// Explains why a package is installed
444    Why {
445        /// The package identifier.
446        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
447        package_name: String
448    },
449
450    /// Find which package owns a file
451    #[command(alias = "owns")]
452    Owner {
453        /// Path to the file
454        #[arg(value_hint = ValueHint::FilePath)]
455        path: std::path::PathBuf
456    },
457
458    /// List all files owned by a package
459    Files {
460        /// The package identifier.
461        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
462        package: String
463    },
464
465    /// Shows the history of package operations
466    History {
467        /// Verify audit log chain integrity instead of printing history
468        /// entries
469        #[arg(long, conflicts_with = "export")]
470        verify: bool,
471        /// Export audit history to a file (default format: JSON array with
472        /// chain fields)
473        #[arg(long, value_hint = ValueHint::FilePath, conflicts_with = "verify")]
474        export: Option<std::path::PathBuf>,
475        /// Export in newline-delimited JSON (ndjson) instead of a JSON array
476        #[arg(long, requires = "export")]
477        ndjson: bool
478    },
479
480    /// Searches for packages by name or description
481    #[command(
482        alias = "s",
483        long_about = "Searches for a case-insensitive term in the name, \
484                      description, and tags of all available packages in the \
485                      database. Filter by repo, type, or tags."
486    )]
487    Search {
488        /// The term to search for (e.g. 'editor', 'cli')
489        search_term: String,
490        /// Filter by registry handle (e.g. 'zoidberg')
491        #[arg(long)]
492        registry: Option<String>,
493        /// Filter by repository (e.g. 'main', 'extra')
494        #[arg(long)]
495        repo: Option<String>,
496        /// Filter by package type (package, app, collection, extension)
497        #[arg(long = "type")]
498        package_type: Option<String>,
499        /// Filter by tags (any match). Multiple via comma or repeated -t
500        #[arg(short = 't', long = "tag", value_delimiter = ',', num_args = 1..)]
501        tags: Option<Vec<String>>,
502        /// Sort results by field (name, repo, type)
503        #[arg(long, default_value = "name")]
504        sort: String,
505        /// Search for files provided by packages instead of package names
506        #[arg(short, long)]
507        files: bool,
508        /// Open results in an interactive TUI
509        #[arg(short = 'i', long)]
510        interactive: bool
511    },
512
513    /// Manage background services for installed packages
514    #[command(alias = "svc")]
515    Service(cmd::service::ServiceCommand),
516
517    /// Set up shell completions or enter an ephemeral environment with specific
518    /// packages
519    #[command(
520        long_about = "If a shell is provided, it installs completion scripts. If 'hook' is provided, it outputs shell-specific hook scripts for auto-activation. If packages are provided via --package/-p, it enters a temporary subshell with those packages available in PATH.",
521        arg_required_else_help = true,
522        group(clap::ArgGroup::new("shell_action").required(true).args(["shell", "hook", "packages"]).multiple(true))
523    )]
524    Shell {
525        /// The shell to set up completions for
526        #[arg(value_enum)]
527        shell: Option<Shell>,
528        /// Generate a shell hook for automatic environment activation
529        #[arg(long)]
530        hook: bool,
531        /// The scope to apply the setup to (user or system-wide)
532        #[arg(long, value_enum, default_value = "user")]
533        scope: SetupScope,
534        /// Packages to include in the ephemeral environment
535        #[arg(short, long = "package", value_name = "ALL_PACKAGES")]
536        packages: Vec<String>,
537        /// Command to run in the ephemeral environment instead of an
538        /// interactive shell
539        #[arg(short, long)]
540        run: Option<String>,
541        /// Show additional details (resolution, installation progress, etc.)
542        #[arg(long, short)]
543        verbose: bool
544    },
545
546    /// Execute a package binary directly with its dependencies resolved
547    #[command(
548        alias = "x",
549        long_about = "Resolves a package and its dependencies, installs them \
550                      if needed, then runs the requested binary directly. By \
551                      default runs the first binary the package provides. \
552                      Uses bwrap for sandboxed packages."
553    )]
554    Exec {
555        /// The package source identifier.
556        #[arg(value_name = "ALL_SOURCES", help = PKG_SOURCE_HELP)]
557        source: String,
558
559        /// Specific binary to run (required if package provides multiple
560        /// binaries)
561        #[arg(long)]
562        bin: Option<String>,
563
564        /// Show additional execution details
565        #[arg(long, short)]
566        verbose: bool,
567
568        /// Arguments to pass to the executed binary
569        #[arg(value_name = "ARGS")]
570        args: Vec<String>
571    },
572
573    /// Clones the git repository of a package
574    Clone {
575        /// The package identifier (e.g. @repo/name, path, or URL)
576        #[arg(value_name = "ALL_PACKAGES", required = true, help = PKG_SOURCE_HELP)]
577        package: String,
578        /// The location to clone the repository to
579        #[arg(value_name = "LOCATION")]
580        location: Option<String>
581    },
582
583    /// Manage Zoi's local cache
584    Cache {
585        /// The cache subcommand to execute.
586        #[command(subcommand)]
587        command: CacheCommands
588    },
589
590    /// Inspect recorded transactions
591    #[command(alias = "tx")]
592    Transaction {
593        /// The transaction subcommand to execute.
594        #[command(subcommand)]
595        command: TransactionCommands
596    },
597
598    /// Manage and author Zoi registries
599    #[command(alias = "reg")]
600    Registry(cmd::registry::RegistryCommand),
601
602    /// Manage declarative user environments (`ZoiOS` only)
603    Home(cmd::home::HomeCommand),
604
605    /// Manage the underlying `ZoiOS` system (`ZoiOS` only)
606    System(cmd::system::SystemCommand),
607
608    /// Manage package repositories
609    #[command(
610        aliases = ["repositories"],
611        long_about = "Manages the list of package repositories used by Zoi.\n\nCommands:\n- add (alias: a): Add an official repo by name or clone from a git URL.\n- remove|rm: Remove a repo from active list (repo rm <name>).\n- list|ls: Show active repositories by default; use 'list all' to show all available repositories.\n- git: Manage cloned git repositories (git ls, git rm <repo-name>)."
612    )]
613    Repo(cmd::repo::RepoCommand),
614
615    /// Manage telemetry settings (opt-in analytics)
616    #[command(long_about = "Manage opt-in anonymous telemetry used to \
617                            understand package popularity. Default is \
618                            disabled.")]
619    Telemetry {
620        /// The telemetry action to perform.
621        #[arg(value_enum)]
622        action: TelemetryAction
623    },
624
625    /// Create an application using a package template
626    Create {
627        /// The package source identifier.
628        #[arg(value_name = "ALL_SOURCES", help = PKG_SOURCE_HELP)]
629        source: String,
630        /// The application name to substitute into template commands
631        app_name: Option<String>
632    },
633
634    /// Downgrade a package to a specific version from local cache or store
635    #[command(
636        alias = "dg",
637        long_about = "Interactively choose and install an older version of a \
638                      package from the local store or archive cache. This is \
639                      useful if a recent update has introduced bugs or \
640                      compatibility issues."
641    )]
642    Downgrade {
643        /// The package identifier.
644        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
645        package: String
646    },
647
648    /// Manage Zoi extensions
649    #[command(alias = "ext")]
650    Extension(ExtensionCommand),
651
652    /// Rollback a package to the previously installed version
653    Rollback {
654        /// The package identifier.
655        #[arg(value_name = "INST_PACKAGES", help = PKG_SOURCE_HELP)]
656        package: String
657    },
658
659    /// Shows a package's manual
660    Man {
661        /// The package identifier.
662        #[arg(value_name = "ALL_PACKAGES", help = PKG_SOURCE_HELP)]
663        package_name: String,
664        /// Always look at the upstream manual even if it's downloaded
665        #[arg(long)]
666        upstream: bool,
667        /// Print the manual to the terminal raw
668        #[arg(long)]
669        raw: bool,
670        /// Do not use the TUI, use the system pager instead
671        #[arg(long)]
672        no_tui: bool
673    },
674
675    /// Build, create, and manage Zoi packages
676    #[command(alias = "pkg")]
677    Package(cmd::package::PackageCommand),
678
679    /// Manage PGP keys for package signature verification
680    Pgp(cmd::pgp::PgpCommand),
681
682    /// Helper commands for various tasks
683    Helper(cmd::helper::HelperCommand),
684
685    /// Checks for common issues and provides actionable suggestions
686    Doctor,
687
688    /// Audit installed or all packages for security vulnerabilities
689    Audit {
690        /// Show all vulnerabilities from the database, not just for installed
691        /// packages
692        #[arg(short, long)]
693        all: bool,
694        /// Filter by registry handle
695        #[arg(long)]
696        registry: Option<String>,
697        /// Filter by repository
698        #[arg(long)]
699        repo: Option<String>
700    },
701
702    /// Execute an external subcommand.
703    #[command(external_subcommand)]
704    External(Vec<String>)
705}
706
707/// The extension management command.
708#[derive(clap::Parser, Debug)]
709pub struct ExtensionCommand {
710    /// The extension subcommand to execute.
711    #[command(subcommand)]
712    pub command: ExtensionCommands
713}
714
715/// The available extension subcommands.
716#[derive(clap::Subcommand, Debug)]
717pub enum ExtensionCommands {
718    /// Add an extension
719    Add {
720        /// The name of the extension to add
721        #[arg(required = true)]
722        name: String
723    },
724    /// Remove an extension
725    Remove {
726        /// The name of the extension to remove
727        #[arg(required = true)]
728        name: String
729    }
730}
731
732/// The available sync subcommands.
733#[derive(clap::Subcommand, Clone)]
734pub enum SyncCommands {
735    /// Add a new registry
736    Add {
737        /// URL of the registry to add
738        url: String
739    },
740    /// Remove a configured registry by its handle
741    Remove {
742        /// Handle of the registry to remove
743        handle: String
744    },
745    /// List configured registries
746    #[command(alias = "ls")]
747    List,
748    /// Set the default registry URL
749    Set {
750        /// URL or keyword (default, github, gitlab, codeberg)
751        url: String
752    }
753}
754
755/// The available cache management subcommands.
756#[derive(clap::Subcommand)]
757pub enum CacheCommands {
758    /// Add package archive(s) to the local cache
759    Add {
760        /// Path to the .zpa archive(s)
761        #[arg(required = true)]
762        files: Vec<std::path::PathBuf>
763    },
764    /// Clear the entire Zoi cache
765    #[command(alias = "clean")]
766    Clear {
767        /// Do not actually clear the cache, just show what would be done
768        #[arg(long)]
769        dry_run: bool
770    },
771    /// List all archives currently in the cache
772    #[command(alias = "ls")]
773    List,
774    /// Manage cache mirrors used for archive downloads
775    Mirror {
776        /// The cache mirror subcommand to execute.
777        #[command(subcommand)]
778        command: CacheMirrorCommands
779    }
780}
781
782/// The available cache mirror management subcommands.
783#[derive(clap::Subcommand)]
784pub enum CacheMirrorCommands {
785    /// Add a cache mirror base URL
786    Add {
787        /// Mirror base URL
788        url: String
789    },
790    /// Remove a cache mirror base URL
791    Remove {
792        /// Mirror base URL
793        url: String
794    },
795    /// List configured cache mirrors
796    #[command(alias = "ls")]
797    List
798}
799
800/// The available transaction management subcommands.
801#[derive(clap::Subcommand)]
802pub enum TransactionCommands {
803    /// List known transaction logs
804    #[command(alias = "ls")]
805    List,
806    /// Show details for a transaction
807    Show {
808        /// Transaction ID
809        id: String
810    },
811    /// List modified files for a transaction
812    Files {
813        /// Transaction ID
814        id: String
815    },
816    /// Undo a transaction by reverting all of its recorded operations.
817    /// Defaults to the most recent transaction when no ID is given.
818    #[command(alias = "rollback")]
819    Undo {
820        /// Transaction ID (defaults to the last transaction)
821        id: Option<String>,
822
823        /// Do not prompt for confirmation
824        #[arg(long)]
825        yes: bool
826    }
827}
828
829/// The available actions for telemetry.
830#[derive(clap::ValueEnum, Clone)]
831enum TelemetryAction {
832    /// Show the current telemetry status.
833    Status,
834    /// Enable anonymous telemetry.
835    Enable,
836    /// Disable anonymous telemetry.
837    Disable
838}
839
840/// The main entry point for the Zoi CLI.
841///
842/// # Errors
843///
844/// Returns an error if argument parsing fails, plugin loading fails, or if any
845/// subcommand fails.
846pub fn run() -> anyhow::Result<()> {
847    let styles = styling::Styles::styled()
848        .header(
849            styling::AnsiColor::Yellow.on_default() | styling::Effects::BOLD
850        )
851        .usage(styling::AnsiColor::Green.on_default() | styling::Effects::BOLD)
852        .literal(styling::AnsiColor::Green.on_default())
853        .placeholder(styling::AnsiColor::Cyan.on_default());
854
855    let commit: &str = option_env!("ZOI_COMMIT_HASH").unwrap_or("dev");
856    let cmd = Cli::command().styles(styles.clone());
857    let matches = cmd.clone().get_matches();
858    let cli = match Cli::from_arg_matches(&matches) {
859        Ok(cli) => cli,
860        Err(err) => {
861            err.print()?;
862            return Err(anyhow::anyhow!("Failed to parse arguments"));
863        }
864    };
865
866    if let Some(root) = cli.root {
867        crate::pkg::sysroot::set_sysroot(root);
868    }
869
870    let config = crate::pkg::config::read_config().unwrap_or_default();
871
872    let is_offline = cli.offline || config.offline_mode;
873    crate::pkg::offline::set_offline(is_offline);
874
875    let mut all_pkg_dirs = cli.pkg_dirs;
876    for dir in config.pkg_dirs {
877        let path = std::path::PathBuf::from(dir);
878        if !all_pkg_dirs.contains(&path) {
879            all_pkg_dirs.push(path);
880        }
881    }
882    crate::pkg::pkgdir::set_pkg_dirs(all_pkg_dirs);
883
884    utils::check_path();
885
886    if let Err(e) = crate::pkg::pgp::ensure_builtin_keys() {
887        eprintln!(
888            "{}: Failed to ensure builtin PGP keys: {}",
889            "Warning".yellow(),
890            e
891        );
892    }
893
894    let plugin_manager = crate::pkg::plugin::PluginManager::new()?;
895    if let Err(e) = plugin_manager.load_all(cli.yes) {
896        eprintln!("{}: Failed to load plugins: {}", "Warning".yellow(), e);
897    }
898
899    if cli.version_flag {
900        cmd::version::run(BRANCH, STATUS, NUMBER, commit);
901        return Ok(());
902    }
903
904    if let Some(command) = cli.command {
905        let needs_lock = matches!(
906            command,
907            Commands::Install { .. }
908                | Commands::Uninstall { .. }
909                | Commands::Update { .. }
910                | Commands::Autoremove { .. }
911                | Commands::Rollback { .. }
912                | Commands::Package(_)
913        );
914
915        let _lock_guard = if needs_lock {
916            Some(lock::acquire_lock()?)
917        } else {
918            None
919        };
920
921        let result = match command {
922            Commands::GenerateCompletions { shell } => {
923                let mut cmd = Cli::command();
924                let bin_name = cmd.get_name().to_string();
925                generate(shell, &mut cmd, bin_name, &mut io::stdout());
926                Ok(())
927            }
928            Commands::Complete {
929                shell,
930                index,
931                words
932            } => cmd::complete::run(shell, index, &words),
933            Commands::Version => {
934                cmd::version::run(BRANCH, STATUS, NUMBER, commit);
935                Ok(())
936            }
937            Commands::About => {
938                cmd::about::run(BRANCH, STATUS, NUMBER, commit);
939                Ok(())
940            }
941            Commands::Info => cmd::info::run(BRANCH, STATUS, NUMBER, commit),
942            Commands::Sync {
943                command,
944                verbose,
945                fallback,
946                no_package_managers,
947                force,
948                local,
949                frozen,
950                scope
951            } => {
952                if let Some(cmd) = command {
953                    match cmd {
954                        SyncCommands::Add { url } => {
955                            cmd::sync::add_registry(&url)
956                        }
957                        SyncCommands::Remove { handle } => {
958                            cmd::sync::remove_registry(&handle)
959                        }
960                        SyncCommands::List => cmd::sync::list_registries(),
961                        SyncCommands::Set { url } => {
962                            cmd::sync::set_registry(&url)
963                        }
964                    }
965                } else if local {
966                    plugin_manager.trigger_hook("on_pre_sync", None)?;
967                    let res =
968                        cmd::sync::run_local(verbose, fallback, force, frozen);
969                    plugin_manager.trigger_hook_nonfatal("on_post_sync", None);
970                    res
971                } else {
972                    plugin_manager.trigger_hook("on_pre_sync", None)?;
973                    let res = cmd::sync::run(
974                        verbose,
975                        fallback,
976                        no_package_managers,
977                        force,
978                        scope
979                    );
980                    plugin_manager.trigger_hook_nonfatal("on_post_sync", None);
981                    res
982                }
983            }
984            Commands::Migrate(args) => cmd::migrate::run(args),
985            Commands::List {
986                all,
987                outdated,
988                registry,
989                repo,
990                package_type,
991                foreign,
992                names,
993                completion
994            } => cmd::list::run(
995                all,
996                outdated,
997                registry.as_deref(),
998                repo.as_deref(),
999                package_type.as_deref(),
1000                foreign,
1001                names,
1002                completion
1003            ),
1004            Commands::Show {
1005                package_name,
1006                raw,
1007                purl
1008            } => cmd::show::run(&package_name, raw, purl),
1009            Commands::Pin { package, version } => {
1010                cmd::pin::run(&package, &version)
1011            }
1012            Commands::Provides { term } => cmd::provides::run(&term),
1013            Commands::Tree { packages } => cmd::tree::run(&packages),
1014            Commands::Unpin { package } => cmd::unpin::run(&package),
1015            Commands::Mark {
1016                packages,
1017                as_dependency,
1018                as_explicit
1019            } => cmd::mark::run(&packages, as_dependency, as_explicit),
1020            Commands::Update {
1021                package_names,
1022                all,
1023                dry_run,
1024                explain,
1025                plan_json,
1026                verbose,
1027                interactive
1028            } => cmd::update::run(
1029                all,
1030                &package_names,
1031                cli.yes,
1032                dry_run,
1033                explain,
1034                plan_json,
1035                verbose,
1036                interactive
1037            )
1038            .map_err(|e| cmd::ux::with_failure_hint("update", e)),
1039            Commands::Install(args) => args
1040                .run(cli.yes)
1041                .map_err(|e| cmd::ux::with_failure_hint("install", e)),
1042            Commands::Use { packages, global } => {
1043                cmd::use_cmd::run(&packages, global)
1044            }
1045            Commands::Uninstall(args) => args
1046                .run(cli.yes)
1047                .map_err(|e| cmd::ux::with_failure_hint("uninstall", e)),
1048            Commands::Run { cmd_alias, args } => {
1049                cmd::run::run(cmd_alias.as_deref(), &args)
1050            }
1051            Commands::Env {
1052                env_alias,
1053                export_shell
1054            } => cmd::env::run(env_alias.as_deref(), export_shell),
1055            Commands::Dev { run, repo } => cmd::dev::run(run, repo),
1056            Commands::Upgrade { force, tag, branch } => {
1057                match cmd::upgrade::run(
1058                    BRANCH, STATUS, NUMBER, force, tag, branch
1059                ) {
1060                    Ok(()) => {
1061                        println!(
1062                            "\n{}",
1063                            "Zoi upgraded successfully! Please restart your \
1064                             shell for changes to take effect."
1065                                .green()
1066                        );
1067                        println!(
1068                            "\n{}: https://github.com/zillowe/zoi/blob/main/CHANGELOG.md",
1069                            "Changelog".cyan().bold()
1070                        );
1071                        println!(
1072                            "\n{}: To update shell completions, run 'zoi \
1073                             shell <your-shell>'.",
1074                            "Hint".cyan().bold()
1075                        );
1076                    }
1077                    Err(e) if e.to_string() == "already_on_latest" => {}
1078                    Err(e) if e.to_string() == "managed_by_package_manager" => {
1079                    }
1080                    Err(e) => return Err(e)
1081                }
1082                Ok(())
1083            }
1084            Commands::Autoremove { dry_run } => {
1085                cmd::autoremove::run(cli.yes, dry_run)
1086            }
1087            Commands::Why { package_name } => cmd::why::run(&package_name),
1088            Commands::Owner { path } => cmd::owner::run(&path),
1089            Commands::Files { package } => cmd::files::run(&package),
1090            Commands::History {
1091                verify,
1092                export,
1093                ndjson
1094            } => cmd::history::run(verify, export, ndjson),
1095            Commands::Search {
1096                search_term,
1097                registry,
1098                repo,
1099                package_type,
1100                tags,
1101                sort,
1102                files,
1103                interactive
1104            } => cmd::search::run(
1105                &search_term,
1106                registry.as_deref(),
1107                repo.as_deref(),
1108                package_type.as_deref(),
1109                tags,
1110                &sort,
1111                files,
1112                interactive
1113            ),
1114            Commands::Service(args) => cmd::service::run(args),
1115            Commands::Shell {
1116                shell,
1117                hook,
1118                scope,
1119                packages,
1120                run,
1121                verbose
1122            } => {
1123                let target_shell = shell
1124                    .or_else(crate::pkg::utils::get_current_shell)
1125                    .unwrap_or(Shell::Bash);
1126                if hook {
1127                    cmd::shell::print_hook(target_shell)
1128                } else if !packages.is_empty() {
1129                    cmd::shell::enter_ephemeral_shell(
1130                        &packages,
1131                        run,
1132                        verbose,
1133                        Some(&plugin_manager)
1134                    )
1135                } else {
1136                    cmd::shell::run(target_shell, scope)
1137                }
1138            }
1139            Commands::Exec {
1140                source,
1141                bin,
1142                verbose,
1143                args
1144            } => cmd::exec::run(&source, bin, &args, verbose),
1145            Commands::Download {
1146                package,
1147                archive: _,
1148                source,
1149                output_dir
1150            } => {
1151                let download_type = if source {
1152                    cmd::download::DownloadType::Source
1153                } else {
1154                    cmd::download::DownloadType::Archive
1155                };
1156                cmd::download::run(&package, download_type, output_dir)
1157            }
1158            Commands::Clone { package, location } => {
1159                cmd::clone::run(&package, location, cli.yes)
1160            }
1161            Commands::Cache { command } => match command {
1162                CacheCommands::Add { files } => cmd::cache::add(&files),
1163                CacheCommands::Clear { dry_run } => cmd::cache::clear(dry_run),
1164                CacheCommands::List => cmd::cache::list(),
1165                CacheCommands::Mirror { command } => match command {
1166                    CacheMirrorCommands::Add { url } => {
1167                        cmd::cache::add_mirror(&url)
1168                    }
1169                    CacheMirrorCommands::Remove { url } => {
1170                        cmd::cache::remove_mirror(&url)
1171                    }
1172                    CacheMirrorCommands::List => cmd::cache::list_mirrors()
1173                }
1174            },
1175            Commands::Transaction { command } => match command {
1176                TransactionCommands::List => cmd::transaction::list(),
1177                TransactionCommands::Show { id } => cmd::transaction::show(&id),
1178                TransactionCommands::Files { id } => {
1179                    cmd::transaction::files(&id)
1180                }
1181                TransactionCommands::Undo { id, yes } => {
1182                    cmd::transaction::undo(id.as_deref(), yes, cli.yes)
1183                }
1184            },
1185            Commands::Repo(args) => cmd::repo::run(args),
1186            Commands::Registry(args) => cmd::registry::run(args),
1187            Commands::Home(args) => cmd::home::run(args),
1188            Commands::System(args) => cmd::system::run(args, cli.yes),
1189            Commands::Telemetry { action } => {
1190                use cmd::telemetry::{TelemetryCommand, run};
1191                let cmd = match action {
1192                    TelemetryAction::Status => TelemetryCommand::Status,
1193                    TelemetryAction::Enable => TelemetryCommand::Enable,
1194                    TelemetryAction::Disable => TelemetryCommand::Disable
1195                };
1196                run(cmd)
1197            }
1198            Commands::Create { source, app_name } => cmd::create::run(
1199                cmd::create::CreateCommand { source, app_name },
1200                cli.yes,
1201                Some(&plugin_manager)
1202            ),
1203            Commands::Downgrade { package } => {
1204                cmd::downgrade::run(&package, cli.yes, Some(&plugin_manager))
1205            }
1206            Commands::Extension(args) => {
1207                cmd::extension::run(args, cli.yes, Some(&plugin_manager))
1208            }
1209            Commands::Rollback { package } => {
1210                cmd::rollback::run(&package, cli.yes, Some(&plugin_manager))
1211            }
1212            Commands::Man {
1213                package_name,
1214                upstream,
1215                raw,
1216                no_tui
1217            } => cmd::man::run(&package_name, upstream, raw, no_tui),
1218            Commands::Package(args) => cmd::package::run(args),
1219            Commands::Pgp(args) => cmd::pgp::run(args),
1220            Commands::Helper(args) => cmd::helper::run(args),
1221            Commands::Doctor => cmd::doctor::run(),
1222            Commands::Audit {
1223                all,
1224                registry,
1225                repo
1226            } => cmd::audit::run(all, registry, repo.as_deref()),
1227            Commands::External(args) => {
1228                let (cmd_name, cmd_args) =
1229                    if let Some((first, rest)) = args.split_first() {
1230                        (first, rest.to_vec())
1231                    } else {
1232                        return Err(anyhow::anyhow!("No command specified"));
1233                    };
1234
1235                match plugin_manager.run_command(cmd_name, cmd_args) {
1236                    Ok(true) => Ok(()),
1237                    Ok(false) => {
1238                        let mut shadow_cmd = Cli::command().styles(styles);
1239                        shadow_cmd =
1240                            shadow_cmd.allow_external_subcommands(false);
1241
1242                        let err = shadow_cmd
1243                            .clone()
1244                            .try_get_matches_from(std::env::args())
1245                            .err()
1246                            .unwrap_or_else(|| {
1247                                shadow_cmd.error(
1248                                    clap::error::ErrorKind::InvalidSubcommand,
1249                                    format!(
1250                                        "unrecognized subcommand '{cmd_name}'"
1251                                    )
1252                                )
1253                            });
1254
1255                        let plugin_cmds = plugin_manager.list_commands()?;
1256                        if !plugin_cmds.is_empty() {
1257                            eprintln!(
1258                                "{}:",
1259                                "Available Plugin Commands".cyan().bold()
1260                            );
1261                            for (pcmd, pdesc) in plugin_cmds {
1262                                if pdesc.is_empty() {
1263                                    eprintln!("  {pcmd}");
1264                                } else {
1265                                    eprintln!(
1266                                        "  {:<12} {}",
1267                                        pcmd,
1268                                        pdesc.dimmed()
1269                                    );
1270                                }
1271                            }
1272                            eprintln!();
1273                        }
1274
1275                        err.exit();
1276                    }
1277                    Err(e) => Err(e)
1278                }
1279            }
1280        };
1281
1282        if let Err(e) = result {
1283            eprintln!("Error: {e}");
1284            std::process::exit(1);
1285        }
1286    }
1287    Ok(())
1288}
zoi_cli/cli.rs

zoi_cli/
cli.rs
