Refresh command docs for Nu 0.98.0 (#1555)

* Refresh command docs for Nu 0.98.0 * Refresh command docs for Nu 0.98.0 * Refresh command docs for Nu 0.98.0
nushell · Sep 18, 2024 · 665d027 · 665d027
1 parent b070777
commit 665d027
Show file tree

Hide file tree

Showing 555 changed files with 1,673 additions and 917 deletions.
diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts
@@ -11,7 +11,6 @@ export const commandCategories = [
   '/commands/categories/debug.md',
   '/commands/categories/default.md',
   '/commands/categories/env.md',
-  '/commands/categories/experimental.md',
   '/commands/categories/expression.md',
   '/commands/categories/filesystem.md',
   '/commands/categories/filters.md',

diff --git a/commands/docs/alias.md b/commands/docs/alias.md
@@ -2,7 +2,7 @@
 title: alias
 categories: |
   core
-version: 0.97.1
+version: 0.98.0
 core: |
   Alias a command (with optional flags) to a new name.
 usage: |

diff --git a/commands/docs/all.md b/commands/docs/all.md
@@ -2,7 +2,7 @@
 title: all
 categories: |
   filters
-version: 0.97.1
+version: 0.98.0
 filters: |
   Test if every element of the input fulfills a predicate expression.
 usage: |

diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md
@@ -2,7 +2,7 @@
 title: ansi
 categories: |
   platform
-version: 0.97.1
+version: 0.98.0
 platform: |
   Output ANSI codes to change color and style of text.
 usage: |
@@ -142,7 +142,7 @@ Operating system commands:
 
 ## Subcommands:
 
-| name                                               | usage                                                              | type     |
+| name                                               | description                                                        | type     |
 | -------------------------------------------------- | ------------------------------------------------------------------ | -------- |
 | [`ansi gradient`](/commands/docs/ansi_gradient.md) | Add a color gradient (using ANSI color codes) to the given string. | built-in |
 | [`ansi link`](/commands/docs/ansi_link.md)         | Add a link (using OSC 8 escape sequence) to the given string.      | built-in |

diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md
@@ -2,7 +2,7 @@
 title: ansi gradient
 categories: |
   platform
-version: 0.97.1
+version: 0.98.0
 platform: |
   Add a color gradient (using ANSI color codes) to the given string.
 usage: |

diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md
@@ -2,7 +2,7 @@
 title: ansi link
 categories: |
   platform
-version: 0.97.1
+version: 0.98.0
 platform: |
   Add a link (using OSC 8 escape sequence) to the given string.
 usage: |

diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md
@@ -2,7 +2,7 @@
 title: ansi strip
 categories: |
   platform
-version: 0.97.1
+version: 0.98.0
 platform: |
   Strip ANSI escape sequences from a string.
 usage: |

diff --git a/commands/docs/any.md b/commands/docs/any.md
@@ -2,7 +2,7 @@
 title: any
 categories: |
   filters
-version: 0.97.1
+version: 0.98.0
 filters: |
   Tests if any element of the input fulfills a predicate expression.
 usage: |

diff --git a/commands/docs/append.md b/commands/docs/append.md
@@ -2,7 +2,7 @@
 title: append
 categories: |
   filters
-version: 0.97.1
+version: 0.98.0
 filters: |
   Append any number of rows to a table.
 usage: |

diff --git a/commands/docs/ast.md b/commands/docs/ast.md
@@ -2,7 +2,7 @@
 title: ast
 categories: |
   debug
-version: 0.97.1
+version: 0.98.0
 debug: |
   Print the abstract syntax tree (ast) for a pipeline.
 usage: |

diff --git a/commands/docs/bits.md b/commands/docs/bits.md
@@ -2,7 +2,7 @@
 title: bits
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Various commands for working with bits.
 usage: |
@@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl
 
 ## Subcommands:
 
-| name                                     | usage                                           | type     |
+| name                                     | description                                     | type     |
 | ---------------------------------------- | ----------------------------------------------- | -------- |
 | [`bits and`](/commands/docs/bits_and.md) | Performs bitwise and for ints or binary values. | built-in |
 | [`bits not`](/commands/docs/bits_not.md) | Performs logical negation on each bit.          | built-in |

diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md
@@ -2,7 +2,7 @@
 title: bits and
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Performs bitwise and for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md
@@ -2,7 +2,7 @@
 title: bits not
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Performs logical negation on each bit.
 usage: |

diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md
@@ -2,7 +2,7 @@
 title: bits or
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Performs bitwise or for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md
@@ -2,7 +2,7 @@
 title: bits rol
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Bitwise rotate left for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md
@@ -2,7 +2,7 @@
 title: bits ror
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Bitwise rotate right for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md
@@ -2,7 +2,7 @@
 title: bits shl
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Bitwise shift left for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md
@@ -2,7 +2,7 @@
 title: bits shr
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Bitwise shift right for ints or binary values.
 usage: |

diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md
@@ -2,7 +2,7 @@
 title: bits xor
 categories: |
   bits
-version: 0.97.1
+version: 0.98.0
 bits: |
   Performs bitwise xor for ints or binary values.
 usage: |

diff --git a/commands/docs/break.md b/commands/docs/break.md
@@ -2,7 +2,7 @@
 title: break
 categories: |
   core
-version: 0.97.1
+version: 0.98.0
 core: |
   Break a loop.
 usage: |

diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md
@@ -2,7 +2,7 @@
 title: bytes
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Various commands for working with byte data.
 usage: |
@@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl
 
 ## Subcommands:
 
-| name                                                       | usage                                                                                      | type     |
+| name                                                       | description                                                                                | type     |
 | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------- |
 | [`bytes add`](/commands/docs/bytes_add.md)                 | Add specified bytes to the input.                                                          | built-in |
 | [`bytes at`](/commands/docs/bytes_at.md)                   | Get bytes defined by a range.                                                              | built-in |

diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md
@@ -2,7 +2,7 @@
 title: bytes add
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Add specified bytes to the input.
 usage: |

diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md
@@ -2,7 +2,7 @@
 title: bytes at
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Get bytes defined by a range.
 usage: |

diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md
@@ -2,7 +2,7 @@
 title: bytes build
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Create bytes from the arguments.
 usage: |

diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md
@@ -2,7 +2,7 @@
 title: bytes collect
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Concatenate multiple binary into a single binary, with an optional separator between each.
 usage: |

diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md
@@ -2,7 +2,7 @@
 title: bytes ends-with
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Check if bytes ends with a pattern.
 usage: |

diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md
@@ -2,7 +2,7 @@
 title: bytes index-of
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Returns start index of first occurrence of pattern in bytes, or -1 if no match.
 usage: |

diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md
@@ -2,7 +2,7 @@
 title: bytes length
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Output the length of any bytes in the pipeline.
 usage: |

diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md
@@ -2,7 +2,7 @@
 title: bytes remove
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Remove bytes.
 usage: |

diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md
@@ -2,7 +2,7 @@
 title: bytes replace
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Find and replace binary.
 usage: |

diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md
@@ -2,7 +2,7 @@
 title: bytes reverse
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Reverse the bytes in the pipeline.
 usage: |

diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md
@@ -2,7 +2,7 @@
 title: bytes starts-with
 categories: |
   bytes
-version: 0.97.1
+version: 0.98.0
 bytes: |
   Check if bytes starts with a pattern.
 usage: |

diff --git a/commands/docs/cal.md b/commands/docs/cal.md
@@ -2,7 +2,7 @@
 title: cal
 categories: |
   generators
-version: 0.97.1
+version: 0.98.0
 generators: |
   Display a calendar.
 usage: |

diff --git a/commands/docs/cd.md b/commands/docs/cd.md
@@ -2,7 +2,7 @@
 title: cd
 categories: |
   filesystem
-version: 0.97.1
+version: 0.98.0
 filesystem: |
   Change directory.
 usage: |

diff --git a/commands/docs/char.md b/commands/docs/char.md
@@ -2,7 +2,7 @@
 title: char
 categories: |
   strings
-version: 0.97.1
+version: 0.98.0
 strings: |
   Output special characters (e.g., 'newline').
 usage: |

diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md
@@ -2,7 +2,7 @@
 title: chunks
 categories: |
   filters
-version: 0.97.1
+version: 0.98.0
 filters: |
   Divide a list or table into chunks of `chunk_size`.
 usage: |

diff --git a/commands/docs/clear.md b/commands/docs/clear.md
@@ -2,7 +2,7 @@
 title: clear
 categories: |
   platform
-version: 0.97.1
+version: 0.98.0
 platform: |
   Clear the terminal.
 usage: |
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--all, -a`: Clear the terminal and its scroll-back history
+ -  `--keep-scrollback, -k`: Do not clear the scrollback history
 
 
 ## Input/output types:
@@ -37,8 +37,11 @@ Clear the terminal
 
 ```
 
-Clear the terminal and its scroll-back history
+Clear the terminal but not its scrollback history
 ```nu
-> clear --all
+> clear --keep-scrollback
 
 ```
+
+## Notes
+By default clears the current screen and the off-screen scrollback buffer.
diff --git a/commands/docs/collect.md b/commands/docs/collect.md
@@ -2,7 +2,7 @@
 title: collect
 categories: |
   filters
-version: 0.97.1
+version: 0.98.0
 filters: |
   Collect a stream into a value.
 usage: |