Skip to content

Home

Jump to bottom
Stig-Ørjan Smelror edited this page Mar 10, 2024 · 11 revisions

zrep - Zsh Repository Tool

Welcome to the official Wiki for zrep, a comprehensive Zsh Repository Tool designed to enhance your Zsh experience. Developed with flexibility and ease of use in mind, zrep allows for the efficient management of Zsh functions, scripts, and addons.

zrep is meant to be used on a per user basis and not globally. This means that you, the user, have full control over what is installed and activated.

Features

  • Version Control: Easily track the version of your zrep installation with a straightforward versioning system.
  • Dynamic Function Path Management: Automatically adds directories containing at least one file to fpath.
  • Modular Design: Supports the installation, removal, and management of Zsh addons and scripts.
  • Configuration via .zreprc: Customizable settings through a dedicated configuration file.

Getting Started

Installation

  1. Clone the zrep repository to your local machine.
  2. Run the script with zrep init to initialize the installation process.

Configuration

Upon first run, zrep will prompt you to specify the installation directory, defaulting to $HOME/.zrep if left unspecified. This path will be used to store scripts, functions, and configuration files.

.zreprc Configuration

The .zreprc file located in your home directory ($HOME/.zreprc) contains all configurable settings for zrep. Initially, this file will include the installation directory path. You can edit this file to adjust zrep settings to your liking.

Usage

Basic Commands

  • zrep init: Initializes zrep, setting up necessary directories and configuration files.
  • zrep install <author/package>: Installs a specified package.
  • zrep remove <author/package>: Removes a specified package.
  • zrep enable <author/package>: Enables a package, adding it to your fpath.
  • zrep disable <author/package>: Disables a package, removing it from your fpath.
  • zrep list: Lists all installed packages along with their status (active/inactive).
  • zrep <author/package> help: Show the included usage information for package.

Advanced Features

  • Color Customization: Customize console output colors by editing the colors associative array within the script.
  • Package Management: Leverage zrep to manage external Zsh scripts and functions efficiently, keeping your shell environment clean and organized.

Contributing

Contributions to zrep are welcome! Whether it's adding new features, improving existing ones, or fixing bugs, your help is appreciated. Please follow the standard GitHub pull request process to submit your contributions.

License

zrep is licensed under the MIT License. See the LICENSE file for more details.

For more detailed information on each command and feature, please refer to the corresponding sections of this Wiki or the zrep script comments.

Clone this wiki locally