Skip to content

Commit 7d16c5b

Browse files
authored
feat: refresh command docs for nu v0.75 (#760)
1 parent 713571e commit 7d16c5b

File tree

449 files changed

+788
-558
lines changed

Some content is hidden

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

449 files changed

+788
-558
lines changed

book/commands/agg-groups.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: agg-groups
33
categories: |
44
expression
5-
version: 0.74.0
5+
version: 0.75.0
66
expression: |
77
creates an agg_groups expression
88
usage: |

book/commands/agg.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: agg
33
categories: |
44
lazyframe
5-
version: 0.74.0
5+
version: 0.75.0
66
lazyframe: |
77
Performs a series of aggregations from a group-by
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
core: |
77
Alias a command (with optional flags) to a new name
88
usage: |

book/commands/all-false.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: all-false
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Returns true if all values are false
88
usage: |

book/commands/all-true.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: all-true
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Returns true if all values are true
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
filters: |
77
Test if every element of the input fulfills a predicate expression.
88
usage: |

book/commands/ansi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi
33
categories: |
44
platform
5-
version: 0.74.0
5+
version: 0.75.0
66
platform: |
77
Output ANSI codes to change color.
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
platform: |
77
Add a color gradient (using ANSI color codes) to the given string
88
usage: |

book/commands/ansi_link.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: ansi link
3+
categories: |
4+
platform
5+
version: 0.75.0
6+
platform: |
7+
Add a link (using OSC 8 escape sequence) to the given string
8+
usage: |
9+
Add a link (using OSC 8 escape sequence) to the given string
10+
---
11+
12+
# <code>{{ $frontmatter.title }}</code> for platform
13+
14+
<div class='command-title'>{{ $frontmatter.platform }}</div>
15+
16+
## Signature
17+
18+
```> ansi link ...rest --text```
19+
20+
## Parameters
21+
22+
- `...rest`: for a data structure input, add links to all strings at the given cell paths
23+
- `--text {string}`: Link text. Uses uri as text if absent. In case of
24+
tables, records and lists applies this text to all elements
25+
26+
## Examples
27+
28+
Create a link to open some file
29+
```shell
30+
> 'file:///file.txt' | ansi link --text 'Open Me!'
31+
```
32+
33+
Create a link without text
34+
```shell
35+
> 'https://www.nushell.sh/' | ansi link
36+
```
37+
38+
Format a table column into links
39+
```shell
40+
> [[url text]; [https://example.com Text]] | ansi link url
41+
```

book/commands/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.74.0
5+
version: 0.75.0
66
platform: |
77
Strip ANSI escape sequences from a string
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
filters: |
77
Tests if any element of the input fulfills a predicate expression.
88
usage: |

book/commands/append.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: append
33
categories: |
44
dataframe
55
filters
6-
version: 0.74.0
6+
version: 0.75.0
77
dataframe: |
88
Appends a new dataframe
99
filters: |

book/commands/arg-max.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-max
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Return index for max value in series
88
usage: |

book/commands/arg-min.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-min
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Return index for min value in series
88
usage: |

book/commands/arg-sort.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-sort
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Returns indexes for a sorted series
88
usage: |

book/commands/arg-true.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-true
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Returns indexes where values are true
88
usage: |

book/commands/arg-unique.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-unique
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Returns indexes for unique values
88
usage: |

book/commands/arg-where.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: arg-where
33
categories: |
44
expression
5-
version: 0.74.0
5+
version: 0.75.0
66
expression: |
77
Creates an expression that returns the arguments where expression is true
88
usage: |

book/commands/as-date.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: as-date
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Converts string to date.
88
usage: |

book/commands/as-datetime.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: as-datetime
33
categories: |
44
dataframe
5-
version: 0.74.0
5+
version: 0.75.0
66
dataframe: |
77
Converts string to datetime.
88
usage: |

book/commands/as.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: as
33
categories: |
44
expression
5-
version: 0.74.0
5+
version: 0.75.0
66
expression: |
77
Creates an alias expression
88
usage: |

book/commands/ast.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ast
33
categories: |
44
core
5-
version: 0.74.0
5+
version: 0.75.0
66
core: |
77
Print the abstract syntax tree (ast) for a pipeline.
88
usage: |

book/commands/benchmark.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: benchmark
33
categories: |
44
system
5-
version: 0.74.0
5+
version: 0.75.0
66
system: |
7-
Time the running time of a block
7+
Time the running time of a closure
88
usage: |
9-
Time the running time of a block
9+
Time the running time of a closure
1010
---
1111

1212
# <code>{{ $frontmatter.title }}</code> for system
@@ -15,15 +15,20 @@ usage: |
1515

1616
## Signature
1717

18-
```> benchmark (block)```
18+
```> benchmark (closure)```
1919

2020
## Parameters
2121

22-
- `block`: the block to run
22+
- `closure`: the closure to run
2323

2424
## Examples
2525

26-
Benchmarks a command within a block
26+
Benchmarks a command within a closure
2727
```shell
2828
> benchmark { sleep 500ms }
2929
```
30+
31+
Benchmark a command using an existing input
32+
```shell
33+
> fetch https://www.nushell.sh/book/ | benchmark { split chars }
34+
```

book/commands/bits.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Various commands for working with bits
88
usage: |

book/commands/bits_and.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits and
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Performs bitwise and for integers
88
usage: |

book/commands/bits_not.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits not
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Performs logical negation on each bit
88
usage: |

book/commands/bits_or.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits or
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Performs bitwise or for integers
88
usage: |

book/commands/bits_rol.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits rol
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Bitwise rotate left for integers
88
usage: |

book/commands/bits_ror.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits ror
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Bitwise rotate right for integers
88
usage: |

book/commands/bits_shl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits shl
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Bitwise shift left for integers
88
usage: |

book/commands/bits_shr.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits shr
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Bitwise shift right for integers
88
usage: |

book/commands/bits_xor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits xor
33
categories: |
44
bits
5-
version: 0.74.0
5+
version: 0.75.0
66
bits: |
77
Performs bitwise xor for integers
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
core: |
77
Break a loop
88
usage: |

book/commands/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.74.0
5+
version: 0.75.0
66
bytes: |
77
Various commands for working with byte data
88
usage: |

book/commands/bytes_add.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes add
33
categories: |
44
bytes
5-
version: 0.74.0
5+
version: 0.75.0
66
bytes: |
77
Add specified bytes to the input
88
usage: |

book/commands/bytes_at.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes at
33
categories: |
44
bytes
5-
version: 0.74.0
5+
version: 0.75.0
66
bytes: |
77
Get bytes defined by a range. Note that the start is included but the end is excluded, and that the first byte is index 0.
88
usage: |

book/commands/bytes_build.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bytes build
33
categories: |
44
bytes
5-
version: 0.74.0
5+
version: 0.75.0
66
bytes: |
77
Create bytes from the arguments.
88
usage: |

0 commit comments

Comments
 (0)