Skip to content
Open
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 .vuepress/configs/sidebar/command_categories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ export const commandCategories = [
'/commands/categories/strings.md',
'/commands/categories/system.md',
'/commands/categories/viewers.md',
];
];
36 changes: 36 additions & 0 deletions commands/docs/abbr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: abbr
categories: |
platform
version: 0.113.0
platform: |
Abbreviations related commands.
usage: |
Abbreviations related commands.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# `abbr` for [platform](/commands/categories/platform.md)

<div class='command-title'>Abbreviations related commands.</div>

## Signature

```> abbr {flags} ```


## Input/output types:

| input | output |
| ------- | ------ |
| nothing | string |
## Notes
You must use one of the following subcommands. Using this command as-is will only produce this help message.

## Subcommands:

| name | description | type |
| ------------------------------------------ | ------------------------------- | -------- |
| [`abbr list`](/commands/docs/abbr_list.md) | List all defined abbreviations. | built-in |
35 changes: 35 additions & 0 deletions commands/docs/abbr_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: abbr list
categories: |
platform
version: 0.113.0
platform: |
List all defined abbreviations.
usage: |
List all defined abbreviations.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# `abbr list` for [platform](/commands/categories/platform.md)

<div class='command-title'>List all defined abbreviations.</div>

## Signature

```> abbr list {flags} ```


## Input/output types:

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

List all abbreviations
```nu
> abbr list

```
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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Expand Down
24 changes: 20 additions & 4 deletions 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.112.0
version: 0.113.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Expand All @@ -24,8 +24,11 @@ contributors: false

- `--fgstart, -a {string}`: Foreground gradient start color in hex (0x123456).
- `--fgend, -b {string}`: Foreground gradient end color in hex.
- `--fgnamed, -F {string}`: Named foreground gradient.
- `--bgstart, -c {string}`: Background gradient start color in hex.
- `--bgend, -d {string}`: Background gradient end color in hex.
- `--bgnamed, -B {string}`: Named background gradient.
- `--list, -l`: List available named gradients and show an example.

## Parameters

Expand All @@ -40,28 +43,41 @@ contributors: false
| list&lt;string&gt; | list&lt;string&gt; |
| table | table |
| record | record |
| nothing | string |
## Examples

draw text in a gradient with foreground start and end colors
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff' --fgend '0xe81cff'

Hello, Nushell! This is a gradient.
```

draw text in a gradient with foreground start and end colors and background start and end colors
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff' --fgend '0xe81cff' --bgstart '0xe81cff' --bgend '0x40c9ff'

Hello, Nushell! This is a gradient.
```

draw text in a gradient by specifying foreground start color - end color is assumed to be black
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff'

Hello, Nushell! This is a gradient.
```

draw text in a gradient by specifying foreground end color - start color is assumed to be black
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgend '0xe81cff'
Hello, Nushell! This is a gradient.
```

draw text in a gradient using a named rainbow foreground gradient
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgnamed rainbow
Hello, Nushell! This is a gradient.
```

draw text in a gradient using a named forest background gradient
```nu
> 'Hello, Nushell! This is a gradient.' | ansi gradient --bgnamed forest
Hello, Nushell! This is a gradient.
```
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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.0
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.112.0
version: 0.113.0
core: |
Various attributes for custom commands.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.112.0
version: 0.113.0
core: |
Attribute for adding a category to custom commands.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/attr_complete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr complete
categories: |
core
version: 0.112.0
version: 0.113.0
core: |
Attribute for using another command as a completion source for all arguments.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion commands/docs/attr_complete_external.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: attr complete external
categories: |
core
version: 0.112.0
version: 0.113.0
core: |
Attribute for enabling use of the external completer for internal commands.
usage: |
Expand Down
2 changes: 1 addition & 1 deletion 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.112.0
version: 0.113.0
core: |
Attribute for marking a command or flag as deprecated.
usage: |
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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.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.112.0
version: 0.113.0
bytes: |
Add specified bytes to the binary input.
usage: |
Expand Down
Loading