Skip to content

Refresh Nu command docs for v0.105.0 #1938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2025
Merged

Refresh Nu command docs for v0.105.0 #1938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cddb0c
Refresh Nu command docs for v0.105.0
hustcer Jun 10, 2025
2c3a088
Remove doc of deprecated command
hustcer Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion commands/docs/alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: alias
categories: |
core
version: 0.104.0
version: 0.105.0
core: |
Alias a command (with optional flags) to a new name.
usage: |
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/all.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: all
categories: |
filters
version: 0.104.0
version: 0.105.0
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Expand All @@ -29,7 +29,7 @@ contributors: false

| input | output |
| --------- | ------ |
| list\<any\> | bool |
| list&lt;any&gt; | bool |
## Examples

Check if a list contains only true values
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi
categories: |
platform
version: 0.104.0
version: 0.105.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Expand Down
6 changes: 3 additions & 3 deletions commands/docs/ansi_gradient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi gradient
categories: |
platform
version: 0.104.0
version: 0.105.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Expand Down Expand Up @@ -36,10 +36,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| list\<string\> | list\<string\> |
| record | record |
| string | string |
| list&lt;string&gt; | list&lt;string&gt; |
| table | table |
| record | record |
## Examples

draw text in a gradient with foreground start and end colors
Expand Down
6 changes: 3 additions & 3 deletions commands/docs/ansi_link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi link
categories: |
platform
version: 0.104.0
version: 0.105.0
platform: |
Add a link (using OSC 8 escape sequence) to the given string.
usage: |
Expand Down Expand Up @@ -34,10 +34,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| list\<string\> | list\<string\> |
| record | record |
| string | string |
| list&lt;string&gt; | list&lt;string&gt; |
| table | table |
| record | record |
## Examples

Create a link to open some file
Expand Down
6 changes: 3 additions & 3 deletions commands/docs/ansi_strip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi strip
categories: |
platform
version: 0.104.0
version: 0.105.0
platform: |
Strip ANSI escape sequences from a string.
usage: |
Expand All @@ -29,10 +29,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| list\<string\> | list\<string\> |
| record | record |
| string | string |
| list&lt;string&gt; | list&lt;string&gt; |
| table | table |
| record | record |
## Examples

Strip ANSI escape sequences from a string
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/any.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: any
categories: |
filters
version: 0.104.0
version: 0.105.0
filters: |
Tests if any element of the input fulfills a predicate expression.
usage: |
Expand All @@ -29,7 +29,7 @@ contributors: false

| input | output |
| --------- | ------ |
| list\<any\> | bool |
| list&lt;any&gt; | bool |
## Examples

Check if a list contains any true values
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/append.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: append
categories: |
filters
version: 0.104.0
version: 0.105.0
filters: |
Append any number of rows to a table.
usage: |
Expand All @@ -29,7 +29,7 @@ contributors: false

| input | output |
| ----- | --------- |
| any | list\<any\> |
| any | list&lt;any&gt; |
## Examples

Append one int to a list
Expand Down
4 changes: 3 additions & 1 deletion commands/docs/ast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ast
categories: |
debug
version: 0.104.0
version: 0.105.0
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Expand Down Expand Up @@ -36,6 +36,8 @@ contributors: false
| input | output |
| ------- | ------ |
| nothing | table |
| nothing | record |
| nothing | string |
## Examples

Print the ast of a string
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/attr_category.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr category
categories: |
core
version: 0.104.0
version: 0.105.0
core: |
Attribute for adding a category to custom commands.
usage: |
Expand All @@ -29,7 +29,7 @@ contributors: false

| input | output |
| ------- | ------------ |
| nothing | list\<string\> |
| nothing | list&lt;string&gt; |
## Examples

Add a category to a custom command
Expand Down
63 changes: 63 additions & 0 deletions commands/docs/attr_deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: attr deprecated
categories: |
core
version: 0.105.0
core: |
Attribute for marking a command or flag as deprecated.
usage: |
Attribute for marking a command or flag as deprecated.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# `attr deprecated` for [core](/commands/categories/core.md)

<div class='command-title'>Attribute for marking a command or flag as deprecated.</div>

## Signature

```> attr deprecated {flags} (message)```

## Flags

- `--flag {string}`: Mark a flag as deprecated rather than the command
- `--since, -s {string}`: Denote a version when this item was deprecated
- `--remove, -r {string}`: Denote a version when this item will be removed
- `--report {string}`: How to warn about this item. One of: first (default), every

## Parameters

- `message`: Help message to include with deprecation warning.


## Input/output types:

| input | output |
| ------- | ------- |
| nothing | nothing |
| nothing | string |
## Examples

Add a deprecation warning to a custom command
```nu
> @deprecated
def outdated [] {}

```

Add a deprecation warning with a custom message
```nu
> @deprecated "Use my-new-command instead."
@category deprecated
def my-old-command [] {}
Use my-new-command instead.
```

## Notes
Mark a command (default) or flag/switch (--flag) as deprecated. By default, only the first usage will trigger a deprecation warning.

A help message can be included to provide more context for the deprecation, such as what to use as a replacement.

Also consider setting the category to deprecated with @category deprecated
4 changes: 2 additions & 2 deletions commands/docs/attr_example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr example
categories: |
core
version: 0.104.0
version: 0.105.0
core: |
Attribute for adding examples to custom commands.
usage: |
Expand Down Expand Up @@ -34,7 +34,7 @@ contributors: false

| input | output |
| ------- | -------------------------------------------- |
| nothing | record\<description: string, example: string\> |
| nothing | record&lt;description: string, example: string&gt; |
## Examples

Add examples to custom command
Expand Down
4 changes: 2 additions & 2 deletions commands/docs/attr_search-terms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr search-terms
categories: |
core
version: 0.104.0
version: 0.105.0
core: |
Attribute for adding search terms to custom commands.
usage: |
Expand All @@ -29,7 +29,7 @@ contributors: false

| input | output |
| ------- | ------------ |
| nothing | list\<string\> |
| nothing | list&lt;string&gt; |
## Examples

Add search terms to a custom command
Expand Down
9 changes: 1 addition & 8 deletions commands/docs/banner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: banner
categories: |
default
version: 0.104.0
version: 0.105.0
default: |
Print a banner for Nushell with information about the project
usage: |
Expand All @@ -23,10 +23,3 @@ contributors: false
## Flags

- `--short`: Only show startup time


## Input/output types:

| input | output |
| ----- | ------ |
| any | any |
2 changes: 1 addition & 1 deletion commands/docs/bits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits
categories: |
bits
version: 0.104.0
version: 0.105.0
bits: |
Various commands for working with bits.
usage: |
Expand Down
8 changes: 4 additions & 4 deletions commands/docs/bits_and.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits and
categories: |
bits
version: 0.104.0
version: 0.105.0
bits: |
Performs bitwise and for ints or binary values.
usage: |
Expand Down Expand Up @@ -33,10 +33,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| binary | binary |
| int | int |
| list\<binary\> | list\<binary\> |
| list\<int\> | list\<int\> |
| binary | binary |
| list&lt;int&gt; | list&lt;int&gt; |
| list&lt;binary&gt; | list&lt;binary&gt; |
## Examples

Apply bitwise and to two numbers
Expand Down
8 changes: 4 additions & 4 deletions commands/docs/bits_not.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits not
categories: |
bits
version: 0.104.0
version: 0.105.0
bits: |
Performs logical negation on each bit.
usage: |
Expand Down Expand Up @@ -30,10 +30,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| binary | binary |
| int | int |
| list\<binary\> | list\<binary\> |
| list\<int\> | list\<int\> |
| binary | binary |
| list&lt;int&gt; | list&lt;int&gt; |
| list&lt;binary&gt; | list&lt;binary&gt; |
## Examples

Apply logical negation to a list of numbers
Expand Down
8 changes: 4 additions & 4 deletions commands/docs/bits_or.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits or
categories: |
bits
version: 0.104.0
version: 0.105.0
bits: |
Performs bitwise or for ints or binary values.
usage: |
Expand Down Expand Up @@ -33,10 +33,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| binary | binary |
| int | int |
| list\<binary\> | list\<binary\> |
| list\<int\> | list\<int\> |
| binary | binary |
| list&lt;int&gt; | list&lt;int&gt; |
| list&lt;binary&gt; | list&lt;binary&gt; |
## Examples

Apply bits or to two numbers
Expand Down
8 changes: 4 additions & 4 deletions commands/docs/bits_rol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits rol
categories: |
bits
version: 0.104.0
version: 0.105.0
bits: |
Bitwise rotate left for ints or binary values.
usage: |
Expand Down Expand Up @@ -34,10 +34,10 @@ contributors: false

| input | output |
| ------------ | ------------ |
| binary | binary |
| int | int |
| list\<binary\> | list\<binary\> |
| list\<int\> | list\<int\> |
| binary | binary |
| list&lt;int&gt; | list&lt;int&gt; |
| list&lt;binary&gt; | list&lt;binary&gt; |
## Examples

Rotate left a number with 2 bits
Expand Down
Loading