Skip to main content

📦 Packages

Find a tool, open its card, and choose an installation profile. Zi packages provide reusable configurations for installing software and setting up your shell.

New to packages? Read the Package guide for setup, profiles, updates, and adding a package.

Before installing

Load Zi first. Many packages also need bin-gem-node or other tools listed in their cards. Review the package repository and your platform requirements before running an installation command.

Browse packages​

any-gem​

Install Ruby gems locally with executable shims.GemView installation optionsHide details
Before you install

Requires Ruby, RubyGems, and bin-gem-node. Set GEM to the gem you want and use a distinct id-as for each installation kept in .zshrc.

Additional current prerequisite

The package manifest also declares npm as a prerequisite. Zi enforces that declaration even though this recipe installs gems, so npm must currently be available too.

Install with Zi​

Installation command
zi id-as=ruby-on-rails pack param='GEM -> rails' for any-gem

any-node​

Install Node modules locally with executable shims.NodeView installation optionsHide details
Before you install

Requires Node.js, npm, and bin-gem-node. Set MOD to the module you want; additional modules use MOD2, MOD3, and so on.

Install with Zi​

Installation command
zi id-as=doctoc pack param='MOD -> doctoc' for any-node

Use a distinct id-as for each installation kept in .zshrc.

apr​

Apache Portable Runtime library for portable applications.Source tarballView installation optionsHide details
Before you install

Requires the readurl annex and a C build toolchain.

Download, build and install the latest Apache Portable Runtime.

Install with Zi​

Installation command
zi pack for apr

asciidoctor​

Convert AsciiDoc documents to HTML, DocBook, and other formats.GemView installation optionsHide details
Before you install

Requires Ruby, RubyGems, and bin-gem-node.

Download the Gem of asciidoctor locally with the bin-gem-node annex.

tip

Using the @ prefix because of collision with the as'' ice.

Install with Zi​

Installation command
zi pack for @asciidoctor

brew-completions​

Bring Homebrew's Zsh completions under Zi's control.Local filesView installation optionsHide details
Before you install

Requires brew in PATH and completion files in share/zsh/site-functions beneath the Homebrew prefix. The recipe discovers that prefix with brew --prefix.

Install with Zi​

Installation command
zi pack for brew-completions

Initialize the Zsh completion system after loading your completion packages.

dircolors-material​

Material colors for directory listings and Zsh completions.GitView installation optionsHide details
Before you install

Requires GNU dircolors and sed (GNU-prefixed tools on macOS).

Installation profiles​

Download the default profile.

Installation command
zi pack for dircolors-material

doctoc​

Generate a table of contents for Markdown documents.NodeView installation optionsHide details
Before you install

Requires Node.js, npm, and bin-gem-node.

Install doctoc locally through npm.

Install with Zi​

Installation command
zi pack for doctoc

ecs-cli​

Work with Amazon ECS using the ECS command-line interface.BinaryView installation optionsHide details
Before you install

The package selects an AMD64 binary for Linux or macOS. The shim profile requires bin-gem-node.

Installation profiles​

Download the binary of the Amazon-ECS-CLI command.

Installation command
zi pack for ecs-cli

firefox-dev​

Firefox Developer Edition with web development tools.BinaryView installation optionsHide details
Before you install

The download recipe selects Linux or macOS. Check the upstream platform requirements before installing; the shim profile requires bin-gem-node.

Installation profiles​

Download the firefox-dev latest binary.

Installation command
zi pack for firefox-dev

fzf​

An interactive command-line fuzzy finder.GitBinaryView installation optionsHide details
Before you install

Git profiles build from source and require Go, Make, and cp. Shim profiles require bin-gem-node.

Installation profiles​

Build from Git with the default profile.

Installation command
zi pack for fzf

fzy​

A small, fast fuzzy finder for the command line.GitView installation optionsHide details
Before you install

Requires a C compiler, Make, and cp. Shim profiles require bin-gem-node.

Installation profiles​

Download the package with the default profile.

Installation command
zi pack for fzy

github-issues​

Display shell notifications for GitHub issues.GitLegacy manifestView installation optionsHide details
Before you install

This is the notification half of a two-package setup. Load github-issues-srv as well to retrieve updates.

Legacy metadata

This package uses zplugin-ices in its manifest. Zi's current main reader accepts this legacy spelling when zi-ices is absent. Use zi-ices when authoring new package metadata.

Installation profiles​

Display notifications with the default message prefix.

Installation command
zi pack for @github-issues

github-issues-srv​

Retrieve GitHub issue updates for shell notifications.GitLegacy manifestView installation optionsHide details
Before you install

Runs the retrieval service used by github-issues. The upstream setup polls GitHub in the background, with a documented default interval of two minutes. Review the upstream configuration before enabling it.

Legacy metadata

The manifest uses the legacy zplugin-ices spelling. Zi's current main reader accepts it when zi-ices is absent; new package metadata should use zi-ices.

Install with Zi​

Installation command
zi pack for @github-issues-srv

ls_colors​

File-type colors for directory listings and Zsh completions.GitView installation optionsHide details
Before you install

Requires GNU dircolors and sed (GNU-prefixed tools on macOS).

Installation profiles​

Download the default profile.

Installation command
zi pack for ls_colors

nb​

Take notes, bookmark, and archive with Git-backed storage.GitView installation optionsHide details
Before you install

Requires Bash and bin-gem-node. See the package repository for optional tools used by individual features.

The default profile exposes nb through bin-gem-node shims.

Install with Zi​

Installation command
zi pack for nb

pyenv​

Install and switch between Python versions.GitView installation optionsHide details
Before you install

Requires Bash and bin-gem-node. Building Python versions also requires the dependencies listed in the pyenv documentation.

Installation profiles​

Clone pyenv and initialize it in Zsh.

Installation command
zi pack for pyenv

remark​

Process Markdown and produce HTML or manual pages.NodeView installation optionsHide details
Before you install

Requires Node.js, npm, and bin-gem-node.

Installation profiles​

Download the Node package of remark-CLI, remark-man and remark-HTML

Installation command
zi pack for remark

subversion​

The Apache Subversion version-control client.Source tarballView installation optionsHide details
Before you install

Requires APR, the readurl annex, and a C build toolchain.

Download, build and install the latest Subversion.

tip

Dependency of Subversion: APR

Install with Zi​

Installation command
zi pack for subversion

system-completions​

Manage the system's stock Zsh completions with Zi.Local filesView installation optionsHide details
Before you install

This recipe imports existing completions from /usr/share/zsh/functions/Completion/*. It requires that directory layout; it is not suitable unchanged for systems that store completions elsewhere.

Install with Zi​

Installation command
zi pack for system-completions

Initialize the Zsh completion system after loading your completion packages. You can then manage individual completions with Zi's cenable and cdisable commands.

zsh​

Build Zsh from its source mirror.GitView installation optionsHide details
Before you install

Requires a C compiler, Make, and the upstream Zsh build prerequisites. Yodl is needed to build manual pages.

Installation profiles​

Install the newest Zsh.

Installation command
zi pack for zsh

zsh-bin​

Prebuilt, relocatable Zsh with rootless installation options.GitBinaryView installation optionsHide details
Before you install

The default profile writes to /usr/local and attempts to register a login shell. Choose Rootless for a user-local installation or Shims with bin-gem-node.

Installation profiles​

Requires root access to install Zsh at /usr/local and will attempt to register it as a login shell.

Installation command
zi pack for zsh-bin

Find more packages in the Z-Shell package repositories.