Refresh command docs for Nu v0.94 (#1419)

* Refresh command docs for Nu v0.94 * ci skip
nushell · May 28, 2024 · b985c65 · b985c65
1 parent b10016d
commit b985c65
Show file tree

Hide file tree

Showing 652 changed files with 1,348 additions and 7,184 deletions.
diff --git a/commands/docs/alias.md b/commands/docs/alias.md
@@ -2,7 +2,7 @@
 title: alias
 categories: |
  core
-version: 0.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.0
 platform: |
  Output ANSI codes to change color and style of text.
 usage: |
@@ -143,8 +143,8 @@ Operating system commands:
 
 ## Subcommands:
 
-| name | type | usage |
-| -------------------------------------------------- | ------- | ------------------------------------------------------------------ |
-| [`ansi gradient`](/commands/docs/ansi_gradient.md) | Builtin | Add a color gradient (using ANSI color codes) to the given string. |
-| [`ansi link`](/commands/docs/ansi_link.md) | Builtin | Add a link (using OSC 8 escape sequence) to the given string. |
-| [`ansi strip`](/commands/docs/ansi_strip.md) | Builtin | Strip ANSI escape sequences from a string. |
+| name | usage   | 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 |
+| [`ansi strip`](/commands/docs/ansi_strip.md) | Strip ANSI escape sequences from a 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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.0
 bits: |
  Various commands for working with bits.
 usage: |
@@ -31,13 +31,13 @@ You must use one of the following subcommands. Using this command as-is will onl
 
 ## Subcommands:
 
-| name | type | usage |
-| ---------------------------------------- | ------- | ----------------------------------------------- |
-| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for ints or binary values. |
-| [`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 ints or binary values. |
-| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for ints or binary values. |
-| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for ints or binary values. |
-| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for ints or binary values. |
-| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for ints or binary values. |
-| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for ints or binary values. |
+| name | usage   | 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 |
+| [`bits or`](/commands/docs/bits_or.md) | Performs bitwise or for ints or binary values.  | built-in |
+| [`bits rol`](/commands/docs/bits_rol.md) | Bitwise rotate left for ints or binary values.  | built-in |
+| [`bits ror`](/commands/docs/bits_ror.md) | Bitwise rotate right for ints or binary values. | built-in |
+| [`bits shl`](/commands/docs/bits_shl.md) | Bitwise shift left for ints or binary values.  | built-in |
+| [`bits shr`](/commands/docs/bits_shr.md) | Bitwise shift right for ints or binary values.  | built-in |
+| [`bits xor`](/commands/docs/bits_xor.md) | Performs bitwise xor for ints or binary values. | 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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.0
 bytes: |
  Various commands for working with byte data.
 usage: |
@@ -31,16 +31,16 @@ You must use one of the following subcommands. Using this command as-is will onl
 
 ## Subcommands:
 
-| name | type | usage |
-| ---------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------ |
-| [`bytes add`](/commands/docs/bytes_add.md) | Builtin | Add specified bytes to the input. |
-| [`bytes at`](/commands/docs/bytes_at.md) | Builtin | Get bytes defined by a range. |
-| [`bytes build`](/commands/docs/bytes_build.md) | Builtin | Create bytes from the arguments. |
-| [`bytes collect`](/commands/docs/bytes_collect.md) | Builtin | Concatenate multiple binary into a single binary, with an optional separator between each. |
-| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Builtin | Check if bytes ends with a pattern. |
-| [`bytes index-of`](/commands/docs/bytes_index-of.md) | Builtin | Returns start index of first occurrence of pattern in bytes, or -1 if no match. |
-| [`bytes length`](/commands/docs/bytes_length.md) | Builtin | Output the length of any bytes in the pipeline. |
-| [`bytes remove`](/commands/docs/bytes_remove.md) | Builtin | Remove bytes. |
-| [`bytes replace`](/commands/docs/bytes_replace.md) | Builtin | Find and replace binary. |
-| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Builtin | Reverse the bytes in the pipeline. |
-| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Builtin | Check if bytes starts with a pattern. |
+| name | usage   | 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 |
+| [`bytes build`](/commands/docs/bytes_build.md) | Create bytes from the arguments.  | built-in |
+| [`bytes collect`](/commands/docs/bytes_collect.md) | Concatenate multiple binary into a single binary, with an optional separator between each. | built-in |
+| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Check if bytes ends with a pattern.  | built-in |
+| [`bytes index-of`](/commands/docs/bytes_index-of.md) | Returns start index of first occurrence of pattern in bytes, or -1 if no match.  | built-in |
+| [`bytes length`](/commands/docs/bytes_length.md) | Output the length of any bytes in the pipeline.  | built-in |
+| [`bytes remove`](/commands/docs/bytes_remove.md) | Remove bytes.  | built-in |
+| [`bytes replace`](/commands/docs/bytes_replace.md) | Find and replace binary.  | built-in |
+| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Reverse the bytes in the pipeline.  | built-in |
+| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Check if bytes starts with a pattern.  | 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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.0
 bytes: |
  Create bytes from the arguments.
 usage: |
@@ -39,3 +39,11 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii
 00000000: 01 02 03 04 ••••
 
 ```
+
+Builds binary data from byte numbers
+```nu
+> bytes build 255 254 253 252
+Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii
+00000000: ff fe fd fc ××××
+
+```
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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.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.93.0
+version: 0.94.0
 filesystem: |
  Change directory.
 usage: |
@@ -19,6 +19,10 @@ feature: default
 
 ```> cd {flags} (path)```
 
+## Flags
+
+ - `--physical, -P`: use the physical directory structure; resolve symbolic links before processing instances of ..
+
 ## Parameters
 
  - `path`: The path to change to.