Nushell

https://www.nushell.sh/
Admin
Nushell is a new type of shell, aiming to provide a modern, cross-platform command-line experience.
Tokens:825,925
Snippets:10,970
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start the Nushell Tutorial

Source: https://www.nushell.sh/commands/docs/tutor.html

Run this command to begin the interactive Nushell tutorial. No specific setup is required beyond having Nushell installed.

```nushell
> tutor begin
```

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

### 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
```

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

### Execute and inspect plugin commands

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

Example of using the installed plugin and viewing its generated help documentation.

```nushell
nu
"hello" | len
# => 5
help len
# => calculates the length of its input
# => 
# => Usage:
# =>   > len
# => 
# => Flags:
# =>   -h, --help - Display the help message for this command
# => 
# => Signatures:
# =>   <string> | len -> <int>
```

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

### Opening Non-HTTP URIs with `start` in Nushell

Source: https://www.nushell.sh/blog/2025-02-04-nushell_0_102_0.html

Shows how the `start` command can now handle non-HTTP URIs, launching them with the system's default handler. This example demonstrates opening a Spotify track link.

```nu
start spotify:track:4PTG3Z6ehGkBFwjybzWkR8?si=f9b4cdfc1aa14831
```

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

### Define Plugin Examples for Testing

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

Implement the `examples` method to provide test cases for your plugin commands. Each example should include the command string, a description, and an expected result.

```rust
use nu_protocol::{Example, ShellError, Value};
use nu_plugin::PluginCommand;

struct FibPlugin;
struct Fib;

// ...

impl PluginCommand for Fib {
    type Plugin = FibPlugin;

    fn name(&self) -> &str {
        "fib"
    }

    // ...

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                example: "fib 20",
                description: "Compute the 20th Fibonacci number",
                result: Some(Value::test_int(6765))
            },
        ]
    }

    // ...
}

#[test]
fn test_examples() -> Result<(), ShellError> {
    use nu_plugin_test_support::PluginTest;

    PluginTest::new("fib", FibPlugin.into())?.test_examples(&Fib)
}
```

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

### Attach examples to command help with @example

Source: https://www.nushell.sh/blog/2025-03-18-nushell_0_103_0.html

Use the @example attribute to define usage examples that appear in the command's help output.

```nushell
@example "double an int"  { 5 | double }   --result 10
@example "double a float" { 0.5 | double } --result 1.0
def double []: [number -> number] {
  $in * 2
}
# The examples above will be shown in `help double` or `double --help`.
```

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

### Examples for `merge` command with output display

Source: https://www.nushell.sh/blog/2023-03-14-nushell_0_77.html

This demonstrates the current `help merge` output, which now includes the results of example commands.

```nushell
Examples:
  Add an 'index' column to the input table
  > [a b c] | wrap name | merge ( [1 2 3] | wrap index )
  ╭───┬──────╮
  │ # │ name │
  ├───┼──────┤
  │ 1 │ a    │
  │ 2 │ b    │
  │ 3 │ c    │
  ╰───┴──────╯

  Merge two records
  > {a: 1, b: 2} | merge {c: 3}
  ╭───┬───╮
  │ a │ 1 │
  │ b │ 2 │
  │ c │ 3 │
  ╰───┴───╯

  Merge two tables, overwriting overlapping columns
  > [{columnA: A0 columnB: B0}] | merge [{columnA: 'A0*'}]
  ╭───┬─────────┬─────────╮
  │ # │ columnA │ columnB │
  ├───┼─────────┼─────────┤
  │ 0 │ A0*     │ B0      │
  ╰───┴─────────┴─────────╯
```

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

### Glob Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a filesystem glob conversion.

```nushell
"src/**/*.rs" | into glob
```

```json
{
  "Glob": {
    "val": "src/**/*.rs",
    "no_expand": false,
    "span": {
      "start": 9400,
      "end": 9413
    }
  }
}
```

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

### IntRange Examples

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Examples of integer ranges with different bounds and step configurations.

```nushell
0..
```

```json
{
  "Range": {
    "val": {
      "IntRange": {
        "start": 0,
        "step": 1,
        "end": "Unbounded"
      }
    },
    "span": {
      "start": 1380,
      "end": 1383
    }
  }
}
```

```nushell
7..10
```

```json
{
  "Range": {
    "val": {
      "IntRange": {
        "start": 7,
        "step": 1,
        "end": { "Included": 10 }
      }
    },
    "span": {
      "start": 1380,
      "end": 1385
    }
  }
}
```

```nushell
7..<10
```

```json
{
  "Range": {
    "val": {
      "IntRange": {
        "start": 7,
        "step": 1,
        "end": { "Excluded": 10 }
      }
    },
    "span": {
      "start": 1380,
      "end": 1386
    }
  }
}
```

```nushell
0..64..128
```

```json
{
  "Range": {
    "val": {
      "IntRange": {
        "start": 0,
        "step": 64,
        "end": { "Included": 128 }
      }
    },
    "span": {
      "start": 1380,
      "end": 1390
    }
  }
}
```

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

### Install and register the plugin

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

Commands to install the plugin binary and register it within the Nushell environment.

```nushell
> cargo install --path . --locked
# nushell only (run with `nu -c` if not in nushell)
> plugin add ~/.cargo/bin/nu_plugin_len # add .exe on Windows
```

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

### Record Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of an associative key-value map.

```nushell
{foo: 5, bar: "hello nushell"}
```

```json
{
  "Record": {
    "val": {
      "foo": {
        "Int": {
          "val": 42,
          "span": {
            "start": 659813,
            "end": 659814
          }
        }
      },
      "bar": {
        "String": {
          "val": "hello nushell",
          "span": {
            "start": 659821,
            "end": 659836
          }
        }
      }
    },
    "span": {
      "start": 659807,
      "end": 659837
    }
  }
}
```

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

### Explore with example data

Source: https://www.nushell.sh/commands/docs/explore_config.html

Opens the TUI using built-in example data to demonstrate features.

```nushell
> explore config --use-example-data
```

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

### Add examples to custom command

Source: https://www.nushell.sh/commands/docs/attr_example.html

Use `attr example` to add examples to your custom Nushell commands. This helps document the command's usage and expected output.

```nushell
> # Double numbers
    @example "double an int" { 2 | double } --result 4
    @example "double a float" { 0.25 | double } --result 0.5
    def double []: [number -> number] { $in * 2 }
```

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

### Install Nushell and Plugins

Source: https://www.nushell.sh/blog/2022-12-20-nushell-0.73.html

Commands to install the core shell and optional plugins via Cargo.

```bash
cargo install nu
```

```bash
cargo install nu --features=dataframe
```

```bash
cargo install nu_plugin_<plugin name>
```

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

### Install Nushell with Experimental Paging Feature

Source: https://www.nushell.sh/blog/2021-03-30-nushell_0_29.html

Install Nushell with the experimental table paging feature enabled.

```bash
cargo install nu --features=table-pager
```

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

### Describe the type of a string

Source: https://www.nushell.sh/commands/docs/describe.html

Use `describe` to get the type of a string value. This is a basic usage example.

```nushell
> 'hello' | describe
string
```

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

### Open files and URLs with start

Source: https://www.nushell.sh/commands/docs/start.html

Use the start command to trigger the default system handler for files, directories, or web addresses.

```nushell
> start file.txt
```

```nushell
> start file.jpg
```

```nushell
> start .
```

```nushell
> start file.pdf
```

```nushell
> start https://www.nushell.sh
```

```nushell
> start obsidian://open?vault=Test
```

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

### 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
```

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

### Get a free port in a specific range

Source: https://www.nushell.sh/commands/docs/port.html

Scans for an available TCP port between the provided start and end values.

```nushell
> port 3121 4000
3121
```

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

### List installed plugins

Source: https://www.nushell.sh/blog/2024-04-02-nushell_0_92_0.html

Displays all installed plugins, their running status, process IDs, and associated commands.

```nushell
> plugin list
╭───┬─────────┬────────────┬─────────┬───────────────────────┬───────┬───────────────────────────────╮
│ # │  name   │ is_running │   pid   │       filename        │ shell │           commands            │
├───┼─────────┼────────────┼─────────┼───────────────────────┼───────┼───────────────────────────────┤
│ 0 │ gstat   │ true       │ 1389890 │ .../nu_plugin_gstat   │       │ ╭───┬───────╮                 │
│   │         │            │         │                       │       │ │ 0 │ gstat │                 │
│   │         │            │         │                       │       │ ╰───┴───────╯                 │
│ 1 │ inc     │ false      │         │ .../nu_plugin_inc     │       │ ╭───┬─────╮                   │
│   │         │            │         │                       │       │ │ 0 │ inc │                   │
│   │         │            │         │                       │       │ ╰───┴─────╯                   │
│ 2 │ example │ false      │         │ .../nu_plugin_example │       │ ╭───┬───────────────────────╮ │
│   │         │            │         │                       │       │ │ 0 │ nu-example-1          │ │
│   │         │            │         │                       │       │ │ 1 │ nu-example-2          │ │
│   │         │            │         │                       │       │ │ 2 │ nu-example-3          │ │
│   │         │            │         │                       │       │ │ 3 │ nu-example-config     │ │
│   │         │            │         │                       │       │ │ 4 │ nu-example-disable-gc │ │
│   │         │            │         │                       │       │ ╰───┴───────────────────────╯ │
╰───┴─────────┴────────────┴─────────┴───────────────────────┴───────┴───────────────────────────────╯
```

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

### 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"
```

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

### 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
})
```

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

### MessagePack Hello Message Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a 'Hello' message encoded in MessagePack format, showing byte string representation.

```plaintext
81                   // map, one element
  a5 "Hello"         // 5-character string
  83                 // map, three elements
    a8 "protocol"    // 8-character string
    a9 "nu-plugin"   // 9-character string
    a7 "version"     // 7-character string
    a6 "0.94.0"      // 6-character string
    a8 "features"    // 8-character string
    90               // array, zero elements
```

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

### Get last 2 items using negative range with `slice`

Source: https://www.nushell.sh/commands/docs/slice.html

Use `slice` with a negative range to get the last N items from a list. The range `(-2)..` selects elements starting from the second to last element to the end.

```nushell
> [0,1,2,3,4,5] | slice (-2)..
╭───┬───╮
│ 0 │ 4 │
│ 1 │ 5 │
╰───┴───╯
```

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

### 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"
```

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

### Convert Table to LazyFrame

Source: https://www.nushell.sh/commands/docs/polars_into-lazy.html

Use this command to convert a table into a lazy Polars DataFrame. No specific setup is required beyond having Polars installed.

```nushell
> [[a b];[1 2] [3 4]] | polars into-lazy
```

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

### 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
```

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

### List Nu Plugins

Source: https://www.nushell.sh/blog/2020-01-07-nushell-0_8_0.html

Use `ls` to list files, `sort-by name` to sort them, and `get name` to extract the names of installed Nu plugins.

```nushell
❯ ls nu_plugin_* | sort-by name | get name
────┬──────────────────────
 #  │ <value>
────┼──────────────────────
  0 │ nu_plugin_average
  1 │ nu_plugin_binaryview
  2 │ nu_plugin_fetch
  3 │ nu_plugin_inc
  4 │ nu_plugin_match
  5 │ nu_plugin_post
  6 │ nu_plugin_ps
  7 │ nu_plugin_str
  8 │ nu_plugin_sum
  9 │ nu_plugin_sys
 10 │ nu_plugin_textview
 11 │ nu_plugin_tree
────┴──────────────────────
```

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

### Use Parentheses in Filenames

Source: https://www.nushell.sh/blog/2022-05-03-nushell_0_62.html

Create filenames using parentheses, for example, `ls ./($dirname)`. This functionality currently has a limitation where parentheses cannot be at the start of the filepath.

```nushell
ls ./($dirname)
```

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

### 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
```

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

### start command

Source: https://www.nushell.sh/commands/docs/start.html

Opens a folder, file, or website in the default application or viewer.

```APIDOC
## start

### Description
Open a folder, file, or website in the default application or viewer.

### Signature
`start {flags} (path)`

### Parameters
- **path** (string) - Optional - Path or URL to open.

### Input/Output Types
- **Input**: nothing
- **Output**: any

### Examples
- Open a text file: `start file.txt`
- Open an image: `start file.jpg`
- Open current directory: `start .`
- Open a website: `start https://www.nushell.sh`
- Open protocol URL: `start obsidian://open?vault=Test`
```

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

### Get current history session ID

Source: https://www.nushell.sh/commands/docs/history_session.html

Use this command to retrieve the integer ID of the current command history session. No setup or imports are required.

```nushell
> history session
```

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

### Get Overlay Status After Hiding

Source: https://www.nushell.sh/commands/docs/overlay_list.html

This example demonstrates how to check the status of a specific overlay after it has been hidden. It filters the list to show only the 'spam' overlay and its active state.

```nushell
> module spam { export def foo [] { "foo" } }
    overlay use spam
    overlay hide spam
    overlay list | where name == "spam"
╭───┬──────┬────────╮
│ # │ name │ active │
├───┼──────┼────────┤
│ 0 │ spam │ false  │
╰───┴──────┴────────╯
```

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

### Enter File as Shell and Navigate

Source: https://www.nushell.sh/blog/2019-08-23-introducing-nushell.html

Demonstrates entering a file as a shell, listing its contents, and then changing the directory within that file context.

```nushell
> enter Cargo.toml
/> shells
---+---+--------------------------------------------+-----------------------------
 # |   | name                                       | path
---+---+--------------------------------------------+-----------------------------
 0 |   | filesystem                                 | /home/sophia/Source/nushell
 1 |   | filesystem                                 | /home/sophia/Source/rhai
 2 | X | {/home/sophia/Source/nushell/Cargo.toml} | /
---+---+--------------------------------------------+-----------------------------
/> ls
------------+--------------+------------------+----------+----------
 bin        | dependencies | dev-dependencies | lib      | package
------------+--------------+------------------+----------+----------
 [11 items] | [object]     | [object]         | [object] | [object] 
------------+--------------+------------------+----------+----------
/> cd bin
/bin> ls
----+----------------------+---------------------------
 #  | name                 | path
----+----------------------+---------------------------
 0  | nu_plugin_inc        | src/plugins/inc.rs
 1  | nu_plugin_sum        | src/plugins/sum.rs
 2  | nu_plugin_add        | src/plugins/add.rs
 3  | nu_plugin_edit       | src/plugins/edit.rs
 4  | nu_plugin_str        | src/plugins/str.rs
 5  | nu_plugin_skip       | src/plugins/skip.rs
 6  | nu_plugin_sys        | src/plugins/sys.rs
 7  | nu_plugin_tree       | src/plugins/tree.rs
 8  | nu_plugin_binaryview | src/plugins/binaryview.rs
 9  | nu_plugin_textview   | src/plugins/textview.rs
 10 | nu                   | src/main.rs
----+----------------------+---------------------------
```

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

### Create an empty selector

Source: https://www.nushell.sh/commands/docs/polars_selector_empty.html

This example demonstrates how to create an empty Polars selector that matches no columns. This is often used as a starting point for composing more complex selectors.

```APIDOC
## `polars selector empty`

### Description
Create an empty selector that matches no columns. Useful as a base for selector composition.

### Signature
`> polars selector empty {flags} `

### Input/output types:
input| output  
---|---  
any| polars_selector  

### Examples
Create an empty selector that matches no columns
```
> polars selector empty
```
```

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

### 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
```

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

### 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]'
```

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

### Fetch Random Chuck Norris Joke

Source: https://www.nushell.sh/blog/2023-08-23-happy-birthday-nushell-4.html

Fetches a random Chuck Norris joke from the Chuck Norris API. This example demonstrates making HTTP GET requests.

```nushell
> (http get https://api.chucknorris.io/jokes/random).value
```

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

### Apply foreground gradient with only end color

Source: https://www.nushell.sh/commands/docs/ansi_gradient.html

This example shows how to apply a foreground gradient when only the end color is specified using `--fgend`. The start color defaults to black.

```nushell
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgend '0xe81cff'
Hello, Nushell! This is a gradient.
```

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

### 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"]
```

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

### Profile Pipeline Execution Time

Source: https://www.nushell.sh/blog/2023-02-21-nushell_0_76.html

Use the `timeit` command to measure the execution time of a pipeline. This example times a pipeline that lists files, sorts them by name and type, and then gets the names.

```nushell
〉timeit { ls | sort-by name type -i | get name }
2ms 509µs 900ns
```

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

### Access Configuration Documentation

Source: https://www.nushell.sh/blog/2024-12-04-configuration_preview.html

View enhanced documentation for configuration options directly in the terminal.

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

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

### 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
}
```

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

### Install Nushell

Source: https://www.nushell.sh/blog/2020-09-22-nushell_0_20.html

Install Nushell using cargo. This is the basic installation command and requires Rust to be installed.

```bash
cargo install nu
```

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

### Examples for `merge` command before output display

Source: https://www.nushell.sh/blog/2023-03-14-nushell_0_77.html

This shows the historical output format for `help merge` examples, lacking command execution results.

```nushell
Examples:
  Add an 'index' column to the input table
  > [a b c] | wrap name | merge ( [1 2 3] | wrap index )

  Merge two records
  > {a: 1, b: 2} | merge {c: 3}

  Merge two tables, overwriting overlapping columns
  > [{columnA: A0 columnB: B0}] | merge [{columnA: 'A0*'}]
```

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

### View Documentation for Configuration Options

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

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
```

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

### GET http get

Source: https://www.nushell.sh/cookbook/help.html

Fetches the contents from a specified URL using the HTTP GET method.

```APIDOC
## GET http get

### Description
Performs an HTTP GET operation to fetch contents from a URL.

### Method
GET

### Endpoint
http get <URL>

### Parameters
#### Path Parameters
- **URL** (string) - Required - The URL to fetch the contents from.

#### Flags
- **-h, --help** (flag) - Optional - Display the help message for this command.
- **-u, --user** (Any) - Optional - The username when authenticating.
- **-p, --password** (Any) - Optional - The password when authenticating.
- **-t, --timeout** (Int) - Optional - Timeout period in seconds.
- **-H, --headers** (Any) - Optional - Custom headers to add.
- **-r, --raw** (flag) - Optional - Fetch contents as text rather than a table.

### Request Example
> http get https://www.example.com

### Response
#### Success Response (200)
- **Result** (any) - The fetched content, returned as a table or raw text.
```

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

### Get Request and Response Headers with http --full

Source: https://www.nushell.sh/blog/2023-08-22-nushell_0_84_0.html

When using `http get --full`, you can now pipe the output to `get headers` and then `get response` to access both request and response headers.

```nushell
http get --full -H {cooke: "my=cookie"} | get headers | get response
```

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

### Strip characters from the start of strings

Source: https://www.nushell.sh/commands/docs/polars_str-strip-chars.html

Uses the --start flag to remove characters only from the start of strings in a column.

```nushell
> [[text]; ["!!!hello"] ["!!!world"] ["!!!test"]] | polars into-df | polars select (polars col text | polars str-strip-chars --start "!") | polars collect
```

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

### Add buffer_editor example with arguments to config nu --doc

Source: https://www.nushell.sh/blog/2025-02-21-twin0287.html

This snippet demonstrates how to add a buffer_editor example with arguments to the `config nu --doc` command. It's useful for showcasing command-line argument handling in Nushell.

```nu
```nu
# Example of buffer_editor with arguments
let example_buffer = buffer_editor --height 10 --width 80
```
```

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

### 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
```

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

### Prepare test environment file

Source: https://www.nushell.sh/cookbook/modules.html

Create an env.json file and set initial environment variables for testing.

```nushell
{ A: 1 B: 2 } | save env.json

$env.A = 'zzz'

print $"('A' in $env) ('B' in $env)"
# => true false
```

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

### Install Nushell with Extra Features

Source: https://www.nushell.sh/blog/2020-09-22-nushell_0_20.html

Install Nushell with all available features using cargo. This command requires Rust to be installed.

```bash
cargo install nu --features=extra
```

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

### Extract titles from RSS feed using `recurse`

Source: https://www.nushell.sh/blog/2025-06-10-nushell_0_105_0.html

Limit `recurse`'s descent using a cell-path or closure to target specific parts of the input, like extracting titles from an XML RSS feed. This example fetches an RSS feed, recurses into the 'content' field, gets items, filters for records with a 'title' tag, extracts the content, and flattens the result.

```nushell
http get 'https://www.nushell.sh/rss.xml'
| recurse content
| get item
| where ($it | describe -d).type == record and $it.tag? == title
| get content.content
| flatten
```

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

### 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"
```

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

### 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!"
```

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

### 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
```

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

### Start Multiple Files with Glob Support in Nushell

Source: https://www.nushell.sh/blog/2020-06-09-nushell_0_15_0.html

The `start` command now supports glob patterns, allowing you to launch multiple files matching a pattern simultaneously.

```nushell
> start file*.rs
```

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

### Install Nushell with Stable Features

Source: https://www.nushell.sh/blog/2020-03-10-nushell_0_11_0.html

Install Nushell with the 'stable' feature flag for additional goodies. Requires Rust and Cargo to be installed.

```bash
cargo install nu --features=stable
```

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

### Example NUON data structure

Source: https://www.nushell.sh/blog/2022-03-22-nushell_0_60.html

Demonstrates the syntax for the experimental NUON format, including support for tables, durations, filesizes, and binary data.

```NUON
# sample.nuon
[
    # The nuon compact table format
    [[a, nuon, table]; [1, 2, 3], [4, 5, 6]],

    # A filesize
    100kib,

    # A duration
    100sec,

    # A date
    2022-01-11,

    # A boolean
    true,

    # A record
    {name: "Bobby", age: 99},

    # Binary data
    0x[11, ff, ee, 1f]
]
```

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

### FloatRange Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a floating-point range.

```nushell
7.5..10.5
```

```json
{
  "Range": {
    "val": {
      "FloatRange": {
        "start": 7.5,
        "step": 1,
        "end": { "Included": 10.5 }
      }
    },
    "span": {
      "start": 1380,
      "end": 1389
    }
  }
}
```

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

### 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
```

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

### Install Nushell with Cargo

Source: https://www.nushell.sh/blog/2023-04-25-nushell_0_79.html

Install Nushell using Cargo if you have Rust installed. For optional dataframe functionality, use the '--features=dataframe' flag.

```bash
cargo install nu
```

```bash
cargo install nu --features=dataframe
```

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

### Block Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a parsed block reference.

```json
{
  "Block": {
    "val": 44500,
    "span": {
      "start": 59400,
      "end": 59480
    }
  }
}
```

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

### 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
```

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

### 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}
```

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

### File redirection examples

Source: https://www.nushell.sh/lang-guide/chapters/pipelines.html

Commands demonstrating how to redirect stdout and stderr to a file.

```nushell
nu demo.nu o> file.txt
```

```nushell
nu demo.nu e> file.txt
```

```nushell
nu demo.nu o+e> file.txt
```

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

### String Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a UTF-8 string representation.

```nushell
"Hello, nu!"
```

```json
{
  "String": {
    "val": "Hello, nu!",
    "span": {
      "start": 8990,
      "end": 9002
    }
  }
}
```

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

### Import custom help command

Source: https://www.nushell.sh/cookbook/help.html

Loads a custom help implementation from the standard library to override default help output.

```nushell
use std/help
```

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

### Example Nushell Plugin Implementation

Source: https://www.nushell.sh/blog/2024-04-02-nushell_0_92_0.html

Demonstrates the new plugin API structure with a 'len' command that calculates the length of string input. Requires `nu_plugin` and `nu_protocol` crates. The `serve_plugin` function is used to launch the plugin.

```rust
use nu_plugin::{serve_plugin, EvaluatedCall, JsonSerializer};
use nu_plugin::{EngineInterface, Plugin, PluginCommand, SimplePluginCommand};
use nu_protocol::{LabeledError, Signature, Type, Value};

struct LenPlugin;

impl Plugin for LenPlugin {
    fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
        vec![Box::new(Len)]
    }
}

struct Len;

impl SimplePluginCommand for Len {
    type Plugin = LenPlugin;

    fn name(&self) -> &str {
        "len"
    }

    fn usage(&self) -> &str {
        "calculates the length of its input"
    }

    fn signature(&self) -> Signature {
        Signature::build(PluginCommand::name(self))
            .input_output_type(Type::String, Type::Int)
    }

    fn run(
        &self,
        _plugin: &LenPlugin,
        _engine: &EngineInterface,
        call: &EvaluatedCall,
        input: &Value,
    ) -> Result<Value, LabeledError> {
        let span = input.span();
        match input {
            Value::String { val, .. } => Ok(Value::int(val.len() as i64, span)),
            _ => Err(
                LabeledError::new("Expected String input from pipeline").with_label(
                    format!("requires string input; got {}", input.get_type()),
                    call.head,
                ),
            ),
        }
    }
}

fn main() {
    serve_plugin(&LenPlugin, JsonSerializer)
}
```

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

### Get the first column from a table

Source: https://www.nushell.sh/commands/docs/columns.html

After getting the column names from a table using `columns`, you can pipe the result to `first` to get only the first column name.

```nushell
> [[name,age,grade]; [bill,20,a]] | columns | first
```

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

### Nushell `attr example` Attribute

Source: https://www.nushell.sh/commands/docs/attr_example.html

The `attr example` attribute allows you to add descriptive examples to your custom Nushell commands. It takes a description string and an example code snippet as arguments, and can optionally include a `--result` flag to specify the expected output.

```APIDOC
## `attr example` for core

Attribute for adding examples to custom commands.

### Signature
`> attr example {flags} (description) (example)`

### Flags
  * `--result {any}`: Expected output of example.


### Parameters
  * `description`: Description of the example.
  * `example`: Example code snippet.


### Input/output types:
input| output  
---|---
nothing| record<description: string, example: string>

### Examples
Add examples to custom command.
```nu
> # Double numbers
    @example "double an int" { 2 | double } --result 4
    @example "double a float" { 0.25 | double } --result 0.5
    def double []: [number -> number] {
      $in * 2
    }
```
```

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

### Install Nushell MSI (User Scope)

Source: https://www.nushell.sh/blog/2025-05-23-nushell_0_104_1.html

Install the Nushell MSI package quietly for the current user using msiexec. This command is for local MSI installations.

```bash
msiexec /i nu-0.104.1-x86_64-pc-windows-msvc.msi /quiet /qn
```

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

### Plugin Signature Example

Source: https://www.nushell.sh/blog/2023-11-14-nushell_0_87_0.html

Demonstrates a plugin signature with extra usage and search terms. Useful for understanding how plugins are defined and exposed.

```nushell
PluginSignature test 1 for plugin. Returns Value::Nothing

Extra usage for nu-example-1

Search terms: example

Usage:
  > nu-example-1 {flags} <a> <b> (opt) ...(rest)

Flags:
  -h, --help - Display the help message for this command
  -f, --flag - a flag for the signature
  -n, --named <String> - named string

Parameters:
  a <int>: required integer value
  b <string>: required string value
  opt <int>: Optional number (optional)
  ...rest <string>: rest value string

Examples:
  running example with an int value and string value
  > nu-example-1 3 bb
```

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

### 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()
```

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

### List Example

Source: https://www.nushell.sh/contributor-book/plugin_protocol_reference.html

Example of a list containing mixed types.

```nushell
[1, 2, foo, bar]
```

```json
{
  "List": {
    "vals": [
      {
        "Int": {
          "val": 1,
          "span": {
            "start": 659951,
            "end": 659952
          }
        }
      },
      {
        "Int": {
          "val": 2,
          "span": {
            "start": 659954,
            "end": 659955
          }
        }
      },
      {
        "String": {
          "val": "foo",
          "span": {
            "start": 659957,
            "end": 659960
          }
        }
      },
      {
        "String": {
          "val": "bar",
          "span": {
            "start": 659962,
            "end": 659965
          }
        }
      }
    ],
    "span": {
      "start": 659950,
      "end": 659966
    }
  }
}
```

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

### Install Nushell MSI (Machine Scope)

Source: https://www.nushell.sh/blog/2025-05-23-nushell_0_104_1.html

Install the Nushell MSI package quietly for all users on the machine using msiexec with the ALLUSERS=1 flag. This is for local MSI installations.

```bash
msiexec /i nu-0.104.1-x86_64-pc-windows-msvc.msi ALLUSERS=1
```

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

### Execute a plugin command with configuration

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

Example usage of the configured motd plugin in the Nushell shell.

```nushell
> $env.config.plugins.motd = {message: "Nushell rocks!"}
> motd
Nushell rocks!
```

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

### Pipeline redirection examples

Source: https://www.nushell.sh/lang-guide/chapters/pipelines.html

Commands demonstrating how to redirect stdout and stderr to a pipeline.

```nushell
let result = nu demo.nu | str upcase
```

```nushell
let result = nu demo.nu e>| str upcase
```

```nushell
let result = nu demo.nu e+o>| str upcase
```

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

### Install Nushell with Starship Feature

Source: https://www.nushell.sh/blog/2019-11-26-nushell-0_6_0.html

Install Nushell with the Starship prompt feature enabled using Cargo. This command ensures that Starship integration is available in your Nu installation.

```bash
> cargo install nu --features starship-prompt
```

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

### Create completion directory and module file

Source: https://www.nushell.sh/cookbook/modules.html

Commands to initialize the directory structure for custom completions.

```nushell
mkdir ($nu.default-config-dir | path join completions)
```

```nushell
touch ($nu.default-config-dir | path join completions mod.nu)
```

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

### Create and activate environment overlay

Source: https://www.nushell.sh/cookbook/modules.html

Define an environment-loading module and activate it as an overlay.

```nushell
'export def --env load [] { open env.json | load-env }' | save env.nu

overlay use ./env.nu

overlay list
# => ╭───┬──────╮
# => │ 0 │ zero │
# => │ 1 │ env  │
# => ╰───┴──────╯
```

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

### Default start value

Source: https://www.nushell.sh/lang-guide/chapters/types/basic_types/range.html

Omitting the start value defaults it to 0.

```nushell
> (..5) == (0..5)
true
```

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

### 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!
```

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

### 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
# => ───┴──────
```

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

### Bytes Starts With

Source: https://www.nushell.sh/commands/docs/bytes_starts-with.html

Checks if binary data starts with a given pattern.

```APIDOC
## `bytes starts-with`

### Description
Check if binary data starts with a pattern.

### Signature
`> bytes starts-with {flags} (pattern) ...rest`

### Parameters
* `pattern` (binary) - The pattern to match.
* `...rest` (any) - For a data structure input, check if bytes at the given cell paths start with the pattern.

### Input/Output Types
input| output  
---|---
binary| bool  
table| table  
record| record  

### Examples

Checks if binary starts with `0x[1F FF AA]`.
```nu
> 0x[1F FF AA AA] | bytes starts-with 0x[1F FF AA]
true
```

Checks if binary starts with `0x[1F]`.
```nu
> 0x[1F FF AA AA] | bytes starts-with 0x[1F]
true
```

Checks if binary starts with `0x[11]`.
```nu
> 0x[1F FF AA AA] | bytes starts-with 0x[11]
false
```
```

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

### Install Nushell via Winget (User Scope)

Source: https://www.nushell.sh/blog/2025-05-23-nushell_0_104_1.html

Use this command to install Nushell for the current user via the winget package manager. Ensure you are installing version 0.104.1.

```bash
winget install Nushell.Nushell
```

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

### Real-world example: Analyze text from a URL

Source: https://www.nushell.sh/commands/docs/split_words.html

This example demonstrates a practical application of `split words` by fetching text from a URL, converting it to lowercase, splitting it into words of at least 2 characters, counting unique words, sorting them by count in reverse order, and displaying the top 10.

```nushell
> http get https://www.gutenberg.org/files/11/11-0.txt | str downcase | split words --min-word-length 2 | uniq --count | sort-by count --reverse | first 10
```
Tokens:
Raw