Refresh command docs for Nu v0.86 (#1112)

* Refresh docs for Nu v0.86 * ci skip * remove some unused commands
nushell · Oct 18, 2023 · 308e38f · 308e38f
1 parent a08b49b
commit 308e38f
Show file tree

Hide file tree

Showing 499 changed files with 1,465 additions and 1,075 deletions.
diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts
@@ -30,4 +30,4 @@ export const commandCategories = [
  '/commands/categories/strings.md',
  '/commands/categories/system.md',
  '/commands/categories/viewers.md',
-];
+];
diff --git a/commands/docs/alias.md b/commands/docs/alias.md
@@ -2,7 +2,7 @@
 title: alias
 categories: |
  core
-version: 0.85.0
+version: 0.86.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.85.0
+version: 0.86.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.85.0
+version: 0.86.0
 platform: |
  Output ANSI codes to change color and style of text.
 usage: |
@@ -93,6 +93,7 @@ Escape sequences usual values:
 │ 3 │ foreground │ 33 │ 93 │ yellow │
 │ 4 │ foreground │ 34 │ 94 │ blue │
 │ 5 │ foreground │ 35 │ 95 │ magenta │
+│ 5 │ foreground │ 35 │ 95 │ purple │
 │ 6 │ foreground │ 36 │ 96 │ cyan │
 │ 7 │ foreground │ 37 │ 97 │ white │
 │ 8 │ foreground │ 39 │ │ default │
@@ -102,6 +103,7 @@ Escape sequences usual values:
 │ 12 │ background │ 43 │ 103 │ yellow │
 │ 13 │ background │ 44 │ 104 │ blue │
 │ 14 │ background │ 45 │ 105 │ magenta │
+│ 14 │ background │ 45 │ 105 │ purple │
 │ 15 │ background │ 46 │ 106 │ cyan │
 │ 16 │ background │ 47 │ 107 │ white │
 │ 17 │ background │ 49 │ │ default │

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.85.0
+version: 0.86.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.85.0
+version: 0.86.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.85.0
+version: 0.86.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.85.0
+version: 0.86.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.85.0
+version: 0.86.0
 filters: |
  Append any number of rows to a table.
 usage: |
@@ -31,7 +31,7 @@ usage: |
 
 ## Examples
 
-Append one integer to a list
+Append one int to a list
 ```nu
 > [0 1 2 3] | append 4
 ╭───┬───╮
@@ -66,7 +66,7 @@ Append a list of string to a string
 
 ```
 
-Append three integer items
+Append three int items
 ```nu
 > [0 1] | append [2 3 4]
 ╭───┬───╮
@@ -79,7 +79,7 @@ Append three integer items
 
 ```
 
-Append integers and strings
+Append ints and strings
 ```nu
 > [0 1] | append [2 nu 4 shell]
 ╭───┬───────╮
@@ -93,7 +93,7 @@ Append integers and strings
 
 ```
 
-Append a range of integers to a list
+Append a range of ints to a list
 ```nu
 > [0 1] | append 2..4
 ╭───┬───╮

diff --git a/commands/docs/ast.md b/commands/docs/ast.md
@@ -2,7 +2,7 @@
 title: ast
 categories: |
  debug
-version: 0.85.0
+version: 0.86.0
 debug: |
  Print the abstract syntax tree (ast) for a pipeline.
 usage: |
@@ -62,6 +62,6 @@ Print the ast of a pipeline with an error, as json, in a nushell table
 
 Print the ast of a pipeline with an error, as json, minified
 ```nu
-> ast 'for x in 1..10 { echo $x ' -j -m
+> ast 'for x in 1..10 { echo $x ' --json --minify
 
 ```
diff --git a/commands/docs/bits.md b/commands/docs/bits.md
@@ -2,7 +2,7 @@
 title: bits
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
  Various commands for working with bits.
 usage: |
@@ -32,13 +32,13 @@ You must use one of the following subcommands. Using this command as-is will onl
 
 | name | type | usage |
 | ---------------------------------------- | ------- | -------------------------------------- |
-| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for integers. |
+| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for ints.  |
 | [`bits not`](/commands/docs/bits_not.md) | Builtin | Performs logical negation on each bit. |
-| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for integers. |
-| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for integers. |
-| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for integers. |
-| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for integers. |
-| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for integers. |
-| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for integers. |
+| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for ints.  |
+| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for ints.  |
+| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for ints.  |
+| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for ints.  |
+| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for ints.  |
+| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for ints.  |
 
 **Tips:** Command `bits` was not included in the official binaries by default, you have to build it with `--features=extra` flag
diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md
@@ -2,11 +2,11 @@
 title: bits and
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Performs bitwise and for integers.
+ Performs bitwise and for ints.
 usage: |
- Performs bitwise and for integers.
+ Performs bitwise and for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 
@@ -20,7 +20,7 @@ usage: |
 
 ## Parameters
 
- - `target`: target integer to perform bit and
+ - `target`: target int to perform bit and
 
 
 ## Input/output types:

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.85.0
+version: 0.86.0
 bits: |
  Performs logical negation on each bit.
 usage: |
@@ -45,7 +45,7 @@ Apply logical negation to a list of numbers
 
 Apply logical negation to a list of numbers, treat input as 2 bytes number
 ```nu
-> [4 3 2] | bits not -n '2'
+> [4 3 2] | bits not --number-bytes '2'
 ╭───┬───────╮
 │ 0 │ 65531 │
 │ 1 │ 65532 │
@@ -56,7 +56,7 @@ Apply logical negation to a list of numbers, treat input as 2 bytes number
 
 Apply logical negation to a list of numbers, treat input as signed number
 ```nu
-> [4 3 2] | bits not -s
+> [4 3 2] | bits not --signed
 ╭───┬────╮
 │ 0 │ -5 │
 │ 1 │ -4 │

diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md
@@ -2,11 +2,11 @@
 title: bits or
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Performs bitwise or for integers.
+ Performs bitwise or for ints.
 usage: |
- Performs bitwise or for integers.
+ Performs bitwise or for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 
@@ -20,7 +20,7 @@ usage: |
 
 ## Parameters
 
- - `target`: target integer to perform bit or
+ - `target`: target int to perform bit or
 
 
 ## Input/output types:

diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md
@@ -2,11 +2,11 @@
 title: bits rol
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Bitwise rotate left for integers.
+ Bitwise rotate left for ints.
 usage: |
- Bitwise rotate left for integers.
+ Bitwise rotate left for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md
@@ -2,11 +2,11 @@
 title: bits ror
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Bitwise rotate right for integers.
+ Bitwise rotate right for ints.
 usage: |
- Bitwise rotate right for integers.
+ Bitwise rotate right for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 
@@ -44,7 +44,7 @@ Rotate right a number with 60 bits
 
 Rotate right a list of numbers of one byte
 ```nu
-> [15 33 92] | bits ror 2 -n '1'
+> [15 33 92] | bits ror 2 --number-bytes '1'
 ╭───┬─────╮
 │ 0 │ 195 │
 │ 1 │ 72 │

diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md
@@ -2,11 +2,11 @@
 title: bits shl
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Bitwise shift left for integers.
+ Bitwise shift left for ints.
 usage: |
- Bitwise shift left for integers.
+ Bitwise shift left for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 
@@ -44,13 +44,13 @@ Shift left a number by 7 bits
 
 Shift left a number with 1 byte by 7 bits
 ```nu
-> 2 | bits shl 7 -n '1'
+> 2 | bits shl 7 --number-bytes '1'
 0
 ```
 
 Shift left a signed number by 1 bit
 ```nu
-> 0x7F | bits shl 1 -s
+> 0x7F | bits shl 1 --signed
 254
 ```
 

diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md
@@ -2,11 +2,11 @@
 title: bits shr
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Bitwise shift right for integers.
+ Bitwise shift right for ints.
 usage: |
- Bitwise shift right for integers.
+ Bitwise shift right for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md
@@ -2,11 +2,11 @@
 title: bits xor
 categories: |
  bits
-version: 0.85.0
+version: 0.86.0
 bits: |
- Performs bitwise xor for integers.
+ Performs bitwise xor for ints.
 usage: |
- Performs bitwise xor for integers.
+ Performs bitwise xor for ints.
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 
@@ -20,7 +20,7 @@ usage: |
 
 ## Parameters
 
- - `target`: target integer to perform bit xor
+ - `target`: target int to perform bit xor
 
 
 ## Input/output types:

diff --git a/commands/docs/break.md b/commands/docs/break.md
@@ -2,7 +2,7 @@
 title: break
 categories: |
  core
-version: 0.85.0
+version: 0.86.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.85.0
+version: 0.86.0
 bytes: |
  Various commands for working with byte data.
 usage: |