Skip to content

Commit 4cddb0c

Browse files
hustcerhustcer
committed
Refresh Nu command docs for v0.105.0
1 parent b210875 commit 4cddb0c

File tree

591 files changed

+2536
-1702
lines changed

Some content is hidden

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

591 files changed

+2536
-1702
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.104.0
5+
version: 0.105.0
66
core: |
77
Alias a command (with optional flags) to a new name.
88
usage: |

‎commands/docs/all.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: all
33
categories: |
44
filters
5-
version: 0.104.0
5+
version: 0.105.0
66
filters: |
77
Test if every element of the input fulfills a predicate expression.
88
usage: |
@@ -29,7 +29,7 @@ contributors: false
2929

3030
| input | output |
3131
| --------- | ------ |
32-
| list\<any\> | bool |
32+
| list&lt;any&gt; | bool |
3333
## Examples
3434

3535
Check if a list contains only true values

‎commands/docs/ansi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi
33
categories: |
44
platform
5-
version: 0.104.0
5+
version: 0.105.0
66
platform: |
77
Output ANSI codes to change color and style of text.
88
usage: |

‎commands/docs/ansi_gradient.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi gradient
33
categories: |
44
platform
5-
version: 0.104.0
5+
version: 0.105.0
66
platform: |
77
Add a color gradient (using ANSI color codes) to the given string.
88
usage: |
@@ -36,10 +36,10 @@ contributors: false
3636

3737
| input | output |
3838
| ------------ | ------------ |
39-
| list\<string\> | list\<string\> |
40-
| record | record |
4139
| string | string |
40+
| list&lt;string&gt; | list&lt;string&gt; |
4241
| table | table |
42+
| record | record |
4343
## Examples
4444

4545
draw text in a gradient with foreground start and end colors

‎commands/docs/ansi_link.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi link
33
categories: |
44
platform
5-
version: 0.104.0
5+
version: 0.105.0
66
platform: |
77
Add a link (using OSC 8 escape sequence) to the given string.
88
usage: |
@@ -34,10 +34,10 @@ contributors: false
3434

3535
| input | output |
3636
| ------------ | ------------ |
37-
| list\<string\> | list\<string\> |
38-
| record | record |
3937
| string | string |
38+
| list&lt;string&gt; | list&lt;string&gt; |
4039
| table | table |
40+
| record | record |
4141
## Examples
4242

4343
Create a link to open some file

‎commands/docs/ansi_strip.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ansi strip
33
categories: |
44
platform
5-
version: 0.104.0
5+
version: 0.105.0
66
platform: |
77
Strip ANSI escape sequences from a string.
88
usage: |
@@ -29,10 +29,10 @@ contributors: false
2929

3030
| input | output |
3131
| ------------ | ------------ |
32-
| list\<string\> | list\<string\> |
33-
| record | record |
3432
| string | string |
33+
| list&lt;string&gt; | list&lt;string&gt; |
3534
| table | table |
35+
| record | record |
3636
## Examples
3737

3838
Strip ANSI escape sequences from a string

‎commands/docs/any.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: any
33
categories: |
44
filters
5-
version: 0.104.0
5+
version: 0.105.0
66
filters: |
77
Tests if any element of the input fulfills a predicate expression.
88
usage: |
@@ -29,7 +29,7 @@ contributors: false
2929

3030
| input | output |
3131
| --------- | ------ |
32-
| list\<any\> | bool |
32+
| list&lt;any&gt; | bool |
3333
## Examples
3434

3535
Check if a list contains any true values

‎commands/docs/append.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: append
33
categories: |
44
filters
5-
version: 0.104.0
5+
version: 0.105.0
66
filters: |
77
Append any number of rows to a table.
88
usage: |
@@ -29,7 +29,7 @@ contributors: false
2929

3030
| input | output |
3131
| ----- | --------- |
32-
| any | list\<any\> |
32+
| any | list&lt;any&gt; |
3333
## Examples
3434

3535
Append one int to a list

‎commands/docs/ast.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ast
33
categories: |
44
debug
5-
version: 0.104.0
5+
version: 0.105.0
66
debug: |
77
Print the abstract syntax tree (ast) for a pipeline.
88
usage: |
@@ -36,6 +36,8 @@ contributors: false
3636
| input | output |
3737
| ------- | ------ |
3838
| nothing | table |
39+
| nothing | record |
40+
| nothing | string |
3941
## Examples
4042

4143
Print the ast of a string

‎commands/docs/attr_category.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: attr category
33
categories: |
44
core
5-
version: 0.104.0
5+
version: 0.105.0
66
core: |
77
Attribute for adding a category to custom commands.
88
usage: |
@@ -29,7 +29,7 @@ contributors: false
2929

3030
| input | output |
3131
| ------- | ------------ |
32-
| nothing | list\<string\> |
32+
| nothing | list&lt;string&gt; |
3333
## Examples
3434

3535
Add a category to a custom command

‎commands/docs/attr_deprecated.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: attr deprecated
3+
categories: |
4+
core
5+
version: 0.105.0
6+
core: |
7+
Attribute for marking a command or flag as deprecated.
8+
usage: |
9+
Attribute for marking a command or flag as deprecated.
10+
editLink: false
11+
contributors: false
12+
---
13+
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
14+
15+
# `attr deprecated` for [core](/commands/categories/core.md)
16+
17+
<div class='command-title'>Attribute for marking a command or flag as deprecated.</div>
18+
19+
## Signature
20+
21+
```> attr deprecated {flags} (message)```
22+
23+
## Flags
24+
25+
- `--flag {string}`: Mark a flag as deprecated rather than the command
26+
- `--since, -s {string}`: Denote a version when this item was deprecated
27+
- `--remove, -r {string}`: Denote a version when this item will be removed
28+
- `--report {string}`: How to warn about this item. One of: first (default), every
29+
30+
## Parameters
31+
32+
- `message`: Help message to include with deprecation warning.
33+
34+
35+
## Input/output types:
36+
37+
| input | output |
38+
| ------- | ------- |
39+
| nothing | nothing |
40+
| nothing | string |
41+
## Examples
42+
43+
Add a deprecation warning to a custom command
44+
```nu
45+
> @deprecated
46+
def outdated [] {}
47+
48+
```
49+
50+
Add a deprecation warning with a custom message
51+
```nu
52+
> @deprecated "Use my-new-command instead."
53+
@category deprecated
54+
def my-old-command [] {}
55+
Use my-new-command instead.
56+
```
57+
58+
## Notes
59+
Mark a command (default) or flag/switch (--flag) as deprecated. By default, only the first usage will trigger a deprecation warning.
60+
61+
A help message can be included to provide more context for the deprecation, such as what to use as a replacement.
62+
63+
Also consider setting the category to deprecated with @category deprecated

‎commands/docs/attr_example.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: attr example
33
categories: |
44
core
5-
version: 0.104.0
5+
version: 0.105.0
66
core: |
77
Attribute for adding examples to custom commands.
88
usage: |
@@ -34,7 +34,7 @@ contributors: false
3434

3535
| input | output |
3636
| ------- | -------------------------------------------- |
37-
| nothing | record\<description: string, example: string\> |
37+
| nothing | record&lt;description: string, example: string&gt; |
3838
## Examples
3939

4040
Add examples to custom command

‎commands/docs/attr_search-terms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: attr search-terms
33
categories: |
44
core
5-
version: 0.104.0
5+
version: 0.105.0
66
core: |
77
Attribute for adding search terms to custom commands.
88
usage: |
@@ -29,7 +29,7 @@ contributors: false
2929

3030
| input | output |
3131
| ------- | ------------ |
32-
| nothing | list\<string\> |
32+
| nothing | list&lt;string&gt; |
3333
## Examples
3434

3535
Add search terms to a custom command

‎commands/docs/banner.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: banner
33
categories: |
44
default
5-
version: 0.104.0
5+
version: 0.105.0
66
default: |
77
Print a banner for Nushell with information about the project
88
usage: |
@@ -23,10 +23,3 @@ contributors: false
2323
## Flags
2424

2525
- `--short`: Only show startup time
26-
27-
28-
## Input/output types:
29-
30-
| input | output |
31-
| ----- | ------ |
32-
| any | any |

‎commands/docs/bits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits
33
categories: |
44
bits
5-
version: 0.104.0
5+
version: 0.105.0
66
bits: |
77
Various commands for working with bits.
88
usage: |

‎commands/docs/bits_and.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits and
33
categories: |
44
bits
5-
version: 0.104.0
5+
version: 0.105.0
66
bits: |
77
Performs bitwise and for ints or binary values.
88
usage: |
@@ -33,10 +33,10 @@ contributors: false
3333

3434
| input | output |
3535
| ------------ | ------------ |
36-
| binary | binary |
3736
| int | int |
38-
| list\<binary\> | list\<binary\> |
39-
| list\<int\> | list\<int\> |
37+
| binary | binary |
38+
| list&lt;int&gt; | list&lt;int&gt; |
39+
| list&lt;binary&gt; | list&lt;binary&gt; |
4040
## Examples
4141

4242
Apply bitwise and to two numbers

‎commands/docs/bits_not.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits not
33
categories: |
44
bits
5-
version: 0.104.0
5+
version: 0.105.0
66
bits: |
77
Performs logical negation on each bit.
88
usage: |
@@ -30,10 +30,10 @@ contributors: false
3030

3131
| input | output |
3232
| ------------ | ------------ |
33-
| binary | binary |
3433
| int | int |
35-
| list\<binary\> | list\<binary\> |
36-
| list\<int\> | list\<int\> |
34+
| binary | binary |
35+
| list&lt;int&gt; | list&lt;int&gt; |
36+
| list&lt;binary&gt; | list&lt;binary&gt; |
3737
## Examples
3838

3939
Apply logical negation to a list of numbers

‎commands/docs/bits_or.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits or
33
categories: |
44
bits
5-
version: 0.104.0
5+
version: 0.105.0
66
bits: |
77
Performs bitwise or for ints or binary values.
88
usage: |
@@ -33,10 +33,10 @@ contributors: false
3333

3434
| input | output |
3535
| ------------ | ------------ |
36-
| binary | binary |
3736
| int | int |
38-
| list\<binary\> | list\<binary\> |
39-
| list\<int\> | list\<int\> |
37+
| binary | binary |
38+
| list&lt;int&gt; | list&lt;int&gt; |
39+
| list&lt;binary&gt; | list&lt;binary&gt; |
4040
## Examples
4141

4242
Apply bits or to two numbers

‎commands/docs/bits_rol.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: bits rol
33
categories: |
44
bits
5-
version: 0.104.0
5+
version: 0.105.0
66
bits: |
77
Bitwise rotate left for ints or binary values.
88
usage: |
@@ -34,10 +34,10 @@ contributors: false
3434

3535
| input | output |
3636
| ------------ | ------------ |
37-
| binary | binary |
3837
| int | int |
39-
| list\<binary\> | list\<binary\> |
40-
| list\<int\> | list\<int\> |
38+
| binary | binary |
39+
| list&lt;int&gt; | list&lt;int&gt; |
40+
| list&lt;binary&gt; | list&lt;binary&gt; |
4141
## Examples
4242

4343
Rotate left a number with 2 bits

0 commit comments

Comments
 (0)