Skip to content

Commit b985c65

Browse files
authored
Refresh command docs for Nu v0.94 (#1419)
* Refresh command docs for Nu v0.94 * ci skip
1 parent b10016d commit b985c65

File tree

652 files changed

+1348
-7184
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

652 files changed

+1348
-7184
lines changed

commands/docs/alias.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: alias
33
categories: |
44
core
5-
version: 0.93.0
5+
version: 0.94.0
66
core: |
77
Alias a command (with optional flags) to a new name.
88
usage: |

commands/docs/all.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: all
33
categories: |
44
filters
5-
version: 0.93.0
5+
version: 0.94.0
66
filters: |
77
Test if every element of the input fulfills a predicate expression.
88
usage: |

commands/docs/ansi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi
33
categories: |
44
platform
5-
version: 0.93.0
5+
version: 0.94.0
66
platform: |
77
Output ANSI codes to change color and style of text.
88
usage: |
@@ -143,8 +143,8 @@ Operating system commands:
143143

144144
## Subcommands:
145145

146-
| name | type | usage |
147-
| -------------------------------------------------- | ------- | ------------------------------------------------------------------ |
148-
| [`ansi gradient`](/commands/docs/ansi_gradient.md) | Builtin | Add a color gradient (using ANSI color codes) to the given string. |
149-
| [`ansi link`](/commands/docs/ansi_link.md) | Builtin | Add a link (using OSC 8 escape sequence) to the given string. |
150-
| [`ansi strip`](/commands/docs/ansi_strip.md) | Builtin | Strip ANSI escape sequences from a string. |
146+
| name | usage | type |
147+
| -------------------------------------------------- | ------------------------------------------------------------------ | -------- |
148+
| [`ansi gradient`](/commands/docs/ansi_gradient.md) | Add a color gradient (using ANSI color codes) to the given string. | built-in |
149+
| [`ansi link`](/commands/docs/ansi_link.md) | Add a link (using OSC 8 escape sequence) to the given string. | built-in |
150+
| [`ansi strip`](/commands/docs/ansi_strip.md) | Strip ANSI escape sequences from a string. | built-in |

commands/docs/ansi_gradient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi gradient
33
categories: |
44
platform
5-
version: 0.93.0
5+
version: 0.94.0
66
platform: |
77
Add a color gradient (using ANSI color codes) to the given string.
88
usage: |

commands/docs/ansi_link.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi link
33
categories: |
44
platform
5-
version: 0.93.0
5+
version: 0.94.0
66
platform: |
77
Add a link (using OSC 8 escape sequence) to the given string.
88
usage: |

commands/docs/ansi_strip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi strip
33
categories: |
44
platform
5-
version: 0.93.0
5+
version: 0.94.0
66
platform: |
77
Strip ANSI escape sequences from a string.
88
usage: |

commands/docs/any.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: any
33
categories: |
44
filters
5-
version: 0.93.0
5+
version: 0.94.0
66
filters: |
77
Tests if any element of the input fulfills a predicate expression.
88
usage: |

commands/docs/append.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: append
33
categories: |
44
filters
5-
version: 0.93.0
5+
version: 0.94.0
66
filters: |
77
Append any number of rows to a table.
88
usage: |

commands/docs/ast.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ast
33
categories: |
44
debug
5-
version: 0.93.0
5+
version: 0.94.0
66
debug: |
77
Print the abstract syntax tree (ast) for a pipeline.
88
usage: |

commands/docs/bits.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Various commands for working with bits.
88
usage: |
@@ -31,13 +31,13 @@ You must use one of the following subcommands. Using this command as-is will onl
3131

3232
## Subcommands:
3333

34-
| name | type | usage |
35-
| ---------------------------------------- | ------- | ----------------------------------------------- |
36-
| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for ints or binary values. |
37-
| [`bits not`](/commands/docs/bits_not.md) | Builtin | Performs logical negation on each bit. |
38-
| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for ints or binary values. |
39-
| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for ints or binary values. |
40-
| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for ints or binary values. |
41-
| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for ints or binary values. |
42-
| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for ints or binary values. |
43-
| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for ints or binary values. |
34+
| name | usage | type |
35+
| ---------------------------------------- | ----------------------------------------------- | -------- |
36+
| [`bits and`](/commands/docs/bits_and.md) | Performs bitwise and for ints or binary values. | built-in |
37+
| [`bits not`](/commands/docs/bits_not.md) | Performs logical negation on each bit. | built-in |
38+
| [`bits or`](/commands/docs/bits_or.md) | Performs bitwise or for ints or binary values. | built-in |
39+
| [`bits rol`](/commands/docs/bits_rol.md) | Bitwise rotate left for ints or binary values. | built-in |
40+
| [`bits ror`](/commands/docs/bits_ror.md) | Bitwise rotate right for ints or binary values. | built-in |
41+
| [`bits shl`](/commands/docs/bits_shl.md) | Bitwise shift left for ints or binary values. | built-in |
42+
| [`bits shr`](/commands/docs/bits_shr.md) | Bitwise shift right for ints or binary values. | built-in |
43+
| [`bits xor`](/commands/docs/bits_xor.md) | Performs bitwise xor for ints or binary values. | built-in |

commands/docs/bits_and.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits and
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Performs bitwise and for ints or binary values.
88
usage: |

commands/docs/bits_not.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits not
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Performs logical negation on each bit.
88
usage: |

commands/docs/bits_or.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits or
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Performs bitwise or for ints or binary values.
88
usage: |

commands/docs/bits_rol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits rol
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Bitwise rotate left for ints or binary values.
88
usage: |

commands/docs/bits_ror.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits ror
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Bitwise rotate right for ints or binary values.
88
usage: |

commands/docs/bits_shl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits shl
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Bitwise shift left for ints or binary values.
88
usage: |

commands/docs/bits_shr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits shr
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Bitwise shift right for ints or binary values.
88
usage: |

commands/docs/bits_xor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits xor
33
categories: |
44
bits
5-
version: 0.93.0
5+
version: 0.94.0
66
bits: |
77
Performs bitwise xor for ints or binary values.
88
usage: |

commands/docs/break.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: break
33
categories: |
44
core
5-
version: 0.93.0
5+
version: 0.94.0
66
core: |
77
Break a loop.
88
usage: |

commands/docs/bytes.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Various commands for working with byte data.
88
usage: |
@@ -31,16 +31,16 @@ You must use one of the following subcommands. Using this command as-is will onl
3131

3232
## Subcommands:
3333

34-
| name | type | usage |
35-
| ---------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------ |
36-
| [`bytes add`](/commands/docs/bytes_add.md) | Builtin | Add specified bytes to the input. |
37-
| [`bytes at`](/commands/docs/bytes_at.md) | Builtin | Get bytes defined by a range. |
38-
| [`bytes build`](/commands/docs/bytes_build.md) | Builtin | Create bytes from the arguments. |
39-
| [`bytes collect`](/commands/docs/bytes_collect.md) | Builtin | Concatenate multiple binary into a single binary, with an optional separator between each. |
40-
| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Builtin | Check if bytes ends with a pattern. |
41-
| [`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. |
42-
| [`bytes length`](/commands/docs/bytes_length.md) | Builtin | Output the length of any bytes in the pipeline. |
43-
| [`bytes remove`](/commands/docs/bytes_remove.md) | Builtin | Remove bytes. |
44-
| [`bytes replace`](/commands/docs/bytes_replace.md) | Builtin | Find and replace binary. |
45-
| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Builtin | Reverse the bytes in the pipeline. |
46-
| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Builtin | Check if bytes starts with a pattern. |
34+
| name | usage | type |
35+
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------- |
36+
| [`bytes add`](/commands/docs/bytes_add.md) | Add specified bytes to the input. | built-in |
37+
| [`bytes at`](/commands/docs/bytes_at.md) | Get bytes defined by a range. | built-in |
38+
| [`bytes build`](/commands/docs/bytes_build.md) | Create bytes from the arguments. | built-in |
39+
| [`bytes collect`](/commands/docs/bytes_collect.md) | Concatenate multiple binary into a single binary, with an optional separator between each. | built-in |
40+
| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Check if bytes ends with a pattern. | built-in |
41+
| [`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 |
42+
| [`bytes length`](/commands/docs/bytes_length.md) | Output the length of any bytes in the pipeline. | built-in |
43+
| [`bytes remove`](/commands/docs/bytes_remove.md) | Remove bytes. | built-in |
44+
| [`bytes replace`](/commands/docs/bytes_replace.md) | Find and replace binary. | built-in |
45+
| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Reverse the bytes in the pipeline. | built-in |
46+
| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Check if bytes starts with a pattern. | built-in |

commands/docs/bytes_add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes add
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Add specified bytes to the input.
88
usage: |

commands/docs/bytes_at.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes at
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Get bytes defined by a range.
88
usage: |

commands/docs/bytes_build.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes build
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Create bytes from the arguments.
88
usage: |
@@ -39,3 +39,11 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii
3939
00000000: 01 02 03 04 ••••
4040
4141
```
42+
43+
Builds binary data from byte numbers
44+
```nu
45+
> bytes build 255 254 253 252
46+
Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii
47+
00000000: ff fe fd fc ××××
48+
49+
```

commands/docs/bytes_collect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes collect
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Concatenate multiple binary into a single binary, with an optional separator between each.
88
usage: |

commands/docs/bytes_ends-with.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes ends-with
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Check if bytes ends with a pattern.
88
usage: |

commands/docs/bytes_index-of.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes index-of
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Returns start index of first occurrence of pattern in bytes, or -1 if no match.
88
usage: |

commands/docs/bytes_length.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes length
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Output the length of any bytes in the pipeline.
88
usage: |

commands/docs/bytes_remove.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes remove
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Remove bytes.
88
usage: |

commands/docs/bytes_replace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes replace
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Find and replace binary.
88
usage: |

commands/docs/bytes_reverse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes reverse
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Reverse the bytes in the pipeline.
88
usage: |

commands/docs/bytes_starts-with.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes starts-with
33
categories: |
44
bytes
5-
version: 0.93.0
5+
version: 0.94.0
66
bytes: |
77
Check if bytes starts with a pattern.
88
usage: |

commands/docs/cal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: cal
33
categories: |
44
generators
5-
version: 0.93.0
5+
version: 0.94.0
66
generators: |
77
Display a calendar.
88
usage: |

commands/docs/cd.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: cd
33
categories: |
44
filesystem
5-
version: 0.93.0
5+
version: 0.94.0
66
filesystem: |
77
Change directory.
88
usage: |
@@ -19,6 +19,10 @@ feature: default
1919

2020
```> cd {flags} (path)```
2121

22+
## Flags
23+
24+
- `--physical, -P`: use the physical directory structure; resolve symbolic links before processing instances of ..
25+
2226
## Parameters
2327

2428
- `path`: The path to change to.

0 commit comments

Comments
 (0)