Skip to content

doubleailes/rez_nushell_plugin

Repository files navigation

Rez Nushell Plugin

This project is a plugin for the Rez package management system, enabling integration with Nushell, a modern shell designed for structured data.

Features

  • Provides support for using Rez with Nushell.
  • Implements environment variable handling specific to Nushell.
  • Nushell comppletion support for Rez commands.

Requirements

  • Python >= 3.9
  • Rez >= 3.2.1
  • Nushell installed on your system

Installation

  1. Clone this repository:

    git clone https://github.com/doubleailes/rez_nushell_plugin.git
  2. Set the plugin path:

    Set the REZ_PLUGIN_PATH environment variable to include the path to this plugin. You can do this by adding the following line to your shell configuration file. The path should point to the rez_nushell directory in the cloned repository.

    $env.REZ_PLUGIN_PATH = './src/rez_nushell/'
  3. Optional: You can add autocompletion for Rez commands in Nushell by adding the following line to your Nushell configuration file:

    source ./rez-completions.nu

Usage

Once set, you can use Rez with Nushell by specifying nu as the shell type. For example:

rez-env my_package -- shell nu

Or simply use rez commands as you would in any other shell in a Nushell session.

Development

To contribute to this project:

  1. Fork the repository and create a new branch for your feature or bugfix.
  2. Make your changes and ensure they are well-tested.
  3. Submit a pull request with a detailed description of your changes.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Acknowledgments

This plugin is inspired by the Rez project and aims to extend its functionality to support modern shells like Nushell.

About

A plugin to use Nushell with Rez as a shell

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors