Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: alias
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Alias a command (with optional flags) to a new name.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/all.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: all
categories: |
filters
version: 0.107.0
version: 0.108.0
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi
categories: |
platform
version: 0.107.0
version: 0.108.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi gradient
categories: |
platform
version: 0.107.0
version: 0.108.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_link.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi link
categories: |
platform
version: 0.107.0
version: 0.108.0
platform: |
Add a link (using OSC 8 escape sequence) to the given string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ansi_strip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi strip
categories: |
platform
version: 0.107.0
version: 0.108.0
platform: |
Strip ANSI escape sequences from a string.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/any.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: any
categories: |
filters
version: 0.107.0
version: 0.108.0
filters: |
Tests if any element of the input fulfills a predicate expression.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/append.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: append
categories: |
filters
version: 0.107.0
version: 0.108.0
filters: |
Append any number of rows to a table.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/ast.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ast
categories: |
debug
version: 0.107.0
version: 0.108.0
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Expand Down
16 changes: 9 additions & 7 deletions commands/docs/attr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Various attributes for custom commands.
usage: |
Expand Down Expand Up @@ -31,9 +31,11 @@ You must use one of the following subcommands. Using this command as-is will onl

## Subcommands:

| name | description | type |
| ---------------------------------------------------------- | ------------------------------------------------------ | -------- |
| [`attr category`](/commands/docs/attr_category.md) | Attribute for adding a category to custom commands. | built-in |
| [`attr deprecated`](/commands/docs/attr_deprecated.md) | Attribute for marking a command or flag as deprecated. | built-in |
| [`attr example`](/commands/docs/attr_example.md) | Attribute for adding examples to custom commands. | built-in |
| [`attr search-terms`](/commands/docs/attr_search-terms.md) | Attribute for adding search terms to custom commands. | built-in |
| name | description | type |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| [`attr category`](/commands/docs/attr_category.md) | Attribute for adding a category to custom commands. | built-in |
| [`attr complete`](/commands/docs/attr_complete.md) | Attribute for using another command as a completion source for all arguments. | built-in |
| [`attr complete external`](/commands/docs/attr_complete_external.md) | Attribute for enabling use of the external completer for internal commands. | built-in |
| [`attr deprecated`](/commands/docs/attr_deprecated.md) | Attribute for marking a command or flag as deprecated. | built-in |
| [`attr example`](/commands/docs/attr_example.md) | Attribute for adding examples to custom commands. | built-in |
| [`attr search-terms`](/commands/docs/attr_search-terms.md) | Attribute for adding search terms to custom commands. | built-in |
8 changes: 4 additions & 4 deletions commands/docs/attr_category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr category
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Attribute for adding a category to custom commands.
usage: |
Expand All @@ -27,9 +27,9 @@ contributors: false

## Input/output types:

| input | output |
| ------- | ------------ |
| nothing | list<string> |
| input | output |
| ------- | ------ |
| nothing | string |
## Examples

Add a category to a custom command
Expand Down
44 changes: 44 additions & 0 deletions commands/docs/attr_complete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: attr complete
categories: |
core
version: 0.108.0
core: |
Attribute for using another command as a completion source for all arguments.
usage: |
Attribute for using another command as a completion source for all arguments.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

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

<div class='command-title'>Attribute for using another command as a completion source for all arguments.</div>

## Signature

```> attr complete {flags} (completer)```

## Parameters

- `completer`: Name of the completion command.


## Input/output types:

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

Use another command as completion source
```nu
> def complete-foo [spans: list<string>] {
[bar baz qux spam eggs] | where $it not-in $spans
}

@complete 'complete-foo'
def foo [...args] { $args }

```
38 changes: 38 additions & 0 deletions commands/docs/attr_complete_external.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: attr complete external
categories: |
core
version: 0.108.0
core: |
Attribute for enabling use of the external completer for internal commands.
usage: |
Attribute for enabling use of the external completer for internal commands.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

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

<div class='command-title'>Attribute for enabling use of the external completer for internal commands.</div>

## Signature

```> attr complete external {flags} ```


## Input/output types:

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

Use the external completer for a wrapper command
```nu
> @complete external
def --wrapped jc [...args] {
^jc ...$args | from json
}

```
9 changes: 4 additions & 5 deletions commands/docs/attr_deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr deprecated
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Attribute for marking a command or flag as deprecated.
usage: |
Expand Down Expand Up @@ -34,10 +34,9 @@ contributors: false

## Input/output types:

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

Add a deprecation warning to a custom command
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/attr_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr example
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Attribute for adding examples to custom commands.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/attr_search-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr search-terms
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Attribute for adding search terms to custom commands.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: banner
categories: |
default
version: 0.107.0
version: 0.108.0
default: |
Print a banner for Nushell with information about the project
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Various commands for working with bits.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_and.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits and
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Performs bitwise and for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_not.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits not
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Performs logical negation on each bit.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_or.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits or
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Performs bitwise or for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_rol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits rol
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Bitwise rotate left for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_ror.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits ror
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Bitwise rotate right for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_shl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits shl
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Bitwise shift left for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_shr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits shr
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Bitwise shift right for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bits_xor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bits xor
categories: |
bits
version: 0.107.0
version: 0.108.0
bits: |
Performs bitwise xor for ints or binary values.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/break.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: break
categories: |
core
version: 0.107.0
version: 0.108.0
core: |
Break a loop.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes
categories: |
bytes
version: 0.107.0
version: 0.108.0
bytes: |
Various commands for working with byte data.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes add
categories: |
bytes
version: 0.107.0
version: 0.108.0
bytes: |
Add specified bytes to the input.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_at.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes at
categories: |
bytes
version: 0.107.0
version: 0.108.0
bytes: |
Get bytes defined by a range.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/bytes_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: bytes build
categories: |
bytes
version: 0.107.0
version: 0.108.0
bytes: |
Create bytes from the arguments.
usage: |
Expand Down
Loading