Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.67 KB

README.md

File metadata and controls

45 lines (35 loc) · 2.67 KB
Raw

built with garnix

nushellWith

Build an isolated nushell environment with a specific set of plugins (from either nixpkgs or built from source) and nu libraries (from source).

See the examples folder for how to use it. Examples show usage with regular nix flakes and with devenv.

Outputs of this flake

  • the flake itself (or lib.nushellWith): 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: 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.<system>: 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 to know which ones.

PRs to add new things to the list of packaged libraries & plugins 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. 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. In both cases, the plugin executable is automatically discovered by nushellWith.
  • Using plugins.source with devenv only works with devenv >= v1.1.