Nushell

https://www.nushell.sh/book/
Admin
Nushell is a modern cross-platform shell that combines Unix philosophy with contemporary programming...
Tokens:110,986
Snippets:1,661
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Rustup Installation Options

Source: https://www.nushell.sh/book/installation.html

Example output from rustup when prompted to choose installation options. Press '1' to proceed with the default installation.

```shell
Current installation options:

default host triple: x86_64-unknown-linux-gnu
default toolchain: stable
profile: default
modify PATH variable: yes

1) Proceed with installation (default)
2) Customize installation
3) Cancel installation
```

--------------------------------

### Install a Plugin from a Local Repository

Source: https://www.nushell.sh/book/plugins.html

Installs a plugin from a local Git repository. Navigate to the cloned repository directory and run this command.

```bash
cargo install --path . --locked
```

--------------------------------

### Example: Greet a VIP

Source: https://www.nushell.sh/book/custom_commands.html

Demonstrates calling the 'vip_greet' command with a single VIP name.

```nu
> vip-greet "Bob"
```

--------------------------------

### Install Nushell with Winget (User Scope)

Source: https://www.nushell.sh/book/installation.html

Install Nushell for the current user on a Windows machine using Winget.

```shell
winget install nushell
```

--------------------------------

### Install Nushell with Winget (Machine Scope)

Source: https://www.nushell.sh/book/installation.html

Install Nushell for all users on a Windows machine using Winget.

```shell
winget install nushell --scope machine
```

--------------------------------

### List Installed Plugins

Source: https://www.nushell.sh/book/plugins.html

Displays all installed plugins, their versions, status, and the commands they provide. Useful for understanding available plugin functionality.

```shell
plugin list
```

--------------------------------

### Install Dependencies for Debian/Ubuntu

Source: https://www.nushell.sh/book/installation.html

Install necessary packages for building Nushell from source on Debian/Ubuntu systems.

```shell
apt install pkg-config libssl-dev build-essential
```

--------------------------------

### Setup directory structure for submodules

Source: https://www.nushell.sh/book/modules/creating_modules.html

Commands to create a directory and move existing module files into it.

```nushell
mkdir my-utils
# Adjust the following as needed
mv increment/mod.nu my-utils/increment.nu
rm increment
cd my-utils
```

--------------------------------

### Using the standard library

Source: https://www.nushell.sh/book/modules/using_modules.html

Example of importing and using a module from the built-in standard library.

```nushell
use std/log
log info "Hello, Modules"
```

--------------------------------

### Install Nushell with Scoop

Source: https://www.nushell.sh/book/installation.html

Install Nushell on Windows using the Scoop package manager.

```shell
scoop install nu
```

--------------------------------

### Example: Greet Multiple People with a VIP

Source: https://www.nushell.sh/book/custom_commands.html

Demonstrates calling the 'vip_greet' command with a VIP name and a list of other guests.

```nu
> vip-greet "Bob" ["Alice" "Charlie"]
```

--------------------------------

### Example: PSQL Table Borders

Source: https://www.nushell.sh/book/coloring_and_theming.html

Demonstrates setting the table border mode to 'psql' and displaying the first 5 table border styles.

```nushell
$env.config.table.mode = 'psql'
table --list | first 5
```

--------------------------------

### Add Nushell APT Repository and Install

Source: https://www.nushell.sh/book/installation.html

Configure the APT package manager for Debian/Ubuntu to include the Nushell repository and install Nushell.

```shell
wget -qO- https://apt.fury.io/nushell/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/fury-nushell.gpg
echo "deb [signed-by=/etc/apt/keyrings/fury-nushell.gpg] https://apt.fury.io/nushell/ /" | sudo tee /etc/apt/sources.list.d/fury-nushell.list
sudo apt update
sudo apt install nushell
```

--------------------------------

### History Search Example

Source: https://www.nushell.sh/book/line_editor.html

Demonstrates the state of the command line before and after filtering history.

```nushell
let a = ()
```

```nushell
let a = (ls | where size > 10MiB)
```

--------------------------------

### ExecuteHostCommand Send Event

Source: https://www.nushell.sh/book/line_editor.html

Example of configuring an ExecuteHostCommand event with a command string.

```nushell
    ...
      event: {
        send: executehostcommand
        cmd: "cd ~"
      }
    ...
```

--------------------------------

### Install Nushell with npm

Source: https://www.nushell.sh/book/installation.html

Install Nushell globally using npm. Note that nu plugins are not included with this installation method.

```shell
npm install -g nushell
```

--------------------------------

### Run Nu with Specific Plugins

Source: https://www.nushell.sh/book/plugins.html

When starting Nu, you can specify plugins to load using the `--plugins` option with a list of plugin executable files.

```bash
nu --plugins '[./my_plugins/nu_plugin_cool]'
```

--------------------------------

### Execute Commands with Input

Source: https://www.nushell.sh/book/pipelines.html

Examples of piping data into commands that support specific input types.

```nushell
[a b c] | first                                                                                                                                   took 1ms
# => a
```

```nushell
1..4 | first                                                                                                                                     took 21ms
# => 1
```

--------------------------------

### Correct Multi-line Nushell Formatting

Source: https://www.nushell.sh/book/style_guide.html

Examples demonstrating the recommended multi-line formatting for pipelines, records, lists, and closures.

```nushell
[[status]; [UP] [UP]] | all {|el|
    $el.status == UP
}

[1 2 3 4] | reduce {|elt, acc|
    $elt + $acc
}

{x: 1, y: 2}

[
  {name: "Teresa", age: 24},
  {name: "Thomas", age: 26}
]

let selectedProfile = (for it in ($credentials | transpose name credentials) {
    echo $it.name
})
```

--------------------------------

### Basic Nushell Script Example

Source: https://www.nushell.sh/book/scripts.html

Defines a custom command and then calls it. Definitions can appear after their usage.

```nushell
# myscript.nu
def greet [name] {
  ["hello" $name]
}

greet "world"

```

```nushell
greet "world"

def greet [name] {
  ["hello" $name]
}

```

--------------------------------

### Install a Specific Plugin from crates.io

Source: https://www.nushell.sh/book/plugins.html

Installs a specific third-party plugin from crates.io using Cargo. Replace `<plugin_name>` with the actual name of the plugin.

```bash
cargo install nu_plugin_<plugin_name> --locked
```

--------------------------------

### Install Dependencies for RHEL based distros

Source: https://www.nushell.sh/book/installation.html

Install necessary packages for building Nushell from source on RHEL-based Linux distributions.

```shell
yum install libxcb openssl-devel libX11-devel
```

--------------------------------

### Call a command with required positional parameters

Source: https://www.nushell.sh/book/custom_commands.html

This example demonstrates calling the `greet` command with two required positional parameters, showing the expected output.

```nushell
def greet [name1, name2] {
  $"Hello, ($name1) and ($name2)!"
}

greet Wei Mei
# => Hello, Wei and Mei!
```

--------------------------------

### Example: Execute Deprecated Command with Flag

Source: https://www.nushell.sh/book/custom_commands.html

Demonstrates executing the deprecated 'greet' command with the '--all-caps' flag, showing the resulting uppercase output and the deprecation warning.

```nu
> greet {name: bob, all-caps: true}
```

--------------------------------

### Interactive Example: Custom Completions

Source: https://www.nushell.sh/book/custom_completions.html

Illustrates the behavior of custom completions in an interactive Nushell session. Shows how completions are suggested and how context is passed to them.

```nushell
>| my-command
cat                 dog                 eel
>| my-command dog
Lulu                Enzo
>my-command dog enzo
The dog is named Enzo
```

--------------------------------

### Install All Default Nushell Plugins

Source: https://www.nushell.sh/book/plugins.html

Installs all default (non-developer) core plugins for Nushell using Cargo. Ensure you are running this command from within Nushell.

```nushell
[ nu_plugin_inc
  nu_plugin_polars
  nu_plugin_gstat
  nu_plugin_formats
  nu_plugin_query
] | each { cargo install $in --locked } | ignore
```

--------------------------------

### Add Nushell DNF Repository and Install

Source: https://www.nushell.sh/book/installation.html

Configure the DNF package manager for RedHat/Fedora/Rocky Linux to include the Nushell repository and install Nushell.

```shell
echo "[gemfury-nushell]
name=Gemfury Nushell Repo
baseurl=https://yum.fury.io/nushell/
enabled=1
gpgcheck=0
gpgkey=https://yum.fury.io/nushell/gpg.key" | sudo tee /etc/yum.repos.d/fury-nushell.repo
sudo dnf install -y nushell
```

--------------------------------

### Example Table Output with Custom Colors

Source: https://www.nushell.sh/book/coloring_and_theming.html

Demonstrates the visual output of a table after applying custom color closures for 'filesize' and 'bool'.

```nushell
{a:true,b:false,c:0mb,d:0.5mb,e:10mib}
```

--------------------------------

### Extracting Data with get and select

Source: https://www.nushell.sh/book/working_with_tables.html

Use get to retrieve values as a list, while select creates a new table containing only the specified columns.

```nushell
ls | get name
```

```nushell
ls | select name
```

--------------------------------

### Launch Nushell

Source: https://www.nushell.sh/book/installation.html

After installation, launch the Nushell interactive shell by typing 'nu'.

```shell
$ nu
/home/sophiajt/Source> 
```

--------------------------------

### List All Standard Library Commands

Source: https://www.nushell.sh/book/standard_library.html

Run this command to see a complete list of available commands in the standard library. It uses `use std` to load the entire library and then filters commands starting with 'std '.

```nu
nu -c "
  use std
  scope commands
  | where name =~ '^std '
  | select name description extra_description
  | wrap 'Standard Library Commands'
  | table -e
"
```

--------------------------------

### Example: Rounded Table Borders

Source: https://www.nushell.sh/book/coloring_and_theming.html

Demonstrates setting the table border mode to 'rounded' and displaying the first 5 table border styles.

```nushell
$env.config.table.mode = 'rounded'
table --list | first 5
```

--------------------------------

### Menu Send Event Configuration

Source: https://www.nushell.sh/book/line_editor.html

Example of configuring a menu event requiring a specific menu name.

```nushell
    ...
      event: {
        send: menu
        name: completion_menu
      }
    ...
```

--------------------------------

### Sourcing with a Parse-Time Constant

Source: https://www.nushell.sh/book/thinking_in_nu.html

This example shows how using a 'const' allows the path to be resolved during parsing, making 'source' work correctly.

```nushell
const my_path = "~/nushell-files"
source $"($my_path)/common.nu"
```

--------------------------------

### Define Keybinding Event Structures

Source: https://www.nushell.sh/book/line_editor.html

Examples of single and multiple event definitions for keybindings.

```nushell
  ...
  event: { send: Enter }
  ...
```

```nushell
  ...
  event: [
    { edit: Clear }
    { send: Enter }
  ]
  ...
```

--------------------------------

### Define a submodule with aliases

Source: https://www.nushell.sh/book/modules/creating_modules.html

Example of a module file containing exported commands and aliases.

```nushell
# go.nu, in the my-utils directory
export def --env home [] {
    cd ~
}

export def --env modules [] {
    cd ($nu.default-config-dir | path join "scripts")
}

export alias h = home
export alias m = modules
```

--------------------------------

### Use a custom command in a pipeline

Source: https://www.nushell.sh/book/custom_commands.html

This example shows how to pipe a list of numbers into the custom `double` command and observe the processed output.

```nushell
[1 2 3] | double
# => ╭───┬───╮
# => │ 0 │ 2 │
# => │ 1 │ 4 │
# => │ 2 │ 6 │
# => ╰───┴───╯
```

--------------------------------

### Incorrect Multi-line Nushell Formatting

Source: https://www.nushell.sh/book/style_guide.html

Examples of common formatting errors that violate the multi-line style guide rules.

```nushell
# too many spaces before "|el|": no space is allowed (like in one-line format)
[[status]; [UP] [UP]] | all { |el|
    # too few "\n" before "}": one "\n" is required
    $el.status == UP}

# too many spaces before "2": one space is required (like in one-line format)
[1  2 3 4] | reduce {|elt, acc|
    $elt + $acc
}

{
   # too many "\n" before "x": one-line format required as no nested lists or record exist
   x: 1,
   y: 2
}

# too few "\n" before "{": multi-line format required as there are two nested records
[{name: "Teresa", age: 24},
  {name: "Thomas", age: 26}]

let selectedProfile = (
    # too many "\n" before "foo": no "\n" is allowed
    for it in ($credentials | transpose name credentials) {
        echo $it.name
})
```

--------------------------------

### Adding Attributes to Custom Commands

Source: https://www.nushell.sh/book/custom_commands.html

Demonstrates how to add attributes like 'example' to custom Nushell commands using the 'attr' builtin.

```APIDOC
## Adding Attributes to Custom Commands via `attr`

As of version 0.103.0, Nushell allows authors of custom commands to enrich their work with attributes with subcommands of the `attr` builtin, prefixed by the `@` symbol before the definition of the command. For those coming from Python, Java, or JavaScript, this will appear similar to decorators or annotations, but serve a slightly different purpose.

Let's improve the documentation for the `vip-greet` custom command. The `example` attribute adds to the output of `help {command}` or `{command} -h`:

```nu
# Greet guests along with a VIP
#
# Use for birthdays, graduation parties,
# retirements, and any other event which
# celebrates an event # for a particular
# person.

@[example "
  > vip-greet 'Alice' 'Bob' 'Charlie'
  Hello, Bob!
  Hello, Charlie!
  And a special welcome to our VIP today, Alice!
"]
def vip-greet [
  vip: string        # The special guest
   ...names: string  # The other guests
] {
  for $name in $names {
    print $("Hello, ($name)!")
  }

  print $("And a special welcome to our VIP today, ($vip)!")
}
```
```

--------------------------------

### Compare Startup Time with and without Standard Library

Source: https://www.nushell.sh/book/standard_library.html

Demonstrates the performance difference in startup time when the standard library is disabled versus when it is enabled. Useful for identifying performance bottlenecks.

```bash
nu --no-std-lib -n -c "$nu.startup-time"
```

```bash
nu -n -c "$nu.startup-time"
```

--------------------------------

### Enable Carapace External Completions

Source: https://www.nushell.sh/book/custom_completions.html

Define a closure for the `completer` field that invokes `carapace` with the current command spans and parses the JSON output. This example assumes `carapace` is installed and configured for Nushell.

```nu
let carapace_completer = {|spans| 
    carapace $spans.0 nushell ...$spans | from json
}
```

--------------------------------

### Configure oh-my-posh Prompt for MacOS

Source: https://www.nushell.sh/book/3rdpartyprompts.html

Sets the PROMPT_COMMAND environment variable to initialize oh-my-posh with a specified theme. Ensure oh-my-posh is installed via brew and a nerd font is downloaded.

```nu
let posh_dir = (brew --prefix oh-my-posh | str trim)
let posh_theme = $'($posh_dir)/share/oh-my-posh/themes/'
# Change the theme names to: zash/space/robbyrussel/powerline/powerlevel10k_lean/
# material/half-life/lambda Or double lines theme: amro/pure/spaceship, etc.
# For more [Themes demo](https://ohmyposh.dev/docs/themes)
$env.PROMPT_COMMAND = { || oh-my-posh prompt print primary --config $'($posh_theme)/zash.omp.json' }
# Optional
$env.PROMPT_INDICATOR = $"(ansi y)$> (ansi reset)"
```

--------------------------------

### Example: Basic Command Execution with Deprecation Warning

Source: https://www.nushell.sh/book/custom_commands.html

Shows the output when executing a deprecated command without any specific flags, including the deprecation warning message.

```nu
> greet "bob"
```

--------------------------------

### Add Plugin (Linux/macOS)

Source: https://www.nushell.sh/book/plugins.html

Use `plugin add` to register a plugin by providing its path. The plugin filename must start with `nu_plugin_`.

```bash
plugin add ./my_plugins/nu_plugin_cool
```

--------------------------------

### Install Nushell via Cargo

Source: https://www.nushell.sh/book/installation.html

Installs the latest Nushell release from crates.io. Note that default plugins must be installed separately.

```bash
cargo install nu --locked
```

--------------------------------

### Create directory using subexpressions vs pipelines

Source: https://www.nushell.sh/book/pipelines.html

Demonstrates equivalent ways to create a directory using subexpressions or a step-by-step pipeline.

```nushell
mkdir $'((date now) + 1day | format date '%F') Report'
```

```nushell
date now                    # 1: today
| $in + 1day                # 2: tomorrow
| format date '%F'          # 3: Format as YYYY-MM-DD
| $'($in) Report'           # 4: Format the directory name
| mkdir $in                 # 5: Create the directory
```

--------------------------------

### View Documentation for Configuration Options

Source: https://www.nushell.sh/book/configuration.html

Opens a paginated view of documentation for all available configuration options. Useful for understanding settings.

```nu
config nu --doc | nu-highlight | bat
```

```nu
config nu --doc | nu-highlight | less -R
```

--------------------------------

### Module naming conflict example

Source: https://www.nushell.sh/book/modules/creating_modules.html

Example of an invalid module definition where a module attempts to export a submodule with the same name.

```nushell
module spam { export module spam { } }
# => Error: nu::parser::named_as_module
# => ...
# => help: Module spam can't export module named
# => the same as the module. Either change the module
# => name, or export `mod` module.
```

--------------------------------

### Get vs Select Table Row

Source: https://www.nushell.sh/book/navigating_structured_data.html

Compare the output of get, which returns a value, against select, which returns a structure.

```nushell
$data | get 1
# => ╭───────────┬───────────────╮
# => │ date      │ 2 years ago   │
# => │           │ ╭───┬───────╮ │
# => │ temps     │ │ 0 │ 35.24 │ │
# => │           │ │ 1 │ 35.94 │ │
# => │           │ │ 2 │ 34.91 │ │
# => │           │ │ 3 │ 35.24 │ │
```

--------------------------------

### Print Hello World in Nushell

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

A basic script demonstrating standard output in Nushell.

```nushell
# hello.nu

print "Hello, World!"
```

--------------------------------

### Configure PROMPT_COMMAND for Custom Prompt

Source: https://www.nushell.sh/book/coloring_and_theming.html

Set the PROMPT_COMMAND environment variable to execute custom code for setting up the prompt. This example includes the current date, time, and the basename of the current working directory.

```nu
$env.PROMPT_COMMAND = { $"(date now | format date '%m/%d/%Y %I:%M:%S%.3f'): (pwd | path basename)" }
```

--------------------------------

### Basic Pipeline Execution

Source: https://www.nushell.sh/book/pipelines.html

Demonstrates a simple pipeline that opens a file, updates a dependency version, and saves the result to a new file.

```nushell
open Cargo.toml | update workspace.dependencies.base64 0.24.2 | save Cargo_new.toml
```

--------------------------------

### Viewing Module Help

Source: https://www.nushell.sh/book/modules/creating_modules.html

Access module documentation using the help command after importing the module.

```nushell
use my-utils *
help my-utils

# => A collection of helpful utility functions
```

--------------------------------

### Corrected 'source-env' with Full Path

Source: https://www.nushell.sh/book/thinking_in_nu.html

This corrected example uses the full path to the file with 'source-env', resolving the parse-time error caused by the 'cd' command.

```nushell
source-env spam/foo.nu
```

--------------------------------

### Install Dependencies for macOS with Homebrew

Source: https://www.nushell.sh/book/installation.html

Install required dependencies 'openssl' and 'cmake' using Homebrew on macOS for building Nushell from source.

```shell
brew install openssl cmake
```

--------------------------------

### Demonstrate Python exec execution

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

Shows how exec can define functions at runtime, making static analysis difficult.

```python
exec("def hello(): print('Hello eval!')")
hello()
```

--------------------------------

### Get help for Nushell concepts

Source: https://www.nushell.sh/book/quick_tour.html

The `help` command can also be used to get information about Nushell concepts like operators and escapes.

```nushell
help operators
```

```nushell
help escapes
```

--------------------------------

### Get Specific Value from JSON

Source: https://www.nushell.sh/book/loading_data.html

After opening a JSON file, use the `get` command to extract a specific value, such as the version number.

```nushell
open editors/vscode/package.json | get version
```

--------------------------------

### Activate and list overlays

Source: https://www.nushell.sh/book/overlays.html

Use the overlay use command to activate a module as an overlay and list active overlays.

```nushell
overlay use spam

foo
# => foo

bar
# => bar

$env.BAZ
# => baz

overlay list
# => ───┬──────
# =>  0 │ zero
# =>  1 │ spam
# => ───┴──────
```

--------------------------------

### Add Nushell APK Repository and Install

Source: https://www.nushell.sh/book/installation.html

Configure the APK package manager for Alpine Linux to include the Nushell repository and install Nushell.

```shell
echo "https://alpine.fury.io/nushell/" | tee -a /etc/apk/repositories
apk update
apk add --allow-untrusted nushell
```

--------------------------------

### Demonstrate Overlay Precedence

Source: https://www.nushell.sh/book/overlays.html

Shows how `overlay use` changes which overlay's definition takes precedence. Use `overlay list` to see the current order.

```nushell
(zero)> def foo [] { "foo-in-zero" }

(zero)> overlay use spam

(spam)> foo
foo

(spam)> overlay use zero

(zero)> foo
foo-in-zero

(zero)> overlay list
───┬──────
 0 │ spam
 1 │ zero
───┴──────
```

--------------------------------

### Get help for a command in Nushell

Source: https://www.nushell.sh/book/quick_tour.html

Use the `help` command followed by the command name to get detailed information. You can also use the `--help` flag.

```nushell
# help <command>
help ls
```

```nushell
# Or
ls --help
```

--------------------------------

### String Starts With Check

Source: https://www.nushell.sh/book/working_with_strings.html

Verify if a string begins with a specified prefix using the `starts-with` operator. Returns `true` if the string starts with the prefix, `false` otherwise.

```nushell
'JavaScript' starts-with 'Java'
```

--------------------------------

### Get List Item by Variable Index in Nushell

Source: https://www.nushell.sh/book/working_with_lists.html

Use the 'get' command to retrieve a list item when the index is stored in a variable. This is useful for dynamic index access.

```nushell
let names = [Mark Tami Amanda Jeremy]
let index = 1
$names | get $index # gives Tami
```

--------------------------------

### Nushell Static Parsing Example

Source: https://www.nushell.sh/book/thinking_in_nu.html

This example illustrates Nushell's static parsing stage, where code is parsed entirely before evaluation. It shows an error when trying to `source` a file that was just created dynamically.

```nushell
"print Hello" | save output.nu;
source output.nu
```

--------------------------------

### View Nushell Configuration Documentation

Source: https://www.nushell.sh/book/configuration.html

Access detailed documentation for Nushell configuration settings directly from the command line. Pipe the output to `less` for easier navigation.

```nu
config nu --doc | nu-highlight | less -R
```

--------------------------------

### Import and test module commands

Source: https://www.nushell.sh/book/modules/creating_modules.html

Shows how to import module contents and demonstrates that non-exported definitions remain inaccessible.

```nushell
use is-alphanumeric.nu *
'Word' | str is-alphanumeric
# => true
'Some punctuation?!' | str is-alphanumeric
# => false
'a' in (alpha-num-range)
# => Error:
# => help: `alpha-num-range` is neither a Nushell built-in or a known external command
```

--------------------------------

### Multi-line record literal

Source: https://www.nushell.sh/book/line_editor.html

Example of a record literal spanning multiple lines.

```nushell
let file = {
  name: 'repos.sqlite'
  hash: 'b939a3fa4ca011ca1aa3548420e78cee'
  version: '1.4.2'
}
```

--------------------------------

### Define and run a custom command

Source: https://www.nushell.sh/book/custom_commands.html

Defines a simple command with a parameter and demonstrates how to execute it.

```nushell
def greet [name] {
  $"Hello, ($name)!"
}
```

```nushell
greet "World"
# => Hello, World!
```

--------------------------------

### Take while condition

Source: https://www.nushell.sh/book/cheat_sheet.html

Returns elements from the start of a list as long as the condition is met.

```nushell
let cond = {|x| $x < 0 }; [-1 -2 9 1] | take while $cond
# => ╭───┬────╮
# => │ 0 │ -1 │
# => │ 1 │ -2 │
# => ╰───┴────╯
```

--------------------------------

### Handle Pipeline Errors

Source: https://www.nushell.sh/book/pipelines.html

Example of an error generated when piping input into a command that does not support it.

```nushell
echo 1sec | sleep
# => Error: nu::parser::missing_positional
# => 
# =>   × Missing required positional argument.
# =>    ╭─[entry #53:1:18]
# =>  1 │ echo 1sec | sleep
# =>    ╰────
# =>   help: Usage: sleep <duration> ...(rest) . Use `--help` for more information.
```

--------------------------------

### Create a Sample CSV File for Dataframe Testing

Source: https://www.nushell.sh/book/dataframes.html

Create a small CSV file named 'test_small.csv' to use as a sample dataframe. This file contains various data types including integers, floats, and strings.

```nushell
("int_1,int_2,float_1,float_2,first,second,third,word
1,11,0.1,1.0,a,b,c,first
2,12,0.2,1.0,a,b,c,second
3,13,0.3,2.0,a,b,c,third
4,14,0.4,3.0,b,a,c,second
0,15,0.5,4.0,b,a,a,third
6,16,0.6,5.0,b,a,a,second
7,17,0.7,6.0,b,c,a,third
8,18,0.8,7.0,c,c,b,eight
9,19,0.9,8.0,c,c,b,ninth
0,10,0.0,9.0,c,c,b,ninth"
| save --raw --force test_small.csv)
```

--------------------------------

### Import and use a module

Source: https://www.nushell.sh/book/modules/creating_modules.html

Import the module using the use command and execute the exported function.

```nushell
use inc.nu *
5 | increment
# => 6
```

--------------------------------

### Edit Event with Value

Source: https://www.nushell.sh/book/line_editor.html

Examples of edit events that require an additional value parameter.

```nushell
    ...
      event: {
        edit: insertstring
        value: "MY NEW STRING"
      }
    ...
```

```nushell
    ...
      event: {
        edit: moverightuntil
        value: "S"
      }
    ...
```

--------------------------------

### Dynamic Filename for 'source' with 'let'

Source: https://www.nushell.sh/book/thinking_in_nu.html

Attempting to source a file using a dynamically created path with 'let' fails because the path is not a parse-time constant.

```nushell
let my_path = "~/nushell-files"
source $"($my_path)/common.nu"
```

--------------------------------

### Using the break command

Source: https://www.nushell.sh/book/control_flow.html

Demonstrates exiting a loop early using the 'break' command.

```nushell
for x in 1..10 { if $x > 3 { break }; print $x }
```

--------------------------------

### Restricted constant assignment

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

Shows an example of an operation that is not allowed during parse-time constant evaluation.

```nushell
const foo_contents = (open foo.nu)
```

--------------------------------

### Navigating the directory stack

Source: https://www.nushell.sh/book/directory_stack.html

Switch between directories using next, prev, and goto commands.

```nushell
dirs next
# Active was 3, is now 0
pwd
# => /home/myuser/src/repo/nushell
dirs goto 2
# => /home/myuser/src/repo/nu_scripts
```

--------------------------------

### Log messages using the standard library

Source: https://www.nushell.sh/book/stdout_stderr_exit_codes.html

Demonstrates how to use the std/log module to output messages at various severity levels.

```nushell
use std/log

def main [] {
    log debug "Debug message"
    log info "Info message"
    log warning "Warning message"
    log error "Error message"
    log critical "Critical message"
}
```

--------------------------------

### Manual newline insertion

Source: https://www.nushell.sh/book/line_editor.html

Example of using manual newlines to format a command pipeline.

```nushell
ls
| where name =~ '^[0-9]'  # Files starting with a digit
| get name
| mv ...$in ./backups/
```

--------------------------------

### Multi-line bracketed expression

Source: https://www.nushell.sh/book/line_editor.html

Example of opening a block or closure that triggers multi-line editing.

```nushell
def my-command [] {
```

--------------------------------

### Define a Custom Command with Parameters

Source: https://www.nushell.sh/book/custom_commands.html

Define a custom command 'vip_greet' that accepts a mandatory 'vip' string and a variadic list of 'names'. Use this for scenarios like birthday or graduation party greetings.

```nu
def vip-greet [
  vip: string        # The special guest
   ...names: string  # The other guests
] {
  for $name in $names {
    print $"Hello, ($name)!"
  }

  print $"And a special welcome to our VIP today, ($vip)!"
}
```

--------------------------------

### Add Plugin (Windows)

Source: https://www.nushell.sh/book/plugins.html

On Windows, use `plugin add` with the correct path separator and executable extension for registering plugins.

```powershell
plugin add .\my_plugins\nu_plugin_cool.exe
```

--------------------------------

### Sequential REPL Command Execution

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

Demonstrates how separate REPL entries allow environment changes to persist between commands.

```nushell
cd spam
source-env foo.nu
```

```nushell
> cd spam
> source-env foo.nu
# Yay, works!
```

--------------------------------

### Import Entire Standard Library

Source: https://www.nushell.sh/book/standard_library.html

Convenient for command-line use, this command loads all standard library modules and submodules into the current scope. Avoid this in custom scripts for better performance.

```nu
use std *
```

--------------------------------

### Multi-line command continuation

Source: https://www.nushell.sh/book/line_editor.html

Example of continuing a command across multiple lines using parentheses.

```nushell
(
  tar
  -cvz
  -f archive.tgz
  --exclude='*.temp'
  --directory=../project/
  ./
)
```

--------------------------------

### Execute custom command with error

Source: https://www.nushell.sh/book/creating_errors.html

Example of calling a command that triggers a custom error message.

```nushell
my-command 100
# => Error:
# =>   × this is fishy
# =>    ╭─[entry #5:1:1]
# =>  1 │ my-command 100
# =>    ·            ─┬─
# =>    ·             ╰── fish right here
# =>    ╰────
```

--------------------------------

### Best Practice for $in in Multiline Code

Source: https://www.nushell.sh/book/pipelines.html

Assigning $in to a variable at the start of a block improves readability and debugging.

```nushell
def "date info" [] {
  let day = $in
  print ($day | format date '%v')
  print $'... was a ($day | format date '%A')'
  print $'... was day ($day | format date '%j') of the year'
}

'2000-01-01' | date info
# =>  1-Jan-2000
# => ... was a Saturday
# => ... was day 001 of the year
```

--------------------------------

### Managing multiple directories

Source: https://www.nushell.sh/book/directory_stack.html

Add multiple paths to the stack to facilitate quick switching.

```nushell
dirs add ../nu_scripts
dirs add ~
dirs
# => ╭───┬────────┬────────────────────────────────────╮
# => │ # │ active │                path                │
# => ├───┼────────┼────────────────────────────────────┤
# => │ 0 │ false  │ /home/myuser/src/repo/nushell      │
# => │ 1 │ false  │ /home/myuser/src/repo/reedline     │
# => │ 2 │ false  │ /home/myuser/src/repo/nu_scripts   │
# => │ 3 │ true   │ /home/myuser                       │
# => ╰───┴────────┴────────────────────────────────────╯
```

--------------------------------

### Multiline Command Grouping

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

Examples of grouping multiple commands into a single commandline using semicolons or newlines.

```nushell
cd spam; source-env foo.nu
```

```nushell
> cd span
  source-env foo.nu
```

--------------------------------

### Importing modules for environment access

Source: https://www.nushell.sh/book/modules/creating_modules.html

Demonstrates two methods to ensure environment variables from a dependency are available within a module.

```nushell
# go.nu
export def --env home [] {
    cd ~
}

export def --env modules [] {
    use my-utils
    cd $env.NU_MODULES_DIR
}
```

```nushell
use my-utils
export-env {
    use my-utils []
}

export def --env home [] {
    cd ~
}

export def --env modules [] {
    cd $env.NU_MODULES_DIR
}
```

--------------------------------

### Execute commands in Nushell REPL

Source: https://www.nushell.sh/book/how_nushell_code_gets_run.html

Examples of executing commands within the Nushell interactive shell environment.

```nushell
> print "Hello world!"
# => Hello world!

> ls
```

--------------------------------

### Identify invalid shell error

Source: https://www.nushell.sh/book/default_shell.html

Example of the error message returned by chsh when the shell is not present in /etc/shells.

```text
chsh: /home/username/.cargo/bin/nu is an invalid shell
```

--------------------------------

### Check Plugin Status After Use

Source: https://www.nushell.sh/book/plugins.html

Demonstrates how to check a plugin's status after it has been used. It first executes a command that utilizes the plugin, then lists the plugin's status.

```shell
http get http://example.com | query web --document --query body
plugin list | where name == query | select name status
```

--------------------------------

### Retrieve Metadata Span

Source: https://www.nushell.sh/book/metadata.html

Access the specific span metadata to identify the start and end positions of a value.

```nushell
metadata (open Cargo.toml) | get span
# => ╭───────┬────────╮
# => │ start │ 212970 │
# => │ end   │ 212987 │
# => ╰───────┴────────╯
```

--------------------------------

### Initialize oh-my-posh Prompt in Nushell

Source: https://www.nushell.sh/book/3rdpartyprompts.html

Generates the .oh-my-posh.nu configuration file. Use `--config` to specify a theme; otherwise, a default theme is used. This file should be sourced in your Nushell config.

```nu
# Generate the .oh-my-posh.nu file
oh-my-posh init nu --config ~/.poshthemes/M365Princess.omp.json

# Initialize oh-my-posh.nu at shell startup by adding this line in your config.nu file
source ~/.oh-my-posh.nu
```

--------------------------------

### Use a main export

Source: https://www.nushell.sh/book/modules/creating_modules.html

Import the module and call the main command by the module name.

```nushell
use ./increment.nu
2024 | increment
# => 2025
```

--------------------------------

### Trigger input type mismatch error

Source: https://www.nushell.sh/book/custom_commands.html

Example of a command that fails when passed an input type not supported by its signature.

```nushell
def inc []: int -> int { $in + 1 }
"Hi" | inc
```

--------------------------------

### Create records from syntax or JSON

Source: https://www.nushell.sh/book/working_with_records.html

Shows record creation using native syntax and converting a JSON string to a record.

```nushell
# Nushell
{ "apples": 543, "bananas": 411, "oranges": 0 }
# => ╭─────────┬─────╮
# => │ apples  │ 543 │
# => │ bananas │ 411 │
# => │ oranges │ 0   │
# => ╰─────────┴─────╯
# JSON
'{ "apples": 543, "bananas": 411, "oranges": 0 }' | from json
# => ╭─────────┬─────╮
# => │ apples  │ 543 │
# => │ bananas │ 411 │
# => │ oranges │ 0   │
# => ╰─────────┴─────╯
```

--------------------------------

### Sort Table and Get First Rows

Source: https://www.nushell.sh/book/cheat_sheet.html

Sorts the output of `ls` by 'size' and then takes the first 5 rows.

```nushell
ls | sort-by size | first 5
```

--------------------------------

### Advanced Color Configuration with Comments

Source: https://www.nushell.sh/book/coloring_and_theming.html

Illustrates advanced color configuration using hex codes, named colors, and attribute settings for elements like 'header' and 'row_index'. Includes comments explaining specific settings.

```nushell
$env.config.color_config.separator = "#88b719" # this sets only the foreground color like PR #486
$env.config.color_config.leading_trailing_space_bg = white # this sets only the foreground color in the original style
$env.config.color_config.header = { # this is like PR #489
    fg: "#B01455", # note, quotes are required on the values with hex colors
    bg: "#ffb900", # note, commas are not required, it could also be all on one line
    attr: bli # note, there are no quotes around this value. it works with or without quotes
}
$env.config.color_config.datetime = "#75507B"
$env.config.color_config.filesize = "#729fcf"
$env.config.color_config.row_index = {
    # note, that this is another way to set only the foreground, no need to specify bg and attr
    fg: "#e50914"
}
```

--------------------------------

### Extract Substring from String

Source: https://www.nushell.sh/book/working_with_strings.html

Use `str substring` with a range (start..end) to extract a portion of a string.

```nushell
'Hello World!' | str substring 4..8
# => o Wor
```

--------------------------------

### Persistence of $in in Scopes

Source: https://www.nushell.sh/book/pipelines.html

Demonstrates Rule 1.5 where $in maintains its value throughout the current scope when used at the start of a pipeline.

```nushell
[ a b c ] | each {
  print $in
  print $in
  $in
}
```

--------------------------------

### Problematic Script with 'source'

Source: https://www.nushell.sh/book/thinking_in_nu.html

This example demonstrates an issue where 'source' is called on a file that is created during evaluation, leading to a parse-time error.

```nushell
# =>  1 │ "print Hello" | save output.nu
# =>  2 │ source output.nu
```
Tokens:
Raw