https://github.com/ypares/nushellwith

Isolated nushell envs with specific plugins and libraries (with Nix)
https://github.com/ypares/nushellwith

nix nix-flakes nu nushell

Last synced: 24 days ago
JSON representation

Isolated nushell envs with specific plugins and libraries (with Nix)

• Host: GitHub
• URL: https://github.com/ypares/nushellwith
• Owner: YPares
• Created: 2024-09-16T14:12:07.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2024-10-27T06:15:16.000Z (24 days ago)
• Last Synced: 2024-10-27T06:48:57.455Z (24 days ago)
• Topics: nix, nix-flakes, nu, nushell
• Language: Nix
• Homepage:
• Size: 69.3 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![built with garnix](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2FYPares%2FnushellWith%3Fbranch%3Dmaster)](https://garnix.io/repo/YPares/nushellWith)

# nushellWith

Build an isolated [nushell](https://www.nushell.sh/) environment with a specific set of plugins (from

either nixpkgs or built from source) and nu libraries (from source).

See the [`examples`](./examples) folder for how to use it. Examples show usage with regular nix

flakes and with [`devenv`](http://devenv.sh).

## Outputs of this flake

- the flake itself (or [`lib.nushellWith`](./nix-src/nushell-with.nix)): a function

  that takes a description of a nushell configuration (which libraries, plugins and

  `config.nu` & `env.nu` files to use) and outputs a nushell wrapper. This nushell

  wrapper derivation also has the following attributes:

  - `plugins-env`: a nix env (from `pkgs.buildEnv`) containing symlinks to all

      the wanted plugins. This can be useful if you want a set of plugins grouped

      together in one place.

- [`lib.makeNuLibrary`](./nix-src/lib.nix): a function that takes a nushell library as a

  folder (e.g. obtained from github via one of your flake inputs flagged with

  `flake = false;`) and patches it to add some binary dependencies to its path

  when it is imported. It outputs the resulting patched folder as a derivation,

  ready to be passed to the `libraries.source` argument of `nushellWith`

- [`packages.`](./nix-src/nu-libs-and-plugins.nix): a set of pre-packaged

  nushell libraries and plugins (see below)

## Pre-packaged nushell libraries & plugins

This flake also provides as Nix derivations some nushell libraries and plugins, so you don't have to write nix derivations for them and

deal with their own dependencies. All plugins from crates.io are procedurally packaged, which means some may fail to build due to their

system dependencies not being explicitly listed here.

See the [garnix build results](https://garnix.io/repo/YPares/nushellWith) to know which ones.

PRs to add new things to the list of [packaged libraries & plugins](./nix-src/nu-libs-and-plugins.nix) are very much welcome.

## Limitations & important notes

- Only plugins written in Rust can be passed to `plugins.source`, and they will

  be built by [`crane`](https://github.com/ipetkov/crane). `plugins.nix` on the

  other hand accepts any derivation that builds a proper plugin, ie. that builds

  a `$out/bin/nu_plugin_*` executable which implements the [nu-plugin

  protocol](https://www.nushell.sh/contributor-book/plugins.html). In both

  cases, the plugin executable is automatically discovered by `nushellWith`.

- Using `plugins.source` with `devenv` only works with `devenv >= v1.1`.