Refresh command docs for Nu v0.87 (#1144)

* Refresh command docs for Nu v0.87 * Refresh command docs for Nu v0.87
nushell · Nov 15, 2023 · ad09ef5 · ad09ef5
1 parent e08f840
commit ad09ef5
Show file tree

Hide file tree

Showing 499 changed files with 1,024 additions and 766 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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.0
 platform: |
  Output ANSI codes to change color and style of text.
 usage: |
@@ -63,7 +63,7 @@ Hello Nu World
 
 Use escape codes, without the '\x1b['
 ```nu
-> $"(ansi -e '3;93;41m')Hello(ansi reset)" # italic bright yellow on red background
+> $"(ansi --escape '3;93;41m')Hello(ansi reset)" # italic bright yellow on red background
 Hello
 ```
 
@@ -74,7 +74,7 @@ Use structured escape codes
  bg: '#ff0000'
  attr: b
  }
- $"(ansi -e $bold_blue_on_red)Hello Nu World(ansi reset)"
+ $"(ansi --escape $bold_blue_on_red)Hello Nu World(ansi reset)"
 Hello Nu World
 ```
 

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.86.0
+version: 0.87.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.86.0
+version: 0.87.0
 platform: |
  Add a link (using OSC 8 escape sequence) to the given string.
 usage: |
@@ -55,6 +55,3 @@ Format a table column into links
 > [[url text]; [https://example.com Text]] | ansi link url
 
 ```
-
-
-**Tips:** Command `ansi link` was not included in the official binaries by default, you have to build it with `--features=extra` flag
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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.0
 bits: |
  Various commands for working with bits.
 usage: |

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.86.0
+version: 0.87.0
 bits: |
  Performs bitwise and for ints.
 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.86.0
+version: 0.87.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.86.0
+version: 0.87.0
 bits: |
  Performs bitwise or for ints.
 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.86.0
+version: 0.87.0
 bits: |
  Bitwise rotate left for ints.
 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.86.0
+version: 0.87.0
 bits: |
  Bitwise rotate right for ints.
 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.86.0
+version: 0.87.0
 bits: |
  Bitwise shift left for ints.
 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.86.0
+version: 0.87.0
 bits: |
  Bitwise shift right for ints.
 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.86.0
+version: 0.87.0
 bits: |
  Performs bitwise xor for ints.
 usage: |

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

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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.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.86.0
+version: 0.87.0
 strings: |
  Output special characters (e.g., 'newline').
 usage: |
@@ -60,18 +60,18 @@ Output prompt character, newline and a hamburger menu character
 
 Output Unicode character
 ```nu
-> char -u 1f378
+> char --unicode 1f378
 🍸
 ```
 
 Create Unicode from integer codepoint values
 ```nu
-> char -i (0x60 + 1) (0x60 + 2)
+> char --integer (0x60 + 1) (0x60 + 2)
 ab
 ```
 
 Output multi-byte Unicode character
 ```nu
-> char -u 1F468 200D 1F466 200D 1F466
+> char --unicode 1F468 200D 1F466 200D 1F466
 👨‍👦‍👦
 ```
diff --git a/commands/docs/clear.md b/commands/docs/clear.md
@@ -2,7 +2,7 @@
 title: clear
 categories: |
  platform
-version: 0.86.0
+version: 0.87.0
 platform: |
  Clear the terminal.
 usage: |

diff --git a/commands/docs/collect.md b/commands/docs/collect.md
@@ -2,7 +2,7 @@
 title: collect
 categories: |
  filters
-version: 0.86.0
+version: 0.87.0
 filters: |
  Collect the stream and pass it to a block.
 usage: |

diff --git a/commands/docs/columns.md b/commands/docs/columns.md
@@ -2,7 +2,7 @@
 title: columns
 categories: |
  filters
-version: 0.86.0
+version: 0.87.0
 filters: |
  Given a record or table, produce a list of its columns' names.
 usage: |

diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md
@@ -2,7 +2,7 @@
 title: commandline
 categories: |
  core
-version: 0.86.0
+version: 0.87.0
 core: |
  View or modify the current command line input buffer.
 usage: |