Skip to content

Commit

Permalink
Refresh command docs for Nu 0.97.1 (#1520)
Browse files Browse the repository at this point in the history
* Refresh command docs for Nu 0.97.0

* Remove deprecated polars to* commands

* Add plugin banners

* chore: Bump patch version

* ci skip
  • Loading branch information
hustcer authored Aug 21, 2024
1 parent 9ef06c5 commit 873c77b
Show file tree
Hide file tree
Showing 541 changed files with 1,664 additions and 907 deletions.
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
core: |
Alias a command (with optional flags) to a new name.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
platform: |
Output ANSI codes to change color and style of text.
usage: |
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
platform: |
Strip ANSI escape sequences from a string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
filters: |
Tests if any element of the input fulfills a predicate expression.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
filters: |
Append any number of rows to a table.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
bits: |
Various commands for working with bits.
usage: |
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
bits: |
Performs bitwise xor for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
core: |
Break a loop.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
bytes: |
Various commands for working with byte data.
usage: |
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.96.0
version: 0.97.1
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.96.0
version: 0.97.1
bytes: |
Get bytes defined by a range.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
bytes: |
Create bytes from the arguments.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.96.0
version: 0.97.1
bytes: |
Concatenate multiple binary into a single binary, with an optional separator between each.
usage: |
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.96.0
version: 0.97.1
bytes: |
Check if bytes ends with a pattern.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_index-of.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes index-of
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Returns start index of first occurrence of pattern in bytes, or -1 if no match.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_length.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes length
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Output the length of any bytes in the pipeline.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes remove
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Remove bytes.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_replace.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes replace
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Find and replace binary.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_reverse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes reverse
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Reverse the bytes in the pipeline.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_starts-with.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes starts-with
categories: |
bytes
version: 0.96.0
version: 0.97.1
bytes: |
Check if bytes starts with a pattern.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/cal.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: cal
categories: |
generators
version: 0.96.0
version: 0.97.1
generators: |
Display a calendar.
usage: |
Expand Down
16 changes: 14 additions & 2 deletions commands/docs/cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: cd
categories: |
filesystem
version: 0.96.0
version: 0.97.1
filesystem: |
Change directory.
usage: |
Expand Down Expand Up @@ -41,7 +41,7 @@ Change to your home directory
```

Change to the previous working directory ($OLDPWD)
Change to the previous working directory (same as "cd $env.OLDPWD")
```nu
> cd -
Expand All @@ -52,3 +52,15 @@ Changing directory with a custom command requires 'def --env'
> def --env gohome [] { cd ~ }
```

Move two directories up in the tree (the parent directory's parent). Additional dots can be added for additional levels.
```nu
> cd ...
```

The cd command itself is often optional. Simply entering a path to a directory will cd to it.
```nu
> /home
```
2 changes: 1 addition & 1 deletion commands/docs/char.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: char
categories: |
strings
version: 0.96.0
version: 0.97.1
strings: |
Output special characters (e.g., 'newline').
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/chunks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: chunks
categories: |
filters
version: 0.96.0
version: 0.97.1
filters: |
Divide a list or table into chunks of `chunk_size`.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/clear.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: clear
categories: |
platform
version: 0.96.0
version: 0.97.1
platform: |
Clear the terminal.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: collect
categories: |
filters
version: 0.96.0
version: 0.97.1
filters: |
Collect a stream into a value.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: columns
categories: |
filters
version: 0.96.0
version: 0.97.1
filters: |
Given a record or table, produce a list of its columns' names.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: commandline
categories: |
core
version: 0.96.0
version: 0.97.1
core: |
View the current command line input buffer.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/commandline_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: commandline edit
categories: |
core
version: 0.96.0
version: 0.97.1
core: |
Modify the current command line input buffer.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/commandline_get-cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: commandline get-cursor
categories: |
core
version: 0.96.0
version: 0.97.1
core: |
Get the current cursor position.
usage: |
Expand Down
Loading

0 comments on commit 873c77b

Please sign in to comment.