Installation

This is just a short description of how you can install Nu. There is a more detailed documentation on how to install Nu. It offers the installation guide in different languages: English, Español, Português do Brasil and 日本語.

Pre-built binaries

Windows

Please Note: Nu works on Windows 10 and does not currently have Windows 7/8.1 support.

Download the current released .zip-file from the release page and extract it for example to:

C:\Program Files

And then add the folder of nu to your PATH. Once we have done that, we can run Nu using the nu command:

> nu
C:\Users\user>

macOS

You can download Nu pre-built from the release page or if you are using Homebrew you can install the binary by running

> brew install nushell

Docker containers

If you want to pull a pre-built container, you can browse tags for the nushell organization on Quay.io. Pulling a container would come down to:

$ docker pull quay.io/nushell/nu
$ docker pull quay.io/nushell/nu-base

Both “nu-base” and “nu” provide the nu binary, however nu-base also includes the source code at /code in the container and all dependencies.

Optionally, you can also build the containers locally using the dockerfiles provided: To build the base image:

$ docker build -f docker/Dockerfile.nu-base -t nushell/nu-base .

And then to build the smaller container (using a Multistage build):

$ docker build -f docker/Dockerfile -t nushell/nu .

Either way, you can run either container as follows:

$ docker run -it nushell/nu-base
$ docker run -it nushell/nu
/> exit

The second container is a bit smaller, if size is important to you.

Building it Local

To build Nu, you will need to use the latest stable (1.39 or later) version of the compiler.

For Rust to work properly, you’ll need to have a compatible compiler suite installed on your system. These are the recommended compiler suites:

Required dependencies:

Optional dependencies:

Installing from crates.io

To install Nu via cargo (make sure you have installed rustup and the latest stable compiler via rustup install stable):

cargo install nu

You can also install Nu with all the bells and whistles (be sure to have installed the dependencies for your platform):

cargo install nu --all-features

Building from source

We can also build our own Nu from source directly from github. This gives us immediate access to the latest Nu features and bug fixes.

> git clone https://github.com/nushell/nushell.git

Git will clone the main nushell repo for us. From there, we can build and run Nu if we are using rustup with:

> cd nushell
nushell> cargo build --all-features && cargo run --all-features

You can also build and run Nu in release mode:

nushell> cargo build --release && cargo run --release

People familiar with Rust may wonder why we do both a “build” and a “run” step if “run” does a build by default. This is to get around a shortcoming of the new default-run option in Cargo, and ensure that all plugins are built, though this may not be required in the future.