Skip to content

Commit 308e38f

Browse files
authored
Refresh command docs for Nu v0.86 (#1112)
* Refresh docs for Nu v0.86 * ci skip * remove some unused commands
1 parent a08b49b commit 308e38f

File tree

499 files changed

+1465
-1075
lines changed

Some content is hidden

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

499 files changed

+1465
-1075
lines changed

.vuepress/configs/sidebar/command_categories.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ export const commandCategories = [
3030
'/commands/categories/strings.md',
3131
'/commands/categories/system.md',
3232
'/commands/categories/viewers.md',
33-
];
33+
];

commands/docs/alias.md

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

commands/docs/all.md

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

commands/docs/ansi.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi
33
categories: |
44
platform
5-
version: 0.85.0
5+
version: 0.86.0
66
platform: |
77
Output ANSI codes to change color and style of text.
88
usage: |
@@ -93,6 +93,7 @@ Escape sequences usual values:
9393
│ 3 │ foreground │ 33 │ 93 │ yellow │
9494
│ 4 │ foreground │ 34 │ 94 │ blue │
9595
│ 5 │ foreground │ 35 │ 95 │ magenta │
96+
│ 5 │ foreground │ 35 │ 95 │ purple │
9697
│ 6 │ foreground │ 36 │ 96 │ cyan │
9798
│ 7 │ foreground │ 37 │ 97 │ white │
9899
│ 8 │ foreground │ 39 │ │ default │
@@ -102,6 +103,7 @@ Escape sequences usual values:
102103
│ 12 │ background │ 43 │ 103 │ yellow │
103104
│ 13 │ background │ 44 │ 104 │ blue │
104105
│ 14 │ background │ 45 │ 105 │ magenta │
106+
│ 14 │ background │ 45 │ 105 │ purple │
105107
│ 15 │ background │ 46 │ 106 │ cyan │
106108
│ 16 │ background │ 47 │ 107 │ white │
107109
│ 17 │ background │ 49 │ │ default │

commands/docs/ansi_gradient.md

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

commands/docs/ansi_link.md

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

commands/docs/ansi_strip.md

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

commands/docs/any.md

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

commands/docs/append.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: append
33
categories: |
44
filters
5-
version: 0.85.0
5+
version: 0.86.0
66
filters: |
77
Append any number of rows to a table.
88
usage: |
@@ -31,7 +31,7 @@ usage: |
3131

3232
## Examples
3333

34-
Append one integer to a list
34+
Append one int to a list
3535
```nu
3636
> [0 1 2 3] | append 4
3737
╭───┬───╮
@@ -66,7 +66,7 @@ Append a list of string to a string
6666
6767
```
6868

69-
Append three integer items
69+
Append three int items
7070
```nu
7171
> [0 1] | append [2 3 4]
7272
╭───┬───╮
@@ -79,7 +79,7 @@ Append three integer items
7979
8080
```
8181

82-
Append integers and strings
82+
Append ints and strings
8383
```nu
8484
> [0 1] | append [2 nu 4 shell]
8585
╭───┬───────╮
@@ -93,7 +93,7 @@ Append integers and strings
9393
9494
```
9595

96-
Append a range of integers to a list
96+
Append a range of ints to a list
9797
```nu
9898
> [0 1] | append 2..4
9999
╭───┬───╮

commands/docs/ast.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ast
33
categories: |
44
debug
5-
version: 0.85.0
5+
version: 0.86.0
66
debug: |
77
Print the abstract syntax tree (ast) for a pipeline.
88
usage: |
@@ -62,6 +62,6 @@ Print the ast of a pipeline with an error, as json, in a nushell table
6262

6363
Print the ast of a pipeline with an error, as json, minified
6464
```nu
65-
> ast 'for x in 1..10 { echo $x ' -j -m
65+
> ast 'for x in 1..10 { echo $x ' --json --minify
6666
6767
```

commands/docs/bits.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
77
Various commands for working with bits.
88
usage: |
@@ -32,13 +32,13 @@ You must use one of the following subcommands. Using this command as-is will onl
3232

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

4444
**Tips:** Command `bits` was not included in the official binaries by default, you have to build it with `--features=extra` flag

commands/docs/bits_and.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits and
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Performs bitwise and for integers.
7+
Performs bitwise and for ints.
88
usage: |
9-
Performs bitwise and for integers.
9+
Performs bitwise and for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

@@ -20,7 +20,7 @@ usage: |
2020

2121
## Parameters
2222

23-
- `target`: target integer to perform bit and
23+
- `target`: target int to perform bit and
2424

2525

2626
## Input/output types:

commands/docs/bits_not.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits not
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
77
Performs logical negation on each bit.
88
usage: |
@@ -45,7 +45,7 @@ Apply logical negation to a list of numbers
4545

4646
Apply logical negation to a list of numbers, treat input as 2 bytes number
4747
```nu
48-
> [4 3 2] | bits not -n '2'
48+
> [4 3 2] | bits not --number-bytes '2'
4949
╭───┬───────╮
5050
│ 0 │ 65531 │
5151
│ 1 │ 65532 │
@@ -56,7 +56,7 @@ Apply logical negation to a list of numbers, treat input as 2 bytes number
5656

5757
Apply logical negation to a list of numbers, treat input as signed number
5858
```nu
59-
> [4 3 2] | bits not -s
59+
> [4 3 2] | bits not --signed
6060
╭───┬────╮
6161
│ 0 │ -5 │
6262
│ 1 │ -4 │

commands/docs/bits_or.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits or
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Performs bitwise or for integers.
7+
Performs bitwise or for ints.
88
usage: |
9-
Performs bitwise or for integers.
9+
Performs bitwise or for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

@@ -20,7 +20,7 @@ usage: |
2020

2121
## Parameters
2222

23-
- `target`: target integer to perform bit or
23+
- `target`: target int to perform bit or
2424

2525

2626
## Input/output types:

commands/docs/bits_rol.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits rol
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Bitwise rotate left for integers.
7+
Bitwise rotate left for ints.
88
usage: |
9-
Bitwise rotate left for integers.
9+
Bitwise rotate left for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

commands/docs/bits_ror.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits ror
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Bitwise rotate right for integers.
7+
Bitwise rotate right for ints.
88
usage: |
9-
Bitwise rotate right for integers.
9+
Bitwise rotate right for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

@@ -44,7 +44,7 @@ Rotate right a number with 60 bits
4444

4545
Rotate right a list of numbers of one byte
4646
```nu
47-
> [15 33 92] | bits ror 2 -n '1'
47+
> [15 33 92] | bits ror 2 --number-bytes '1'
4848
╭───┬─────╮
4949
│ 0 │ 195 │
5050
│ 1 │ 72 │

commands/docs/bits_shl.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits shl
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Bitwise shift left for integers.
7+
Bitwise shift left for ints.
88
usage: |
9-
Bitwise shift left for integers.
9+
Bitwise shift left for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

@@ -44,13 +44,13 @@ Shift left a number by 7 bits
4444

4545
Shift left a number with 1 byte by 7 bits
4646
```nu
47-
> 2 | bits shl 7 -n '1'
47+
> 2 | bits shl 7 --number-bytes '1'
4848
0
4949
```
5050

5151
Shift left a signed number by 1 bit
5252
```nu
53-
> 0x7F | bits shl 1 -s
53+
> 0x7F | bits shl 1 --signed
5454
254
5555
```
5656

commands/docs/bits_shr.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits shr
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Bitwise shift right for integers.
7+
Bitwise shift right for ints.
88
usage: |
9-
Bitwise shift right for integers.
9+
Bitwise shift right for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

commands/docs/bits_xor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: bits xor
33
categories: |
44
bits
5-
version: 0.85.0
5+
version: 0.86.0
66
bits: |
7-
Performs bitwise xor for integers.
7+
Performs bitwise xor for ints.
88
usage: |
9-
Performs bitwise xor for integers.
9+
Performs bitwise xor for ints.
1010
---
1111
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
1212

@@ -20,7 +20,7 @@ usage: |
2020

2121
## Parameters
2222

23-
- `target`: target integer to perform bit xor
23+
- `target`: target int to perform bit xor
2424

2525

2626
## Input/output types:

commands/docs/break.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: break
33
categories: |
44
core
5-
version: 0.85.0
5+
version: 0.86.0
66
core: |
77
Break a loop.
88
usage: |

commands/docs/bytes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes
33
categories: |
44
bytes
5-
version: 0.85.0
5+
version: 0.86.0
66
bytes: |
77
Various commands for working with byte data.
88
usage: |

0 commit comments

Comments
 (0)