- Notifications
You must be signed in to change notification settings - Fork1.9k
nushell/nushell
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A new type of shell.
- Status
- Learning About Nu
- Installation
- Configuration
- Philosophy
- Goals
- Officially Supported By
- Contributing
- License
This project has reached a minimum-viable-product level of quality. Many people use it as their daily driver, but it may be unstable for some commands. Nu's design is subject to change as it matures.
TheNushell book is the primary source of Nushell documentation. You can finda full list of Nu commands in the book, and we have many examples of using Nu in ourcookbook.
We're also active onDiscord; come and chat with us!
To quickly install Nu:
# Linux and macOSbrew install nushell# Windowswinget install nushell
To useNu
in GitHub Action, checksetup-nu for more detail.
Detailed installation instructions can be found in theinstallation chapter of the book. Nu is available via many package managers:
For details about which platforms the Nushell team actively supports, seeour platform support policy.
The default configurations can be found atsample_configwhich are the configuration files one gets when they startup Nushell for the first time.
It sets all of the default configuration to run Nushell. From here one canthen customize this file for their specific needs.
To see whereconfig.nu is located on your system simply type this command.
$nu.config-path
Please see ourbook for all of the Nushell documentation.
Nu draws inspiration from projects like PowerShell, functional programming languages, and modern CLI tools.Rather than thinking of files and data as raw streams of text, Nu looks at each input as something with structure.For example, when you list the contents of a directory what you get back is a table of rows, where each row represents an item in that directory.These values can be piped through a series of steps, in a series of commands called a 'pipeline'.
In Unix, it's common to pipe between commands to split up a sophisticated command over multiple steps.Nu takes this a step further and builds heavily on the idea ofpipelines.As in the Unix philosophy, Nu allows commands to output to stdout and read from stdin.Additionally, commands can output structured data (you can think of this as a third kind of stream).Commands that work in the pipeline fit into one of three categories:
- Commands that produce a stream (e.g.,
ls
) - Commands that filter a stream (e.g.,
where type == "dir"
) - Commands that consume the output of the pipeline (e.g.,
table
)
Commands are separated by the pipe symbol (|
) to denote a pipeline flowing left to right.
ls| wheretype =="dir"| table# => ╭────┬──────────┬──────┬─────────┬───────────────╮# => │ # │ name │ type │ size │ modified │# => ├────┼──────────┼──────┼─────────┼───────────────┤# => │ 0 │ .cargo │ dir │ 0 B │ 9 minutes ago │# => │ 1 │ assets │ dir │ 0 B │ 2 weeks ago │# => │ 2 │ crates │ dir │ 4.0 KiB │ 2 weeks ago │# => │ 3 │ docker │ dir │ 0 B │ 2 weeks ago │# => │ 4 │ docs │ dir │ 0 B │ 2 weeks ago │# => │ 5 │ images │ dir │ 0 B │ 2 weeks ago │# => │ 6 │ pkg_mgrs │ dir │ 0 B │ 2 weeks ago │# => │ 7 │ samples │ dir │ 0 B │ 2 weeks ago │# => │ 8 │ src │ dir │ 4.0 KiB │ 2 weeks ago │# => │ 9 │ target │ dir │ 0 B │ a day ago │# => │ 10 │ tests │ dir │ 4.0 KiB │ 2 weeks ago │# => │ 11 │ wix │ dir │ 0 B │ 2 weeks ago │# => ╰────┴──────────┴──────┴─────────┴───────────────╯
Because most of the time you'll want to see the output of a pipeline,table
is assumed.We could have also written the above:
ls| wheretype =="dir"
Being able to use the same commands and compose them differently is an important philosophy in Nu.For example, we could use the built-inps
command to get a list of the running processes, using the samewhere
as above.
ps| where cpu> 0# => ╭───┬───────┬───────────┬───────┬───────────┬───────────╮# => │ # │ pid │ name │ cpu │ mem │ virtual │# => ├───┼───────┼───────────┼───────┼───────────┼───────────┤# => │ 0 │ 2240 │ Slack.exe │ 16.40 │ 178.3 MiB │ 232.6 MiB │# => │ 1 │ 16948 │ Slack.exe │ 16.32 │ 205.0 MiB │ 197.9 MiB │# => │ 2 │ 17700 │ nu.exe │ 3.77 │ 26.1 MiB │ 8.8 MiB │# => ╰───┴───────┴───────────┴───────┴───────────┴───────────╯
Nu can load file and URL contents as raw text or structured data (if it recognizes the format).For example, you can load a .toml file as structured data and explore it:
open Cargo.toml# => ╭──────────────────┬────────────────────╮# => │ bin │ [table 1 row] │# => │ dependencies │ {record 25 fields} │# => │ dev-dependencies │ {record 8 fields} │# => │ features │ {record 10 fields} │# => │ package │ {record 13 fields} │# => │ patch │ {record 1 field} │# => │ profile │ {record 3 fields} │# => │ target │ {record 3 fields} │# => │ workspace │ {record 1 field} │# => ╰──────────────────┴────────────────────╯
We can pipe this into a command that gets the contents of one of the columns:
open Cargo.toml| get package# => ╭───────────────┬────────────────────────────────────╮# => │ authors │ [list 1 item] │# => │ default-run │ nu │# => │ description │ A new type of shell │# => │ documentation │ https://www.nushell.sh/book/ │# => │ edition │ 2018 │# => │ exclude │ [list 1 item] │# => │ homepage │ https://www.nushell.sh │# => │ license │ MIT │# => │ metadata │ {record 1 field} │# => │ name │ nu │# => │ repository │ https://github.com/nushell/nushell │# => │ rust-version │ 1.60 │# => │ version │ 0.72.0 │# => ╰───────────────┴────────────────────────────────────╯
And if needed we can drill down further:
open Cargo.toml| get package.version# => 0.72.0
Nu supports plugins that offer additional functionality to the shell and follow the same structured data model that built-in commands use. There are a few examples in thecrates/nu_plugins_*
directories.
Plugins are binaries that are available in your path and follow anu_plugin_*
naming convention.These binaries interact with nu via a simple JSON-RPC protocol where the command identifies itself and passes along its configuration, making it available for use.If the plugin is a filter, data streams to it one element at a time, and it can stream data back in return via stdin/stdout.If the plugin is a sink, it is given the full vector of final data and is given free reign over stdin/stdout to use as it pleases.
Theawesome-nu repo lists a variety of nu-plugins while theshowcase reposhows off informative blog posts that have been written about Nushell along with videos that highlight technicaltopics that have been presented.
Nu adheres closely to a set of goals that make up its design philosophy. As features are added, they are checked against these goals.
First and foremost, Nu is cross-platform. Commands and techniques should work across platforms and Nu hasfirst-class support for Windows, macOS, and Linux.
Nu ensures compatibility with existing platform-specific executables.
Nu's workflow and tools should have the usability expected of modern software in 2022 (and beyond).
Nu views data as either structured or unstructured. It is a structured shell like PowerShell.
Finally, Nu views data functionally. Rather than using mutation, pipelines act as a means to load, change, and save data without mutable state.
Please submit an issue or PR to be added to this list.
SeeContributing for details. Thanks to all the people who already contributed!
The project is made available under the MIT license. See theLICENSE
file for more information.
About
A new type of shell
Topics
Resources
License
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.