Zoi

Universal Package Manager & Environment Setup Tool

Zoi is a universal package manager and environment setup tool, designed to simplify package management and environment configuration across multiple operating systems.

✨ Features

• Cross-Platform: Works seamlessly on Linux, macOS, and Windows.
• Universal Package Support: Install packages from various sources: binaries, compressed archives, build from source, or installer scripts.
• Extensive Dependency Management: Integrates with over 30+ package managers (apt, brew, cargo, npm, pip, scoop, etc.) to handle dependencies.
• Rich Dependencies: Packages can define runtime and build dependencies with required, optional, and selectable options groups.
• Project Environments: Easily define and manage project-specific environments and commands using zoi.yaml.
• Repository-Based: Manage packages from official or community repositories. Easily add your own.
• Intuitive CLI: A simple and powerful command-line interface with helpful aliases for a better developer experience.
• Package Types: Supports standard packages, meta-packages (collections), background services, and configuration file management.
• Secure Package Distribution: Support for checksums and GPG signatures to verify package integrity and authenticity.
• Tag-based Discovery: Search by and filter packages using tags for faster discovery.

🚀 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 hello
   

📦 Installation

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

Package Managers

Arch Linux (AUR)

Install zoi-bin (Pre-compiled binary) or zoi (built from source) from the AUR using your favorite helper (e.g. yay, paru):

yay -S zoi-bin

Or manually without any helpers:

git clone https://aur.archlinux.org/zoi-bin.git
cd zoi-bin
makepkg -si

macOS (Homebrew)

Install Zoi using Homebrew:

brew install Zillowe/tap/zoi

Windows (Scoop)

Install Zoi using Scoop:

scoop bucket add zillowe https://github.com/Zillowe/scoop.git
scoop install zoi

Crates.io

You can install zoi-cli directly from crates.io using cargo:

cargo install zoi-cli

NPM

You can install @zillowe/zoi from npm also.

npx @zillowe/zoi
bunx @zillowe/zoi
pnpm dlx @zillowe/zoi
yarn dlx @zillowe/zoi

📜 Scripts

You can also use our installer scripts for a quick setup.

Linux / macOS :

curl -fsSL https://gitlab.com/Zillowe/Zillwen/Zusty/Zoi/-/raw/main/app/install.sh | bash

Windows:

powershell -c "irm gitlab.com/Zillowe/Zillwen/Zusty/Zoi/-/raw/main/app/install.ps1|iex"

🛠️ Build from Source

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

Build the release binary:

# For Linux/macOS
./build/build-release.sh

# For Windows
./build/build-release.ps1

Install it locally:

./configure
make
sudo make install
# Install CLI completions (bash, zsh, fish, elvish, powershell)
make install-completion

💻 Platforms

What platforms we currently support.

We're planning to add support for more platforms.

🔗 Dependencies Support

What dependency installation we support.

For more dependencies information please visit the Dependencies Page on Docs.

Some of the package manager are OS specific, so when a dependency is in that package manager it only installs it for that OS.

But some other package managers like npm, it installs the dependency if the package manager is available.

💡 Usage

Here are some common commands to get you started.

• Install a package:

  zoi install <package_name>
  

• Uninstall a package:

  zoi uninstall <package_name>
  

• Install from a specific repository:

  zoi install @<repo_name>/<package_name>
  

• List all available packages from active repos:

  zoi list --all
  

• List packages from a specific repo:

  zoi list --all --repo <repo_name>
  

• Search for a package:

  zoi search <term>
  

• Search for a package from a specific repo:

  zoi search <term> @<repo_name>
  

• Add a new repository:

  # Interactively
  zoi repo add
  
  # By name
  zoi repo add <repo_name>
  # From a git repo
  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.

📦 Packaging Status

🤝 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:

• Zoi Source Code (this repo)

  • Primary: GitLab
  • Mirrors: GitHub, Codeberg

• Packages Database (Zoi-Pkgs)

  • Primary: GitLab
  • Mirrors: GitHub, Codeberg

Repository tiers

• Core: Essential packages, libraries and very common/maintained packages.
• Main: Packages that don't fit in Core but are essential for most people.
• Extra: Packages that are new, not very common or maintained, not preferable.
• Community: User submitted packages that are new, can be upgraded to a higher repo.
• Test: Testing repo for new Zoi features and for new packages before release.
• Archive: Archived packages that are no longer maintained.

For details and CLI usage examples, see the docs page: Repositories.

📜 License

Zoi is licensed under the Apache-2.0 License.