zoi-rs 1.25.3

Advanced Package Manager & Environment Orchestrator
Documentation

Zoi is an advanced package manager and environment orchestrator, designed to simplify package management and environment configuration across multiple operating systems.

Features

  • Cross-Platform: Works seamlessly on Linux, macOS, and Windows.
  • Just-in-Time Privilege Escalation: Automatically prompts for sudo or doas only when system-wide operations are required, keeping your environment and caches cleanly in user-space.
  • Dynamic Package Definitions: Define packages with dynamic Lua scripts (.pkg.lua) for maximum flexibility.
  • ZoiOS Distro Engine: Bootstrap and manage entire Linux distributions declaratively.
  • Extensive Dependency Management: Integrates with over 40 system and language package managers (apt, brew, cargo, npm, pip, go, bun, etc.).
  • Version Multiplexing via Intelligent Shims: Automatically switch between different versions of the same tool (e.g. Node.js 18 vs 20) based on your project context (zoi.lua) or legacy configuration files (.nvmrc) through its extensible Lua plugin system.
  • Rich Dependencies: Define runtime and build dependencies with required, optional, and selectable options.
  • Project Environments: Manage project-specific commands and environments using a local zoi.yaml or a zoi.lua file.
  • Repository-Based: Use official, community, or your own private/public Git-based repositories.
  • Secure & Verifiable: Verifies package integrity with checksums and authenticity with GPG signatures. Supports Git commit signature verification for entire registries (Chain of Trust) and includes a built-in PGP keyring for out-of-the-box security.
  • Decentralized Security Advisories: Automated vulnerability tracking via .sec.yaml files co-located with packages. Zoi proactively warns you during installation or upgrades if a package has known security issues.
  • Compliance & Audit Logging: Maintain a persistent, tamper-evident audit log of all package operations (install, uninstall, upgrade), viewable via the zoi history command.
  • Advanced Dependencies: Supports virtual packages (provides) and package replacement (replaces).
  • Versatile Package Types: Supports different types of packages:
    • Package: A standard software package.
    • Collection: A meta-package that groups other packages together.
    • App: A template for bootstrapping new projects (zoi create).
    • Extension: A package to extend Zoi's own functionality or configuration.
  • Local Package Development: A dedicated zoi package command set (build, bundle, install, doctor, init-lsp) to streamline creating, linting, and testing packages locally.
  • Advanced CLI Tools:
    • zoi man: Read package manuals in the terminal.
    • zoi audit: Scan installed packages for known security vulnerabilities.
    • zoi clone: Clone a package's git repository.
    • zoi download: Download a package archive (.zpa) or source bundle (.zsa).
    • zoi why: Understand why a package is installed.
    • zoi rollback: Revert a package to its previous version or roll back the newest remaining transaction log.
    • zoi pin: Pin a package to a specific version.
    • zoi exec: Run a package's binary without installing it.
    • zoi dev: Enter a project-specific development shell with all dependencies.
  • Zoi Mini: A lightweight, zero-sync version for quick, one-off installations via zm.sh or zm.ps1. Supports install, update, uninstall, and list commands.
  • Library Support: Core functionality is available as a Rust library to be integrated into other applications.

Special Thanks

Thanks you all for helping with developing Zoi.

Getting Started

Getting started with Zoi is simple. Just follow these three steps:

  1. Install Zoi: Choose one of the installation methods below.

  2. Sync Repositories: Before you can install packages, you need to sync the package repositories.

    zoi sync

  3. Install a Package: Now you can install any package you want. For example, to install hello:

    zoi install @zillowe/hello

Installation

You can install Zoi using a package manager, an installer script, or by building it from source.

Scripts

You can use our installer scripts for a quick setup.

Linux / macOS :

curl -fsSL https://zillowe.pages.dev/scripts/zoi/install.sh | bash

Or if you want a truly safe way to run this script use ZSM.

curl -fsSL https://zillowe.pages.dev/scripts/zoi/install.zsm | zsm

Windows:

powershell -c "irm zillowe.pages.dev/scripts/zoi/install.ps1|iex"

Don't see your preferred installation method here? It's probably in INSTALL.md.

Build from Source

If you prefer, you can build Zoi from source. You'll need Rust installed.

Build the release binary:

./configure
just build

Install it locally:

sudo just install

Zoi Mini

Zoi Mini is a lightweight, zero-sync version of Zoi that allows you to install packages from the official Zoidberg registry without installing the full Zoi suite. It's designed for quick, one-off installations and supports basic management commands: install, update, uninstall, and list.

Quick Start (Zero-Install)

You can install any package from the Zoidberg registry using a single command:

Linux / macOS :

curl -fsSL https://zillowe.pages.dev/zm.sh | sh -s -- i @zillowe/hello

Windows (amd64):

powershell -c "irm zillowe.pages.dev/zm.ps1 | iex" -args "i @zillowe/hello"

This will download the zoi-mini binary to a temporary location, resolve the package metadata dynamically, and perform the installation.

Usage

Here are some common commands to get you started.

  • Install a package:

    zoi install <package_name>

  • Uninstall a package:

    zoi uninstall <package_name>

  • Update packages:

    # Update all installed packages
zoi update --all

# Update specific packages
zoi update <package1> <package2>

  • Search for a package:

    # Standard search
zoi search <term>

# Interactive TUI mode
zoi search <term> -i

  • Find which package provides a command:

    zoi provides <command>

  • View dependency tree:

    zoi tree <package_name>

  • View operation history:

    zoi history

  • Show package details:

    zoi show <package_name>

  • Run a project command:

    # Run a command defined in zoi.yaml
zoi run <command_alias>

  • Enter a development shell:

    # Enter a subshell with project dependencies available
zoi dev

  • Run a command without installing the package:

    zoi exec <package_name> -- <command>

  • Enter an ephemeral shell with packages:

    zoi shell -p <package1> <package2>

  • Create a new project from a template:

    zoi create <app_template> <project_name>

  • Add a new repository:

    # Interactively
zoi repo add

# By name from the default registry
zoi repo add <repo_name>

# From a git repo URL
zoi repo add https://github.com/<user_name>/<repo_name>.git

  • Update Zoi to the latest version:

    zoi upgrade

For more detailed information, please refer to the Docs.

Contributing

We welcome contributions from the community! If you'd like to contribute, please read our Contributing Guidelines for more information.

New features, enhancements and bug reports are welcome.

Repositories & Mirrors

Zoi is hosted on multiple forges. The primary locations and mirrors are:

For details and CLI usage examples about Zoidberg registry, see the docs page: Zoidberg.

License

Zoi is licensed under the Apache 2.0 License.