diff --git a/commands/README.md b/commands/README.md index 8e9a4b95aff..578a22be446 100644 --- a/commands/README.md +++ b/commands/README.md @@ -25,7 +25,7 @@ To see all commands from inside Nushell, run [`help commands`](/commands/docs/he Feature - {{ command.title }} + {{ command.title }} {{ command.frontmatter.categories }} {{ command.frontmatter.usage }} {{ command.frontmatter.feature }} diff --git a/commands/categories/bits.md b/commands/categories/bits.md index a06f8010741..014d878ae76 100644 --- a/commands/categories/bits.md +++ b/commands/categories/bits.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/bytes.md b/commands/categories/bytes.md index 1376a23642d..50584dab9cc 100644 --- a/commands/categories/bytes.md +++ b/commands/categories/bytes.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/chart.md b/commands/categories/chart.md index 3e7cd914ec2..d2c46939a23 100644 --- a/commands/categories/chart.md +++ b/commands/categories/chart.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/conversions.md b/commands/categories/conversions.md index c74936edce1..a5bb11139e8 100644 --- a/commands/categories/conversions.md +++ b/commands/categories/conversions.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/core.md b/commands/categories/core.md index 79a38ddb1ab..5489796e80b 100644 --- a/commands/categories/core.md +++ b/commands/categories/core.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/database.md b/commands/categories/database.md index cdb858219d1..585f8166379 100644 --- a/commands/categories/database.md +++ b/commands/categories/database.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/dataframe.md b/commands/categories/dataframe.md index 2944ec4da3b..06b0f5ca896 100644 --- a/commands/categories/dataframe.md +++ b/commands/categories/dataframe.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/dataframe_or_lazyframe.md b/commands/categories/dataframe_or_lazyframe.md index 26efecdb7bd..63d80247360 100644 --- a/commands/categories/dataframe_or_lazyframe.md +++ b/commands/categories/dataframe_or_lazyframe.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/date.md b/commands/categories/date.md index d3459271a3d..c563d672b2f 100644 --- a/commands/categories/date.md +++ b/commands/categories/date.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/debug.md b/commands/categories/debug.md index 0769590e1dd..8aac7248fb2 100644 --- a/commands/categories/debug.md +++ b/commands/categories/debug.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/default.md b/commands/categories/default.md index 0be364cddb9..81286869521 100644 --- a/commands/categories/default.md +++ b/commands/categories/default.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/env.md b/commands/categories/env.md index 50d84c1210c..981fb2b05ed 100644 --- a/commands/categories/env.md +++ b/commands/categories/env.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/experimental.md b/commands/categories/experimental.md index 28ee38f3876..9008981e821 100644 --- a/commands/categories/experimental.md +++ b/commands/categories/experimental.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/expression.md b/commands/categories/expression.md index b40dd3d0459..d34aea9d9d1 100644 --- a/commands/categories/expression.md +++ b/commands/categories/expression.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/filesystem.md b/commands/categories/filesystem.md index 58863466e76..a4826d9dc09 100644 --- a/commands/categories/filesystem.md +++ b/commands/categories/filesystem.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/filters.md b/commands/categories/filters.md index 0eb06ff55ab..fa369f782c7 100644 --- a/commands/categories/filters.md +++ b/commands/categories/filters.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/formats.md b/commands/categories/formats.md index eb343707654..6b66981f89a 100644 --- a/commands/categories/formats.md +++ b/commands/categories/formats.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/generators.md b/commands/categories/generators.md index 6d122a2cd8e..2f1e1f1e836 100644 --- a/commands/categories/generators.md +++ b/commands/categories/generators.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/hash.md b/commands/categories/hash.md index c9c1a6c159f..09654b4413d 100644 --- a/commands/categories/hash.md +++ b/commands/categories/hash.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/history.md b/commands/categories/history.md index 18d0c43208c..d82e54a268f 100644 --- a/commands/categories/history.md +++ b/commands/categories/history.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/lazyframe.md b/commands/categories/lazyframe.md index d51e759c00a..2fcb835525e 100644 --- a/commands/categories/lazyframe.md +++ b/commands/categories/lazyframe.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/math.md b/commands/categories/math.md index f60245a0aec..03571c3143d 100644 --- a/commands/categories/math.md +++ b/commands/categories/math.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/misc.md b/commands/categories/misc.md index 40262dfffe3..cc42c55e31d 100644 --- a/commands/categories/misc.md +++ b/commands/categories/misc.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/network.md b/commands/categories/network.md index 85662d2cc57..e0eb5ec52f5 100644 --- a/commands/categories/network.md +++ b/commands/categories/network.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/path.md b/commands/categories/path.md index d96e2f29721..7b115a964b8 100644 --- a/commands/categories/path.md +++ b/commands/categories/path.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/platform.md b/commands/categories/platform.md index 4361ce7310a..c7199d8b86f 100644 --- a/commands/categories/platform.md +++ b/commands/categories/platform.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/random.md b/commands/categories/random.md index d63021c12b3..fecaffb616a 100644 --- a/commands/categories/random.md +++ b/commands/categories/random.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/removed.md b/commands/categories/removed.md index bbb0c9095ba..5827cf388b8 100644 --- a/commands/categories/removed.md +++ b/commands/categories/removed.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/shells.md b/commands/categories/shells.md index 35c0de1b29b..46ccaabec8e 100644 --- a/commands/categories/shells.md +++ b/commands/categories/shells.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/strings.md b/commands/categories/strings.md index 767219418f4..d82068a03b8 100644 --- a/commands/categories/strings.md +++ b/commands/categories/strings.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/system.md b/commands/categories/system.md index 0e3c94ef8cd..b54bc622201 100644 --- a/commands/categories/system.md +++ b/commands/categories/system.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/categories/viewers.md b/commands/categories/viewers.md index 3791046aa3d..94b2dfed432 100644 --- a/commands/categories/viewers.md +++ b/commands/categories/viewers.md @@ -20,7 +20,7 @@ Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} diff --git a/commands/docs/alias.md b/commands/docs/alias.md index a0d33aedf93..610b141af4e 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.91.0 +version: 0.92.0 core: | Alias a command (with optional flags) to a new name. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `alias` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Alias a command (with optional flags) to a new name.
## Signature diff --git a/commands/docs/all.md b/commands/docs/all.md index 815e032125f..c5a11cd6e1f 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Test if every element of the input fulfills a predicate expression. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `all` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Test if every element of the input fulfills a predicate expression.
## Signature diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index 3b1cb80286a..92b8a882575 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Output ANSI codes to change color and style of text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `ansi` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Output ANSI codes to change color and style of text.
## Signature diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index a1e165919bc..bc594c1f49c 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,23 +2,19 @@ title: ansi gradient categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | Add a color gradient (using ANSI color codes) to the given string. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for platform +# `ansi gradient` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Add a color gradient (using ANSI color codes) to the given string.
- -::: warning - Command `ansi gradient` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> ansi gradient {flags} ...rest``` diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 82cf452c875..65c1868c249 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `ansi link` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Add a link (using OSC 8 escape sequence) to the given string.
## Signature diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 9ecc3ee0506..79fab015a21 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Strip ANSI escape sequences from a string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `ansi strip` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Strip ANSI escape sequences from a string.
## Signature diff --git a/commands/docs/any.md b/commands/docs/any.md index 3b6075463ae..24c1fd767f1 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Tests if any element of the input fulfills a predicate expression. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `any` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Tests if any element of the input fulfills a predicate expression.
## Signature diff --git a/commands/docs/append.md b/commands/docs/append.md index 1239db92a33..bae3ab8b984 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Append any number of rows to a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `append` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Append any number of rows to a table.
## Signature diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 2802441358d..d203722be8d 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `ast` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Print the abstract syntax tree (ast) for a pipeline.
## Signature diff --git a/commands/docs/bits.md b/commands/docs/bits.md index c2c9075f19e..669bc680ffa 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,23 +2,19 @@ title: bits categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Various commands for working with bits. usage: | Various commands for working with bits. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Various commands for working with bits.
- -::: warning - Command `bits` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits {flags} ``` diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 758746ae2b0..cb68463db19 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,23 +2,19 @@ title: bits and categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Performs bitwise and for ints or binary values. usage: | Performs bitwise and for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits and` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Performs bitwise and for ints or binary values.
- -::: warning - Command `bits and` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits and {flags} (target)``` diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index 96ea690bb27..9e0b123eb5f 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,23 +2,19 @@ title: bits not categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Performs logical negation on each bit. usage: | Performs logical negation on each bit. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits not` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Performs logical negation on each bit.
- -::: warning - Command `bits not` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits not {flags} ``` diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 9193baa2cda..2daf015664b 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,23 +2,19 @@ title: bits or categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Performs bitwise or for ints or binary values. usage: | Performs bitwise or for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits or` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Performs bitwise or for ints or binary values.
- -::: warning - Command `bits or` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits or {flags} (target)``` diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 327f945ae22..81ff41372b1 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,23 +2,19 @@ title: bits rol categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Bitwise rotate left for ints or binary values. usage: | Bitwise rotate left for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits rol` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Bitwise rotate left for ints or binary values.
- -::: warning - Command `bits rol` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits rol {flags} (bits)``` diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index edb40ccef11..200de1badfd 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,23 +2,19 @@ title: bits ror categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Bitwise rotate right for ints or binary values. usage: | Bitwise rotate right for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits ror` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Bitwise rotate right for ints or binary values.
- -::: warning - Command `bits ror` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits ror {flags} (bits)``` diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 92a86ec8192..c3d584f002a 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,23 +2,19 @@ title: bits shl categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Bitwise shift left for ints or binary values. usage: | Bitwise shift left for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits shl` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Bitwise shift left for ints or binary values.
- -::: warning - Command `bits shl` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits shl {flags} (bits)``` diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 2913abc73aa..e0c744701fe 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,23 +2,19 @@ title: bits shr categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Bitwise shift right for ints or binary values. usage: | Bitwise shift right for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits shr` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Bitwise shift right for ints or binary values.
- -::: warning - Command `bits shr` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits shr {flags} (bits)``` diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index a5a73f5c6aa..7d62031a5f8 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,23 +2,19 @@ title: bits xor categories: | bits -version: 0.91.0 +version: 0.92.0 bits: | Performs bitwise xor for ints or binary values. usage: | Performs bitwise xor for ints or binary values. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for bits +# `bits xor` for [bits](/commands/categories/bits.md) -
{{ $frontmatter.bits }}
+
Performs bitwise xor for ints or binary values.
- -::: warning - Command `bits xor` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> bits xor {flags} (target)``` diff --git a/commands/docs/break.md b/commands/docs/break.md index 33d0a781563..da695b2d365 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.91.0 +version: 0.92.0 core: | Break a loop. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `break` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Break a loop.
## Signature diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 8420a9a4f11..176b865ffc1 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Various commands for working with byte data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Various commands for working with byte data.
## Signature diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index 87076910661..559419465ff 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Add specified bytes to the input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes add` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Add specified bytes to the input.
## Signature diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 3f66de0d05c..e320bfb51b4 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Get bytes defined by a range. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes at` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Get bytes defined by a range.
## Signature diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index b408e790a85..75c05fcb815 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Create bytes from the arguments. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes build` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Create bytes from the arguments.
## Signature diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index 3eac5e5f87b..d4328bde9fc 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes collect` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Concatenate multiple binary into a single binary, with an optional separator between each.
## Signature diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 819db3f40bb..c94a437cafd 100644 --- a/commands/docs/bytes_ends-with.md +++ b/commands/docs/bytes_ends-with.md @@ -2,7 +2,7 @@ title: bytes ends-with categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Check if bytes ends with a pattern. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes ends-with` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Check if bytes ends with a pattern.
## Signature diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 42c7d3ba009..81f74a12af1 100644 --- a/commands/docs/bytes_index-of.md +++ b/commands/docs/bytes_index-of.md @@ -2,7 +2,7 @@ title: bytes index-of categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes index-of` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Returns start index of first occurrence of pattern in bytes, or -1 if no match.
## Signature diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 61a2f20e754..eafdc76eb05 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Output the length of any bytes in the pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes length` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Output the length of any bytes in the pipeline.
## Signature diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index ff7b6dfea55..e1109ba5886 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Remove bytes. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes remove` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Remove bytes.
## Signature diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index c412c6e4250..628e823b7dd 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Find and replace binary. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes replace` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Find and replace binary.
## Signature diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index b99846847a3..80e93cceb52 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Reverse the bytes in the pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes reverse` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Reverse the bytes in the pipeline.
## Signature diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index 6afebb639e5..16614398eea 100644 --- a/commands/docs/bytes_starts-with.md +++ b/commands/docs/bytes_starts-with.md @@ -2,7 +2,7 @@ title: bytes starts-with categories: | bytes -version: 0.91.0 +version: 0.92.0 bytes: | Check if bytes starts with a pattern. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for bytes +# `bytes starts-with` for [bytes](/commands/categories/bytes.md) -
{{ $frontmatter.bytes }}
+
Check if bytes starts with a pattern.
## Signature diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 10c0f289372..13c0c6db21c 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.91.0 +version: 0.92.0 generators: | Display a calendar. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for generators +# `cal` for [generators](/commands/categories/generators.md) -
{{ $frontmatter.generators }}
+
Display a calendar.
## Signature diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 54ffab6aa13..973504dadab 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Change directory. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `cd` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Change directory.
## Signature diff --git a/commands/docs/char.md b/commands/docs/char.md index b665bcf2198..1061b688c9b 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Output special characters (e.g., 'newline'). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `char` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Output special characters (e.g., 'newline').
## Signature diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 7cf3d3c3fa5..ff947c93700 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Clear the terminal. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `clear` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Clear the terminal.
## Signature diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 8d7bf03c457..40ceaaab6a7 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Collect the stream and pass it to a block. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `collect` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Collect the stream and pass it to a block.
## Signature diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 50751736e44..d1e5c20c579 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Given a record or table, produce a list of its columns' names. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `columns` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Given a record or table, produce a list of its columns' names.
## Signature diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index e92722daea5..23834a5a1c9 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.91.0 +version: 0.92.0 core: | View or modify the current command line input buffer. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `commandline` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
View or modify the current command line input buffer.
## Signature diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index 705280dc9b2..bc605a1f662 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.91.0 +version: 0.92.0 core: | Modify the current command line input buffer. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `commandline edit` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Modify the current command line input buffer.
## Signature diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 7f4efec4345..d39cc474116 100644 --- a/commands/docs/commandline_get-cursor.md +++ b/commands/docs/commandline_get-cursor.md @@ -2,7 +2,7 @@ title: commandline get-cursor categories: | core -version: 0.91.0 +version: 0.92.0 core: | Get the current cursor position. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `commandline get-cursor` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Get the current cursor position.
## Signature diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 9b6070e2150..38da9f6c57c 100644 --- a/commands/docs/commandline_set-cursor.md +++ b/commands/docs/commandline_set-cursor.md @@ -2,7 +2,7 @@ title: commandline set-cursor categories: | core -version: 0.91.0 +version: 0.92.0 core: | Set the current cursor position. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `commandline set-cursor` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Set the current cursor position.
## Signature diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 7d907752d29..d95f279b663 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Creates a table with non-empty rows. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `compact` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Creates a table with non-empty rows.
## Signature diff --git a/commands/docs/complete.md b/commands/docs/complete.md index fd0adc9d962..0fe9010b015 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.91.0 +version: 0.92.0 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `complete` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
Capture the outputs and exit code from an external piped in command in a nushell table.
## Signature @@ -28,17 +28,11 @@ feature: default ## Examples -Run the external command to completion, capturing stdout and exit_code +Run the external command to completion, capturing stdout, stderr, and exit_code ```nu > ^external arg1 | complete ``` -Run external command to completion, capturing, stdout, stderr and exit_code -```nu -> do { ^external arg1 } | complete - -``` - ## Notes In order to capture stdout, stderr, and exit_code, externally piped in commands need to be wrapped with `do` \ No newline at end of file diff --git a/commands/docs/config.md b/commands/docs/config.md index d1c5106f565..c2747b81e9f 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.91.0 +version: 0.92.0 env: | Edit nushell configuration files. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `config` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Edit nushell configuration files.
## Signature diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 0a0fb6af76f..634c5751639 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.91.0 +version: 0.92.0 env: | Edit nu environment configurations. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `config env` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Edit nu environment configurations.
## Signature diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index ff94bb9653c..af7fcb170f6 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.91.0 +version: 0.92.0 env: | Edit nu configurations. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `config nu` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Edit nu configurations.
## Signature diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 30bc7af97e8..2624852d340 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.91.0 +version: 0.92.0 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `config reset` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu.
## Signature diff --git a/commands/docs/const.md b/commands/docs/const.md index 95496b08bbc..dd23242aea0 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create a parse-time constant. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `const` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create a parse-time constant.
## Signature diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 757a615d58f..1963e45d25d 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.91.0 +version: 0.92.0 core: | Continue a loop from the next iteration. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `continue` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Continue a loop from the next iteration.
## Signature diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 72d965441bf..5f25f3947f6 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Copy files using uutils/coreutils cp. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `cp` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Copy files using uutils/coreutils cp.
## Signature diff --git a/commands/docs/date.md b/commands/docs/date.md index 860fbd8d68d..f94dc8d069b 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.91.0 +version: 0.92.0 date: | Date-related commands. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Date-related commands.
## Signature diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index b8f0a794034..3ad08a44ff5 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.91.0 +version: 0.92.0 removed: | Removed command: use `format date` instead. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for removed +# `date format` for [removed](/commands/categories/removed.md) -
{{ $frontmatter.removed }}
+
Removed command: use `format date` instead.
## Signature diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 4a5ec5ec791..4f16d8c3224 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.91.0 +version: 0.92.0 date: | Print a 'humanized' format for the date, relative to now. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date humanize` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Print a 'humanized' format for the date, relative to now.
## Signature diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index 8aabf7c03aa..f5c6b170c43 100644 --- a/commands/docs/date_list-timezone.md +++ b/commands/docs/date_list-timezone.md @@ -2,7 +2,7 @@ title: date list-timezone categories: | date -version: 0.91.0 +version: 0.92.0 date: | List supported time zones. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date list-timezone` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
List supported time zones.
## Signature diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 748b197914f..0ff5537f626 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.91.0 +version: 0.92.0 date: | Get the current date. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date now` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Get the current date.
## Signature diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index 9364c28ed26..286c753672c 100644 --- a/commands/docs/date_to-record.md +++ b/commands/docs/date_to-record.md @@ -2,7 +2,7 @@ title: date to-record categories: | date -version: 0.91.0 +version: 0.92.0 date: | Convert the date into a record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date to-record` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Convert the date into a record.
## Signature diff --git a/commands/docs/date_to-table.md b/commands/docs/date_to-table.md index 214b80fc597..b73b1c33c0b 100644 --- a/commands/docs/date_to-table.md +++ b/commands/docs/date_to-table.md @@ -2,7 +2,7 @@ title: date to-table categories: | date -version: 0.91.0 +version: 0.92.0 date: | Convert the date into a structured table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date to-table` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Convert the date into a structured table.
## Signature diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index f1426da2063..874eca5b3db 100644 --- a/commands/docs/date_to-timezone.md +++ b/commands/docs/date_to-timezone.md @@ -2,7 +2,7 @@ title: date to-timezone categories: | date -version: 0.91.0 +version: 0.92.0 date: | Convert a date to a given time zone. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `date to-timezone` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Convert a date to a given time zone.
## Signature diff --git a/commands/docs/debug.md b/commands/docs/debug.md index c038d88e56b..42b09a290ca 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Debug print the value(s) piped in. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `debug` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Debug print the value(s) piped in.
## Signature @@ -61,6 +61,7 @@ Debug print a table ## Subcommands: -| name | type | usage | -| -------------------------------------------- | ------- | ------------------------- | -| [`debug info`](/commands/docs/debug_info.md) | Builtin | View process memory info. | +| name | type | usage | +| -------------------------------------------------- | ------- | --------------------------------------- | +| [`debug info`](/commands/docs/debug_info.md) | Builtin | View process memory info. | +| [`debug profile`](/commands/docs/debug_profile.md) | Builtin | Profile pipeline elements in a closure. | \ No newline at end of file diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 4af375fae7f..d470dfd7261 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | View process memory info. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `debug info` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
View process memory info.
## Signature diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md new file mode 100644 index 00000000000..4b98c60c6b9 --- /dev/null +++ b/commands/docs/debug_profile.md @@ -0,0 +1,88 @@ +--- +title: debug profile +categories: | + debug +version: 0.92.0 +debug: | + Profile pipeline elements in a closure. +usage: | + Profile pipeline elements in a closure. +feature: default +--- + + +# `debug profile` for [debug](/commands/categories/debug.md) + +
Profile pipeline elements in a closure.
+ +## Signature + +```> debug profile {flags} (closure)``` + +## Flags + + - `--spans, -s`: Collect spans of profiled elements + - `--expand-source, -e`: Collect full source fragments of profiled elements + - `--values, -v`: Collect pipeline element output values + - `--expr, -x`: Collect expression types + - `--max-depth, -m {int}`: How many blocks/closures deep to step into (default 2) + +## Parameters + + - `closure`: The closure to profile. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | table | + +## Examples + +Profile config evaluation +```nu +> debug profile { source $nu.config-path } + +``` + +Profile config evaluation with more granularity +```nu +> debug profile { source $nu.config-path } --max-depth 4 + +``` + +## Notes +The profiler profiles every evaluated pipeline element inside a closure, stepping into all +commands calls and other blocks/closures. + +The output can be heavily customized. By default, the following columns are included: +- depth : Depth of the pipeline element. Each entered block adds one level of depth. How many + blocks deep to step into is controlled with the --max-depth option. +- id : ID of the pipeline element +- parent_id : ID of the parent element +- source : Source code of the pipeline element. If the element has multiple lines, only the + first line is used and `...` is appended to the end. Full source code can be shown + with the --expand-source flag. +- duration_ms : How long it took to run the pipeline element in milliseconds. +- (optional) span : Span of the element. Can be viewed via the `view span` command. Enabled with + the --spans flag. +- (optional) expr : The type of expression of the pipeline element. Enabled with the --expr flag. +- (optional) output : The output value of the pipeline element. Enabled with the --values flag. + +To illustrate the depth and IDs, consider `debug profile { if true { echo 'spam' } }`. There are +three pipeline elements: + +depth id parent_id + 0 0 0 debug profile { do { if true { 'spam' } } } + 1 1 0 if true { 'spam' } + 2 2 1 'spam' + +Each block entered increments depth by 1 and each block left decrements it by one. This way you can +control the profiling granularity. Passing --max-depth=1 to the above would stop at +`if true { 'spam' }`. The id is used to identify each element. The parent_id tells you that 'spam' +was spawned from `if true { 'spam' }` which was spawned from the root `debug profile { ... }`. + +Note: In some cases, the ordering of piepeline elements might not be intuitive. For example, +`[ a bb cc ] | each { $in | str length }` involves some implicit collects and lazy evaluation +confusing the id/parent_id hierarchy. The --expr flag is helpful for investigating these issues. \ No newline at end of file diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 7ce63253629..6db7c3ea257 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Decode bytes into a string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `decode` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Decode bytes into a string.
## Signature diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 3d1a1e91e0f..ab2bb9ec5f0 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.91.0 +version: 0.92.0 hash: | Base64 decode a value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for hash +# `decode base64` for [hash](/commands/categories/hash.md) -
{{ $frontmatter.hash }}
+
Base64 decode a value.
## Signature diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 37344d75641..d6b9a8cfde9 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,23 +2,19 @@ title: decode hex categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Hex decode a value. usage: | Hex decode a value. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for formats +# `decode hex` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Hex decode a value.
- -::: warning - Command `decode hex` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> decode hex {flags} ...rest``` diff --git a/commands/docs/def.md b/commands/docs/def.md index fca164e582f..0c1f2a68e0e 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.91.0 +version: 0.92.0 core: | Define a custom command. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `def` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Define a custom command.
## Signature diff --git a/commands/docs/default.md b/commands/docs/default.md index 775b18d464a..a626c4cf20b 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Sets a default row's column if missing. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `default` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Sets a default row's column if missing.
## Signature diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 0da51e59db1..cf3b9b0c8ca 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.91.0 +version: 0.92.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `describe` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Describe the type and structure of the value(s) piped in.
## Signature diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index ac42bffcfdb..948b2cbe192 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Attempt to automatically split text into multiple columns. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `detect columns` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Attempt to automatically split text into multiple columns.
## Signature @@ -24,6 +24,7 @@ feature: default - `--skip, -s {int}`: number of rows to skip before detecting - `--no-headers, -n`: don't detect headers - `--combine-columns, -c {range}`: columns to be combined; listed as a range + - `--guess, -`: detect columns by guessing width, it may be useful if default one doesn't work ## Input/output types: @@ -34,9 +35,22 @@ feature: default ## Examples -Splits string across multiple columns +use --guess if you find default algorithm not working ```nu -> 'a b c' | detect columns --no-headers +> +'Filesystem 1K-blocks Used Available Use% Mounted on +none 8150224 4 8150220 1% /mnt/c' | detect columns --guess +╭───┬────────────┬───────────┬──────┬───────────┬──────┬────────────╮ +│ # │ Filesystem │ 1K-blocks │ Used │ Available │ Use% │ Mounted on │ +├───┼────────────┼───────────┼──────┼───────────┼──────┼────────────┤ +│ 0 │ none │ 8150224 │ 4 │ 8150220 │ 1% │ /mnt/c │ +╰───┴────────────┴───────────┴──────┴───────────┴──────┴────────────╯ + +``` + +detect columns with no headers +```nu +> 'a b c' | detect columns --no-headers ╭───┬─────────┬─────────┬─────────╮ │ # │ column0 │ column1 │ column2 │ ├───┼─────────┼─────────┼─────────┤ diff --git a/commands/docs/dfr.md b/commands/docs/dfr.md index 229dc51dfb3..dec08a2935b 100644 --- a/commands/docs/dfr.md +++ b/commands/docs/dfr.md @@ -2,7 +2,7 @@ title: dfr categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr` for [dataframe](/commands/categories/dataframe.md) +
Operate with data in a dataframe format.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr {flags} ``` diff --git a/commands/docs/dfr_agg-groups.md b/commands/docs/dfr_agg-groups.md index 54dca90845f..4a55d1d85a4 100644 --- a/commands/docs/dfr_agg-groups.md +++ b/commands/docs/dfr_agg-groups.md @@ -2,7 +2,7 @@ title: dfr agg-groups categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates an agg_groups expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr agg-groups` for [expression](/commands/categories/expression.md) +
Creates an agg_groups expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr agg-groups {flags} ``` diff --git a/commands/docs/dfr_agg.md b/commands/docs/dfr_agg.md index 0b4bf4c7999..713bf2f5396 100644 --- a/commands/docs/dfr_agg.md +++ b/commands/docs/dfr_agg.md @@ -2,7 +2,7 @@ title: dfr agg categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr agg` for [lazyframe](/commands/categories/lazyframe.md) +
Performs a series of aggregations from a group-by.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr agg {flags} ...rest``` diff --git a/commands/docs/dfr_all-false.md b/commands/docs/dfr_all-false.md index bd53c98bbcc..b6ef2ef0271 100644 --- a/commands/docs/dfr_all-false.md +++ b/commands/docs/dfr_all-false.md @@ -2,7 +2,7 @@ title: dfr all-false categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns true if all values are false. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr all-false` for [dataframe](/commands/categories/dataframe.md) +
Returns true if all values are false.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr all-false {flags} ``` diff --git a/commands/docs/dfr_all-true.md b/commands/docs/dfr_all-true.md index bf184cd5d45..41762c0bd25 100644 --- a/commands/docs/dfr_all-true.md +++ b/commands/docs/dfr_all-true.md @@ -2,7 +2,7 @@ title: dfr all-true categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns true if all values are true. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr all-true` for [dataframe](/commands/categories/dataframe.md) +
Returns true if all values are true.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr all-true {flags} ``` diff --git a/commands/docs/dfr_append.md b/commands/docs/dfr_append.md index 02230a76b3e..d675227b0a4 100644 --- a/commands/docs/dfr_append.md +++ b/commands/docs/dfr_append.md @@ -2,7 +2,7 @@ title: dfr append categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Appends a new dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr append` for [dataframe](/commands/categories/dataframe.md) +
Appends a new dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr append {flags} (other)``` diff --git a/commands/docs/dfr_arg-max.md b/commands/docs/dfr_arg-max.md index e29c4ae03da..a1478efab5b 100644 --- a/commands/docs/dfr_arg-max.md +++ b/commands/docs/dfr_arg-max.md @@ -2,7 +2,7 @@ title: dfr arg-max categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Return index for max value in series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr arg-max` for [dataframe](/commands/categories/dataframe.md) +
Return index for max value in series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-max {flags} ``` diff --git a/commands/docs/dfr_arg-min.md b/commands/docs/dfr_arg-min.md index 5598a2f00da..124b7c760cc 100644 --- a/commands/docs/dfr_arg-min.md +++ b/commands/docs/dfr_arg-min.md @@ -2,7 +2,7 @@ title: dfr arg-min categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Return index for min value in series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr arg-min` for [dataframe](/commands/categories/dataframe.md) +
Return index for min value in series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-min {flags} ``` diff --git a/commands/docs/dfr_arg-sort.md b/commands/docs/dfr_arg-sort.md index 3e13f1821c6..a4913eecc9b 100644 --- a/commands/docs/dfr_arg-sort.md +++ b/commands/docs/dfr_arg-sort.md @@ -2,7 +2,7 @@ title: dfr arg-sort categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns indexes for a sorted series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr arg-sort` for [dataframe](/commands/categories/dataframe.md) +
Returns indexes for a sorted series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-sort {flags} ``` diff --git a/commands/docs/dfr_arg-true.md b/commands/docs/dfr_arg-true.md index 12a792f15ca..6fd783a8d9e 100644 --- a/commands/docs/dfr_arg-true.md +++ b/commands/docs/dfr_arg-true.md @@ -2,7 +2,7 @@ title: dfr arg-true categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns indexes where values are true. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr arg-true` for [dataframe](/commands/categories/dataframe.md) +
Returns indexes where values are true.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-true {flags} ``` diff --git a/commands/docs/dfr_arg-unique.md b/commands/docs/dfr_arg-unique.md index da017cbf8c1..146eb7edca5 100644 --- a/commands/docs/dfr_arg-unique.md +++ b/commands/docs/dfr_arg-unique.md @@ -2,7 +2,7 @@ title: dfr arg-unique categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns indexes for unique values. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr arg-unique` for [dataframe](/commands/categories/dataframe.md) +
Returns indexes for unique values.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-unique {flags} ``` diff --git a/commands/docs/dfr_arg-where.md b/commands/docs/dfr_arg-where.md index e270d7df76b..3656484d152 100644 --- a/commands/docs/dfr_arg-where.md +++ b/commands/docs/dfr_arg-where.md @@ -2,7 +2,7 @@ title: dfr arg-where categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr arg-where` for [expression](/commands/categories/expression.md) +
Creates an expression that returns the arguments where expression is true.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr arg-where {flags} (column name)``` diff --git a/commands/docs/dfr_as-date.md b/commands/docs/dfr_as-date.md index 30d82431405..2a4b48c12e0 100644 --- a/commands/docs/dfr_as-date.md +++ b/commands/docs/dfr_as-date.md @@ -2,7 +2,7 @@ title: dfr as-date categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Converts string to date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr as-date` for [dataframe](/commands/categories/dataframe.md) +
Converts string to date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr as-date {flags} (format)``` diff --git a/commands/docs/dfr_as-datetime.md b/commands/docs/dfr_as-datetime.md index 0a3ec5b63f8..2d6593db043 100644 --- a/commands/docs/dfr_as-datetime.md +++ b/commands/docs/dfr_as-datetime.md @@ -2,7 +2,7 @@ title: dfr as-datetime categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Converts string to datetime. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr as-datetime` for [dataframe](/commands/categories/dataframe.md) +
Converts string to datetime.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr as-datetime {flags} (format)``` diff --git a/commands/docs/dfr_as.md b/commands/docs/dfr_as.md index 0079fe3c9a1..f23fccc14e3 100644 --- a/commands/docs/dfr_as.md +++ b/commands/docs/dfr_as.md @@ -2,7 +2,7 @@ title: dfr as categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates an alias expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr as` for [expression](/commands/categories/expression.md) +
Creates an alias expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr as {flags} (Alias name)``` diff --git a/commands/docs/dfr_cache.md b/commands/docs/dfr_cache.md index a0db9e32625..60cfd2b752e 100644 --- a/commands/docs/dfr_cache.md +++ b/commands/docs/dfr_cache.md @@ -2,7 +2,7 @@ title: dfr cache categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Caches operations in a new LazyFrame. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr cache` for [lazyframe](/commands/categories/lazyframe.md) +
Caches operations in a new LazyFrame.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr cache {flags} ``` diff --git a/commands/docs/dfr_cast.md b/commands/docs/dfr_cast.md index 2e220010684..58ccaba0282 100644 --- a/commands/docs/dfr_cast.md +++ b/commands/docs/dfr_cast.md @@ -2,7 +2,7 @@ title: dfr cast categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Cast a column to a different dtype. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr cast` for [dataframe](/commands/categories/dataframe.md) +
Cast a column to a different dtype.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr cast {flags} (dtype) (column)``` diff --git a/commands/docs/dfr_col.md b/commands/docs/dfr_col.md index 7c47773a307..a49747d7e1f 100644 --- a/commands/docs/dfr_col.md +++ b/commands/docs/dfr_col.md @@ -2,7 +2,7 @@ title: dfr col categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a named column expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr col` for [expression](/commands/categories/expression.md) +
Creates a named column expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr col {flags} (column name)``` diff --git a/commands/docs/dfr_collect.md b/commands/docs/dfr_collect.md index 85b6d7f09ca..d14fea4514d 100644 --- a/commands/docs/dfr_collect.md +++ b/commands/docs/dfr_collect.md @@ -2,7 +2,7 @@ title: dfr collect categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr collect` for [lazyframe](/commands/categories/lazyframe.md) +
Collect lazy dataframe into eager dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr collect {flags} ``` diff --git a/commands/docs/dfr_columns.md b/commands/docs/dfr_columns.md index 54aed04888c..2e6e3683bbe 100644 --- a/commands/docs/dfr_columns.md +++ b/commands/docs/dfr_columns.md @@ -2,7 +2,7 @@ title: dfr columns categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Show dataframe columns. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr columns` for [dataframe](/commands/categories/dataframe.md) +
Show dataframe columns.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr columns {flags} ``` diff --git a/commands/docs/dfr_concat-str.md b/commands/docs/dfr_concat-str.md index 2bf456800a7..5d80a6fbb9d 100644 --- a/commands/docs/dfr_concat-str.md +++ b/commands/docs/dfr_concat-str.md @@ -2,7 +2,7 @@ title: dfr concat-str categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a concat string expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr concat-str` for [expression](/commands/categories/expression.md) +
Creates a concat string expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr concat-str {flags} (separator) (concat expressions)``` diff --git a/commands/docs/dfr_concatenate.md b/commands/docs/dfr_concatenate.md index 1a74bce9415..51956487c3c 100644 --- a/commands/docs/dfr_concatenate.md +++ b/commands/docs/dfr_concatenate.md @@ -2,7 +2,7 @@ title: dfr concatenate categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Concatenates strings with other array. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr concatenate` for [dataframe](/commands/categories/dataframe.md) +
Concatenates strings with other array.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr concatenate {flags} (other)``` diff --git a/commands/docs/dfr_contains.md b/commands/docs/dfr_contains.md index d420b1f12eb..80ee37580ac 100644 --- a/commands/docs/dfr_contains.md +++ b/commands/docs/dfr_contains.md @@ -2,7 +2,7 @@ title: dfr contains categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr contains` for [dataframe](/commands/categories/dataframe.md) +
Checks if a pattern is contained in a string.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr contains {flags} (pattern)``` diff --git a/commands/docs/dfr_count-null.md b/commands/docs/dfr_count-null.md index 66287f4987e..5a0192dc8a2 100644 --- a/commands/docs/dfr_count-null.md +++ b/commands/docs/dfr_count-null.md @@ -2,7 +2,7 @@ title: dfr count-null categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Counts null values. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr count-null` for [dataframe](/commands/categories/dataframe.md) +
Counts null values.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr count-null {flags} ``` diff --git a/commands/docs/dfr_count.md b/commands/docs/dfr_count.md index 166e4ea0f6a..00a30ec9623 100644 --- a/commands/docs/dfr_count.md +++ b/commands/docs/dfr_count.md @@ -2,7 +2,7 @@ title: dfr count categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a count expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr count` for [expression](/commands/categories/expression.md) +
Creates a count expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr count {flags} ``` diff --git a/commands/docs/dfr_cumulative.md b/commands/docs/dfr_cumulative.md index 22a00024376..ee0dd441d56 100644 --- a/commands/docs/dfr_cumulative.md +++ b/commands/docs/dfr_cumulative.md @@ -2,7 +2,7 @@ title: dfr cumulative categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Cumulative calculation for a series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr cumulative` for [dataframe](/commands/categories/dataframe.md) +
Cumulative calculation for a series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr cumulative {flags} (type)``` diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md index 82b70d32028..265eecd7a1a 100644 --- a/commands/docs/dfr_datepart.md +++ b/commands/docs/dfr_datepart.md @@ -2,7 +2,7 @@ title: dfr datepart categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr datepart` for [expression](/commands/categories/expression.md) +
Creates an expression for capturing the specified datepart in a column.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr datepart {flags} (Datepart name)``` @@ -57,10 +57,10 @@ Creates an expression to capture multiple date parts (dfr col datetime | dfr datepart minute | dfr as datetime_minute ), (dfr col datetime | dfr datepart second | dfr as datetime_second ), (dfr col datetime | dfr datepart nanosecond | dfr as datetime_ns ) ] -╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ -├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤ -│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ -╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯ +╭───────┬─────────────────┬──────────────────┬───────────────────┬─────────────────┬──────────────────┬────────────────────┬────────────────────┬────────────────╮ +│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ +├───────┼─────────────────┼──────────────────┼───────────────────┼─────────────────┼──────────────────┼────────────────────┼────────────────────┼────────────────┤ +│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ +╰───────┴─────────────────┴──────────────────┴───────────────────┴─────────────────┴──────────────────┴────────────────────┴────────────────────┴────────────────╯ ``` diff --git a/commands/docs/dfr_drop-duplicates.md b/commands/docs/dfr_drop-duplicates.md index 3c1dd0cc487..1aca9a2f454 100644 --- a/commands/docs/dfr_drop-duplicates.md +++ b/commands/docs/dfr_drop-duplicates.md @@ -2,7 +2,7 @@ title: dfr drop-duplicates categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Drops duplicate values in dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr drop-duplicates` for [dataframe](/commands/categories/dataframe.md) +
Drops duplicate values in dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr drop-duplicates {flags} (subset)``` diff --git a/commands/docs/dfr_drop-nulls.md b/commands/docs/dfr_drop-nulls.md index 637fb63a144..afbda181a48 100644 --- a/commands/docs/dfr_drop-nulls.md +++ b/commands/docs/dfr_drop-nulls.md @@ -2,7 +2,7 @@ title: dfr drop-nulls categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Drops null values in dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr drop-nulls` for [dataframe](/commands/categories/dataframe.md) +
Drops null values in dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr drop-nulls {flags} (subset)``` diff --git a/commands/docs/dfr_drop.md b/commands/docs/dfr_drop.md index 9feac569957..7789ecae762 100644 --- a/commands/docs/dfr_drop.md +++ b/commands/docs/dfr_drop.md @@ -2,7 +2,7 @@ title: dfr drop categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr drop` for [dataframe](/commands/categories/dataframe.md) +
Creates a new dataframe by dropping the selected columns.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr drop {flags} ...rest``` diff --git a/commands/docs/dfr_dtypes.md b/commands/docs/dfr_dtypes.md index 5cfaa0d55dc..9bf6da6c444 100644 --- a/commands/docs/dfr_dtypes.md +++ b/commands/docs/dfr_dtypes.md @@ -2,7 +2,7 @@ title: dfr dtypes categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Show dataframe data types. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr dtypes` for [dataframe](/commands/categories/dataframe.md) +
Show dataframe data types.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr dtypes {flags} ``` diff --git a/commands/docs/dfr_dummies.md b/commands/docs/dfr_dummies.md index 91fbb80ddfc..75c63ea9fa2 100644 --- a/commands/docs/dfr_dummies.md +++ b/commands/docs/dfr_dummies.md @@ -2,7 +2,7 @@ title: dfr dummies categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates a new dataframe with dummy variables. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr dummies` for [dataframe](/commands/categories/dataframe.md) +
Creates a new dataframe with dummy variables.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr dummies {flags} ``` diff --git a/commands/docs/dfr_explode.md b/commands/docs/dfr_explode.md index 57fddc09295..7a2c5fadfc7 100644 --- a/commands/docs/dfr_explode.md +++ b/commands/docs/dfr_explode.md @@ -2,7 +2,7 @@ title: dfr explode categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr explode` for [lazyframe](/commands/categories/lazyframe.md) +
Explodes a dataframe or creates a explode expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr explode {flags} ...rest``` diff --git a/commands/docs/dfr_expr-not.md b/commands/docs/dfr_expr-not.md index 9cb1f9db435..e869eb609e6 100644 --- a/commands/docs/dfr_expr-not.md +++ b/commands/docs/dfr_expr-not.md @@ -2,7 +2,7 @@ title: dfr expr-not categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a not expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr expr-not` for [expression](/commands/categories/expression.md) +
Creates a not expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr expr-not {flags} ``` diff --git a/commands/docs/dfr_fetch.md b/commands/docs/dfr_fetch.md index 46e44783d40..4ea30cf045b 100644 --- a/commands/docs/dfr_fetch.md +++ b/commands/docs/dfr_fetch.md @@ -2,7 +2,7 @@ title: dfr fetch categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Collects the lazyframe to the selected rows. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr fetch` for [lazyframe](/commands/categories/lazyframe.md) +
Collects the lazyframe to the selected rows.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr fetch {flags} (rows)``` diff --git a/commands/docs/dfr_fill-nan.md b/commands/docs/dfr_fill-nan.md index 90a11ae7e3b..726cc1d1f9a 100644 --- a/commands/docs/dfr_fill-nan.md +++ b/commands/docs/dfr_fill-nan.md @@ -2,7 +2,7 @@ title: dfr fill-nan categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Replaces NaN values with the given expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr fill-nan` for [lazyframe](/commands/categories/lazyframe.md) +
Replaces NaN values with the given expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr fill-nan {flags} (fill)``` diff --git a/commands/docs/dfr_fill-null.md b/commands/docs/dfr_fill-null.md index 8e09e582378..0bbd5bac873 100644 --- a/commands/docs/dfr_fill-null.md +++ b/commands/docs/dfr_fill-null.md @@ -2,7 +2,7 @@ title: dfr fill-null categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Replaces NULL values with the given expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr fill-null` for [lazyframe](/commands/categories/lazyframe.md) +
Replaces NULL values with the given expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr fill-null {flags} (fill)``` diff --git a/commands/docs/dfr_filter-with.md b/commands/docs/dfr_filter-with.md index 19298490459..376e346895c 100644 --- a/commands/docs/dfr_filter-with.md +++ b/commands/docs/dfr_filter-with.md @@ -2,7 +2,7 @@ title: dfr filter-with categories: | dataframe or lazyframe -version: 0.91.0 +version: 0.92.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe or lazyframe - -
{{ $frontmatter.dataframe_or_lazyframe }}
+# `dfr filter-with` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) +
Filters dataframe using a mask or expression as reference.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr filter-with {flags} (mask or expression)``` diff --git a/commands/docs/dfr_filter.md b/commands/docs/dfr_filter.md index d23ea6e2fab..1771f21e04f 100644 --- a/commands/docs/dfr_filter.md +++ b/commands/docs/dfr_filter.md @@ -2,7 +2,7 @@ title: dfr filter categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Filter dataframe based in expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr filter` for [lazyframe](/commands/categories/lazyframe.md) +
Filter dataframe based in expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr filter {flags} (filter expression)``` diff --git a/commands/docs/dfr_first.md b/commands/docs/dfr_first.md index e01292fc38f..8a32cee5ff8 100644 --- a/commands/docs/dfr_first.md +++ b/commands/docs/dfr_first.md @@ -2,7 +2,7 @@ title: dfr first categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Show only the first number of rows or create a first expression usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr first` for [dataframe](/commands/categories/dataframe.md) +
Show only the first number of rows or create a first expression
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr first {flags} (rows)``` diff --git a/commands/docs/dfr_flatten.md b/commands/docs/dfr_flatten.md index ea2371e8552..749bcb23ded 100644 --- a/commands/docs/dfr_flatten.md +++ b/commands/docs/dfr_flatten.md @@ -2,7 +2,7 @@ title: dfr flatten categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | An alias for dfr explode. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr flatten` for [lazyframe](/commands/categories/lazyframe.md) +
An alias for dfr explode.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr flatten {flags} ...rest``` diff --git a/commands/docs/dfr_get-day.md b/commands/docs/dfr_get-day.md index 8e8ff6f7afa..d42a70ca0b2 100644 --- a/commands/docs/dfr_get-day.md +++ b/commands/docs/dfr_get-day.md @@ -2,7 +2,7 @@ title: dfr get-day categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets day from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-day` for [dataframe](/commands/categories/dataframe.md) +
Gets day from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-day {flags} ``` diff --git a/commands/docs/dfr_get-hour.md b/commands/docs/dfr_get-hour.md index 7a8585f3c57..5aff596a6f9 100644 --- a/commands/docs/dfr_get-hour.md +++ b/commands/docs/dfr_get-hour.md @@ -2,7 +2,7 @@ title: dfr get-hour categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets hour from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-hour` for [dataframe](/commands/categories/dataframe.md) +
Gets hour from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-hour {flags} ``` diff --git a/commands/docs/dfr_get-minute.md b/commands/docs/dfr_get-minute.md index 2e0974d10a4..51fec609242 100644 --- a/commands/docs/dfr_get-minute.md +++ b/commands/docs/dfr_get-minute.md @@ -2,7 +2,7 @@ title: dfr get-minute categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets minute from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-minute` for [dataframe](/commands/categories/dataframe.md) +
Gets minute from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-minute {flags} ``` diff --git a/commands/docs/dfr_get-month.md b/commands/docs/dfr_get-month.md index 344bf627a6e..04a28218bd7 100644 --- a/commands/docs/dfr_get-month.md +++ b/commands/docs/dfr_get-month.md @@ -2,7 +2,7 @@ title: dfr get-month categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets month from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-month` for [dataframe](/commands/categories/dataframe.md) +
Gets month from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-month {flags} ``` diff --git a/commands/docs/dfr_get-nanosecond.md b/commands/docs/dfr_get-nanosecond.md index 416a8674556..edd4ca9c265 100644 --- a/commands/docs/dfr_get-nanosecond.md +++ b/commands/docs/dfr_get-nanosecond.md @@ -2,7 +2,7 @@ title: dfr get-nanosecond categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets nanosecond from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-nanosecond` for [dataframe](/commands/categories/dataframe.md) +
Gets nanosecond from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-nanosecond {flags} ``` diff --git a/commands/docs/dfr_get-ordinal.md b/commands/docs/dfr_get-ordinal.md index 2f9023da080..72ce9d5620c 100644 --- a/commands/docs/dfr_get-ordinal.md +++ b/commands/docs/dfr_get-ordinal.md @@ -2,7 +2,7 @@ title: dfr get-ordinal categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets ordinal from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-ordinal` for [dataframe](/commands/categories/dataframe.md) +
Gets ordinal from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-ordinal {flags} ``` diff --git a/commands/docs/dfr_get-second.md b/commands/docs/dfr_get-second.md index c3cd784771b..5acf1d8710a 100644 --- a/commands/docs/dfr_get-second.md +++ b/commands/docs/dfr_get-second.md @@ -2,7 +2,7 @@ title: dfr get-second categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets second from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-second` for [dataframe](/commands/categories/dataframe.md) +
Gets second from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-second {flags} ``` diff --git a/commands/docs/dfr_get-week.md b/commands/docs/dfr_get-week.md index 24a72569755..c132c4efac5 100644 --- a/commands/docs/dfr_get-week.md +++ b/commands/docs/dfr_get-week.md @@ -2,7 +2,7 @@ title: dfr get-week categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets week from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-week` for [dataframe](/commands/categories/dataframe.md) +
Gets week from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-week {flags} ``` diff --git a/commands/docs/dfr_get-weekday.md b/commands/docs/dfr_get-weekday.md index f482087142d..3d6586cf7e3 100644 --- a/commands/docs/dfr_get-weekday.md +++ b/commands/docs/dfr_get-weekday.md @@ -2,7 +2,7 @@ title: dfr get-weekday categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets weekday from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-weekday` for [dataframe](/commands/categories/dataframe.md) +
Gets weekday from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-weekday {flags} ``` diff --git a/commands/docs/dfr_get-year.md b/commands/docs/dfr_get-year.md index 7d36836be2c..3d7f0edfe5d 100644 --- a/commands/docs/dfr_get-year.md +++ b/commands/docs/dfr_get-year.md @@ -2,7 +2,7 @@ title: dfr get-year categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Gets year from date. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get-year` for [dataframe](/commands/categories/dataframe.md) +
Gets year from date.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get-year {flags} ``` diff --git a/commands/docs/dfr_get.md b/commands/docs/dfr_get.md index 12809de1557..542238d43c8 100644 --- a/commands/docs/dfr_get.md +++ b/commands/docs/dfr_get.md @@ -2,7 +2,7 @@ title: dfr get categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates dataframe with the selected columns. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr get` for [dataframe](/commands/categories/dataframe.md) +
Creates dataframe with the selected columns.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr get {flags} ...rest``` diff --git a/commands/docs/dfr_group-by.md b/commands/docs/dfr_group-by.md index 4ae4847fba7..fc5b6de9e4d 100644 --- a/commands/docs/dfr_group-by.md +++ b/commands/docs/dfr_group-by.md @@ -2,7 +2,7 @@ title: dfr group-by categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr group-by` for [lazyframe](/commands/categories/lazyframe.md) +
Creates a group-by object that can be used for other aggregations.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr group-by {flags} ...rest``` diff --git a/commands/docs/dfr_implode.md b/commands/docs/dfr_implode.md index 83db911a81a..4e56b78fe39 100644 --- a/commands/docs/dfr_implode.md +++ b/commands/docs/dfr_implode.md @@ -2,7 +2,7 @@ title: dfr implode categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Aggregates a group to a Series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr implode` for [expression](/commands/categories/expression.md) +
Aggregates a group to a Series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr implode {flags} ``` diff --git a/commands/docs/dfr_into-df.md b/commands/docs/dfr_into-df.md index 5ca83a54f1a..daf33616b83 100644 --- a/commands/docs/dfr_into-df.md +++ b/commands/docs/dfr_into-df.md @@ -2,7 +2,7 @@ title: dfr into-df categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Converts a list, table or record into a dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr into-df` for [dataframe](/commands/categories/dataframe.md) +
Converts a list, table or record into a dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr into-df {flags} ``` diff --git a/commands/docs/dfr_into-lazy.md b/commands/docs/dfr_into-lazy.md index bdefcbdb836..80c698b90d2 100644 --- a/commands/docs/dfr_into-lazy.md +++ b/commands/docs/dfr_into-lazy.md @@ -2,7 +2,7 @@ title: dfr into-lazy categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr into-lazy` for [lazyframe](/commands/categories/lazyframe.md) +
Converts a dataframe into a lazy dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr into-lazy {flags} ``` diff --git a/commands/docs/dfr_into-nu.md b/commands/docs/dfr_into-nu.md index dc57ca86cea..b2e1e5e9b2f 100644 --- a/commands/docs/dfr_into-nu.md +++ b/commands/docs/dfr_into-nu.md @@ -2,7 +2,7 @@ title: dfr into-nu categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Converts a dataframe or an expression into into nushell value for access and exploration. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr into-nu` for [dataframe](/commands/categories/dataframe.md) +
Converts a dataframe or an expression into into nushell value for access and exploration.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr into-nu {flags} ``` diff --git a/commands/docs/dfr_is-duplicated.md b/commands/docs/dfr_is-duplicated.md index 0438dde89d6..1e4490f542b 100644 --- a/commands/docs/dfr_is-duplicated.md +++ b/commands/docs/dfr_is-duplicated.md @@ -2,7 +2,7 @@ title: dfr is-duplicated categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates mask indicating duplicated values. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr is-duplicated` for [dataframe](/commands/categories/dataframe.md) +
Creates mask indicating duplicated values.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr is-duplicated {flags} ``` diff --git a/commands/docs/dfr_is-in.md b/commands/docs/dfr_is-in.md index a8818411794..897f0d0ea9d 100644 --- a/commands/docs/dfr_is-in.md +++ b/commands/docs/dfr_is-in.md @@ -2,7 +2,7 @@ title: dfr is-in categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates an is-in expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr is-in` for [expression](/commands/categories/expression.md) +
Creates an is-in expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr is-in {flags} (list)``` diff --git a/commands/docs/dfr_is-not-null.md b/commands/docs/dfr_is-not-null.md index d71294595df..cafdeaaaba1 100644 --- a/commands/docs/dfr_is-not-null.md +++ b/commands/docs/dfr_is-not-null.md @@ -2,7 +2,7 @@ title: dfr is-not-null categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates mask where value is not null. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr is-not-null` for [dataframe](/commands/categories/dataframe.md) +
Creates mask where value is not null.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr is-not-null {flags} ``` diff --git a/commands/docs/dfr_is-null.md b/commands/docs/dfr_is-null.md index b63776b1a2f..cf29d8d3317 100644 --- a/commands/docs/dfr_is-null.md +++ b/commands/docs/dfr_is-null.md @@ -2,7 +2,7 @@ title: dfr is-null categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates mask where value is null. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr is-null` for [dataframe](/commands/categories/dataframe.md) +
Creates mask where value is null.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr is-null {flags} ``` diff --git a/commands/docs/dfr_is-unique.md b/commands/docs/dfr_is-unique.md index 45413eb0a35..4ea062036e7 100644 --- a/commands/docs/dfr_is-unique.md +++ b/commands/docs/dfr_is-unique.md @@ -2,7 +2,7 @@ title: dfr is-unique categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates mask indicating unique values. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr is-unique` for [dataframe](/commands/categories/dataframe.md) +
Creates mask indicating unique values.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr is-unique {flags} ``` diff --git a/commands/docs/dfr_join.md b/commands/docs/dfr_join.md index 88314a1a0f0..d237c375013 100644 --- a/commands/docs/dfr_join.md +++ b/commands/docs/dfr_join.md @@ -2,7 +2,7 @@ title: dfr join categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr join` for [lazyframe](/commands/categories/lazyframe.md) +
Joins a lazy frame with other lazy frame.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr join {flags} (other) (left_on) (right_on)``` diff --git a/commands/docs/dfr_last.md b/commands/docs/dfr_last.md index b690e03ec55..c9fd3983ba8 100644 --- a/commands/docs/dfr_last.md +++ b/commands/docs/dfr_last.md @@ -2,7 +2,7 @@ title: dfr last categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr last` for [dataframe](/commands/categories/dataframe.md) +
Creates new dataframe with tail rows or creates a last expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr last {flags} (rows)``` diff --git a/commands/docs/dfr_lit.md b/commands/docs/dfr_lit.md index 1448c789401..76e32f3ee5d 100644 --- a/commands/docs/dfr_lit.md +++ b/commands/docs/dfr_lit.md @@ -2,7 +2,7 @@ title: dfr lit categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a literal expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr lit` for [expression](/commands/categories/expression.md) +
Creates a literal expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr lit {flags} (literal)``` diff --git a/commands/docs/dfr_lowercase.md b/commands/docs/dfr_lowercase.md index 9bd3a2a23e2..9a3ac289263 100644 --- a/commands/docs/dfr_lowercase.md +++ b/commands/docs/dfr_lowercase.md @@ -2,7 +2,7 @@ title: dfr lowercase categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Lowercase the strings in the column. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr lowercase` for [dataframe](/commands/categories/dataframe.md) +
Lowercase the strings in the column.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr lowercase {flags} ``` diff --git a/commands/docs/dfr_ls.md b/commands/docs/dfr_ls.md index 54b82cb4eca..4bcb37bcdea 100644 --- a/commands/docs/dfr_ls.md +++ b/commands/docs/dfr_ls.md @@ -2,7 +2,7 @@ title: dfr ls categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Lists stored dataframes. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr ls` for [dataframe](/commands/categories/dataframe.md) +
Lists stored dataframes.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr ls {flags} ``` diff --git a/commands/docs/dfr_max.md b/commands/docs/dfr_max.md index 807fc1c6a14..3308ab125ac 100644 --- a/commands/docs/dfr_max.md +++ b/commands/docs/dfr_max.md @@ -2,7 +2,7 @@ title: dfr max categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a max expression or aggregates columns to their max value. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr max` for [expression](/commands/categories/expression.md) +
Creates a max expression or aggregates columns to their max value.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr max {flags} ``` diff --git a/commands/docs/dfr_mean.md b/commands/docs/dfr_mean.md index fdba96b99e4..ab4f3fdae13 100644 --- a/commands/docs/dfr_mean.md +++ b/commands/docs/dfr_mean.md @@ -2,7 +2,7 @@ title: dfr mean categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr mean` for [expression](/commands/categories/expression.md) +
Creates a mean expression for an aggregation or aggregates columns to their mean value.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr mean {flags} ``` diff --git a/commands/docs/dfr_median.md b/commands/docs/dfr_median.md index ab86b27aae3..c40a4260b1b 100644 --- a/commands/docs/dfr_median.md +++ b/commands/docs/dfr_median.md @@ -2,7 +2,7 @@ title: dfr median categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Aggregates columns to their median value usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr median` for [lazyframe](/commands/categories/lazyframe.md) +
Aggregates columns to their median value
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr median {flags} ``` diff --git a/commands/docs/dfr_melt.md b/commands/docs/dfr_melt.md index 01ba7cf7506..ec8aa5f2211 100644 --- a/commands/docs/dfr_melt.md +++ b/commands/docs/dfr_melt.md @@ -2,7 +2,7 @@ title: dfr melt categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr melt` for [dataframe](/commands/categories/dataframe.md) +
Unpivot a DataFrame from wide to long format.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr melt {flags} ``` diff --git a/commands/docs/dfr_min.md b/commands/docs/dfr_min.md index ee592d32add..a8fddfbe5d2 100644 --- a/commands/docs/dfr_min.md +++ b/commands/docs/dfr_min.md @@ -2,7 +2,7 @@ title: dfr min categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a min expression or aggregates columns to their min value. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr min` for [expression](/commands/categories/expression.md) +
Creates a min expression or aggregates columns to their min value.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr min {flags} ``` diff --git a/commands/docs/dfr_n-unique.md b/commands/docs/dfr_n-unique.md index 8a41bcb8142..852cf33c61d 100644 --- a/commands/docs/dfr_n-unique.md +++ b/commands/docs/dfr_n-unique.md @@ -2,7 +2,7 @@ title: dfr n-unique categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Counts unique values. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr n-unique` for [dataframe](/commands/categories/dataframe.md) +
Counts unique values.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr n-unique {flags} ``` diff --git a/commands/docs/dfr_not.md b/commands/docs/dfr_not.md index bff7eee9291..4e858509cb5 100644 --- a/commands/docs/dfr_not.md +++ b/commands/docs/dfr_not.md @@ -2,7 +2,7 @@ title: dfr not categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Inverts boolean mask. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr not` for [dataframe](/commands/categories/dataframe.md) +
Inverts boolean mask.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr not {flags} ``` diff --git a/commands/docs/dfr_open.md b/commands/docs/dfr_open.md index 0f07b262111..1045b071746 100644 --- a/commands/docs/dfr_open.md +++ b/commands/docs/dfr_open.md @@ -2,7 +2,7 @@ title: dfr open categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr open` for [dataframe](/commands/categories/dataframe.md) +
Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr open {flags} (file)``` diff --git a/commands/docs/dfr_otherwise.md b/commands/docs/dfr_otherwise.md index 6da8fc25f5e..40a4d80ddc3 100644 --- a/commands/docs/dfr_otherwise.md +++ b/commands/docs/dfr_otherwise.md @@ -2,7 +2,7 @@ title: dfr otherwise categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Completes a when expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr otherwise` for [expression](/commands/categories/expression.md) +
Completes a when expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr otherwise {flags} (otherwise expression)``` diff --git a/commands/docs/dfr_quantile.md b/commands/docs/dfr_quantile.md index 67ceaf2ea5b..61ac07f1a74 100644 --- a/commands/docs/dfr_quantile.md +++ b/commands/docs/dfr_quantile.md @@ -2,7 +2,7 @@ title: dfr quantile categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr quantile` for [lazyframe](/commands/categories/lazyframe.md) +
Aggregates the columns to the selected quantile.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr quantile {flags} (quantile)``` diff --git a/commands/docs/dfr_query.md b/commands/docs/dfr_query.md index 57f662a6f85..0495af52e63 100644 --- a/commands/docs/dfr_query.md +++ b/commands/docs/dfr_query.md @@ -2,7 +2,7 @@ title: dfr query categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr query` for [dataframe](/commands/categories/dataframe.md) +
Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr query {flags} (sql)``` diff --git a/commands/docs/dfr_rename.md b/commands/docs/dfr_rename.md index 110ea98d71d..a64674f49c5 100644 --- a/commands/docs/dfr_rename.md +++ b/commands/docs/dfr_rename.md @@ -2,7 +2,7 @@ title: dfr rename categories: | dataframe or lazyframe -version: 0.91.0 +version: 0.92.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe or lazyframe - -
{{ $frontmatter.dataframe_or_lazyframe }}
+# `dfr rename` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) +
Rename a dataframe column.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr rename {flags} (columns) (new names)``` diff --git a/commands/docs/dfr_replace-all.md b/commands/docs/dfr_replace-all.md index 90afc74e396..cb3244fb3be 100644 --- a/commands/docs/dfr_replace-all.md +++ b/commands/docs/dfr_replace-all.md @@ -2,7 +2,7 @@ title: dfr replace-all categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr replace-all` for [dataframe](/commands/categories/dataframe.md) +
Replace all (sub)strings by a regex pattern.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr replace-all {flags} ``` diff --git a/commands/docs/dfr_replace.md b/commands/docs/dfr_replace.md index 6655c1e7b9b..dba261d59de 100644 --- a/commands/docs/dfr_replace.md +++ b/commands/docs/dfr_replace.md @@ -2,7 +2,7 @@ title: dfr replace categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr replace` for [dataframe](/commands/categories/dataframe.md) +
Replace the leftmost (sub)string by a regex pattern.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr replace {flags} ``` diff --git a/commands/docs/dfr_reverse.md b/commands/docs/dfr_reverse.md index 9bc4aa39997..629ec8fdecd 100644 --- a/commands/docs/dfr_reverse.md +++ b/commands/docs/dfr_reverse.md @@ -2,7 +2,7 @@ title: dfr reverse categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Reverses the LazyFrame usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr reverse` for [lazyframe](/commands/categories/lazyframe.md) +
Reverses the LazyFrame
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr reverse {flags} ``` diff --git a/commands/docs/dfr_rolling.md b/commands/docs/dfr_rolling.md index 334c1776f54..87afccfcc18 100644 --- a/commands/docs/dfr_rolling.md +++ b/commands/docs/dfr_rolling.md @@ -2,7 +2,7 @@ title: dfr rolling categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Rolling calculation for a series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr rolling` for [dataframe](/commands/categories/dataframe.md) +
Rolling calculation for a series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr rolling {flags} (type) (window)``` diff --git a/commands/docs/dfr_sample.md b/commands/docs/dfr_sample.md index e3bc1df511c..0ae2c967009 100644 --- a/commands/docs/dfr_sample.md +++ b/commands/docs/dfr_sample.md @@ -2,7 +2,7 @@ title: dfr sample categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Create sample dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr sample` for [dataframe](/commands/categories/dataframe.md) +
Create sample dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr sample {flags} ``` diff --git a/commands/docs/dfr_schema.md b/commands/docs/dfr_schema.md index ecadd808e77..307f99f05c7 100644 --- a/commands/docs/dfr_schema.md +++ b/commands/docs/dfr_schema.md @@ -2,7 +2,7 @@ title: dfr schema categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Show schema for a dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr schema` for [dataframe](/commands/categories/dataframe.md) +
Show schema for a dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr schema {flags} ``` diff --git a/commands/docs/dfr_select.md b/commands/docs/dfr_select.md index 95704aa1f6a..a50fdfbffbe 100644 --- a/commands/docs/dfr_select.md +++ b/commands/docs/dfr_select.md @@ -2,7 +2,7 @@ title: dfr select categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Selects columns from lazyframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr select` for [lazyframe](/commands/categories/lazyframe.md) +
Selects columns from lazyframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr select {flags} ...rest``` diff --git a/commands/docs/dfr_set-with-idx.md b/commands/docs/dfr_set-with-idx.md index 33cbb52cff7..62574d8c95e 100644 --- a/commands/docs/dfr_set-with-idx.md +++ b/commands/docs/dfr_set-with-idx.md @@ -2,7 +2,7 @@ title: dfr set-with-idx categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Sets value in the given index. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr set-with-idx` for [dataframe](/commands/categories/dataframe.md) +
Sets value in the given index.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr set-with-idx {flags} (value)``` diff --git a/commands/docs/dfr_set.md b/commands/docs/dfr_set.md index 7faae6d4316..6a3dc9c03b6 100644 --- a/commands/docs/dfr_set.md +++ b/commands/docs/dfr_set.md @@ -2,7 +2,7 @@ title: dfr set categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Sets value where given mask is true. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr set` for [dataframe](/commands/categories/dataframe.md) +
Sets value where given mask is true.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr set {flags} (value)``` diff --git a/commands/docs/dfr_shape.md b/commands/docs/dfr_shape.md index 51543261b75..dd84670c177 100644 --- a/commands/docs/dfr_shape.md +++ b/commands/docs/dfr_shape.md @@ -2,7 +2,7 @@ title: dfr shape categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Shows column and row size for a dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr shape` for [dataframe](/commands/categories/dataframe.md) +
Shows column and row size for a dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr shape {flags} ``` diff --git a/commands/docs/dfr_shift.md b/commands/docs/dfr_shift.md index 4064987ca91..d57ba2f59b2 100644 --- a/commands/docs/dfr_shift.md +++ b/commands/docs/dfr_shift.md @@ -2,7 +2,7 @@ title: dfr shift categories: | dataframe or lazyframe -version: 0.91.0 +version: 0.92.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe or lazyframe - -
{{ $frontmatter.dataframe_or_lazyframe }}
+# `dfr shift` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) +
Shifts the values by a given period.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr shift {flags} (period)``` diff --git a/commands/docs/dfr_slice.md b/commands/docs/dfr_slice.md index 43a079189e5..5b81dcc8276 100644 --- a/commands/docs/dfr_slice.md +++ b/commands/docs/dfr_slice.md @@ -2,7 +2,7 @@ title: dfr slice categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates new dataframe from a slice of rows. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr slice` for [dataframe](/commands/categories/dataframe.md) +
Creates new dataframe from a slice of rows.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr slice {flags} (offset) (size)``` diff --git a/commands/docs/dfr_sort-by.md b/commands/docs/dfr_sort-by.md index 82ae0e75f54..c3f6fe5b4a1 100644 --- a/commands/docs/dfr_sort-by.md +++ b/commands/docs/dfr_sort-by.md @@ -2,7 +2,7 @@ title: dfr sort-by categories: | lazyframe -version: 0.91.0 +version: 0.92.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for lazyframe - -
{{ $frontmatter.lazyframe }}
+# `dfr sort-by` for [lazyframe](/commands/categories/lazyframe.md) +
Sorts a lazy dataframe based on expression(s).
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr sort-by {flags} ...rest``` diff --git a/commands/docs/dfr_std.md b/commands/docs/dfr_std.md index f934a2559b9..bc4c5a3ecb0 100644 --- a/commands/docs/dfr_std.md +++ b/commands/docs/dfr_std.md @@ -2,7 +2,7 @@ title: dfr std categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr std` for [expression](/commands/categories/expression.md) +
Creates a std expression for an aggregation of std value from columns in a dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr std {flags} ``` diff --git a/commands/docs/dfr_str-lengths.md b/commands/docs/dfr_str-lengths.md index 908b2cd8d04..cfcbac76220 100644 --- a/commands/docs/dfr_str-lengths.md +++ b/commands/docs/dfr_str-lengths.md @@ -2,7 +2,7 @@ title: dfr str-lengths categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Get lengths of all strings. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr str-lengths` for [dataframe](/commands/categories/dataframe.md) +
Get lengths of all strings.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr str-lengths {flags} ``` diff --git a/commands/docs/dfr_str-slice.md b/commands/docs/dfr_str-slice.md index 4ae197f84c3..534a222b4f5 100644 --- a/commands/docs/dfr_str-slice.md +++ b/commands/docs/dfr_str-slice.md @@ -2,7 +2,7 @@ title: dfr str-slice categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr str-slice` for [dataframe](/commands/categories/dataframe.md) +
Slices the string from the start position until the selected length.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr str-slice {flags} (start)``` diff --git a/commands/docs/dfr_strftime.md b/commands/docs/dfr_strftime.md index 159e9816517..44ebd444860 100644 --- a/commands/docs/dfr_strftime.md +++ b/commands/docs/dfr_strftime.md @@ -2,7 +2,7 @@ title: dfr strftime categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Formats date based on string rule. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr strftime` for [dataframe](/commands/categories/dataframe.md) +
Formats date based on string rule.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr strftime {flags} (fmt)``` diff --git a/commands/docs/dfr_sum.md b/commands/docs/dfr_sum.md index 794c03432b3..21ce0a0b7ff 100644 --- a/commands/docs/dfr_sum.md +++ b/commands/docs/dfr_sum.md @@ -2,7 +2,7 @@ title: dfr sum categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr sum` for [expression](/commands/categories/expression.md) +
Creates a sum expression for an aggregation or aggregates columns to their sum value.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr sum {flags} ``` diff --git a/commands/docs/dfr_summary.md b/commands/docs/dfr_summary.md index 1e34af2ec92..f9be747f372 100644 --- a/commands/docs/dfr_summary.md +++ b/commands/docs/dfr_summary.md @@ -2,7 +2,7 @@ title: dfr summary categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr summary` for [dataframe](/commands/categories/dataframe.md) +
For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr summary {flags} ``` diff --git a/commands/docs/dfr_take.md b/commands/docs/dfr_take.md index 50811d98004..884901e1bc2 100644 --- a/commands/docs/dfr_take.md +++ b/commands/docs/dfr_take.md @@ -2,7 +2,7 @@ title: dfr take categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Creates new dataframe using the given indices. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr take` for [dataframe](/commands/categories/dataframe.md) +
Creates new dataframe using the given indices.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr take {flags} (indices)``` diff --git a/commands/docs/dfr_to-arrow.md b/commands/docs/dfr_to-arrow.md index 43e5ae9e532..4839ba6caf3 100644 --- a/commands/docs/dfr_to-arrow.md +++ b/commands/docs/dfr_to-arrow.md @@ -2,7 +2,7 @@ title: dfr to-arrow categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Saves dataframe to arrow file. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr to-arrow` for [dataframe](/commands/categories/dataframe.md) +
Saves dataframe to arrow file.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr to-arrow {flags} (file)``` diff --git a/commands/docs/dfr_to-avro.md b/commands/docs/dfr_to-avro.md index 9184d0c06f7..5578c5ad91b 100644 --- a/commands/docs/dfr_to-avro.md +++ b/commands/docs/dfr_to-avro.md @@ -2,7 +2,7 @@ title: dfr to-avro categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Saves dataframe to avro file. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr to-avro` for [dataframe](/commands/categories/dataframe.md) +
Saves dataframe to avro file.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr to-avro {flags} (file)``` diff --git a/commands/docs/dfr_to-csv.md b/commands/docs/dfr_to-csv.md index 81047f8ee2a..0a948a6ea81 100644 --- a/commands/docs/dfr_to-csv.md +++ b/commands/docs/dfr_to-csv.md @@ -2,7 +2,7 @@ title: dfr to-csv categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Saves dataframe to CSV file. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr to-csv` for [dataframe](/commands/categories/dataframe.md) +
Saves dataframe to CSV file.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr to-csv {flags} (file)``` diff --git a/commands/docs/dfr_to-jsonl.md b/commands/docs/dfr_to-jsonl.md index 43f4de388e2..a61d9b480dc 100644 --- a/commands/docs/dfr_to-jsonl.md +++ b/commands/docs/dfr_to-jsonl.md @@ -2,7 +2,7 @@ title: dfr to-jsonl categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Saves dataframe to a JSON lines file. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr to-jsonl` for [dataframe](/commands/categories/dataframe.md) +
Saves dataframe to a JSON lines file.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr to-jsonl {flags} (file)``` diff --git a/commands/docs/dfr_to-parquet.md b/commands/docs/dfr_to-parquet.md index cc8b44cc415..e84748e6695 100644 --- a/commands/docs/dfr_to-parquet.md +++ b/commands/docs/dfr_to-parquet.md @@ -2,7 +2,7 @@ title: dfr to-parquet categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Saves dataframe to parquet file. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr to-parquet` for [dataframe](/commands/categories/dataframe.md) +
Saves dataframe to parquet file.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr to-parquet {flags} (file)``` diff --git a/commands/docs/dfr_unique.md b/commands/docs/dfr_unique.md index 4385e0a6c36..c180b1b4c7e 100644 --- a/commands/docs/dfr_unique.md +++ b/commands/docs/dfr_unique.md @@ -2,7 +2,7 @@ title: dfr unique categories: | dataframe or lazyframe -version: 0.91.0 +version: 0.92.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe or lazyframe - -
{{ $frontmatter.dataframe_or_lazyframe }}
+# `dfr unique` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) +
Returns unique values from a dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr unique {flags} ``` diff --git a/commands/docs/dfr_uppercase.md b/commands/docs/dfr_uppercase.md index 915c13bc92b..a78422b5d6c 100644 --- a/commands/docs/dfr_uppercase.md +++ b/commands/docs/dfr_uppercase.md @@ -2,7 +2,7 @@ title: dfr uppercase categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Uppercase the strings in the column. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr uppercase` for [dataframe](/commands/categories/dataframe.md) +
Uppercase the strings in the column.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr uppercase {flags} ``` diff --git a/commands/docs/dfr_value-counts.md b/commands/docs/dfr_value-counts.md index 97abce0dc17..ee135f4d993 100644 --- a/commands/docs/dfr_value-counts.md +++ b/commands/docs/dfr_value-counts.md @@ -2,7 +2,7 @@ title: dfr value-counts categories: | dataframe -version: 0.91.0 +version: 0.92.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe - -
{{ $frontmatter.dataframe }}
+# `dfr value-counts` for [dataframe](/commands/categories/dataframe.md) +
Returns a dataframe with the counts for unique values in series.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr value-counts {flags} ``` diff --git a/commands/docs/dfr_var.md b/commands/docs/dfr_var.md index ce4601cd15f..c07f82a2f92 100644 --- a/commands/docs/dfr_var.md +++ b/commands/docs/dfr_var.md @@ -2,7 +2,7 @@ title: dfr var categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Create a var expression for an aggregation. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr var` for [expression](/commands/categories/expression.md) +
Create a var expression for an aggregation.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr var {flags} ``` diff --git a/commands/docs/dfr_when.md b/commands/docs/dfr_when.md index 6a26c31cfe7..36f9f21bf73 100644 --- a/commands/docs/dfr_when.md +++ b/commands/docs/dfr_when.md @@ -2,7 +2,7 @@ title: dfr when categories: | expression -version: 0.91.0 +version: 0.92.0 expression: | Creates and modifies a when expression. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for expression - -
{{ $frontmatter.expression }}
+# `dfr when` for [expression](/commands/categories/expression.md) +
Creates and modifies a when expression.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr when {flags} (when expression) (then expression)``` diff --git a/commands/docs/dfr_with-column.md b/commands/docs/dfr_with-column.md index 833d865098a..1e48bc1e716 100644 --- a/commands/docs/dfr_with-column.md +++ b/commands/docs/dfr_with-column.md @@ -2,7 +2,7 @@ title: dfr with-column categories: | dataframe or lazyframe -version: 0.91.0 +version: 0.92.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | @@ -11,14 +11,14 @@ feature: dataframe --- -# {{ $frontmatter.title }} for dataframe or lazyframe - -
{{ $frontmatter.dataframe_or_lazyframe }}
+# `dfr with-column` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) +
Adds a series to the dataframe.
::: warning Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag ::: + ## Signature ```> dfr with-column {flags} ...rest``` diff --git a/commands/docs/do.md b/commands/docs/do.md index a21dac12a6b..8f043073fd4 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.91.0 +version: 0.92.0 core: | Run a closure, providing it with the pipeline input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `do` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Run a closure, providing it with the pipeline input.
## Signature diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 98f538c40e8..0e6e35b6214 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `drop` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`.
## Signature diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index e74e2a72251..83d998fcf11 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `drop column` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`.
## Signature diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index 9d3cb103fa3..20249965e5b 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Drop the selected rows. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `drop nth` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Drop the selected rows.
## Signature diff --git a/commands/docs/du.md b/commands/docs/du.md index 20edc7e8169..56677f4903f 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Find disk usage sizes of specified items. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `du` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Find disk usage sizes of specified items.
## Signature diff --git a/commands/docs/each.md b/commands/docs/each.md index 961c8e555f8..51e9676daf8 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `each` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Run a closure on each row of the input list, creating a new list with the results.
## Signature diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 25526b0b75d..f2369b06e37 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,23 +2,19 @@ title: each while categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Run a block on each row of the input list until a null is found, then create a new list with the results. usage: | Run a block on each row of the input list until a null is found, then create a new list with the results. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `each while` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Run a block on each row of the input list until a null is found, then create a new list with the results.
- -::: warning - Command `each while` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> each while {flags} (closure)``` diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 4b4bbd97b57..2be145cd15a 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.91.0 +version: 0.92.0 core: | Returns its arguments, ignoring the piped-in value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `echo` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Returns its arguments, ignoring the piped-in value.
## Signature diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 940f9f440d4..738044d6939 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Encode a string into bytes. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `encode` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Encode a string into bytes.
## Signature diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 292042ff70b..90aeea5cbff 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.91.0 +version: 0.92.0 hash: | Encode a string or binary value using Base64. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for hash +# `encode base64` for [hash](/commands/categories/hash.md) -
{{ $frontmatter.hash }}
+
Encode a string or binary value using Base64.
## Signature diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 0010d3bfc73..8c8604ff9ba 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,23 +2,19 @@ title: encode hex categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Encode a binary value using hex. usage: | Encode a binary value using hex. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for formats +# `encode hex` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Encode a binary value using hex.
- -::: warning - Command `encode hex` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> encode hex {flags} ...rest``` diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 1d0088caac1..70379c3adee 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Enumerate the elements in a stream. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `enumerate` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Enumerate the elements in a stream.
## Signature diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 50542453ff1..86985fa10fc 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create an error. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `error make` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create an error.
## Signature @@ -39,7 +39,7 @@ feature: default Create a simple custom error ```nu > error make {msg: "my custom error message"} -{msg: my custom error message, debug: GenericError { error: "my custom error message", msg: "", span: None, help: None, inner: [] }, raw: GenericError { error: "my custom error message", msg: "", span: None, help: None, inner: [] }} + ``` Create a more complex custom error @@ -57,7 +57,7 @@ Create a more complex custom error } help: "A help string, suggesting a fix to the user" # optional } -{msg: my custom error message, debug: GenericError { error: "my custom error message", msg: "my custom label text", span: Some(Span { start: 123, end: 456 }), help: Some("A help string, suggesting a fix to the user"), inner: [] }, raw: GenericError { error: "my custom error message", msg: "my custom label text", span: Some(Span { start: 123, end: 456 }), help: Some("A help string, suggesting a fix to the user"), inner: [] }} + ``` Create a custom error for a custom command that shows the span of the argument diff --git a/commands/docs/every.md b/commands/docs/every.md index 1aa794d839d..b9b02012cf1 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Show (or skip) every n-th row, starting from the first one. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `every` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Show (or skip) every n-th row, starting from the first one.
## Signature diff --git a/commands/docs/exec.md b/commands/docs/exec.md index 45b189df3c6..5353c5a26ee 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.91.0 +version: 0.92.0 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `exec` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
Execute a command, replacing or exiting the current process, depending on platform.
## Signature diff --git a/commands/docs/exit.md b/commands/docs/exit.md index bc5784024cf..e36b4034a49 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.91.0 +version: 0.92.0 shells: | Exit Nu. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for shells +# `exit` for [shells](/commands/categories/shells.md) -
{{ $frontmatter.shells }}
+
Exit Nu.
## Signature diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 4787ba9ed78..c2f7b5cba0f 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Explain closure contents. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `explain` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Explain closure contents.
## Signature diff --git a/commands/docs/explore.md b/commands/docs/explore.md index e2f235b343f..5f6ca1e03d4 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.91.0 +version: 0.92.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for viewers +# `explore` for [viewers](/commands/categories/viewers.md) -
{{ $frontmatter.viewers }}
+
Explore acts as a table pager, just like `less` does for text.
## Signature diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index cc5b0d4ac18..6c87c3a74cc 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.91.0 +version: 0.92.0 env: | Run a block and preserve its environment in a current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `export-env` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Run a block and preserve its environment in a current scope.
## Signature diff --git a/commands/docs/export.md b/commands/docs/export.md index f53bddc37b7..008a3f4b86b 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.91.0 +version: 0.92.0 core: | Export definitions or environment variables from a module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Export definitions or environment variables from a module.
## Signature diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 4391951e82e..c30e7f9fe8b 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.91.0 +version: 0.92.0 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export alias` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Alias a command (with optional flags) to a new name and export it from a module.
## Signature diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index 17bf9a27003..25944520907 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.91.0 +version: 0.92.0 core: | Use parse-time constant from a module and export them from this module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export const` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Use parse-time constant from a module and export them from this module.
## Signature diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index 9eac0331505..29358f1b728 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.91.0 +version: 0.92.0 core: | Define a custom command and export it from a module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export def` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Define a custom command and export it from a module.
## Signature diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index 0d34b4902ad..b045718a0b6 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.91.0 +version: 0.92.0 core: | Define an extern and export it from a module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export extern` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Define an extern and export it from a module.
## Signature diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index be45ddf59e2..933b7886df1 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.91.0 +version: 0.92.0 core: | Export a custom module from a module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export module` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Export a custom module from a module.
## Signature diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 0ce7ceb1b18..6ac2589a048 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.91.0 +version: 0.92.0 core: | Use definitions from a module and export them from this module. usage: | @@ -11,18 +11,18 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `export use` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Use definitions from a module and export them from this module.
## Signature -```> export use {flags} (module) (members)``` +```> export use {flags} (module) ...rest``` ## Parameters - `module`: Module or module file. - - `members`: Which members of the module to import. + - `...rest`: Which members of the module to import. ## Input/output types: diff --git a/commands/docs/extern.md b/commands/docs/extern.md index 7a646371d5d..9a46deec039 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.91.0 +version: 0.92.0 core: | Define a signature for an external command. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `extern` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Define a signature for an external command.
## Signature diff --git a/commands/docs/fill.md b/commands/docs/fill.md index eb0b92ab64d..4b736630f06 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Fill and Align. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `fill` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Fill and Align.
## Signature diff --git a/commands/docs/filter.md b/commands/docs/filter.md index e4ab6da6f3c..c428722a5ba 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Filter values based on a predicate closure. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `filter` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Filter values based on a predicate closure.
## Signature diff --git a/commands/docs/find.md b/commands/docs/find.md index d8b398392e3..884e824d1f7 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Searches terms in the input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `find` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Searches terms in the input.
## Signature diff --git a/commands/docs/first.md b/commands/docs/first.md index 56f20e3d4c1..4918a52dceb 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `first` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`.
## Signature diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 28963dd8945..ebbda5cb933 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Flatten the table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `flatten` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Flatten the table.
## Signature diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index 69d843fb5a8..9f47d09286c 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,23 +2,19 @@ title: fmt categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Format a number. usage: | Format a number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for conversions +# `fmt` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Format a number.
- -::: warning - Command `fmt` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> fmt {flags} ``` diff --git a/commands/docs/for.md b/commands/docs/for.md index 6dced68c72d..c690ab96f3a 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.91.0 +version: 0.92.0 core: | Loop over a range. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `for` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Loop over a range.
## Signature diff --git a/commands/docs/format.md b/commands/docs/format.md index e04454a8a69..66d25964362 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Various commands for formatting data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `format` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Various commands for formatting data.
## Signature diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index fa2dcc812d7..3a6831f9563 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | date -version: 0.91.0 +version: 0.92.0 date: | Format a given date using a format string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for date +# `format date` for [date](/commands/categories/date.md) -
{{ $frontmatter.date }}
+
Format a given date using a format string.
## Signature diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 68ca069a531..30eefad7932 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Outputs duration with a specified unit of time. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `format duration` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Outputs duration with a specified unit of time.
## Signature diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index e0c373e3e13..439bc2056eb 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Converts a column of filesizes to some specified format. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `format filesize` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Converts a column of filesizes to some specified format.
## Signature diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 3b90506d45d..a2c6c2d5217 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,23 +2,19 @@ title: format pattern categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Format columns into a string using a simple pattern. usage: | Format columns into a string using a simple pattern. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `format pattern` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Format columns into a string using a simple pattern.
- -::: warning - Command `format pattern` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> format pattern {flags} (pattern)``` diff --git a/commands/docs/from.md b/commands/docs/from.md index a68dabfd50e..f204aa19743 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse a string or binary data into structured data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse a string or binary data into structured data.
## Signature @@ -31,21 +31,17 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | -| [`from eml`](/commands/docs/from_eml.md) | Builtin,Plugin | Parse text as .eml and create record. | -| [`from ics`](/commands/docs/from_ics.md) | Builtin,Plugin | Parse text as .ics and create table. | -| [`from ini`](/commands/docs/from_ini.md) | Builtin,Plugin | Parse text as .ini and create table. | -| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | -| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | -| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | -| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | -| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | -| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | -| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | -| [`from vcf`](/commands/docs/from_vcf.md) | Builtin,Plugin | Parse text as .vcf and create table. | -| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | -| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | -| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | -| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file +| name | type | usage | +| ------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------- | +| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | +| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | +| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | +| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | +| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | +| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | +| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | +| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | +| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | +| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | +| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | +| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index f80e8a65b7a..a0eaa27cde6 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .csv and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from csv` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .csv and create table.
## Signature diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 75a4413bab2..2edc46ad731 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert from json to structured data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from json` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert from json to structured data.
## Signature diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index d2870ee43bf..2eb441a8d12 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert from nuon to structured data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from nuon` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert from nuon to structured data.
## Signature diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index b8d64d5f4c6..876571c6b8e 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from ods` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse OpenDocument Spreadsheet(.ods) data and create table.
## Signature diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index ec7ce630329..c85297f866a 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from ssv` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2.
## Signature diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 489c54573fb..c7fb2f2d4f8 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .toml and create record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from toml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .toml and create record.
## Signature diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 5b3c350c22d..00d23ec70c7 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .tsv and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from tsv` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .tsv and create table.
## Signature diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 9f3be67135e..969e3653308 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,23 +2,19 @@ title: from url categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse url-encoded string as a record. usage: | Parse url-encoded string as a record. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for formats +# `from url` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse url-encoded string as a record.
- -::: warning - Command `from url` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> from url {flags} ``` diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index f3d6474015c..6b9679d754a 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from xlsx` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse binary Excel(.xlsx) data and create table.
## Signature diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index f4e0c17c585..9339984258f 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .xml and create record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from xml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .xml and create record.
## Signature diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index faac4ff41fa..3d6cfa80746 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .yaml/.yml and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from yaml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .yaml/.yml and create table.
## Signature diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index fef196e8246..a10ab8ae669 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Parse text as .yaml/.yml and create table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `from yml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Parse text as .yaml/.yml and create table.
## Signature diff --git a/commands/docs/generate.md b/commands/docs/generate.md index ffc9c0f9359..c24270ba2fc 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.91.0 +version: 0.92.0 generators: | Generate a list of values by successively invoking a closure. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for generators +# `generate` for [generators](/commands/categories/generators.md) -
{{ $frontmatter.generators }}
+
Generate a list of values by successively invoking a closure.
## Signature diff --git a/commands/docs/get.md b/commands/docs/get.md index 0d2b2050954..3ed5a86eba3 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Extract data using a cell path. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `get` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Extract data using a cell path.
## Signature diff --git a/commands/docs/glob.md b/commands/docs/glob.md index b715f967947..cbbe35d46f4 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `glob` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Creates a list of files and/or folders based on the glob pattern provided.
## Signature diff --git a/commands/docs/grid.md b/commands/docs/grid.md index 8cee6ec09fd..48d8cd1caaf 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.91.0 +version: 0.92.0 viewers: | Renders the output to a textual terminal grid. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for viewers +# `grid` for [viewers](/commands/categories/viewers.md) -
{{ $frontmatter.viewers }}
+
Renders the output to a textual terminal grid.
## Signature diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index 6bdbd7cfd26..2d1dfe202a0 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `group-by` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Splits a list or table into groups, and returns a record containing those groups.
## Signature diff --git a/commands/docs/group.md b/commands/docs/group.md index 505bfb7b641..33155fc8bcd 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Groups input into groups of `group_size`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `group` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Groups input into groups of `group_size`.
## Signature diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 9e75bdb855d..c590dd603bc 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.91.0 +version: 0.92.0 hash: | Apply hash function. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for hash +# `hash` for [hash](/commands/categories/hash.md) -
{{ $frontmatter.hash }}
+
Apply hash function.
## Signature diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 74f1ffa2405..e29e0c22f4f 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.91.0 +version: 0.92.0 hash: | Hash a value using the md5 hash algorithm. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for hash +# `hash md5` for [hash](/commands/categories/hash.md) -
{{ $frontmatter.hash }}
+
Hash a value using the md5 hash algorithm.
## Signature diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index 417b422802e..ca9b109e77b 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.91.0 +version: 0.92.0 hash: | Hash a value using the sha256 hash algorithm. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for hash +# `hash sha256` for [hash](/commands/categories/hash.md) -
{{ $frontmatter.hash }}
+
Hash a value using the sha256 hash algorithm.
## Signature diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 682b6ce889c..dd064814b1f 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Use the first row of the table as column names. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `headers` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Use the first row of the table as column names.
## Signature diff --git a/commands/docs/help.md b/commands/docs/help.md index 03478ab59e7..9eb2c3eef35 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.91.0 +version: 0.92.0 core: | Display help information about different parts of Nushell. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Display help information about different parts of Nushell.
## Signature @@ -44,7 +44,7 @@ show help for single command, alias, or module show help for single sub-command, alias, or module ```nu -> help str lpad +> help str join ``` diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index f9121768837..940b1f86fb2 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell aliases. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help aliases` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell aliases.
## Signature diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 266ef7825f8..8a74baa03b3 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell commands. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help commands` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell commands.
## Signature diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index ff5b5cd7f8d..7507aa594a8 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell string escapes. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help escapes` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell string escapes.
## Signature diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 7d2cc259a91..e1c916349d8 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell externs. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help externs` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell externs.
## Signature diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 1672884c194..6a3707db41d 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell modules. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help modules` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell modules.
## Signature diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 6281efc8d17..e8d197e0fe2 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.91.0 +version: 0.92.0 core: | Show help on nushell operators. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `help operators` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Show help on nushell operators.
## Signature diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index ed735db53ce..30e64e29644 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.91.0 +version: 0.92.0 core: | Hide environment variables in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `hide-env` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Hide environment variables in the current scope.
## Signature diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 403075720db..cc0accb605b 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.91.0 +version: 0.92.0 core: | Hide definitions in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `hide` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Hide definitions in the current scope.
## Signature diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index 1b6e27bdc00..e8be61d9fe6 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.91.0 +version: 0.92.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for chart +# `histogram` for [chart](/commands/categories/chart.md) -
{{ $frontmatter.chart }}
+
Creates a new table with a histogram based on the column name passed in.
## Signature diff --git a/commands/docs/history.md b/commands/docs/history.md index a769cbfebba..5ab0a1b8025 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.91.0 +version: 0.92.0 history: | Get the command history. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for history +# `history` for [history](/commands/categories/history.md) -
{{ $frontmatter.history }}
+
Get the command history.
## Signature diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 10804f24049..52f9f377056 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.91.0 +version: 0.92.0 history: | Get the command history session. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for history +# `history session` for [history](/commands/categories/history.md) -
{{ $frontmatter.history }}
+
Get the command history session.
## Signature diff --git a/commands/docs/http.md b/commands/docs/http.md index ad0e76852c4..e082a6b4ab9 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.91.0 +version: 0.92.0 network: | Various commands for working with http methods. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Various commands for working with http methods.
## Signature diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 7b1f966d7e3..c99a0abf535 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.91.0 +version: 0.92.0 network: | Delete the specified resource. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http delete` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Delete the specified resource.
## Signature diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index dd85c2441d2..05bbec7792f 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.91.0 +version: 0.92.0 network: | Fetch the contents from a URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http get` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Fetch the contents from a URL.
## Signature diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index e63c9b51797..25f70dff366 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.91.0 +version: 0.92.0 network: | Get the headers from a URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http head` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Get the headers from a URL.
## Signature diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 78820ee26b1..f6e5060ede6 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.91.0 +version: 0.92.0 network: | Requests permitted communication options for a given URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http options` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Requests permitted communication options for a given URL.
## Signature diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 05844c59619..6f768e76495 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.91.0 +version: 0.92.0 network: | Patch a body to a URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http patch` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Patch a body to a URL.
## Signature diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 5480cfcba13..160ffdf41e4 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.91.0 +version: 0.92.0 network: | Post a body to a URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http post` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Post a body to a URL.
## Signature diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 9a7efec39fe..b7d33dbcae9 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.91.0 +version: 0.92.0 network: | Put a body to a URL. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `http put` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Put a body to a URL.
## Signature diff --git a/commands/docs/if.md b/commands/docs/if.md index 52c6c6e37cc..d7a36e86547 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.91.0 +version: 0.92.0 core: | Conditionally run a block. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `if` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Conditionally run a block.
## Signature diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index df9a8d162f9..4a5c5f7a2f1 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.91.0 +version: 0.92.0 core: | Ignore the output of the previous command in the pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `ignore` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Ignore the output of the previous command in the pipeline.
## Signature diff --git a/commands/docs/input.md b/commands/docs/input.md index f2d575afde2..ec59dc34f82 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Get input from the user. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `input` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Get input from the user.
## Signature diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index cd89ff6dc07..7a424ccbea5 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Interactive list selection. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `input list` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Interactive list selection.
## Signature diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index d84c3cd7841..8458d07e725 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Listen for user interface event. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `input listen` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Listen for user interface event.
## Signature diff --git a/commands/docs/insert.md b/commands/docs/insert.md index f096c333da2..91ffd53f42d 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `insert` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Insert a new column, using an expression or closure to create each row's values.
## Signature @@ -91,3 +91,7 @@ Insert a new value at the end of a list ╰───┴───╯ ``` + +## Notes +When inserting a column, the closure will be run for each row, and the current row will be passed as the first argument. +When inserting into a specific index, the closure will instead get the current value at the index or null if inserting at the end of a list/table. \ No newline at end of file diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index ca729797dca..e37bc2e3f4d 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Inspect pipeline results while running a pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `inspect` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Inspect pipeline results while running a pipeline.
## Signature diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 7dfa4e2b771..9653128b068 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `interleave` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Read multiple streams in parallel and combine them into one stream.
## Signature diff --git a/commands/docs/into.md b/commands/docs/into.md index 2aa8cbfb94c..0b992c6b86c 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Commands to convert data from one type to another. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Commands to convert data from one type to another.
## Signature diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 951f4253828..a2b02563510 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to a binary primitive. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into binary` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to a binary primitive.
## Signature diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index c3f16198916..96a8ca61b19 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,23 +2,19 @@ title: into bits categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to a binary primitive. usage: | Convert value to a binary primitive. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for conversions +# `into bits` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to a binary primitive.
- -::: warning - Command `into bits` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> into bits {flags} ...rest``` @@ -34,7 +30,6 @@ feature: extra | -------- | ------ | | binary | string | | bool | string | -| datetime | string | | duration | string | | filesize | string | | int | string | @@ -73,12 +68,6 @@ convert a boolean value into a string, padded to 8 places with 0s 00000001 ``` -convert a datetime value into a string, padded to 8 places with 0s -```nu -> 2023-04-17T01:02:03 | into bits -01001101 01101111 01101110 00100000 01000001 01110000 01110010 00100000 00110001 00110111 00100000 00110000 00110001 00111010 00110000 00110010 00111010 00110000 00110011 00100000 00110010 00110000 00110010 00110011 -``` - convert a string into a raw binary string, padded with 0s to 8 places ```nu > 'nushell.sh' | into bits diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index d0619145fbd..1115db0658e 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to boolean. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into bool` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to boolean.
## Signature diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index db24dacac08..de9a8cc8692 100644 --- a/commands/docs/into_cell-path.md +++ b/commands/docs/into_cell-path.md @@ -2,7 +2,7 @@ title: into cell-path categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to a cell-path. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into cell-path` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to a cell-path.
## Signature diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index ff673d3e945..aba3d2c3633 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into datetime` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert text or timestamp into a datetime.
## Signature @@ -77,9 +77,9 @@ Convert list of timestamps to datetimes ```nu > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime ╭───┬───────────────╮ -│ 0 │ 11 months ago │ -│ 1 │ 10 months ago │ -│ 2 │ 9 months ago │ +│ 0 │ a year ago │ +│ 1 │ 11 months ago │ +│ 2 │ 10 months ago │ ╰───┴───────────────╯ ``` diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index a280c32258b..f252b585fdd 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to duration. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into duration` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to duration.
## Signature diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 5aa5f8b98b6..e0126678cb8 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to filesize. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into filesize` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to filesize.
## Signature diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 4967ef4317c..7bc48cb9e05 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert data into floating point number. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into float` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert data into floating point number.
## Signature diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index c12a481f293..08748418bc0 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to glob. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into glob` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to glob.
## Signature diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 33493c3cd21..15c0f628536 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to integer. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into int` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to integer.
## Signature diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index a632f83431c..b5dc611b278 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into record` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to record.
## Signature diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index df1657d14ba..687135d0674 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert table into a SQLite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into sqlite` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert table into a SQLite database.
## Signature diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 472b6270f97..04529b08db5 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.91.0 +version: 0.92.0 conversions: | Convert value to string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for conversions +# `into string` for [conversions](/commands/categories/conversions.md) -
{{ $frontmatter.conversions }}
+
Convert value to string.
## Signature diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 27b1fee1553..f77890663ec 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Infer nushell datatype for each cell. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `into value` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Infer nushell datatype for each cell.
## Signature diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 7453a81447a..eeb9f46488d 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.91.0 +version: 0.92.0 core: | Check if nushell is running with administrator or root privileges. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `is-admin` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Check if nushell is running with administrator or root privileges.
## Signature diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index f066d0509b2..713cf69485d 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Check for empty values. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `is-empty` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Check for empty values.
## Signature diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index cc716efa9f1..9045925a1ee 100644 --- a/commands/docs/is-not-empty.md +++ b/commands/docs/is-not-empty.md @@ -2,7 +2,7 @@ title: is-not-empty categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Check for non-empty values. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `is-not-empty` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Check for non-empty values.
## Signature diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 01f631ca549..a98613076a6 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `is-terminal` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Check if stdin, stdout, or stderr is a terminal.
## Signature diff --git a/commands/docs/items.md b/commands/docs/items.md index b82ae9126b6..1295aafe388 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `items` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Given a record, iterate on each pair of column name and associated value.
## Signature diff --git a/commands/docs/join.md b/commands/docs/join.md index 7f5df815c97..1e949cec085 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Join two tables. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `join` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Join two tables.
## Signature diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 74bd7340ba5..9cddb041586 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Keybindings related commands. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `keybindings` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Keybindings related commands.
## Signature diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 3f7a09fae93..a43b365ea54 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | List default keybindings. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `keybindings default` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
List default keybindings.
## Signature diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 39dae146614..c6409ac65f2 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | List available options that can be used to create keybindings. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `keybindings list` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
List available options that can be used to create keybindings.
## Signature diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index fe788984cd9..998b8dff936 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Get input from the user. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `keybindings listen` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Get input from the user.
## Signature diff --git a/commands/docs/kill.md b/commands/docs/kill.md index a09fbfdc9b2..7f7cb02e4cb 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Kill a process using the process id. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `kill` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Kill a process using the process id.
## Signature diff --git a/commands/docs/last.md b/commands/docs/last.md index 6969edad0c7..fcb4e0a736f 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `last` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`.
## Signature diff --git a/commands/docs/lazy_make.md b/commands/docs/lazy_make.md index 079311b6c7b..0e0a0789e34 100644 --- a/commands/docs/lazy_make.md +++ b/commands/docs/lazy_make.md @@ -2,7 +2,7 @@ title: lazy make categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create a lazy record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `lazy make` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create a lazy record.
## Signature diff --git a/commands/docs/length.md b/commands/docs/length.md index 0b96043e110..35d9025c7ab 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Count the number of items in an input list or rows in a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `length` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Count the number of items in an input list or rows in a table.
## Signature diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index fef2d33e070..81361e66771 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.91.0 +version: 0.92.0 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for removed +# `let-env` for [removed](/commands/categories/removed.md) -
{{ $frontmatter.removed }}
+
`let-env FOO = ...` has been removed, use `$env.FOO = ...` instead.
## Signature diff --git a/commands/docs/let.md b/commands/docs/let.md index 1d9d1c8eaf9..de5226f303c 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create a variable and give it a value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `let` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create a variable and give it a value.
## Signature diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 29273f38306..ccb860758fc 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Converts input to lines. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `lines` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Converts input to lines.
## Signature diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index bf53d690931..a0c0f221d5c 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Loads an environment update from a record. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `load-env` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Loads an environment update from a record.
## Signature diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 49a822d7625..79546b420e9 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.91.0 +version: 0.92.0 core: | Run a block in a loop. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `loop` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Run a block in a loop.
## Signature diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 99ed0377186..00e08583df5 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `ls` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
List the filenames, sizes, and modification times of items in a directory.
## Signature diff --git a/commands/docs/match.md b/commands/docs/match.md index dd5d2a4d74c..639933e9906 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.91.0 +version: 0.92.0 core: | Conditionally run a block on a matched value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `match` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Conditionally run a block on a matched value.
## Signature diff --git a/commands/docs/math.md b/commands/docs/math.md index 6a09cbaa578..b37d5176e08 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.91.0 +version: 0.92.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Use mathematical functions as aggregate functions on a list of numbers or tables.
## Signature diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 69a9788dbf8..1e1cd3b4861 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the absolute value of a number. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math abs` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the absolute value of a number.
## Signature diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 1727b9ef7f0..6f68ad77ece 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,23 +2,19 @@ title: math arccos categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the arccosine of the number. usage: | Returns the arccosine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arccos` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the arccosine of the number.
- -::: warning - Command `math arccos` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arccos {flags} ``` diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 0711bfb59e5..707f667d987 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,23 +2,19 @@ title: math arccosh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | Returns the inverse of the hyperbolic cosine function. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arccosh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the inverse of the hyperbolic cosine function.
- -::: warning - Command `math arccosh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arccosh {flags} ``` diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index 746fb130422..cc0679e2d19 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,23 +2,19 @@ title: math arcsin categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the arcsine of the number. usage: | Returns the arcsine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arcsin` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the arcsine of the number.
- -::: warning - Command `math arcsin` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arcsin {flags} ``` diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index d6a9fe2d8a0..f753cde1b56 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,23 +2,19 @@ title: math arcsinh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the inverse of the hyperbolic sine function. usage: | Returns the inverse of the hyperbolic sine function. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arcsinh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the inverse of the hyperbolic sine function.
- -::: warning - Command `math arcsinh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arcsinh {flags} ``` diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index 46c4dada656..7a5f5eaa8f1 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,23 +2,19 @@ title: math arctan categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the arctangent of the number. usage: | Returns the arctangent of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arctan` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the arctangent of the number.
- -::: warning - Command `math arctan` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arctan {flags} ``` diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 63aea27e626..36fce759ec7 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,23 +2,19 @@ title: math arctanh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | Returns the inverse of the hyperbolic tangent function. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math arctanh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the inverse of the hyperbolic tangent function.
- -::: warning - Command `math arctanh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math arctanh {flags} ``` diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 4c901ab2f71..61ba289ace4 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the average of a list of numbers. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math avg` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the average of a list of numbers.
## Signature diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index c624a2c6de1..fb95478628d 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math ceil` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the ceil of a number (smallest integer greater than or equal to that number).
## Signature diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index 22f0cf02095..56a4970db62 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,23 +2,19 @@ title: math cos categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the cosine of the number. usage: | Returns the cosine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math cos` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the cosine of the number.
- -::: warning - Command `math cos` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math cos {flags} ``` diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 1ca65d50a24..5e9683108ee 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,23 +2,19 @@ title: math cosh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the hyperbolic cosine of the number. usage: | Returns the hyperbolic cosine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math cosh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the hyperbolic cosine of the number.
- -::: warning - Command `math cosh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math cosh {flags} ``` diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 2985f00d3b9..5e3fc3b0b83 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,23 +2,19 @@ title: math exp categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns e raised to the power of x. usage: | Returns e raised to the power of x. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math exp` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns e raised to the power of x.
- -::: warning - Command `math exp` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math exp {flags} ``` diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index fff1ca37f1c..12f41264d6d 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math floor` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the floor of a number (largest integer less than or equal to that number).
## Signature diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 6f07a8f1f7c..3fae863fe7b 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,23 +2,19 @@ title: math ln categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the natural logarithm. Base: (math e). usage: | Returns the natural logarithm. Base: (math e). -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math ln` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the natural logarithm. Base: (math e).
- -::: warning - Command `math ln` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math ln {flags} ``` diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 5dc9182dc81..6c207b87c93 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the logarithm for an arbitrary base. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math log` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the logarithm for an arbitrary base.
## Signature diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index c34aa12183b..982e57473e1 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the maximum of a list of values, or of columns in a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math max` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the maximum of a list of values, or of columns in a table.
## Signature diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index e9d437a4878..20d0c518bc8 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.91.0 +version: 0.92.0 math: | Computes the median of a list of numbers. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math median` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Computes the median of a list of numbers.
## Signature diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index 8e667ddd1b8..7cea201b563 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.91.0 +version: 0.92.0 math: | Finds the minimum within a list of values or tables. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math min` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Finds the minimum within a list of values or tables.
## Signature diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index 531d69e5b6f..208f8e16ee1 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math mode` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the most frequent element(s) from a list of numbers or tables.
## Signature diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index 91bc950c699..1ef7bc51b73 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math product` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the product of a list of numbers or the products of each column of a table.
## Signature diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index 92915e57f06..a0178de11f4 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the input number rounded to the specified precision. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math round` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the input number rounded to the specified precision.
## Signature diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index 80e6aad5273..61fd6fbd9e7 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,23 +2,19 @@ title: math sin categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the sine of the number. usage: | Returns the sine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math sin` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the sine of the number.
- -::: warning - Command `math sin` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math sin {flags} ``` diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index c083360b07a..62d020a6277 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,23 +2,19 @@ title: math sinh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the hyperbolic sine of the number. usage: | Returns the hyperbolic sine of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math sinh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the hyperbolic sine of the number.
- -::: warning - Command `math sinh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math sinh {flags} ``` diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index c24f047443d..f6d5afb4bc5 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the square root of the input number. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math sqrt` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the square root of the input number.
## Signature diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index ac405db5f05..e745353cec5 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math stddev` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the standard deviation of a list of numbers, or of each column in a table.
## Signature diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index 800fbf82d3a..317f6486d19 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the sum of a list of numbers or of each column in a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math sum` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the sum of a list of numbers or of each column in a table.
## Signature diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index 11d4fb173aa..caff8601c54 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,23 +2,19 @@ title: math tan categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the tangent of the number. usage: | Returns the tangent of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math tan` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the tangent of the number.
- -::: warning - Command `math tan` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math tan {flags} ``` diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 79087f73048..bf3a9665337 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,23 +2,19 @@ title: math tanh categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the hyperbolic tangent of the number. usage: | Returns the hyperbolic tangent of the number. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for math +# `math tanh` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the hyperbolic tangent of the number.
- -::: warning - Command `math tanh` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> math tanh {flags} ``` diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 480e6589f98..4ede3ce86b7 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.91.0 +version: 0.92.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for math +# `math variance` for [math](/commands/categories/math.md) -
{{ $frontmatter.math }}
+
Returns the variance of a list of numbers or of each column in a table.
## Signature diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 3bd9e6a2bcf..a568da3f8d4 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `merge` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Merge the input with a record or table, overwriting values in matching columns.
## Signature diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index 735c8ab087c..d711e371528 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Get the metadata for items in the stream. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `metadata` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Get the metadata for items in the stream.
## Signature diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 0f65946c7ed..c92f5078060 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `mkdir` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Create directories, with intermediary directories if required using uutils/coreutils mkdir.
## Signature diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 46787861d96..bffc44aadd6 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `mktemp` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Create temporary files or directories using uutils/coreutils mktemp.
## Signature diff --git a/commands/docs/module.md b/commands/docs/module.md index 060485617fd..075f330cdbd 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.91.0 +version: 0.92.0 core: | Define a custom module. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `module` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Define a custom module.
## Signature diff --git a/commands/docs/move.md b/commands/docs/move.md index 3afbed72475..140796a262b 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Move columns before or after other columns. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `move` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Move columns before or after other columns.
## Signature diff --git a/commands/docs/mut.md b/commands/docs/mut.md index d20e3a45dc0..e5d29f4f7d3 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create a mutable variable and give it a value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `mut` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create a mutable variable and give it a value.
## Signature diff --git a/commands/docs/mv.md b/commands/docs/mv.md index f167fb791ce..6952a5e68ff 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `mv` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Move files or directories using uutils/coreutils mv.
## Signature diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 0c951c29adc..dcea12841fc 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Validate and parse input content. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `nu-check` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Validate and parse input content.
## Signature @@ -23,7 +23,6 @@ feature: default - `--as-module, -m`: Parse content as module - `--debug, -d`: Show error messages - - `--all, -a`: Parse content as script first, returns result if success, otherwise, try with module ## Parameters diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 03e8de37a45..a457d1d09eb 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Syntax highlight the input string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `nu-highlight` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Syntax highlight the input string.
## Signature diff --git a/commands/docs/open.md b/commands/docs/open.md index dacd341b778..138ebd81cc0 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `open` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Load a file into a cell, converting to table if possible (avoid by appending '--raw').
## Signature diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index 0f1baadc7ea..d650c426268 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.91.0 +version: 0.92.0 core: | Commands for manipulating overlays. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `overlay` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Commands for manipulating overlays.
## Signature diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index bed38c15bd3..586582a1bd6 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.91.0 +version: 0.92.0 core: | Hide an active overlay. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `overlay hide` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Hide an active overlay.
## Signature diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 0e7eef7cc9b..10d4053e66c 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.91.0 +version: 0.92.0 core: | List all active overlays. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `overlay list` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
List all active overlays.
## Signature diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 84317d6b151..d033faf4f78 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.91.0 +version: 0.92.0 core: | Create an empty overlay. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `overlay new` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Create an empty overlay.
## Signature diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index a1f3accae81..82842186be4 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.91.0 +version: 0.92.0 core: | Use definitions from a module as an overlay. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `overlay use` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Use definitions from a module as an overlay.
## Signature diff --git a/commands/docs/panic.md b/commands/docs/panic.md index d2cc69c3170..ad3c7216ee6 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | experimental -version: 0.91.0 +version: 0.92.0 experimental: | Executes a rust panic, useful only for testing. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for experimental +# `panic` for [experimental](/commands/categories/experimental.md) -
{{ $frontmatter.experimental }}
+
Executes a rust panic, useful only for testing.
## Signature diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 0260f40ce37..b0ff72793df 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `par-each` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Run a closure on each row of the input list in parallel, creating a new list with the results.
## Signature diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 90ed892ec2a..d1cf02a6ae4 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Parse columns from string data using a simple pattern. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `parse` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Parse columns from string data using a simple pattern.
## Signature diff --git a/commands/docs/path.md b/commands/docs/path.md index a6bd6bac840..9aace873b95 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.91.0 +version: 0.92.0 path: | Explore and manipulate paths. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Explore and manipulate paths.
## Signature diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 094379f8d53..0f178d19781 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.91.0 +version: 0.92.0 path: | Get the final component of a path. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path basename` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Get the final component of a path.
## Signature diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index bfb03c62c7e..d7ffe7f9fc8 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.91.0 +version: 0.92.0 path: | Get the parent directory of a path. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path dirname` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Get the parent directory of a path.
## Signature diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 9d3f7fd1d50..9dfa0894de9 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.91.0 +version: 0.92.0 path: | Check whether a path exists. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path exists` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Check whether a path exists.
## Signature diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 0d7009df792..6529ac3aad6 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.91.0 +version: 0.92.0 path: | Try to expand a path to its absolute form. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path expand` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Try to expand a path to its absolute form.
## Signature diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index 04521ec2052..f7ce65bec5f 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.91.0 +version: 0.92.0 path: | Join a structured path or a list of path parts. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path join` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Join a structured path or a list of path parts.
## Signature diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index edff61b6b93..268f47508f9 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.91.0 +version: 0.92.0 path: | Convert a path into structured data. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path parse` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Convert a path into structured data.
## Signature diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index a7f90ea840b..09e2f96c3e8 100644 --- a/commands/docs/path_relative-to.md +++ b/commands/docs/path_relative-to.md @@ -2,7 +2,7 @@ title: path relative-to categories: | path -version: 0.91.0 +version: 0.92.0 path: | Express a path as relative to another path. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path relative-to` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Express a path as relative to another path.
## Signature diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index 2fb1a973d04..9df2f926df5 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.91.0 +version: 0.92.0 path: | Split a path into a list based on the system's path separator. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path split` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Split a path into a list based on the system's path separator.
## Signature diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index c8b9956ed69..32de8046ba8 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.91.0 +version: 0.92.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for path +# `path type` for [path](/commands/categories/path.md) -
{{ $frontmatter.path }}
+
Get the type of the object a path refers to (e.g., file, dir, symlink).
## Signature diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md new file mode 100644 index 00000000000..aec6d16fa62 --- /dev/null +++ b/commands/docs/plugin.md @@ -0,0 +1,51 @@ +--- +title: plugin +categories: | + core +version: 0.92.0 +core: | + Commands for managing plugins. +usage: | + Commands for managing plugins. +feature: default +--- + + +# `plugin` for [core](/commands/categories/core.md) + +
Commands for managing plugins.
+ +## Signature + +```> plugin {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +List installed plugins +```nu +> plugin list + +``` + +Stop the plugin named `inc`. +```nu +> plugin stop inc + +``` + +## Notes +To load a plugin, see `register`. + +## Subcommands: + +| name | type | usage | +| ---------------------------------------------- | ------- | ------------------------------------------- | +| [`plugin list`](/commands/docs/plugin_list.md) | Builtin | List installed plugins. | +| [`plugin stop`](/commands/docs/plugin_stop.md) | Builtin | Stop an installed plugin if it was running. | \ No newline at end of file diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md new file mode 100644 index 00000000000..3ea7315cfe8 --- /dev/null +++ b/commands/docs/plugin_list.md @@ -0,0 +1,48 @@ +--- +title: plugin list +categories: | + core +version: 0.92.0 +core: | + List installed plugins. +usage: | + List installed plugins. +feature: default +--- + + +# `plugin list` for [core](/commands/categories/core.md) + +
List installed plugins.
+ +## Signature + +```> plugin list {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | -------------------------------------------------------------------------------------------------------- | +| nothing | table\\> | + +## Examples + +List installed plugins. +```nu +> plugin list +╭───┬──────┬────────────┬────────┬───────────────────────────────┬───────┬─────────────╮ +│ # │ name │ is_running │ pid │ filename │ shell │ commands │ +├───┼──────┼────────────┼────────┼───────────────────────────────┼───────┼─────────────┤ +│ 0 │ inc │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ │ │ │ │ │ │ │ 0 │ inc │ │ +│ │ │ │ │ │ │ ╰───┴─────╯ │ +╰───┴──────┴────────────┴────────┴───────────────────────────────┴───────┴─────────────╯ + +``` + +Get process information for running plugins. +```nu +> ps | where pid in (plugin list).pid + +``` diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md new file mode 100644 index 00000000000..e61e53707cc --- /dev/null +++ b/commands/docs/plugin_stop.md @@ -0,0 +1,45 @@ +--- +title: plugin stop +categories: | + core +version: 0.92.0 +core: | + Stop an installed plugin if it was running. +usage: | + Stop an installed plugin if it was running. +feature: default +--- + + +# `plugin stop` for [core](/commands/categories/core.md) + +
Stop an installed plugin if it was running.
+ +## Signature + +```> plugin stop {flags} (name)``` + +## Parameters + + - `name`: The name of the plugin to stop. + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Stop the plugin named `inc`. +```nu +> plugin stop inc + +``` + +Stop all plugins. +```nu +> plugin list | each { |p| plugin stop $p.name } + +``` diff --git a/commands/docs/port.md b/commands/docs/port.md index 86a91089578..3adc3ef53a7 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.91.0 +version: 0.92.0 network: | Get a free port from system. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `port` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Get a free port from system.
## Signature diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 1bf8b6cdae2..cf82feeac60 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Prepend any number of rows to a table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `prepend` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Prepend any number of rows to a table.
## Signature diff --git a/commands/docs/print.md b/commands/docs/print.md index c9f0ecf42cd..eb2aca423e3 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Print the given values to stdout. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `print` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Print the given values to stdout.
## Signature diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 2c33cc6ddb0..e9bb9f8b86b 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.91.0 +version: 0.92.0 system: | View information about system processes. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `ps` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
View information about system processes.
## Signature diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md new file mode 100644 index 00000000000..0da3bfefd96 --- /dev/null +++ b/commands/docs/pwd.md @@ -0,0 +1,27 @@ +--- +title: pwd +categories: | + default +version: 0.92.0 +default: | + Return the current working directory +usage: | + Return the current working directory +feature: default +--- + + +# `pwd` for [default](/commands/categories/default.md) + +
Return the current working directory
+ +## Signature + +```> pwd {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index a35eeabad87..c6e8e8e4273 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.91.0 +version: 0.92.0 database: | Query a database using SQL. usage: | @@ -11,14 +11,18 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `query db` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Query a database using SQL.
## Signature ```> query db {flags} (SQL)``` +## Flags + + - `--params, -p {any}`: List of parameters for the SQL statement + ## Parameters - `SQL`: SQL to execute against the database. @@ -37,3 +41,23 @@ Execute SQL against a SQLite database > open foo.db | query db "SELECT * FROM Bar" ``` + +Execute a SQL statement with parameters +```nu +> stor create -t my_table -c { first: str, second: int } +stor open | query db "INSERT INTO my_table VALUES (?, ?)" -p [hello 123] + +``` + +Execute a SQL statement with named parameters +```nu +> stor create -t my_table -c { first: str, second: int } +stor insert -t my_table -d { first: 'hello', second: '123' } +stor open | query db "SELECT * FROM my_table WHERE second = :search_second" -p { search_second: 123 } +╭───┬───────┬────────╮ +│ # │ first │ second │ +├───┼───────┼────────┤ +│ 0 │ hello │ 123 │ +╰───┴───────┴────────╯ + +``` diff --git a/commands/docs/random.md b/commands/docs/random.md index fc9e52bdf0d..cc22e7f893a 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random value.
## Signature diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 1d0c5991caa..2532692a740 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random boolean value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random bool` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random boolean value.
## Signature diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index baf81c17cbc..7b4898d73b0 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate random chars. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random chars` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate random chars.
## Signature diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index c2c04306f5e..81ab1255003 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random dice roll. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random dice` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random dice roll.
## Signature diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index d4cd4f5762f..cc1f8c73feb 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random float within a range [min..max]. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random float` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random float within a range [min..max].
## Signature diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 8ff588f470b..3a9feb5e1aa 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random integer [min..max]. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random int` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random integer [min..max].
## Signature diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 35566b6d859..fbe9fd4ee1a 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.91.0 +version: 0.92.0 random: | Generate a random uuid4 string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for random +# `random uuid` for [random](/commands/categories/random.md) -
{{ $frontmatter.random }}
+
Generate a random uuid4 string.
## Signature diff --git a/commands/docs/range.md b/commands/docs/range.md index 54e3e81c5d9..4e0cd4feeb8 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Return only the selected rows. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `range` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Return only the selected rows.
## Signature diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 2a67c812b53..10b29fed46b 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Aggregate a list to a single value using an accumulator closure. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `reduce` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Aggregate a list to a single value using an accumulator closure.
## Signature diff --git a/commands/docs/register.md b/commands/docs/register.md index 0a856be8d43..afdab432f1f 100644 --- a/commands/docs/register.md +++ b/commands/docs/register.md @@ -2,7 +2,7 @@ title: register categories: | core -version: 0.91.0 +version: 0.92.0 core: | Register a plugin. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `register` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Register a plugin.
## Signature diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 449b1525e28..feca5cf9383 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `reject` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Remove the given columns or rows from the table. Opposite of `select`.
## Signature diff --git a/commands/docs/rename.md b/commands/docs/rename.md index f19ab0fbd08..24e2c163a8b 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Creates a new table with columns renamed. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `rename` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Creates a new table with columns renamed.
## Signature diff --git a/commands/docs/return.md b/commands/docs/return.md index 036c38c63fc..064f8f4321f 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.91.0 +version: 0.92.0 core: | Return early from a function. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `return` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Return early from a function.
## Signature diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index db40d19c5b2..553f47eb0bc 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Reverses the input list or table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `reverse` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Reverses the input list or table.
## Signature diff --git a/commands/docs/rm.md b/commands/docs/rm.md index b360a39983e..44528700e85 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Remove files and directories. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `rm` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Remove files and directories.
## Signature diff --git a/commands/docs/roll.md b/commands/docs/roll.md index f245a96bf94..c27b1e8a41e 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,23 +2,19 @@ title: roll categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Rolling commands for tables. usage: | Rolling commands for tables. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `roll` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Rolling commands for tables.
- -::: warning - Command `roll` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> roll {flags} ``` diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 87a0d80a8d2..95477e2aeab 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,23 +2,19 @@ title: roll down categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Roll table rows down. usage: | Roll table rows down. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `roll down` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Roll table rows down.
- -::: warning - Command `roll down` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> roll down {flags} ``` diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 57ce092d3f3..d9b7c92def5 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,23 +2,19 @@ title: roll left categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Roll record or table columns left. usage: | Roll record or table columns left. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `roll left` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Roll record or table columns left.
- -::: warning - Command `roll left` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> roll left {flags} ``` diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index ed5c8b6328a..e1a363858c7 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,23 +2,19 @@ title: roll right categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Roll table columns right. usage: | Roll table columns right. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `roll right` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Roll table columns right.
- -::: warning - Command `roll right` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> roll right {flags} ``` diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index b8aab82e5ad..cc6c9608659 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,23 +2,19 @@ title: roll up categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Roll table rows up. usage: | Roll table rows up. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `roll up` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Roll table rows up.
- -::: warning - Command `roll up` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> roll up {flags} ``` diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 3b73b858835..9a8602943ba 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,23 +2,19 @@ title: rotate categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `rotate` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag).
- -::: warning - Command `rotate` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> rotate {flags} ...rest``` diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index 2f218529760..63b201a78a7 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.91.0 +version: 0.92.0 system: | Runs external command. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `run-external` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
Runs external command.
## Signature @@ -48,6 +48,12 @@ Run an external command Redirect stdout from an external command into the pipeline ```nu -> run-external --redirect-stdout "echo" "-n" "hello" | split chars +> run-external "echo" "-n" "hello" | split chars + +``` + +Redirect stderr from an external command into the pipeline +```nu +> run-external "nu" "-c" "print -e hello" e>| split chars ``` diff --git a/commands/docs/save.md b/commands/docs/save.md index cb689ed05d4..1fee947c59c 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Save a file. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `save` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Save a file.
## Signature diff --git a/commands/docs/schema.md b/commands/docs/schema.md index b5892b5592a..7fe90f80f33 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.91.0 +version: 0.92.0 database: | Show the schema of a SQLite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `schema` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Show the schema of a SQLite database.
## Signature diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 75595c4b264..bb0c3973111 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.91.0 +version: 0.92.0 core: | Commands for getting info about what is in scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Commands for getting info about what is in scope.
## Signature diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index b3f7ebf917f..963136494a8 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output info on the aliases in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope aliases` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output info on the aliases in the current scope.
## Signature diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index d8c605b41df..49e9003676f 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output info on the commands in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope commands` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output info on the commands in the current scope.
## Signature @@ -22,9 +22,9 @@ feature: default ## Input/output types: -| input | output | -| ------- | ------ | -| nothing | any | +| input | output | +| ------- | --------- | +| nothing | list\ | ## Examples diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index c068c721809..f5b6aa739dc 100644 --- a/commands/docs/scope_engine-stats.md +++ b/commands/docs/scope_engine-stats.md @@ -2,7 +2,7 @@ title: scope engine-stats categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output stats on the engine in the current state. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope engine-stats` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output stats on the engine in the current state.
## Signature diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index b085a4d2d53..9b757aa7329 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output info on the known externals in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope externs` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output info on the known externals in the current scope.
## Signature diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 4b54b5d7ccc..0556d655182 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output info on the modules in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope modules` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output info on the modules in the current scope.
## Signature diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index d2c70a4f56a..d912dacdfd5 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.91.0 +version: 0.92.0 core: | Output info on the variables in the current scope. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `scope variables` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Output info on the variables in the current scope.
## Signature diff --git a/commands/docs/select.md b/commands/docs/select.md index db5b79ae288..df806dbb346 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `select` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Select only these columns or rows from the input. Opposite of `reject`.
## Signature diff --git a/commands/docs/seq.md b/commands/docs/seq.md index aaa02f2f97c..2f6f9b889ba 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.91.0 +version: 0.92.0 generators: | Output sequences of numbers. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for generators +# `seq` for [generators](/commands/categories/generators.md) -
{{ $frontmatter.generators }}
+
Output sequences of numbers.
## Signature diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index fa6bb3e164d..1b76c095c1f 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.91.0 +version: 0.92.0 generators: | Print a sequence of ASCII characters. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for generators +# `seq char` for [generators](/commands/categories/generators.md) -
{{ $frontmatter.generators }}
+
Print a sequence of ASCII characters.
## Signature diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 33bc0b5b01d..8ecb46bb39e 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.91.0 +version: 0.92.0 generators: | Print sequences of dates. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for generators +# `seq date` for [generators](/commands/categories/generators.md) -
{{ $frontmatter.generators }}
+
Print sequences of dates.
## Signature diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 8416bb8c2d0..570236802e0 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Shuffle rows randomly. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `shuffle` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Shuffle rows randomly.
## Signature diff --git a/commands/docs/skip.md b/commands/docs/skip.md index fc1c096c776..0fc41701115 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `skip` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`.
## Signature diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 67797c32286..2c0bd2d0d38 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Skip elements of the input until a predicate is true. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `skip until` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Skip elements of the input until a predicate is true.
## Signature diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index 09af61a822d..425f7436954 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Skip elements of the input while a predicate is true. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `skip while` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Skip elements of the input while a predicate is true.
## Signature diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index 6430b997b6f..575c9e473a2 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Delay for a specified amount of time. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `sleep` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Delay for a specified amount of time.
## Signature diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index 3f802f96bde..2b80ab73ed7 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Sort by the given columns, in increasing order. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `sort-by` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Sort by the given columns, in increasing order.
## Signature diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 350b31130a6..96612c1f6e5 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Sort in increasing order. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `sort` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Sort in increasing order.
## Signature diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 2552d934849..9bce0c15c1d 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.91.0 +version: 0.92.0 core: | Source the environment from a source file into the current environment. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `source-env` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Source the environment from a source file into the current environment.
## Signature diff --git a/commands/docs/source.md b/commands/docs/source.md index eb2926cdf0f..56459dd6880 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.91.0 +version: 0.92.0 core: | Runs a script file in the current context. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `source` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Runs a script file in the current context.
## Signature diff --git a/commands/docs/split-by.md b/commands/docs/split-by.md index e4732f21e76..e4b7f8dc1bf 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Split a record into groups. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `split-by` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Split a record into groups.
## Signature diff --git a/commands/docs/split.md b/commands/docs/split.md index 5466c467050..c67e24385ac 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `split` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Split contents across desired subcommand (like row, column) via the separator.
## Signature diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index b6309e96738..5f11b7312b4 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Split a string into a list of characters. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `split chars` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Split a string into a list of characters.
## Signature diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index 47afc4d2fa8..e0a801b934c 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Split a string into multiple columns using a separator. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `split column` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Split a string into multiple columns using a separator.
## Signature diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index 3f1f4b92b5d..7bdb44be375 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Split a list into multiple lists using a separator. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `split list` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Split a list into multiple lists using a separator.
## Signature diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 1bb445484a9..22451ef8741 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Split a string into multiple rows using a separator. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `split row` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Split a string into multiple rows using a separator.
## Signature diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index 273a38758c5..73dbcaaf113 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Split a string's words into separate rows. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `split words` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Split a string's words into separate rows.
## Signature diff --git a/commands/docs/start.md b/commands/docs/start.md index ceaceac74ea..0a30c0d43ee 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Open a folder, file or website in the default application or viewer. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `start` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Open a folder, file or website in the default application or viewer.
## Signature @@ -29,7 +29,7 @@ feature: default | input | output | | ------- | ------ | | nothing | any | -| string | any | + ## Examples Open a text file with the default text editor diff --git a/commands/docs/stor.md b/commands/docs/stor.md index ffb29c7fd35..cca1a6f5b0e 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.91.0 +version: 0.92.0 database: | Various commands for working with the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Various commands for working with the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index 2da4d8c9352..c81405d923e 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.91.0 +version: 0.92.0 database: | Create a table in the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor create` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Create a table in the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index e14def9ab40..412047c2008 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.91.0 +version: 0.92.0 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor delete` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Delete a table or specified rows in the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index 032aa66f834..bc3f9e0db1d 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.91.0 +version: 0.92.0 database: | Export the in-memory sqlite database to a sqlite database file. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor export` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Export the in-memory sqlite database to a sqlite database file.
## Signature diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index ed5efd155bb..8587b2a7361 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.91.0 +version: 0.92.0 database: | Import a sqlite database file into the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor import` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Import a sqlite database file into the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index 69970a080f8..ab803bf863d 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.91.0 +version: 0.92.0 database: | Insert information into a specified table in the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor insert` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Insert information into a specified table in the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index b0b43c21cc2..5b37336deff 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.91.0 +version: 0.92.0 database: | Opens the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor open` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Opens the in-memory sqlite database.
## Signature diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index e11a2916def..3fca3fec1b0 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.91.0 +version: 0.92.0 database: | Reset the in-memory database by dropping all tables. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor reset` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Reset the in-memory database by dropping all tables.
## Signature diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index d849d1f4229..f129eed9522 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.91.0 +version: 0.92.0 database: | Update information in a specified table in the in-memory sqlite database. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for database +# `stor update` for [database](/commands/categories/database.md) -
{{ $frontmatter.database }}
+
Update information in a specified table in the in-memory sqlite database.
## Signature diff --git a/commands/docs/str.md b/commands/docs/str.md index 7178e7097d0..3d7589b3f15 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,23 +2,19 @@ title: str categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Various commands for working with string data. usage: | Various commands for working with string data. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Various commands for working with string data.
- -::: warning - Command `str` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str {flags} ``` @@ -43,7 +39,6 @@ You must use one of the following subcommands. Using this command as-is will onl | [`str distance`](/commands/docs/str_distance.md) | Builtin | Compare two strings and return the edit distance/Levenshtein distance. | | [`str downcase`](/commands/docs/str_downcase.md) | Builtin | Make text lowercase. | | [`str ends-with`](/commands/docs/str_ends-with.md) | Builtin | Check if an input ends with a string. | -| [`str escape-glob`](/commands/docs/str_escape-glob.md) | Builtin | Escape glob pattern. | | [`str expand`](/commands/docs/str_expand.md) | Builtin | Generates all possible combinations defined in brace expansion syntax. | | [`str index-of`](/commands/docs/str_index-of.md) | Builtin | Returns start index of first occurrence of string in input, or -1 if no match. | | [`str join`](/commands/docs/str_join.md) | Builtin | Concatenate multiple strings into a single string, with an optional separator between each. | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index dd6c7cefa2a..faa581f46f7 100644 --- a/commands/docs/str_camel-case.md +++ b/commands/docs/str_camel-case.md @@ -2,23 +2,19 @@ title: str camel-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to camelCase. usage: | Convert a string to camelCase. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str camel-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to camelCase.
- -::: warning - Command `str camel-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str camel-case {flags} ...rest``` diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 7020ffdb462..df442944bc9 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Capitalize first letter of text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str capitalize` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Capitalize first letter of text.
## Signature diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 622b284081e..6d9a40c2b7a 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Checks if string input contains a substring. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str contains` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Checks if string input contains a substring.
## Signature diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index e2be7486d39..3e717e2968a 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str distance` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Compare two strings and return the edit distance/Levenshtein distance.
## Signature diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index aac08b8684e..82961ae66f3 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Make text lowercase. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str downcase` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Make text lowercase.
## Signature diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index fa69fe116ea..fd2d953b554 100644 --- a/commands/docs/str_ends-with.md +++ b/commands/docs/str_ends-with.md @@ -2,7 +2,7 @@ title: str ends-with categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Check if an input ends with a string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str ends-with` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Check if an input ends with a string.
## Signature diff --git a/commands/docs/str_escape-glob.md b/commands/docs/str_escape-glob.md index 5ce18c31bba..c6327813835 100644 --- a/commands/docs/str_escape-glob.md +++ b/commands/docs/str_escape-glob.md @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str escape-glob` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Escape glob pattern.
## Signature diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index aad95ce42bd..20cabbd99a5 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str expand` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Generates all possible combinations defined in brace expansion syntax.
## Signature diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index 608b82ac488..30126a9ab10 100644 --- a/commands/docs/str_index-of.md +++ b/commands/docs/str_index-of.md @@ -2,7 +2,7 @@ title: str index-of categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str index-of` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Returns start index of first occurrence of string in input, or -1 if no match.
## Signature diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index 6358070ea41..ae2e004b3fb 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str join` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Concatenate multiple strings into a single string, with an optional separator between each.
## Signature diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index b3268ccfb3d..b275ceb6c79 100644 --- a/commands/docs/str_kebab-case.md +++ b/commands/docs/str_kebab-case.md @@ -2,23 +2,19 @@ title: str kebab-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to kebab-case. usage: | Convert a string to kebab-case. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str kebab-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to kebab-case.
- -::: warning - Command `str kebab-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str kebab-case {flags} ...rest``` diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 571abd679cc..1ab6e280c5b 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Output the length of any strings in the pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str length` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Output the length of any strings in the pipeline.
## Signature diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 33f3dfee46f..f37db4df041 100644 --- a/commands/docs/str_pascal-case.md +++ b/commands/docs/str_pascal-case.md @@ -2,23 +2,19 @@ title: str pascal-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to PascalCase. usage: | Convert a string to PascalCase. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str pascal-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to PascalCase.
- -::: warning - Command `str pascal-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str pascal-case {flags} ...rest``` diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 302282f4751..da74484bd56 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Find and replace text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str replace` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Find and replace text.
## Signature diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index ffc8e8d2444..de648493bdf 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Reverse every string in the pipeline. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str reverse` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Reverse every string in the pipeline.
## Signature diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index 7ed9f75d173..0adc0ad80d1 100644 --- a/commands/docs/str_screaming-snake-case.md +++ b/commands/docs/str_screaming-snake-case.md @@ -2,23 +2,19 @@ title: str screaming-snake-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | Convert a string to SCREAMING_SNAKE_CASE. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str screaming-snake-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to SCREAMING_SNAKE_CASE.
- -::: warning - Command `str screaming-snake-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str screaming-snake-case {flags} ...rest``` diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index 1739471283e..c033665b61a 100644 --- a/commands/docs/str_snake-case.md +++ b/commands/docs/str_snake-case.md @@ -2,23 +2,19 @@ title: str snake-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to snake_case. usage: | Convert a string to snake_case. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str snake-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to snake_case.
- -::: warning - Command `str snake-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str snake-case {flags} ...rest``` diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index f9072e4b28d..97aca1ccbe1 100644 --- a/commands/docs/str_starts-with.md +++ b/commands/docs/str_starts-with.md @@ -2,7 +2,7 @@ title: str starts-with categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Check if an input starts with a string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str starts-with` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Check if an input starts with a string.
## Signature diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index ea68886e683..821864652ed 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Gather word count statistics on the text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str stats` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Gather word count statistics on the text.
## Signature diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index f508744a6ee..42c89d0b01f 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str substring` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0.
## Signature diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index f1222308870..5ffa45ba891 100644 --- a/commands/docs/str_title-case.md +++ b/commands/docs/str_title-case.md @@ -2,23 +2,19 @@ title: str title-case categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Convert a string to Title Case. usage: | Convert a string to Title Case. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for strings +# `str title-case` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Convert a string to Title Case.
- -::: warning - Command `str title-case` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> str title-case {flags} ...rest``` diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 03d016e9dcc..c13779f1d75 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Trim whitespace or specific character. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str trim` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Trim whitespace or specific character.
## Signature diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 3bacadacc5b..03db15b3f8a 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Make text uppercase. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `str upcase` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Make text uppercase.
## Signature diff --git a/commands/docs/sys.md b/commands/docs/sys.md index afd8d6c865c..98567df7bc6 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.91.0 +version: 0.92.0 system: | View information about the system. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `sys` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
View information about the system.
## Signature diff --git a/commands/docs/table.md b/commands/docs/table.md index a42bf12ad8e..74f502dc747 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.91.0 +version: 0.92.0 viewers: | Render the table. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for viewers +# `table` for [viewers](/commands/categories/viewers.md) -
{{ $frontmatter.viewers }}
+
Render the table.
## Signature diff --git a/commands/docs/take.md b/commands/docs/take.md index f3ff73acfdd..b9765024a98 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `take` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Take only the first n elements of a list, or the first n bytes of a binary value.
## Signature diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 3671f072c67..fc76376aedd 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Take elements of the input until a predicate is true. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `take until` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Take elements of the input until a predicate is true.
## Signature diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index f2a9005fe39..37abf215c7b 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Take elements of the input while a predicate is true. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `take while` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Take elements of the input while a predicate is true.
## Signature diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 50371887704..19bd9e5ebe2 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Copy a stream to another command in parallel. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `tee` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Copy a stream to another command in parallel.
## Signature @@ -44,7 +44,7 @@ Save a webpage to a file while also printing it Save error messages from an external command to a file without redirecting them ```nu -> do { nu --commands 'print -e error; print ok' } | tee --stderr { save error.log } | complete +> nu -c 'print -e error; print ok' | tee --stderr { save error.log } | complete ``` diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index eded313933c..929582ab0c1 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `term size` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Returns a record containing the number of columns (width) and rows (height) of the terminal.
## Signature diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index 548fbc8fea7..6673665eb74 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Time the running time of a block. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `timeit` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Time the running time of a block.
## Signature diff --git a/commands/docs/to.md b/commands/docs/to.md index 31eab5b84d4..f94773277de 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Translate structured data to a format. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Translate structured data to a format.
## Signature diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 9ff53068c04..e4bb3a4e012 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert table into .csv text . usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to csv` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert table into .csv text .
## Signature diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index badfd21fd25..6672a30ff40 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,23 +2,19 @@ title: to html categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert table into simple HTML. usage: | Convert table into simple HTML. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for formats +# `to html` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert table into simple HTML.
- -::: warning - Command `to html` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> to html {flags} ``` @@ -35,10 +31,10 @@ feature: extra ## Input/output types: -| input | output | -| ----- | ------ | -| any | string | - +| input | output | +| ------- | ------ | +| any | string | +| nothing | any | ## Examples Outputs an HTML string representing the contents of this table diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index b605ded4920..85916570b2b 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Converts table data into JSON text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to json` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Converts table data into JSON text.
## Signature diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 0ce0fdbaaa5..d76edf88649 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert table into simple Markdown. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to md` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert table into simple Markdown.
## Signature diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 8faf11a0252..53704570260 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to nuon` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Converts table data into Nuon (Nushell Object Notation) text.
## Signature diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 76e60d4f366..41b82766dc9 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Converts data into simple text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to text` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Converts data into simple text.
## Signature diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 2d3adf580ea..0de33642287 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert record into .toml text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to toml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert record into .toml text.
## Signature diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 5679b54d960..340a0fec246 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert table into .tsv text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to tsv` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert table into .tsv text.
## Signature diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 7c45d05c23b..af73f22d638 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert special record structure into .xml text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to xml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert special record structure into .xml text.
## Signature diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 0690c233f27..43db1567096 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.91.0 +version: 0.92.0 formats: | Convert table into .yaml/.yml text. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for formats +# `to yaml` for [formats](/commands/categories/formats.md) -
{{ $frontmatter.formats }}
+
Convert table into .yaml/.yml text.
## Signature diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 0a898933f49..53b2e9de703 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Creates one or more files. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `touch` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Creates one or more files.
## Signature diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index a39e0cb5a6d..bdc87bc1dee 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `transpose` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Transposes the table contents so rows become columns and columns become rows.
## Signature diff --git a/commands/docs/try.md b/commands/docs/try.md index ec1fd58a107..e883dc0f678 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.91.0 +version: 0.92.0 core: | Try to run a block, if it fails optionally run a catch block. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `try` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Try to run a block, if it fails optionally run a catch block.
## Signature diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 05d14493554..57a42e7f50e 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.91.0 +version: 0.92.0 misc: | Run the tutorial. To begin, run: tutor. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for misc +# `tutor` for [misc](/commands/categories/misc.md) -
{{ $frontmatter.misc }}
+
Run the tutorial. To begin, run: tutor.
## Signature diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 11bac6981e7..ef336892a29 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Set or get resource usage limits. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `ulimit` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Set or get resource usage limits.
## Signature diff --git a/commands/docs/uname.md b/commands/docs/uname.md new file mode 100644 index 00000000000..107d2efda88 --- /dev/null +++ b/commands/docs/uname.md @@ -0,0 +1,35 @@ +--- +title: uname +categories: | + system +version: 0.92.0 +system: | + Print certain system information using uutils/coreutils uname. +usage: | + Print certain system information using uutils/coreutils uname. +feature: default +--- + + +# `uname` for [system](/commands/categories/system.md) + +
Print certain system information using uutils/coreutils uname.
+ +## Signature + +```> uname {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +Print all information +```nu +> uname + +``` diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index 29d6e88904b..77eb07e852a 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Return the distinct values in the input by the given column(s). usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `uniq-by` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Return the distinct values in the input by the given column(s).
## Signature diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index aa33260c849..649de3b07ba 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Return the distinct values in the input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `uniq` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Return the distinct values in the input.
## Signature diff --git a/commands/docs/update.md b/commands/docs/update.md index 2d99d8fa94b..d1d86c4a374 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Update an existing column to have a new value. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `update` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Update an existing column to have a new value.
## Signature @@ -54,7 +54,7 @@ Use a closure to alter each value in the 'authors' column to a single string ``` -You can also use a simple command to update 'authors' to a single string +Implicitly use the `$in` value in a closure to update 'authors' ```nu > [[project, authors]; ['nu', ['Andrés', 'JT', 'Yehuda']]] | update authors { str join ',' } ╭───┬─────────┬──────────────────╮ @@ -87,6 +87,10 @@ Use a closure to compute a new value at an index ``` +## Notes +When updating a column, the closure will be run for each row, and the current row will be passed as the first argument. Referencing `$in` inside the closure will provide the value at the column for the current row. + +When updating a specific index, the closure will instead be run once. The first argument to the closure and the `$in` value will both be the current value at the index. ## Subcommands: diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index 94ee4e93ef7..ba8a8936322 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,23 +2,19 @@ title: update cells categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Update the table cells. usage: | Update the table cells. -feature: extra +feature: default --- -# {{ $frontmatter.title }} for filters +# `update cells` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Update the table cells.
- -::: warning - Command `update cells` was not included in the official binaries by default, you have to build it with `--features=extra` flag -::: ## Signature ```> update cells {flags} (closure)``` diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 63539baea40..a8beb7583e4 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `upsert` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Update an existing column to have a new value, or insert a new column.
## Signature @@ -113,3 +113,8 @@ Upsert into a list, inserting a new value at the end ╰───┴───╯ ``` + +## Notes +When updating or inserting a column, the closure will be run for each row, and the current row will be passed as the first argument. Referencing `$in` inside the closure will provide the value at the column for the current row or null if the column does not exist. + +When updating a specific index, the closure will instead be run once. The first argument to the closure and the `$in` value will both be the current value at the index. If the command is inserting at the end of a list or table, then both of these values will be null. \ No newline at end of file diff --git a/commands/docs/url.md b/commands/docs/url.md index 736092980bd..e05e4a2690c 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.91.0 +version: 0.92.0 network: | Various commands for working with URLs. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `url` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Various commands for working with URLs.
## Signature diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index b8f0070f7bd..1c96f7b8685 100644 --- a/commands/docs/url_build-query.md +++ b/commands/docs/url_build-query.md @@ -2,7 +2,7 @@ title: url build-query categories: | network -version: 0.91.0 +version: 0.92.0 network: | Converts record or table into query string applying percent-encoding. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `url build-query` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Converts record or table into query string applying percent-encoding.
## Signature diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index 3db5e3fae1c..e462d7dc039 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Converts a percent-encoded web safe string to a string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `url decode` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Converts a percent-encoded web safe string to a string.
## Signature diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index fa6f82c3207..b09855cac6e 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.91.0 +version: 0.92.0 strings: | Converts a string to a percent encoded web safe string. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for strings +# `url encode` for [strings](/commands/categories/strings.md) -
{{ $frontmatter.strings }}
+
Converts a string to a percent encoded web safe string.
## Signature diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index 56d5a08ab4d..9773e8e153d 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.91.0 +version: 0.92.0 network: | Converts a record to url. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `url join` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Converts a record to url.
## Signature diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index f6dc57962da..bbdcee7483f 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.91.0 +version: 0.92.0 network: | Parses a url. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for network +# `url parse` for [network](/commands/categories/network.md) -
{{ $frontmatter.network }}
+
Parses a url.
## Signature diff --git a/commands/docs/use.md b/commands/docs/use.md index ac4bfd669e4..e67a48a8605 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.91.0 +version: 0.92.0 core: | Use definitions from a module, making them available in your shell. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `use` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Use definitions from a module, making them available in your shell.
## Signature diff --git a/commands/docs/values.md b/commands/docs/values.md index 8f239e77763..b8b0e36bc1c 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Given a record or table, produce a list of its columns' values. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `values` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Given a record or table, produce a list of its columns' values.
## Signature diff --git a/commands/docs/version.md b/commands/docs/version.md index b6194b7a44d..a2d6e49652b 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.91.0 +version: 0.92.0 core: | Display Nu version, and its build configuration. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `version` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Display Nu version, and its build configuration.
## Signature diff --git a/commands/docs/view.md b/commands/docs/view.md index ea50922e45d..741cf20a0d1 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | Various commands for viewing debug information. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `view` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
Various commands for viewing debug information.
## Signature diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 7940cbbf120..62d40b14618 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | View the files registered in nushell's EngineState memory. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `view files` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
View the files registered in nushell's EngineState memory.
## Signature diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index cefffc2ba69..b7566303275 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | View a block, module, or a definition. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `view source` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
View a block, module, or a definition.
## Signature diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index a9320d5ec26..a14b2fd1188 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.91.0 +version: 0.92.0 debug: | View the contents of a span. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for debug +# `view span` for [debug](/commands/categories/debug.md) -
{{ $frontmatter.debug }}
+
View the contents of a span.
## Signature diff --git a/commands/docs/watch.md b/commands/docs/watch.md index 4b23974f692..bb2405d5866 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.91.0 +version: 0.92.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filesystem +# `watch` for [filesystem](/commands/categories/filesystem.md) -
{{ $frontmatter.filesystem }}
+
Watch for file changes and execute Nu code when they happen.
## Signature diff --git a/commands/docs/where.md b/commands/docs/where.md index 674269ba1a1..3f4e6e02a9a 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Filter values based on a row condition. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `where` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Filter values based on a row condition.
## Signature diff --git a/commands/docs/which.md b/commands/docs/which.md index 7ac2243c4ef..1a6656c8d17 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.91.0 +version: 0.92.0 system: | Finds a program file, alias or custom command. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for system +# `which` for [system](/commands/categories/system.md) -
{{ $frontmatter.system }}
+
Finds a program file, alias or custom command.
## Signature diff --git a/commands/docs/while.md b/commands/docs/while.md index 4b9e07fa3cc..9ef79f29ef5 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.91.0 +version: 0.92.0 core: | Conditionally run a block in a loop. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for core +# `while` for [core](/commands/categories/core.md) -
{{ $frontmatter.core }}
+
Conditionally run a block in a loop.
## Signature diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index fefdb0d9e82..933a995e92d 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.91.0 +version: 0.92.0 platform: | Get the current username using uutils/coreutils whoami. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for platform +# `whoami` for [platform](/commands/categories/platform.md) -
{{ $frontmatter.platform }}
+
Get the current username using uutils/coreutils whoami.
## Signature diff --git a/commands/docs/window.md b/commands/docs/window.md index 2b9679ea34d..77453c666e9 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `window` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Creates a sliding window of `window_size` that slide by n rows/elements across input.
## Signature diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index 68e4bca1926..d76b1705adb 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.91.0 +version: 0.92.0 env: | Runs a block with an environment variable set. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for env +# `with-env` for [env](/commands/categories/env.md) -
{{ $frontmatter.env }}
+
Runs a block with an environment variable set.
## Signature diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index f5fbdc1af2a..5437f4dcb52 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Wrap the value into a column. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `wrap` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Wrap the value into a column.
## Signature diff --git a/commands/docs/zip.md b/commands/docs/zip.md index e595036598f..07cd9b4d636 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.91.0 +version: 0.92.0 filters: | Combine a stream with the input. usage: | @@ -11,9 +11,9 @@ feature: default --- -# {{ $frontmatter.title }} for filters +# `zip` for [filters](/commands/categories/filters.md) -
{{ $frontmatter.filters }}
+
Combine a stream with the input.
## Signature @@ -21,7 +21,7 @@ feature: default ## Parameters - - `other`: The other input. + - `other`: The other input, or closure returning a stream. ## Input/output types: diff --git a/make_docs.nu b/make_docs.nu index 88b769ebc7c..b475d4d60fb 100644 --- a/make_docs.nu +++ b/make_docs.nu @@ -1,3 +1,14 @@ +# get all command names from a clean scope +def command-names [] { + nu --no-config-file --commands ' + scope commands | select name + | to json' | from json +} + +def html-escape [] { + to html | parse --regex '(?.*)' | get html.0 +} + # remove invalid characters from a path # # # Examples @@ -91,9 +102,9 @@ feature: ($feature) # TODO: be more detailed here def command-doc [command] { let top = $" -# {{ $frontmatter.title }} for ($command.category) +# `($command.name)` for [($command.category)]\(/commands/categories/($command.category).md\) -
{{ $frontmatter.($command.category | str snake-case) }}
+
($command.usage | html-escape)
" @@ -229,11 +240,11 @@ $"($example.description) } else { '' } let features = if $command.name =~ '^dfr' { - $'(char nl)::: warning(char nl)Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag(char nl):::(char nl)' + $'::: warning(char nl)Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag(char nl):::(char nl)(char nl)' } else { '' } let plugins = if $command.name in ['from ini', 'from ics', 'from eml', 'from vcf'] { - $"(char nl)::: warning(char nl)Command `($command.name)` resides in [plugin]\(/book/plugins.html) [`nu_plugin_formats`]\(https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats(char nl):::(char nl)" + $"::: warning(char nl)Command `($command.name)` resides in [plugin]\(/book/plugins.html) [`nu_plugin_formats`]\(https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats(char nl):::(char nl)(char nl)" } else { '' } let doc = ( @@ -342,7 +353,7 @@ $"# ($category | str title-case) Description - {{ command.title }} + {{ command.title }} {{ command.frontmatter.usage }} @@ -361,7 +372,7 @@ def main [] { let commands = ( scope commands - | where is_custom == false and is_extern == false + | join (command-names) name | sort-by category ) let commands_group = ($commands | group-by name)