Skip to content

Refresh Nu command docs for v0.104 #1900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 1 addition & 2 deletions commands/docs/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: alias
categories: |
core
version: 0.103.0
version: 0.104.0
core: |
Alias a command (with optional flags) to a new name.
usage: |
Expand Down Expand Up @@ -31,7 +31,6 @@ contributors: false
| input | output |
| ------- | ------- |
| nothing | nothing |

## Examples

Alias ll to ls -l
Expand Down
9 changes: 7 additions & 2 deletions commands/docs/all.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: all
categories: |
filters
version: 0.103.0
version: 0.104.0
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Expand Down Expand Up @@ -30,9 +30,14 @@ contributors: false
| input | output |
| --------- | ------ |
| list\<any\> | bool |

## Examples

Check if a list contains only true values
```nu
> [false true true false] | all {}
false
```

Check if each row's status is the string 'UP'
```nu
> [[status]; [UP] [UP]] | all {|el| $el.status == UP }
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/ansi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi
categories: |
platform
version: 0.103.0
version: 0.104.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Expand Down Expand Up @@ -36,7 +36,6 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | any |

## Examples

Change color to green (see how the next example text will be green!)
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi gradient
categories: |
platform
version: 0.103.0
version: 0.104.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_link.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi link
categories: |
platform
version: 0.103.0
version: 0.104.0
platform: |
Add a link (using OSC 8 escape sequence) to the given string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_strip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi strip
categories: |
platform
version: 0.103.0
version: 0.104.0
platform: |
Strip ANSI escape sequences from a string.
usage: |
Expand Down
9 changes: 7 additions & 2 deletions commands/docs/any.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: any
categories: |
filters
version: 0.103.0
version: 0.104.0
filters: |
Tests if any element of the input fulfills a predicate expression.
usage: |
Expand Down Expand Up @@ -30,9 +30,14 @@ contributors: false
| input | output |
| --------- | ------ |
| list\<any\> | bool |

## Examples

Check if a list contains any true values
```nu
> [false true true false] | any {}
true
```

Check if any row's status is the string 'DOWN'
```nu
> [[status]; [UP] [DOWN] [UP]] | any {|el| $el.status == DOWN }
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/append.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: append
categories: |
filters
version: 0.103.0
version: 0.104.0
filters: |
Append any number of rows to a table.
usage: |
Expand Down Expand Up @@ -30,7 +30,6 @@ contributors: false
| input | output |
| ----- | --------- |
| any | list\<any\> |

## Examples

Append one int to a list
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/ast.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ast
categories: |
debug
version: 0.103.0
version: 0.104.0
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Expand Down Expand Up @@ -36,7 +36,6 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | table |

## Examples

Print the ast of a string
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/attr_category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr category
categories: |
core
version: 0.103.0
version: 0.104.0
core: |
Attribute for adding a category to custom commands.
usage: |
Expand Down Expand Up @@ -30,7 +30,6 @@ contributors: false
| input | output |
| ------- | ------------ |
| nothing | list\<string\> |

## Examples

Add a category to a custom command
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/attr_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr example
categories: |
core
version: 0.103.0
version: 0.104.0
core: |
Attribute for adding examples to custom commands.
usage: |
Expand Down Expand Up @@ -35,7 +35,6 @@ contributors: false
| input | output |
| ------- | -------------------------------------------- |
| nothing | record\<description: string, example: string\> |

## Examples

Add examples to custom command
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/attr_search-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr search-terms
categories: |
core
version: 0.103.0
version: 0.104.0
core: |
Attribute for adding search terms to custom commands.
usage: |
Expand Down Expand Up @@ -30,7 +30,6 @@ contributors: false
| input | output |
| ------- | ------------ |
| nothing | list\<string\> |

## Examples

Add search terms to a custom command
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: banner
categories: |
default
version: 0.103.0
version: 0.104.0
default: |
Print a banner for Nushell with information about the project
usage: |
Expand All @@ -29,4 +29,4 @@ contributors: false

| input | output |
| ----- | ------ |
| any | any |
| any | any |
3 changes: 1 addition & 2 deletions commands/docs/bits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Various commands for working with bits.
usage: |
Expand All @@ -26,7 +26,6 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | string |

## Notes
You must use one of the following subcommands. Using this command as-is will only produce this help message.

Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_and.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits and
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Performs bitwise and for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_not.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits not
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Performs logical negation on each bit.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_or.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits or
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Performs bitwise or for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_rol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits rol
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Bitwise rotate left for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_ror.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits ror
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Bitwise rotate right for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_shl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits shl
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Bitwise shift left for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_shr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits shr
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Bitwise shift right for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_xor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits xor
categories: |
bits
version: 0.103.0
version: 0.104.0
bits: |
Performs bitwise xor for ints or binary values.
usage: |
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/break.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: break
categories: |
core
version: 0.103.0
version: 0.104.0
core: |
Break a loop.
usage: |
Expand All @@ -26,7 +26,6 @@ contributors: false
| input | output |
| ------- | ------- |
| nothing | nothing |

## Examples

Break out of a loop
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Various commands for working with byte data.
usage: |
Expand All @@ -26,7 +26,6 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | string |

## Notes
You must use one of the following subcommands. Using this command as-is will only produce this help message.

Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes add
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Add specified bytes to the input.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_at.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes at
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Get bytes defined by a range.
usage: |
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/bytes_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes build
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Create bytes from the arguments.
usage: |
Expand Down Expand Up @@ -30,7 +30,6 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | binary |

## Examples

Builds binary data from 0x[01 02], 0x[03], 0x[04]
Expand Down
3 changes: 1 addition & 2 deletions commands/docs/bytes_collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes collect
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Concatenate multiple binary into a single binary, with an optional separator between each.
usage: |
Expand Down Expand Up @@ -30,7 +30,6 @@ contributors: false
| input | output |
| ------------ | ------ |
| list\<binary\> | binary |

## Examples

Create a byte array from input
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_ends-with.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes ends-with
categories: |
bytes
version: 0.103.0
version: 0.104.0
bytes: |
Check if bytes ends with a pattern.
usage: |
Expand Down
Loading