Table of Contents
- Introduction - Getting started
- Installation - Installing Nushell
- Default Shell - Setting Nushell as your default login shell
- Getting Started
- Quick Tour - A quick tour of Nushell's features
- Moving Around the System - Moving around in Nushell
- Thinking in Nu - Thinking in Nushell
- Nushell Cheat Sheet - A summary of common commands and syntax
- Nu Fundamentals
- Types of Data - Types of data in Nushell
- Loading Data - Loading data and using it
- Data Formats - Reading and writing CSV, MessagePack, spreadsheets, XML, HTML, and other formats
- Working with SQLite - SQLite files and the in-memory
stordatabase - Pipelines - How the pipeline works
- Working with Strings - Strings, escape characters, and string interpolation
- Regular Expressions - Guide to use regex
- Working with Binary Data - The
bytes,bits, andhashcommands - Working with Lists - Working with Nu lists
- Working with Records - Working with Nu records
- Working with Numbers - The
mathandrandomcommands - Working with Tables - Working with Nu tables
- Working with Paths - The
pathcommands - Navigating and Accessing Structured Data - Cell paths and getting at nested data
- Special Variables - Variables that Nushell defines for you
- Programming in Nu
- Custom Commands - Creating your own commands
- Aliases - How to alias commands
- Operators - Operators supported by Nushell
- Variables - Working with variables
- Control Flow - Working with the control flow commands
- Scripts - Creating your own scripts
- Modules - Creating and using your own modules
- Overlays - Activating and deactivating layers of definitions
- Sorting - Sorting lists, records, and tables
- Testing your Nushell Code - Writing tests with the standard library
- Debugging Scripts - Stepping through scripts in your editor with
nu --dap - Language Server - Using Nushell in an editor with
nu --lsp - Best Practices - Formatting and naming conventions
- Nu as a Shell
- Configuration - How to configure Nushell
- Configuration Reference - Every setting in
$env.config - Environment - Working with environment variables
- Stdout, Stderr, and Exit Codes - Working with stdout, stderr, and exit codes
- Working with the Terminal - Terminal size, queries, grids, and hyperlinks
- Running System (External) Commands - Running external commands with a naming conflict
- How to Configure 3rd Party Prompts - How to configure 3rd party prompts
- Directory Stack - Working with multiple locations
- Reedline, Nu's Line Editor - Nushell's line editor
- Custom Completions - Adding completions to your commands
- Externs - Describing the signatures of external commands
- Coloring and Theming in Nu - How to change the colors and themes in Nushell
- Hooks - Adding code snippets to be run automatically
- Background Jobs - Running code in the background
- Coming to Nu
- Coming from Bash - Guide for those coming to Nushell from Bash
- Coming from CMD.EXE - Guide for those coming to Nushell from CMD.EXE
- Coming from PowerShell - Guide for those coming to Nushell from PowerShell
- Nu map from other shells and domain specific languages - Guide to show how Nushell compares with SQL, LINQ, PowerShell, and Bash
- Nu Map from Imperative Languages - Guide to show how Nushell compares with Python, Kotlin, C++, C#, and Rust
- Nu Map from Functional Languages - Guide to show how Nushell compares with Clojure, Tablecloth (OCaml / Elm) and Haskell
- Nushell operator map - Guide to show how Nushell operators compare with those in general purpose programming languages
- Design Notes
- How Nushell Code Gets Run - Parsing, evaluation, and why some things must be known at parse time
- (Not So) Advanced
- Standard Library - Nushell's standard library
std/assertstd/benchstd/clipstd/configstd/dtstd/formatsstd/helpstd/inputstd/iterstd/logstd/mathstd/randomstd/utilstd/xmlstd-rfc- Candidate modules for the standard library
- Dataframes - Working with dataframes in Nushell
- Metadata - An explanation of Nu's metadata system
- Creating Your Own Errors - Creating your own error messages
- Parallelism - Running your code in parallel
- Plugins - Enhancing Nushell with more features using plugins
- Explore - Browsing structured data with
explore - Building TUIs with
tui- Building your own interactive terminal interfaces - MCP Server - Letting AI agents run Nushell code through the Model Context Protocol
- Standard Library - Nushell's standard library
- Command Reference - List of all Nushell's commands