Refresh Nu command docs for v0.101 (#1687)

* Refresh Nu command docs for v0.101 * Refresh Nu command docs for v0.101 --------- Co-authored-by: sholderbach <[email protected]>
nushell · Dec 22, 2024 · 90b46ce · 90b46ce
1 parent 8943a68
commit 90b46ce
Show file tree

Hide file tree

Showing 560 changed files with 1,575 additions and 822 deletions.
diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts
@@ -10,6 +10,7 @@ export const commandCategories = [
   '/commands/categories/date.md',
   '/commands/categories/debug.md',
   '/commands/categories/default.md',
+  '/commands/categories/deprecated.md',
   '/commands/categories/env.md',
   '/commands/categories/expression.md',
   '/commands/categories/filesystem.md',

diff --git a/commands/categories/deprecated.md b/commands/categories/deprecated.md
@@ -20,7 +20,7 @@
     <th>Description</th>
   </tr>
   <tr v-for="command in commands">
-   <td><a :href="command.path">{{ command.title }}</a></td>
+   <td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
    <td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
   </tr>
 </table>
diff --git a/commands/docs/alias.md b/commands/docs/alias.md
@@ -2,7 +2,7 @@
 title: alias
 categories: |
   core
-version: 0.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.0
 platform: |
   Output ANSI codes to change color and style of text.
 usage: |

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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.0
 debug: |
   Print the abstract syntax tree (ast) for a pipeline.
 usage: |
@@ -20,8 +20,9 @@ usage: |
 
 ## Flags
 
- -  `--json, -j`: serialize to json
- -  `--minify, -m`: minify the nuon or json output
+ -  `--json, -j`: Serialize to json
+ -  `--minify, -m`: Minify the nuon or json output
+ -  `--flatten, -f`: An easier to read version of the ast
 
 ## Parameters
 
@@ -30,9 +31,9 @@ usage: |
 
 ## Input/output types:
 
-| input  | output |
-| ------ | ------ |
-| string | record |
+| input   | output |
+| ------- | ------ |
+| nothing | table  |
 
 ## Examples
 
@@ -65,3 +66,57 @@ Print the ast of a pipeline with an error, as json, minified
 > ast 'for x in 1..10 { echo $x ' --json --minify
 
 ```
+
+Print the ast of a string flattened
+```nu
+> ast "'hello'" --flatten
+╭───┬─────────┬──────────────┬───────────────╮
+│ # │ content │    shape     │     span      │
+├───┼─────────┼──────────────┼───────────────┤
+│ 0 │ 'hello' │ shape_string │ ╭───────┬───╮ │
+│   │         │              │ │ start │ 0 │ │
+│   │         │              │ │ end   │ 7 │ │
+│   │         │              │ ╰───────┴───╯ │
+╰───┴─────────┴──────────────┴───────────────╯
+
+```
+
+Print the ast of a string flattened, as json, minified
+```nu
+> ast "'hello'" --flatten --json --minify
+[{"content":"'hello'","shape":"shape_string","span":{"start":0,"end":7}}]
+```
+
+Print the ast of a pipeline flattened
+```nu
+> ast 'ls | sort-by type name -i' --flatten
+╭───┬─────────┬────────────────────┬────────────────╮
+│ # │ content │       shape        │      span      │
+├───┼─────────┼────────────────────┼────────────────┤
+│ 0 │ ls      │ shape_external     │ ╭───────┬───╮  │
+│   │         │                    │ │ start │ 0 │  │
+│   │         │                    │ │ end   │ 2 │  │
+│   │         │                    │ ╰───────┴───╯  │
+│ 1 │ |       │ shape_pipe         │ ╭───────┬───╮  │
+│   │         │                    │ │ start │ 3 │  │
+│   │         │                    │ │ end   │ 4 │  │
+│   │         │                    │ ╰───────┴───╯  │
+│ 2 │ sort-by │ shape_internalcall │ ╭───────┬────╮ │
+│   │         │                    │ │ start │ 5  │ │
+│   │         │                    │ │ end   │ 12 │ │
+│   │         │                    │ ╰───────┴────╯ │
+│ 3 │ type    │ shape_string       │ ╭───────┬────╮ │
+│   │         │                    │ │ start │ 13 │ │
+│   │         │                    │ │ end   │ 17 │ │
+│   │         │                    │ ╰───────┴────╯ │
+│ 4 │ name    │ shape_string       │ ╭───────┬────╮ │
+│   │         │                    │ │ start │ 18 │ │
+│   │         │                    │ │ end   │ 22 │ │
+│   │         │                    │ ╰───────┴────╯ │
+│ 5 │ -i      │ shape_flag         │ ╭───────┬────╮ │
+│   │         │                    │ │ start │ 23 │ │
+│   │         │                    │ │ end   │ 25 │ │
+│   │         │                    │ ╰───────┴────╯ │
+╰───┴─────────┴────────────────────┴────────────────╯
+
+```
diff --git a/commands/docs/banner.md b/commands/docs/banner.md
@@ -2,7 +2,7 @@
 title: banner
 categories: |
   default
-version: 0.100.0
+version: 0.101.0
 default: |
   Print a banner for nushell with information about the project
 usage: |

diff --git a/commands/docs/bits.md b/commands/docs/bits.md
@@ -2,7 +2,7 @@
 title: bits
 categories: |
   bits
-version: 0.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.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.100.0
+version: 0.101.0
 generators: |
   Display a calendar.
 usage: |