diff --git a/commands/docs/abbr.md b/commands/docs/abbr.md index e193d27ea40..3994d601116 100644 --- a/commands/docs/abbr.md +++ b/commands/docs/abbr.md @@ -2,7 +2,7 @@ title: abbr categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Abbreviations related commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Abbreviations related commands.
+## Command Type + +`built-in` + ## Signature ```> abbr {flags} ``` diff --git a/commands/docs/abbr_list.md b/commands/docs/abbr_list.md index 1393dfdf89d..23426081e44 100644 --- a/commands/docs/abbr_list.md +++ b/commands/docs/abbr_list.md @@ -2,7 +2,7 @@ title: abbr list categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | List all defined abbreviations. usage: | @@ -16,6 +16,10 @@ contributors: false
List all defined abbreviations.
+## Command Type + +`built-in` + ## Signature ```> abbr list {flags} ``` diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 0e802a3ddd1..c6d85809ab5 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.115.0 +version: 0.115.1 core: | Alias a command (with optional flags) to a new name. usage: | @@ -16,6 +16,10 @@ contributors: false
Alias a command (with optional flags) to a new name.
+## Command Type + +`keyword` + ## Signature ```> alias {flags} (name) (initial_value)``` diff --git a/commands/docs/all.md b/commands/docs/all.md index 5e6da29de87..9ab967b231d 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Test if every element of the input fulfills a predicate expression. usage: | @@ -16,6 +16,10 @@ contributors: false
Test if every element of the input fulfills a predicate expression.
+## Command Type + +`built-in` + ## Signature ```> all {flags} (predicate)``` diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index b59f774911a..4aa45ede4ee 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Output ANSI codes to change color and style of text. usage: | @@ -16,6 +16,10 @@ contributors: false
Output ANSI codes to change color and style of text.
+## Command Type + +`built-in` + ## Signature ```> ansi {flags} (code)``` diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index 691f3e5d6e0..520cfa4b3ea 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | @@ -16,6 +16,10 @@ contributors: false
Add a color gradient (using ANSI color codes) to the given string.
+## Command Type + +`built-in` + ## Signature ```> ansi gradient {flags} ...rest``` diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 351dbf53973..f52364a85e8 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | @@ -16,6 +16,10 @@ contributors: false
Add a link (using OSC 8 escape sequence) to the given string.
+## Command Type + +`built-in` + ## Signature ```> ansi link {flags} ...rest``` diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 024837fdc94..a97daa1175e 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Strip ANSI escape sequences from a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Strip ANSI escape sequences from a string.
+## Command Type + +`built-in` + ## Signature ```> ansi strip {flags} ...rest``` diff --git a/commands/docs/any.md b/commands/docs/any.md index 7bd2d8d0384..1476daf23b1 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Tests if any element of the input fulfills a predicate expression. usage: | @@ -16,6 +16,10 @@ contributors: false
Tests if any element of the input fulfills a predicate expression.
+## Command Type + +`built-in` + ## Signature ```> any {flags} (predicate)``` diff --git a/commands/docs/append.md b/commands/docs/append.md index 2cbe659530f..7b7bba1397f 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Append any number of rows to a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Append any number of rows to a table.
+## Command Type + +`built-in` + ## Signature ```> append {flags} (row) ...rest``` diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 447f9827707..21024e74ebd 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Print the abstract syntax tree (ast) for a pipeline.
+## Command Type + +`built-in` + ## Signature ```> ast {flags} (pipeline)``` diff --git a/commands/docs/attr.md b/commands/docs/attr.md index 79e0022f64c..0c61a016fcf 100644 --- a/commands/docs/attr.md +++ b/commands/docs/attr.md @@ -2,7 +2,7 @@ title: attr categories: | core -version: 0.115.0 +version: 0.115.1 core: | Various attributes for custom commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Various attributes for custom commands.
+## Command Type + +`built-in` + ## Signature ```> attr {flags} ``` diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md index fea32eeb391..a96540edcd2 100644 --- a/commands/docs/attr_category.md +++ b/commands/docs/attr_category.md @@ -2,7 +2,7 @@ title: attr category categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for adding a category to custom commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for adding a category to custom commands.
+## Command Type + +`built-in` + ## Signature ```> attr category {flags} (category)``` diff --git a/commands/docs/attr_complete.md b/commands/docs/attr_complete.md index 8963ddcd29e..ca0d62a05be 100644 --- a/commands/docs/attr_complete.md +++ b/commands/docs/attr_complete.md @@ -2,7 +2,7 @@ title: attr complete categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for using another command as a completion source for all arguments. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for using another command as a completion source for all arguments.
+## Command Type + +`built-in` + ## Signature ```> attr complete {flags} (completer)``` diff --git a/commands/docs/attr_complete_external.md b/commands/docs/attr_complete_external.md index 17181c1a78e..aa6f55c69d6 100644 --- a/commands/docs/attr_complete_external.md +++ b/commands/docs/attr_complete_external.md @@ -2,7 +2,7 @@ title: attr complete external categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for enabling use of the external completer for internal commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for enabling use of the external completer for internal commands.
+## Command Type + +`built-in` + ## Signature ```> attr complete external {flags} ``` diff --git a/commands/docs/attr_deprecated.md b/commands/docs/attr_deprecated.md index b1758131583..60e1860fd21 100644 --- a/commands/docs/attr_deprecated.md +++ b/commands/docs/attr_deprecated.md @@ -2,7 +2,7 @@ title: attr deprecated categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for marking a command or flag as deprecated. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for marking a command or flag as deprecated.
+## Command Type + +`built-in` + ## Signature ```> attr deprecated {flags} (message)``` diff --git a/commands/docs/attr_example.md b/commands/docs/attr_example.md index e05425d3ad7..ba3ea8083ed 100644 --- a/commands/docs/attr_example.md +++ b/commands/docs/attr_example.md @@ -2,7 +2,7 @@ title: attr example categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for adding examples to custom commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for adding examples to custom commands.
+## Command Type + +`built-in` + ## Signature ```> attr example {flags} (description) (example)``` diff --git a/commands/docs/attr_search-terms.md b/commands/docs/attr_search-terms.md index 95087ec3631..e2ad2850e59 100644 --- a/commands/docs/attr_search-terms.md +++ b/commands/docs/attr_search-terms.md @@ -2,7 +2,7 @@ title: attr search-terms categories: | core -version: 0.115.0 +version: 0.115.1 core: | Attribute for adding search terms to custom commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Attribute for adding search terms to custom commands.
+## Command Type + +`built-in` + ## Signature ```> attr search-terms {flags} ...rest``` diff --git a/commands/docs/banner.md b/commands/docs/banner.md index 9e697125182..fb59a0a2eb8 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.115.0 +version: 0.115.1 default: | Print a banner for Nushell with information about the project usage: | @@ -16,6 +16,10 @@ contributors: false
Print a banner for Nushell with information about the project
+## Command Type + +`custom` + ## Signature ```> banner {flags} ``` diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 8b3bbc5a4e8..fa95a5ac6fb 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Various commands for working with bits. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with bits.
+## Command Type + +`built-in` + ## Signature ```> bits {flags} ``` diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 6741534bddf..f6f7c1545e6 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Performs bitwise and for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Performs bitwise and for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits and {flags} (target)``` diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index 6ace59194db..6804fdfabd5 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Performs logical negation on each bit. usage: | @@ -16,6 +16,10 @@ contributors: false
Performs logical negation on each bit.
+## Command Type + +`built-in` + ## Signature ```> bits not {flags} ``` diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 17df40608d9..51179a20dd1 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Performs bitwise or for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Performs bitwise or for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits or {flags} (target)``` diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 4f3e9e339ce..0da2b59930a 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Bitwise rotate left for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Bitwise rotate left for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits rol {flags} (bits)``` diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 124ee799260..c08d029ff9f 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Bitwise rotate right for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Bitwise rotate right for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits ror {flags} (bits)``` diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 084552eefe0..97136495ac6 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Bitwise shift left for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Bitwise shift left for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits shl {flags} (bits)``` diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index cf3d7d9c1bc..001fc351ba8 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Bitwise shift right for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Bitwise shift right for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits shr {flags} (bits)``` diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index 5b7634d91aa..90308d503f4 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.115.0 +version: 0.115.1 bits: | Performs bitwise xor for ints or binary values. usage: | @@ -16,6 +16,10 @@ contributors: false
Performs bitwise xor for ints or binary values.
+## Command Type + +`built-in` + ## Signature ```> bits xor {flags} (target)``` diff --git a/commands/docs/break.md b/commands/docs/break.md index 541e1784e33..4f5f328946e 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.115.0 +version: 0.115.1 core: | Break a loop. usage: | @@ -16,6 +16,10 @@ contributors: false
Break a loop.
+## Command Type + +`keyword` + ## Signature ```> break {flags} ``` diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 617b682403a..110e1f54162 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Various commands for working with byte data. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with byte data.
+## Command Type + +`built-in` + ## Signature ```> bytes {flags} ``` diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index d2e3bb8d5ba..88a051a3501 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Add specified bytes to the binary input. usage: | @@ -16,6 +16,10 @@ contributors: false
Add specified bytes to the binary input.
+## Command Type + +`built-in` + ## Signature ```> bytes add {flags} (data) ...rest``` diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index d51f6092d25..3ed216bf343 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Get bytes from the input defined by a range. usage: | @@ -16,6 +16,10 @@ contributors: false
Get bytes from the input defined by a range.
+## Command Type + +`built-in` + ## Signature ```> bytes at {flags} (range) ...rest``` diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 80717a5c506..7227327c9f5 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Create a binary value from the provided arguments. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a binary value from the provided arguments.
+## Command Type + +`built-in` + ## Signature ```> bytes build {flags} ...rest``` diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index 72e8910371f..a7962ec34ae 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | @@ -16,6 +16,10 @@ contributors: false
Concatenate multiple binary into a single binary, with an optional separator between each.
+## Command Type + +`built-in` + ## Signature ```> bytes collect {flags} (separator)``` diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 79fa4142c1c..a6677fcf400 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.115.0 +version: 0.115.1 bytes: | Check if binary data ends with a pattern. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if binary data ends with a pattern.
+## Command Type + +`built-in` + ## Signature ```> bytes ends-with {flags} (pattern) ...rest``` diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 221555e4dcc..7e0d46b33c2 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.115.0 +version: 0.115.1 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns start index of first occurrence of pattern in bytes, or -1 if no match.
+## Command Type + +`built-in` + ## Signature ```> bytes index-of {flags} (pattern) ...rest``` diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 19286915865..15c8784939a 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Output the length of any bytes in the pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Output the length of any bytes in the pipeline.
+## Command Type + +`built-in` + ## Signature ```> bytes length {flags} ...rest``` diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index 10c08878ab6..f43214d6917 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Remove specified bytes from the input. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove specified bytes from the input.
+## Command Type + +`built-in` + ## Signature ```> bytes remove {flags} (pattern) ...rest``` diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 80470464bf8..21386b6ce0e 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Find and replace bytes in binary data. usage: | @@ -16,6 +16,10 @@ contributors: false
Find and replace bytes in binary data.
+## Command Type + +`built-in` + ## Signature ```> bytes replace {flags} (find) (replace) ...rest``` diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index ae8a798b0b4..aca5e1db6c5 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Reverse the bytes in the pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Reverse the bytes in the pipeline.
+## Command Type + +`built-in` + ## Signature ```> bytes reverse {flags} ...rest``` diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index 169ec91d252..02d42ddfb5a 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.115.0 +version: 0.115.1 bytes: | Split input into multiple items using a separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split input into multiple items using a separator.
+## Command Type + +`built-in` + ## Signature ```> bytes split {flags} (separator)``` diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index a39e6fbdf2e..6632ddf3493 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.115.0 +version: 0.115.1 bytes: | Check if binary data starts with a pattern. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if binary data starts with a pattern.
+## Command Type + +`built-in` + ## Signature ```> bytes starts-with {flags} (pattern) ...rest``` diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 8fdd0c8e430..1220d9e1bef 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.115.0 +version: 0.115.1 generators: | Display a calendar. usage: | @@ -16,6 +16,10 @@ contributors: false
Display a calendar.
+## Command Type + +`built-in` + ## Signature ```> cal {flags} ``` diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 2e50d8b0318..901c828885c 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Change the current working directory. usage: | @@ -16,6 +16,10 @@ contributors: false
Change the current working directory.
+## Command Type + +`built-in` + ## Signature ```> cd {flags} (path)``` diff --git a/commands/docs/char.md b/commands/docs/char.md index 57fa4638e70..19afcd4f6a9 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Output special characters (e.g., 'newline'). usage: | @@ -16,6 +16,10 @@ contributors: false
Output special characters (e.g., 'newline').
+## Command Type + +`built-in` + ## Signature ```> char {flags} (character) ...rest``` diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index d993fbf7084..f583c5ab7cf 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Divides a sequence into sub-sequences based on a closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Divides a sequence into sub-sequences based on a closure.
+## Command Type + +`built-in` + ## Signature ```> chunk-by {flags} (closure)``` diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index 30a253d8a6e..f127a6e7970 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Divide a list, table or binary input into chunks of `chunk_size`. For binary input, `chunk_size` can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Divide a list, table or binary input into chunks of `chunk_size`. For binary input, `chunk_size` can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> chunks {flags} (chunk_size)``` diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 40f2a7691bb..1b56d8d4608 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Clear the terminal screen. usage: | @@ -16,6 +16,10 @@ contributors: false
Clear the terminal screen.
+## Command Type + +`built-in` + ## Signature ```> clear {flags} ``` diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 0bc63b34b0a..1440a4710a5 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | core -version: 0.115.0 +version: 0.115.1 core: | Collect a stream into a value. usage: | @@ -16,6 +16,10 @@ contributors: false
Collect a stream into a value.
+## Command Type + +`keyword` + ## Signature ```> collect {flags} (closure)``` diff --git a/commands/docs/columns.md b/commands/docs/columns.md index c4bbf82f453..879d12ec773 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Given a record or table, produce a list of its columns' names. usage: | @@ -16,6 +16,10 @@ contributors: false
Given a record or table, produce a list of its columns' names.
+## Command Type + +`built-in` + ## Signature ```> columns {flags} ``` diff --git a/commands/docs/combinations.md b/commands/docs/combinations.md index b116317a304..8d909cd6c2f 100644 --- a/commands/docs/combinations.md +++ b/commands/docs/combinations.md @@ -2,7 +2,7 @@ title: combinations categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Generates all combinations of size k from the input list. usage: | @@ -16,6 +16,10 @@ contributors: false
Generates all combinations of size k from the input list.
+## Command Type + +`built-in` + ## Signature ```> combinations {flags} (k)``` diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index 9f1b318e5b4..9ed5395fecc 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.115.0 +version: 0.115.1 core: | View the current command line input buffer. usage: | @@ -16,6 +16,10 @@ contributors: false
View the current command line input buffer.
+## Command Type + +`built-in` + ## Signature ```> commandline {flags} ``` diff --git a/commands/docs/commandline_complete.md b/commands/docs/commandline_complete.md index de07c974a68..aa681aae21a 100644 --- a/commands/docs/commandline_complete.md +++ b/commands/docs/commandline_complete.md @@ -2,7 +2,7 @@ title: commandline complete categories: | core -version: 0.115.0 +version: 0.115.1 core: | Complete a string using the default completions. usage: | @@ -16,6 +16,10 @@ contributors: false
Complete a string using the default completions.
+## Command Type + +`built-in` + ## Signature ```> commandline complete {flags} ``` diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index 03a97e5cc2e..d23eab913b8 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.115.0 +version: 0.115.1 core: | Modify the current command line input buffer. usage: | @@ -16,6 +16,10 @@ contributors: false
Modify the current command line input buffer.
+## Command Type + +`built-in` + ## Signature ```> commandline edit {flags} (str)``` diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 20cc96fc05b..00df305035a 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.115.0 +version: 0.115.1 core: | Get the current cursor position. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the current cursor position.
+## Command Type + +`built-in` + ## Signature ```> commandline get-cursor {flags} ``` diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index d4aa89e18fc..c41ce80a47b 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.115.0 +version: 0.115.1 core: | Set the current cursor position. usage: | @@ -16,6 +16,10 @@ contributors: false
Set the current cursor position.
+## Command Type + +`built-in` + ## Signature ```> commandline set-cursor {flags} (pos)``` diff --git a/commands/docs/commandline_set-prompt.md b/commands/docs/commandline_set-prompt.md index 1cf20eb9143..f7189b65065 100644 --- a/commands/docs/commandline_set-prompt.md +++ b/commands/docs/commandline_set-prompt.md @@ -2,7 +2,7 @@ title: commandline set-prompt categories: | core -version: 0.115.0 +version: 0.115.1 core: | Replace the current prompt and repaint it in place, without disturbing the line being edited. usage: | @@ -16,6 +16,10 @@ contributors: false
Replace the current prompt and repaint it in place, without disturbing the line being edited.
+## Command Type + +`built-in` + ## Signature ```> commandline set-prompt {flags} (prompt)``` diff --git a/commands/docs/compact.md b/commands/docs/compact.md index fffdfcbd13d..9821cb2a996 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Creates a table with non-empty rows. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates a table with non-empty rows.
+## Command Type + +`built-in` + ## Signature ```> compact {flags} ...rest``` diff --git a/commands/docs/complete.md b/commands/docs/complete.md index ff81f4646f4..20a0977b31f 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.115.0 +version: 0.115.1 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | @@ -16,6 +16,10 @@ contributors: false
Capture the outputs and exit code from an external piped in command in a nushell table.
+## Command Type + +`built-in` + ## Signature ```> complete {flags} ``` diff --git a/commands/docs/config.md b/commands/docs/config.md index 3359bc42eac..51451d05925 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.115.0 +version: 0.115.1 env: | Edit nushell configuration files. usage: | @@ -16,6 +16,10 @@ contributors: false
Edit nushell configuration files.
+## Command Type + +`built-in` + ## Signature ```> config {flags} ``` diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index be29c41321b..803be68f2d9 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.115.0 +version: 0.115.1 env: | Edit nu environment configurations. usage: | @@ -16,6 +16,10 @@ contributors: false
Edit nu environment configurations.
+## Command Type + +`built-in` + ## Signature ```> config env {flags} ``` diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index 7109539b704..386df888701 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Show the current configuration in a flattened form. usage: | @@ -16,6 +16,10 @@ contributors: false
Show the current configuration in a flattened form.
+## Command Type + +`built-in` + ## Signature ```> config flatten {flags} ``` diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 451b8cd82a1..ccacbc7e176 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.115.0 +version: 0.115.1 env: | Edit nu configurations. usage: | @@ -16,6 +16,10 @@ contributors: false
Edit nu configurations.
+## Command Type + +`built-in` + ## Signature ```> config nu {flags} ``` diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 4ebeaf0b58c..9c656a2db3e 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.115.0 +version: 0.115.1 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | @@ -16,6 +16,10 @@ contributors: false
Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu.
+## Command Type + +`built-in` + ## Signature ```> config reset {flags} ``` diff --git a/commands/docs/config_use-colors.md b/commands/docs/config_use-colors.md index bbcc9307aa7..8b8ecd4ccaf 100644 --- a/commands/docs/config_use-colors.md +++ b/commands/docs/config_use-colors.md @@ -2,7 +2,7 @@ title: config use-colors categories: | env -version: 0.115.0 +version: 0.115.1 env: | Get the configuration for color output. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the configuration for color output.
+## Command Type + +`built-in` + ## Signature ```> config use-colors {flags} ``` diff --git a/commands/docs/const.md b/commands/docs/const.md index bec50fb771f..d8c15082331 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.115.0 +version: 0.115.1 core: | Create a parse-time constant. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a parse-time constant.
+## Command Type + +`keyword` + ## Signature ```> const {flags} (const_name) (initial_value)``` diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 276c3f698b9..c194d862bfb 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.115.0 +version: 0.115.1 core: | Continue a loop from the next iteration. usage: | @@ -16,6 +16,10 @@ contributors: false
Continue a loop from the next iteration.
+## Command Type + +`keyword` + ## Signature ```> continue {flags} ``` diff --git a/commands/docs/cp.md b/commands/docs/cp.md index a6bc8f9ddf9..82e8a7aac5d 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Copy files using uutils/coreutils cp. usage: | @@ -16,6 +16,10 @@ contributors: false
Copy files using uutils/coreutils cp.
+## Command Type + +`built-in` + ## Signature ```> cp {flags} ...rest``` diff --git a/commands/docs/date.md b/commands/docs/date.md index 4cf97fc9de5..203bb435c1c 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.115.0 +version: 0.115.1 date: | Date-related commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Date-related commands.
+## Command Type + +`built-in` + ## Signature ```> date {flags} ``` diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index fe9037a1dd4..3aaf8b2abaf 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.115.0 +version: 0.115.1 removed: | Removed command: use `format date` instead. usage: | @@ -16,6 +16,10 @@ contributors: false
Removed command: use `format date` instead.
+## Command Type + +`built-in` + ## Signature ```> date format {flags} (format string)``` diff --git a/commands/docs/date_from-human.md b/commands/docs/date_from-human.md index b3faccc45b8..96fd53ef96e 100644 --- a/commands/docs/date_from-human.md +++ b/commands/docs/date_from-human.md @@ -2,7 +2,7 @@ title: date from-human categories: | date -version: 0.115.0 +version: 0.115.1 date: | Convert a human readable datetime string to a datetime. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a human readable datetime string to a datetime.
+## Command Type + +`built-in` + ## Signature ```> date from-human {flags} ``` diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index a0e7c5c0c23..4c75ea6d841 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.115.0 +version: 0.115.1 date: | Print a 'humanized' format for the date, relative to now. usage: | @@ -16,6 +16,10 @@ contributors: false
Print a 'humanized' format for the date, relative to now.
+## Command Type + +`built-in` + ## Signature ```> date humanize {flags} ``` diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index e068aee7424..75127773be7 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.115.0 +version: 0.115.1 date: | List supported time zones. usage: | @@ -16,6 +16,10 @@ contributors: false
List supported time zones.
+## Command Type + +`built-in` + ## Signature ```> date list-timezone {flags} ``` diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 1cf68b59a4a..dcf3133209b 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.115.0 +version: 0.115.1 date: | Get the current date. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the current date.
+## Command Type + +`built-in` + ## Signature ```> date now {flags} ``` diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 1ef185501fe..d9c04306b7b 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.115.0 +version: 0.115.1 date: | Convert a date to a given time zone. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a date to a given time zone.
+## Command Type + +`built-in` + ## Signature ```> date to-timezone {flags} (time zone)``` diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 16affae35ed..b487a77ef2a 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Debug print the value(s) piped in. usage: | @@ -16,6 +16,10 @@ contributors: false
Debug print the value(s) piped in.
+## Command Type + +`built-in` + ## Signature ```> debug {flags} ``` diff --git a/commands/docs/debug_env.md b/commands/docs/debug_env.md index 2259aad8f63..925909e0697 100644 --- a/commands/docs/debug_env.md +++ b/commands/docs/debug_env.md @@ -2,7 +2,7 @@ title: debug env categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Show environment variables as external commands would get it. usage: | @@ -16,6 +16,10 @@ contributors: false
Show environment variables as external commands would get it.
+## Command Type + +`built-in` + ## Signature ```> debug env {flags} ``` diff --git a/commands/docs/debug_experimental-options.md b/commands/docs/debug_experimental-options.md index 94bddfaaf89..705eb822069 100644 --- a/commands/docs/debug_experimental-options.md +++ b/commands/docs/debug_experimental-options.md @@ -2,7 +2,7 @@ title: debug experimental-options categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Show all experimental options. usage: | @@ -16,6 +16,10 @@ contributors: false
Show all experimental options.
+## Command Type + +`built-in` + ## Signature ```> debug experimental-options {flags} ``` diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 5ae231497f8..058b454abde 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View process memory info. usage: | @@ -16,6 +16,10 @@ contributors: false
View process memory info.
+## Command Type + +`built-in` + ## Signature ```> debug info {flags} ``` diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 62778723d54..2df775b2560 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Profile pipeline elements in a closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Profile pipeline elements in a closure.
+## Command Type + +`built-in` + ## Signature ```> debug profile {flags} (closure)``` diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 715ab8b704e..d005df87fff 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Decode bytes into a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Decode bytes into a string.
+## Command Type + +`built-in` + ## Signature ```> decode {flags} (encoding)``` diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 67a18035a94..80c000628cf 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Decode a Base32-encoded value. usage: | @@ -16,6 +16,10 @@ contributors: false
Decode a Base32-encoded value.
+## Command Type + +`built-in` + ## Signature ```> decode base32 {flags} ``` diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 63b8dd80ec0..4f58c885787 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Encode a base32hex value. usage: | @@ -16,6 +16,10 @@ contributors: false
Encode a base32hex value.
+## Command Type + +`built-in` + ## Signature ```> decode base32hex {flags} ``` diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 01f30a4476d..a26fd1d475f 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Decode a Base64-encoded value. usage: | @@ -16,6 +16,10 @@ contributors: false
Decode a Base64-encoded value.
+## Command Type + +`built-in` + ## Signature ```> decode base64 {flags} ``` diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 35c5b8dacaa..ad5993c77c8 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Decode a hex-encoded value. usage: | @@ -16,6 +16,10 @@ contributors: false
Decode a hex-encoded value.
+## Command Type + +`built-in` + ## Signature ```> decode hex {flags} ``` diff --git a/commands/docs/def.md b/commands/docs/def.md index 1d92ba1cf02..c424a95151b 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.115.0 +version: 0.115.1 core: | Define a custom command. usage: | @@ -16,6 +16,10 @@ contributors: false
Define a custom command.
+## Command Type + +`keyword` + ## Signature ```> def {flags} (def_name) (params) (block)``` diff --git a/commands/docs/default.md b/commands/docs/default.md index 73b45029b25..66b3d70809b 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Sets a default value if a row's column is missing or null. usage: | @@ -16,6 +16,10 @@ contributors: false
Sets a default value if a row's column is missing or null.
+## Command Type + +`built-in` + ## Signature ```> default {flags} (default value) ...rest``` diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 3395fed95b2..a7fab28a7da 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.115.0 +version: 0.115.1 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -16,6 +16,10 @@ contributors: false
Describe the type and structure of the value(s) piped in.
+## Command Type + +`built-in` + ## Signature ```> describe {flags} ``` diff --git a/commands/docs/detect.md b/commands/docs/detect.md index aec60c0a337..dac5ebb4672 100644 --- a/commands/docs/detect.md +++ b/commands/docs/detect.md @@ -2,7 +2,7 @@ title: detect categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Various commands for detecting things. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for detecting things.
+## Command Type + +`built-in` + ## Signature ```> detect {flags} ``` diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 684c196ed08..d86be32ad75 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Attempt to automatically split text into multiple columns. usage: | @@ -16,6 +16,10 @@ contributors: false
Attempt to automatically split text into multiple columns.
+## Command Type + +`built-in` + ## Signature ```> detect columns {flags} ``` diff --git a/commands/docs/detect_type.md b/commands/docs/detect_type.md index 2ebf0ead75e..305d526484e 100644 --- a/commands/docs/detect_type.md +++ b/commands/docs/detect_type.md @@ -2,7 +2,7 @@ title: detect type categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Infer Nushell datatype from a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Infer Nushell datatype from a string.
+## Command Type + +`built-in` + ## Signature ```> detect type {flags} ``` diff --git a/commands/docs/difference.md b/commands/docs/difference.md index 589d61b6696..33a4bbafa79 100644 --- a/commands/docs/difference.md +++ b/commands/docs/difference.md @@ -2,7 +2,7 @@ title: difference categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Returns a list of unique elements in the input that are not present in the other list. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns a list of unique elements in the input that are not present in the other list.
+## Command Type + +`built-in` + ## Signature ```> difference {flags} (other)``` diff --git a/commands/docs/do.md b/commands/docs/do.md index 06ea62a758b..b20fb45bc00 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.115.0 +version: 0.115.1 core: | Run a closure, providing it with the pipeline input. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a closure, providing it with the pipeline input.
+## Command Type + +`built-in` + ## Signature ```> do {flags} (closure) ...rest``` diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 5a19212fc12..53c57d6f664 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Remove items/rows from the end of the input list/table, or remove bytes from the end of binary data. Counterpart of `skip`. Opposite of `last`. For binary input, `rows` can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove items/rows from the end of the input list/table, or remove bytes from the end of binary data. Counterpart of `skip`. Opposite of `last`. For binary input, `rows` can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> drop {flags} (rows)``` diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index b086dac64cf..089f6a5d919 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`.
+## Command Type + +`built-in` + ## Signature ```> drop column {flags} (columns)``` diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index 73ba85c0cde..529909d0956 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Drop the selected rows. usage: | @@ -16,6 +16,10 @@ contributors: false
Drop the selected rows.
+## Command Type + +`built-in` + ## Signature ```> drop nth {flags} ...rest``` diff --git a/commands/docs/du.md b/commands/docs/du.md index 0f2455a2af6..7fb78642131 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Find disk usage sizes of specified items. usage: | @@ -16,6 +16,10 @@ contributors: false
Find disk usage sizes of specified items.
+## Command Type + +`built-in` + ## Signature ```> du {flags} ...rest``` diff --git a/commands/docs/each.md b/commands/docs/each.md index 0eb84b97f4c..0f533e8b8f3 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a closure on each row of the input list, creating a new list with the results.
+## Command Type + +`built-in` + ## Signature ```> each {flags} (closure)``` diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index e0d83d2f0bf..2e57a7bb025 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a closure on each row of the input list until a null is found, then create a new list with the results.
+## Command Type + +`built-in` + ## Signature ```> each while {flags} (closure)``` diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 5dfab3f1cd6..454dfaf7408 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.115.0 +version: 0.115.1 core: | Returns its arguments, ignoring the piped-in value. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns its arguments, ignoring the piped-in value.
+## Command Type + +`built-in` + ## Signature ```> echo {flags} ...rest``` diff --git a/commands/docs/encode.md b/commands/docs/encode.md index e6e8cedcda7..79e7775cc69 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Encode a string into bytes. usage: | @@ -16,6 +16,10 @@ contributors: false
Encode a string into bytes.
+## Command Type + +`built-in` + ## Signature ```> encode {flags} (encoding)``` diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index c1c36c92387..8b20ff52c9f 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Encode a string or binary value using Base32. usage: | @@ -16,6 +16,10 @@ contributors: false
Encode a string or binary value using Base32.
+## Command Type + +`built-in` + ## Signature ```> encode base32 {flags} ``` diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md index 0d25a169599..ae577e710ce 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Encode a binary value or a string using base32hex. usage: | @@ -16,6 +16,10 @@ contributors: false
Encode a binary value or a string using base32hex.
+## Command Type + +`built-in` + ## Signature ```> encode base32hex {flags} ``` diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 2dab1d21c84..50e22f52534 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Encode a string or binary value using Base64. usage: | @@ -16,6 +16,10 @@ contributors: false
Encode a string or binary value using Base64.
+## Command Type + +`built-in` + ## Signature ```> encode base64 {flags} ``` diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 5ee704ef378..7d77a674851 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Hex encode a binary value or a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Hex encode a binary value or a string.
+## Command Type + +`built-in` + ## Signature ```> encode hex {flags} ``` diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 1f1c5352491..0ca73b4db23 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Enumerate the elements in a stream. usage: | @@ -16,6 +16,10 @@ contributors: false
Enumerate the elements in a stream.
+## Command Type + +`built-in` + ## Signature ```> enumerate {flags} ``` diff --git a/commands/docs/error.md b/commands/docs/error.md index b2c1afd4031..8a07bba0fba 100644 --- a/commands/docs/error.md +++ b/commands/docs/error.md @@ -2,7 +2,7 @@ title: error categories: | core -version: 0.115.0 +version: 0.115.1 core: | Various commands for working with errors. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with errors.
+## Command Type + +`built-in` + ## Signature ```> error {flags} ``` diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index b9827eb4bcb..51e89130296 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.115.0 +version: 0.115.1 core: | Create an error. usage: | @@ -16,6 +16,10 @@ contributors: false
Create an error.
+## Command Type + +`built-in` + ## Signature ```> error make {flags} (error_struct)``` diff --git a/commands/docs/every.md b/commands/docs/every.md index cff5d8a212c..0f545f8a43c 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Show (or skip) every n-th row, starting from the first one. usage: | @@ -16,6 +16,10 @@ contributors: false
Show (or skip) every n-th row, starting from the first one.
+## Command Type + +`built-in` + ## Signature ```> every {flags} (stride)``` diff --git a/commands/docs/exec.md b/commands/docs/exec.md index 8d7d773f7e3..970a9b20822 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.115.0 +version: 0.115.1 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | @@ -16,6 +16,10 @@ contributors: false
Execute a command, replacing or exiting the current process, depending on platform.
+## Command Type + +`built-in` + ## Signature ```> exec {flags} ...rest``` diff --git a/commands/docs/exit.md b/commands/docs/exit.md index c47f89725ad..cf75d1a2143 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.115.0 +version: 0.115.1 shells: | Exit Nu. usage: | @@ -16,6 +16,10 @@ contributors: false
Exit Nu.
+## Command Type + +`built-in` + ## Signature ```> exit {flags} (exit_code)``` diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 9138885f5b0..c882efb2d1c 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Explain closure contents. usage: | @@ -16,6 +16,10 @@ contributors: false
Explain closure contents.
+## Command Type + +`built-in` + ## Signature ```> explain {flags} (closure)``` diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 875cceffc2d..acd32044d08 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.115.0 +version: 0.115.1 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | @@ -16,6 +16,10 @@ contributors: false
Explore acts as a table pager, just like `less` does for text.
+## Command Type + +`built-in` + ## Signature ```> explore {flags} ``` diff --git a/commands/docs/explore_config.md b/commands/docs/explore_config.md index 01d70a659a2..a93d542c66e 100644 --- a/commands/docs/explore_config.md +++ b/commands/docs/explore_config.md @@ -2,7 +2,7 @@ title: explore config categories: | viewers -version: 0.115.0 +version: 0.115.1 viewers: | Launch a TUI to view and edit the nushell configuration interactively. usage: | @@ -16,6 +16,10 @@ contributors: false
Launch a TUI to view and edit the nushell configuration interactively.
+## Command Type + +`built-in` + ## Signature ```> explore config {flags} ``` diff --git a/commands/docs/explore_regex.md b/commands/docs/explore_regex.md index 50726f70667..4b8c1d590e1 100644 --- a/commands/docs/explore_regex.md +++ b/commands/docs/explore_regex.md @@ -2,7 +2,7 @@ title: explore regex categories: | viewers -version: 0.115.0 +version: 0.115.1 viewers: | Launch a TUI to create and explore regular expressions interactively. usage: | @@ -16,6 +16,10 @@ contributors: false
Launch a TUI to create and explore regular expressions interactively.
+## Command Type + +`built-in` + ## Signature ```> explore regex {flags} ``` diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 562dec7e7e7..7873c79d55b 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.115.0 +version: 0.115.1 env: | Run a block and preserve its environment in a current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a block and preserve its environment in a current scope.
+## Command Type + +`keyword` + ## Signature ```> export-env {flags} (block)``` diff --git a/commands/docs/export.md b/commands/docs/export.md index 8e62ba9c4aa..a4d15066d41 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.115.0 +version: 0.115.1 core: | Export definitions or environment variables from a module. usage: | @@ -16,6 +16,10 @@ contributors: false
Export definitions or environment variables from a module.
+## Command Type + +`keyword` + ## Signature ```> export {flags} ``` diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 2f7b5d07a67..73a37c81b38 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.115.0 +version: 0.115.1 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | @@ -16,6 +16,10 @@ contributors: false
Alias a command (with optional flags) to a new name and export it from a module.
+## Command Type + +`keyword` + ## Signature ```> export alias {flags} (name) (initial_value)``` diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index 927fe9d1a1b..31f52a027be 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.115.0 +version: 0.115.1 core: | Use parse-time constant from a module and export them from this module. usage: | @@ -16,6 +16,10 @@ contributors: false
Use parse-time constant from a module and export them from this module.
+## Command Type + +`keyword` + ## Signature ```> export const {flags} (const_name) (initial_value)``` diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index 759eda0e8f5..a8dad394fc3 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.115.0 +version: 0.115.1 core: | Define a custom command and export it from a module. usage: | @@ -16,6 +16,10 @@ contributors: false
Define a custom command and export it from a module.
+## Command Type + +`keyword` + ## Signature ```> export def {flags} (def_name) (params) (block)``` diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index 9d09b1646a5..cb699363b0e 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.115.0 +version: 0.115.1 core: | Define an extern and export it from a module. usage: | @@ -16,6 +16,10 @@ contributors: false
Define an extern and export it from a module.
+## Command Type + +`keyword` + ## Signature ```> export extern {flags} (def_name) (params)``` diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index a69bc2adcab..31ca822dafa 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.115.0 +version: 0.115.1 core: | Export a custom module from a module. usage: | @@ -16,6 +16,10 @@ contributors: false
Export a custom module from a module.
+## Command Type + +`keyword` + ## Signature ```> export module {flags} (module) (block)``` diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index dc9c9747644..b3293fca7a9 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.115.0 +version: 0.115.1 core: | Use definitions from a module and export them from this module. usage: | @@ -16,6 +16,10 @@ contributors: false
Use definitions from a module and export them from this module.
+## Command Type + +`keyword` + ## Signature ```> export use {flags} (module) ...rest``` diff --git a/commands/docs/extern.md b/commands/docs/extern.md index 1fc007e3e96..ab9df7a53d7 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.115.0 +version: 0.115.1 core: | Define a signature for an external command. usage: | @@ -16,6 +16,10 @@ contributors: false
Define a signature for an external command.
+## Command Type + +`keyword` + ## Signature ```> extern {flags} (def_name) (params)``` diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 7f9aa5f5297..ced6a1639cf 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Fill and align text in columns. usage: | @@ -16,6 +16,10 @@ contributors: false
Fill and align text in columns.
+## Command Type + +`built-in` + ## Signature ```> fill {flags} ``` diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 2f7c9ca79cb..1f1cf529aa6 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Filter values based on a predicate closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Filter values based on a predicate closure.
+## Command Type + +`built-in` + ## Signature ```> filter {flags} (closure)``` diff --git a/commands/docs/find.md b/commands/docs/find.md index 4d4fb883318..c369dfaaeff 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Search for terms in the input data. usage: | @@ -16,6 +16,10 @@ contributors: false
Search for terms in the input data.
+## Command Type + +`built-in` + ## Signature ```> find {flags} ...rest``` diff --git a/commands/docs/first.md b/commands/docs/first.md index f7cbb2d1eef..5aa80a9947d 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. For binary input, rows can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. For binary input, rows can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> first {flags} (rows)``` diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 2a3f5ecdfab..6db83a57fd3 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Flatten a table by extracting nested values. usage: | @@ -16,6 +16,10 @@ contributors: false
Flatten a table by extracting nested values.
+## Command Type + +`built-in` + ## Signature ```> flatten {flags} ...rest``` diff --git a/commands/docs/for.md b/commands/docs/for.md index b3f5f23d989..54e16359b5c 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.115.0 +version: 0.115.1 core: | Loop over a range. usage: | @@ -16,6 +16,10 @@ contributors: false
Loop over a range.
+## Command Type + +`keyword` + ## Signature ```> for {flags} (var_name) (range) (block)``` diff --git a/commands/docs/format.md b/commands/docs/format.md index 3c12c081406..feb24876865 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Various commands for formatting data. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for formatting data.
+## Command Type + +`built-in` + ## Signature ```> format {flags} ``` diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index 96635866b41..32ca672145b 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a string of binary data represented by 0 and 1. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a string of binary data represented by 0 and 1.
+## Command Type + +`built-in` + ## Signature ```> format bits {flags} ...rest``` diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 033d5781151..7311568d6d2 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Format a given date using a format string. usage: | @@ -16,6 +16,10 @@ contributors: false
Format a given date using a format string.
+## Command Type + +`built-in` + ## Signature ```> format date {flags} (format string)``` diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index d7dda11275b..4a946b12e86 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Outputs duration with a specified unit of time. usage: | @@ -16,6 +16,10 @@ contributors: false
Outputs duration with a specified unit of time.
+## Command Type + +`built-in` + ## Signature ```> format duration {flags} (format value) ...rest``` diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index b42d7ac7400..fd9eb97c8af 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Converts a column of filesizes to some specified format. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts a column of filesizes to some specified format.
+## Command Type + +`built-in` + ## Signature ```> format filesize {flags} (format value) ...rest``` diff --git a/commands/docs/format_number.md b/commands/docs/format_number.md index f61c10bcb51..5da391b7ab0 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Format a number. usage: | @@ -16,6 +16,10 @@ contributors: false
Format a number.
+## Command Type + +`built-in` + ## Signature ```> format number {flags} ``` diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index b43141e92b7..49d16adae19 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Format columns into a string using a simple pattern. usage: | @@ -16,6 +16,10 @@ contributors: false
Format columns into a string using a simple pattern.
+## Command Type + +`built-in` + ## Signature ```> format pattern {flags} (pattern)``` diff --git a/commands/docs/from.md b/commands/docs/from.md index 3911e8a38f9..ba4d7147954 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse a string or binary data into structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse a string or binary data into structured data.
+## Command Type + +`built-in` + ## Signature ```> from {flags} ``` diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index c993d20d2b8..a7e1f9481c2 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .csv and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .csv and create table.
+## Command Type + +`built-in` + ## Signature ```> from csv {flags} ``` diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index 32fdb7c6f86..74ec9b304d7 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .eml and create record. usage: | @@ -16,6 +16,17 @@ contributors: false
Parse text as .eml and create record.
+::: warning This command requires a plugin +The `from eml` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> from eml {flags} ``` diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index cce8d496fdf..085c0e48fdd 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .ics and create table. usage: | @@ -16,6 +16,17 @@ contributors: false
Parse text as .ics and create table.
+::: warning This command requires a plugin +The `from ics` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> from ics {flags} ``` diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 6874ba34323..693e9217f9a 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .ini and create table. usage: | @@ -16,6 +16,17 @@ contributors: false
Parse text as .ini and create table.
+::: warning This command requires a plugin +The `from ini` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> from ini {flags} ``` diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 1b569554fe9..74193c82d94 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert JSON text into structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert JSON text into structured data.
+## Command Type + +`built-in` + ## Signature ```> from json {flags} ``` diff --git a/commands/docs/from_kdl.md b/commands/docs/from_kdl.md index db815761afb..cfe4051177c 100644 --- a/commands/docs/from_kdl.md +++ b/commands/docs/from_kdl.md @@ -2,7 +2,7 @@ title: from kdl categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert KDL text into structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert KDL text into structured data.
+## Command Type + +`built-in` + ## Signature ```> from kdl {flags} ``` diff --git a/commands/docs/from_md.md b/commands/docs/from_md.md index cd6cbf3acd0..51f2de72de9 100644 --- a/commands/docs/from_md.md +++ b/commands/docs/from_md.md @@ -2,7 +2,7 @@ title: from md categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert markdown text into human-friendly structured rows. Use --verbose for the full AST. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert markdown text into human-friendly structured rows. Use --verbose for the full AST.
+## Command Type + +`built-in` + ## Signature ```> from md {flags} ``` diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 5f52a043b46..d15429d86b2 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert MessagePack data into Nu values. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert MessagePack data into Nu values.
+## Command Type + +`built-in` + ## Signature ```> from msgpack {flags} ``` diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index db8cfee68e0..cf331e3d16c 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert brotli-compressed MessagePack data into Nu values. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert brotli-compressed MessagePack data into Nu values.
+## Command Type + +`built-in` + ## Signature ```> from msgpackz {flags} ``` diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 21b7e1fa938..7eb67d5c29e 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert from nuon to structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert from nuon to structured data.
+## Command Type + +`built-in` + ## Signature ```> from nuon {flags} ``` diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 5ffd3d71b50..ddc5deaeefe 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse OpenDocument Spreadsheet(.ods) data and create table.
+## Command Type + +`built-in` + ## Signature ```> from ods {flags} ``` diff --git a/commands/docs/from_plist.md b/commands/docs/from_plist.md index a2eaab3aac5..d38149ec582 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert plist to Nushell values usage: | @@ -16,6 +16,17 @@ contributors: false
Convert plist to Nushell values
+::: warning This command requires a plugin +The `from plist` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> from plist {flags} ``` diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index bebd70cbb16..43bbf8ad831 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2.
+## Command Type + +`built-in` + ## Signature ```> from ssv {flags} ``` diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 9b3cda7dddd..e1236481075 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .toml and create record. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .toml and create record.
+## Command Type + +`built-in` + ## Signature ```> from toml {flags} ``` diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 00719629e59..54ea2c1367a 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .tsv and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .tsv and create table.
+## Command Type + +`built-in` + ## Signature ```> from tsv {flags} ``` diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 3600090beab..e6143484e21 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse url-encoded string as a record. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse url-encoded string as a record.
+## Command Type + +`built-in` + ## Signature ```> from url {flags} ``` diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index 64e15f2a195..98e88b457e5 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .vcf and create table. usage: | @@ -16,6 +16,17 @@ contributors: false
Parse text as .vcf and create table.
+::: warning This command requires a plugin +The `from vcf` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> from vcf {flags} ``` diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 4fe2249574e..79d0fbbfad9 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse binary Excel(.xlsx) data and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse binary Excel(.xlsx) data and create table.
+## Command Type + +`built-in` + ## Signature ```> from xlsx {flags} ``` diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 6bbe2e14864..2dc40594f26 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .xml and create record. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .xml and create record.
+## Command Type + +`built-in` + ## Signature ```> from xml {flags} ``` diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index e1de23635fc..90a44f289e9 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .yaml/.yml and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .yaml/.yml and create table.
+## Command Type + +`built-in` + ## Signature ```> from yaml {flags} ``` diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index fccfa2fd1d2..68289792f6d 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Parse text as .yaml/.yml and create table. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse text as .yaml/.yml and create table.
+## Command Type + +`built-in` + ## Signature ```> from yml {flags} ``` diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 8ba4df0baa7..b6f1103ccc6 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.115.0 +version: 0.115.1 generators: | Generate a list of values by successively invoking a closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a list of values by successively invoking a closure.
+## Command Type + +`built-in` + ## Signature ```> generate {flags} (closure) (initial)``` diff --git a/commands/docs/get.md b/commands/docs/get.md index 74b7f1db36e..c85060a7691 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Extract data using a cell path. usage: | @@ -16,6 +16,10 @@ contributors: false
Extract data using a cell path.
+## Command Type + +`built-in` + ## Signature ```> get {flags} (cell_path) ...rest``` diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 14392e97df6..24cfd2ee69b 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates a list of files and/or folders based on the glob pattern provided.
+## Command Type + +`built-in` + ## Signature ```> glob {flags} (glob)``` diff --git a/commands/docs/grid.md b/commands/docs/grid.md index ca209981e4c..1621806102e 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.115.0 +version: 0.115.1 viewers: | Renders the output to a textual terminal grid. usage: | @@ -16,6 +16,10 @@ contributors: false
Renders the output to a textual terminal grid.
+## Command Type + +`built-in` + ## Signature ```> grid {flags} (column)``` diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index e732594f3a2..d81a1b30eaa 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | @@ -16,6 +16,10 @@ contributors: false
Splits a list or table into groups, and returns a record containing those groups.
+## Command Type + +`built-in` + ## Signature ```> group-by {flags} ...rest``` diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 79b55959820..0159294119d 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.115.0 +version: 0.115.1 prompt: | Get the git status of a repo usage: | @@ -16,6 +16,17 @@ contributors: false
Get the git status of a repo
+::: warning This command requires a plugin +The `gstat` command resides in the `gstat` plugin. +To use this command, you must install and register `nu_plugin_gstat`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> gstat {flags} (path)``` diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 0f2133d0761..0b99e954d72 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.115.0 +version: 0.115.1 hash: | Apply hash function. usage: | @@ -16,6 +16,10 @@ contributors: false
Apply hash function.
+## Command Type + +`built-in` + ## Signature ```> hash {flags} ``` diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index db87e154701..4d0e6403faf 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.115.0 +version: 0.115.1 hash: | Hash a value using the md5 hash algorithm. usage: | @@ -16,6 +16,10 @@ contributors: false
Hash a value using the md5 hash algorithm.
+## Command Type + +`built-in` + ## Signature ```> hash md5 {flags} ...rest``` diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index bd4dc11bfd8..38cc61488ee 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.115.0 +version: 0.115.1 hash: | Hash a value using the sha256 hash algorithm. usage: | @@ -16,6 +16,10 @@ contributors: false
Hash a value using the sha256 hash algorithm.
+## Command Type + +`built-in` + ## Signature ```> hash sha256 {flags} ...rest``` diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 6ea155e77ae..063a8f72bc0 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Use the first row of the table as column names. usage: | @@ -16,6 +16,10 @@ contributors: false
Use the first row of the table as column names.
+## Command Type + +`built-in` + ## Signature ```> headers {flags} ``` diff --git a/commands/docs/help.md b/commands/docs/help.md index b9e0ae3611e..fdaaac0a41b 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.115.0 +version: 0.115.1 core: | Display help information about different parts of Nushell. usage: | @@ -16,6 +16,10 @@ contributors: false
Display help information about different parts of Nushell.
+## Command Type + +`built-in` + ## Signature ```> help {flags} ...rest``` diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index ae3f88d33e5..856e151c3ee 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell aliases. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell aliases.
+## Command Type + +`built-in` + ## Signature ```> help aliases {flags} ...rest``` diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index bea1ce20267..56910c3b916 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell commands.
+## Command Type + +`built-in` + ## Signature ```> help commands {flags} ...rest``` diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index bb4a759c609..871132bdd28 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell string escapes. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell string escapes.
+## Command Type + +`built-in` + ## Signature ```> help escapes {flags} ``` diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 9f0d8a31830..778d2bcc4bf 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell externs. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell externs.
+## Command Type + +`built-in` + ## Signature ```> help externs {flags} ...rest``` diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 6d286695534..e97c3f81fc2 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell modules. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell modules.
+## Command Type + +`built-in` + ## Signature ```> help modules {flags} ...rest``` diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index b4be4deceeb..7e3de28a960 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell operators. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell operators.
+## Command Type + +`built-in` + ## Signature ```> help operators {flags} ``` diff --git a/commands/docs/help_pipe-and-redirect.md b/commands/docs/help_pipe-and-redirect.md index 58b12b8138b..e5706f6a86a 100644 --- a/commands/docs/help_pipe-and-redirect.md +++ b/commands/docs/help_pipe-and-redirect.md @@ -2,7 +2,7 @@ title: help pipe-and-redirect categories: | core -version: 0.115.0 +version: 0.115.1 core: | Show help on nushell pipes and redirects. usage: | @@ -16,6 +16,10 @@ contributors: false
Show help on nushell pipes and redirects.
+## Command Type + +`built-in` + ## Signature ```> help pipe-and-redirect {flags} ``` diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 4bd3456b38c..ebdb01e4a4f 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.115.0 +version: 0.115.1 core: | Hide environment variables in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Hide environment variables in the current scope.
+## Command Type + +`built-in` + ## Signature ```> hide-env {flags} ...rest``` diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 766d09c0b98..97cf12af73c 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.115.0 +version: 0.115.1 core: | Hide definitions in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Hide definitions in the current scope.
+## Command Type + +`keyword` + ## Signature ```> hide {flags} (module) (members)``` diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index d5b84a40a30..c789c62bd7d 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.115.0 +version: 0.115.1 chart: | Creates a new table with a histogram based on the column name passed in. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates a new table with a histogram based on the column name passed in.
+## Command Type + +`built-in` + ## Signature ```> histogram {flags} (column-name) (frequency-column-name)``` diff --git a/commands/docs/history.md b/commands/docs/history.md index b8373b53776..80e9cfdafc6 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.115.0 +version: 0.115.1 history: | Get the command history. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the command history.
+## Command Type + +`built-in` + ## Signature ```> history {flags} ``` diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index a3dea002be8..cd85122b165 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,7 +2,7 @@ title: history import categories: | history -version: 0.115.0 +version: 0.115.1 history: | Import command line history. usage: | @@ -16,6 +16,10 @@ contributors: false
Import command line history.
+## Command Type + +`built-in` + ## Signature ```> history import {flags} ``` diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 70b5024bb46..18077f5defb 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.115.0 +version: 0.115.1 history: | Get the command history session. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the command history session.
+## Command Type + +`built-in` + ## Signature ```> history session {flags} ``` diff --git a/commands/docs/http.md b/commands/docs/http.md index b6e783fe48b..557a6802587 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.115.0 +version: 0.115.1 network: | Various commands for working with http methods. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with http methods.
+## Command Type + +`built-in` + ## Signature ```> http {flags} (URL) (data)``` diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 7fe67de7d52..61edab45b4a 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.115.0 +version: 0.115.1 network: | Delete the specified resource. usage: | @@ -16,6 +16,10 @@ contributors: false
Delete the specified resource.
+## Command Type + +`built-in` + ## Signature ```> http delete {flags} (URL)``` diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 61a9db94c9a..f3aa9df95e1 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.115.0 +version: 0.115.1 network: | Fetch the contents from a URL. usage: | @@ -16,6 +16,10 @@ contributors: false
Fetch the contents from a URL.
+## Command Type + +`built-in` + ## Signature ```> http get {flags} (URL)``` diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 149d2bc2898..ddaa0193bf4 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.115.0 +version: 0.115.1 network: | Get the headers from a URL. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the headers from a URL.
+## Command Type + +`built-in` + ## Signature ```> http head {flags} (URL)``` diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 6c94ac70f60..0b558dffb32 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.115.0 +version: 0.115.1 network: | Requests permitted communication options for a given URL. usage: | @@ -16,6 +16,10 @@ contributors: false
Requests permitted communication options for a given URL.
+## Command Type + +`built-in` + ## Signature ```> http options {flags} (URL)``` diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index dca68dd96ef..d8f9dab7066 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.115.0 +version: 0.115.1 network: | Send a PATCH request to a URL with a request body. usage: | @@ -16,6 +16,10 @@ contributors: false
Send a PATCH request to a URL with a request body.
+## Command Type + +`built-in` + ## Signature ```> http patch {flags} (URL) (data)``` diff --git a/commands/docs/http_pool.md b/commands/docs/http_pool.md index f0109b42c14..e708bd86f5f 100644 --- a/commands/docs/http_pool.md +++ b/commands/docs/http_pool.md @@ -2,7 +2,7 @@ title: http pool categories: | network -version: 0.115.0 +version: 0.115.1 network: | Configure and reset builtin http connection pool. usage: | @@ -16,6 +16,10 @@ contributors: false
Configure and reset builtin http connection pool.
+## Command Type + +`built-in` + ## Signature ```> http pool {flags} ``` diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index ca78c669ade..1f4315bdcbf 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.115.0 +version: 0.115.1 network: | Send a POST request to a URL with a request body. usage: | @@ -16,6 +16,10 @@ contributors: false
Send a POST request to a URL with a request body.
+## Command Type + +`built-in` + ## Signature ```> http post {flags} (URL) (data)``` diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index d8f994e0c3d..711a7ef4854 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.115.0 +version: 0.115.1 network: | Send a PUT request to a URL with a request body. usage: | @@ -16,6 +16,10 @@ contributors: false
Send a PUT request to a URL with a request body.
+## Command Type + +`built-in` + ## Signature ```> http put {flags} (URL) (data)``` diff --git a/commands/docs/idx.md b/commands/docs/idx.md index 15a55c9b050..1fe55c48dd0 100644 --- a/commands/docs/idx.md +++ b/commands/docs/idx.md @@ -2,7 +2,7 @@ title: idx categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Manage in-memory file index state. usage: | @@ -16,6 +16,10 @@ contributors: false
Manage in-memory file index state.
+## Command Type + +`built-in` + ## Signature ```> idx {flags} ``` diff --git a/commands/docs/idx_dirs.md b/commands/docs/idx_dirs.md index 9195894ff8f..d439e63df05 100644 --- a/commands/docs/idx_dirs.md +++ b/commands/docs/idx_dirs.md @@ -2,7 +2,7 @@ title: idx dirs categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | List indexed directories, or fuzzy-match directories by query. usage: | @@ -16,6 +16,10 @@ contributors: false
List indexed directories, or fuzzy-match directories by query.
+## Command Type + +`built-in` + ## Signature ```> idx dirs {flags} (query)``` diff --git a/commands/docs/idx_drop.md b/commands/docs/idx_drop.md index efc6587a33e..f0b9dec4a91 100644 --- a/commands/docs/idx_drop.md +++ b/commands/docs/idx_drop.md @@ -2,7 +2,7 @@ title: idx drop categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Drop the current idx runtime from memory. usage: | @@ -16,6 +16,10 @@ contributors: false
Drop the current idx runtime from memory.
+## Command Type + +`built-in` + ## Signature ```> idx drop {flags} ``` diff --git a/commands/docs/idx_files.md b/commands/docs/idx_files.md index 106fa1f5062..340f773f13a 100644 --- a/commands/docs/idx_files.md +++ b/commands/docs/idx_files.md @@ -2,7 +2,7 @@ title: idx files categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | List indexed files, or fuzzy-match files by query. usage: | @@ -16,6 +16,10 @@ contributors: false
List indexed files, or fuzzy-match files by query.
+## Command Type + +`built-in` + ## Signature ```> idx files {flags} (query)``` diff --git a/commands/docs/idx_find.md b/commands/docs/idx_find.md index 94704272d80..81b1e822e3f 100644 --- a/commands/docs/idx_find.md +++ b/commands/docs/idx_find.md @@ -2,7 +2,7 @@ title: idx find categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Search idx with fuzzy matching across files and directories by default. usage: | @@ -16,6 +16,10 @@ contributors: false
Search idx with fuzzy matching across files and directories by default.
+## Command Type + +`built-in` + ## Signature ```> idx find {flags} (query)``` diff --git a/commands/docs/idx_init.md b/commands/docs/idx_init.md index 0588bba0ede..788796a2d44 100644 --- a/commands/docs/idx_init.md +++ b/commands/docs/idx_init.md @@ -2,7 +2,7 @@ title: idx init categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Initialize the in-memory idx index for a path. usage: | @@ -16,6 +16,10 @@ contributors: false
Initialize the in-memory idx index for a path.
+## Command Type + +`built-in` + ## Signature ```> idx init {flags} (path)``` diff --git a/commands/docs/idx_search.md b/commands/docs/idx_search.md index 986865652d5..01c4e283f0c 100644 --- a/commands/docs/idx_search.md +++ b/commands/docs/idx_search.md @@ -2,7 +2,7 @@ title: idx search categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Search indexed file contents. usage: | @@ -16,6 +16,10 @@ contributors: false
Search indexed file contents.
+## Command Type + +`built-in` + ## Signature ```> idx search {flags} ...rest``` diff --git a/commands/docs/idx_status.md b/commands/docs/idx_status.md index ccf5a06c6a6..c0317be9a15 100644 --- a/commands/docs/idx_status.md +++ b/commands/docs/idx_status.md @@ -2,7 +2,7 @@ title: idx status categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Show status information for the global in-memory idx runtime. usage: | @@ -16,6 +16,10 @@ contributors: false
Show status information for the global in-memory idx runtime.
+## Command Type + +`built-in` + ## Signature ```> idx status {flags} ``` diff --git a/commands/docs/idx_watch.md b/commands/docs/idx_watch.md index d702c0bff74..3af1e1f9a7c 100644 --- a/commands/docs/idx_watch.md +++ b/commands/docs/idx_watch.md @@ -2,7 +2,7 @@ title: idx watch categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Stream filesystem change events from the live idx index. usage: | @@ -16,6 +16,10 @@ contributors: false
Stream filesystem change events from the live idx index.
+## Command Type + +`built-in` + ## Signature ```> idx watch {flags} (pattern)``` diff --git a/commands/docs/if.md b/commands/docs/if.md index 9b5b6f00a9b..189c078dd19 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.115.0 +version: 0.115.1 core: | Conditionally run a block. usage: | @@ -16,6 +16,10 @@ contributors: false
Conditionally run a block.
+## Command Type + +`keyword` + ## Signature ```> if {flags} (cond) (then_block) (else_expression)``` diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 6fcba1a8259..f3e36cd0955 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.115.0 +version: 0.115.1 core: | Ignore selected output streams from the previous command in the pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Ignore selected output streams from the previous command in the pipeline.
+## Command Type + +`built-in` + ## Signature ```> ignore {flags} ``` diff --git a/commands/docs/inc.md b/commands/docs/inc.md index 5415525fb3f..acd3e565181 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.115.0 +version: 0.115.1 default: | Increment a value or version. Optionally use the column of a table. usage: | @@ -16,6 +16,17 @@ contributors: false
Increment a value or version. Optionally use the column of a table.
+::: warning This command requires a plugin +The `inc` command resides in the `inc` plugin. +To use this command, you must install and register `nu_plugin_inc`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> inc {flags} (cell_path)``` diff --git a/commands/docs/input.md b/commands/docs/input.md index ebbde075288..b7d9b61fe49 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Get input from the user via the terminal. usage: | @@ -16,6 +16,10 @@ contributors: false
Get input from the user via the terminal.
+## Command Type + +`built-in` + ## Signature ```> input {flags} (prompt)``` diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index b63654f6866..332302d02c6 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Display an interactive list for user selection. usage: | @@ -16,6 +16,10 @@ contributors: false
Display an interactive list for user selection.
+## Command Type + +`built-in` + ## Signature ```> input list {flags} (prompt)``` diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 56a4359a0cd..dac45649412 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Listen for user interface events. usage: | @@ -16,6 +16,10 @@ contributors: false
Listen for user interface events.
+## Command Type + +`built-in` + ## Signature ```> input listen {flags} ``` diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 45652d8dffd..2675ab83a45 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | @@ -16,6 +16,10 @@ contributors: false
Insert a new column, using an expression or closure to create each row's values.
+## Command Type + +`built-in` + ## Signature ```> insert {flags} (field) (new value)``` diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 0d7c77984cb..71ffea9dc1a 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Inspect pipeline results while running a pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Inspect pipeline results while running a pipeline.
+## Command Type + +`built-in` + ## Signature ```> inspect {flags} ``` diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 9da97fb9981..3a16e432312 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Read multiple streams in parallel and combine them into one stream. usage: | @@ -16,6 +16,10 @@ contributors: false
Read multiple streams in parallel and combine them into one stream.
+## Command Type + +`built-in` + ## Signature ```> interleave {flags} ...rest``` diff --git a/commands/docs/intersect.md b/commands/docs/intersect.md index def127ba191..528449c4ac5 100644 --- a/commands/docs/intersect.md +++ b/commands/docs/intersect.md @@ -2,7 +2,7 @@ title: intersect categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Returns a list of unique elements present in both the input and the provided list. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns a list of unique elements present in both the input and the provided list.
+## Command Type + +`built-in` + ## Signature ```> intersect {flags} (other)``` diff --git a/commands/docs/into.md b/commands/docs/into.md index f41396db3a7..8bbd39c4069 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Commands to convert data from one type to another. usage: | @@ -16,6 +16,10 @@ contributors: false
Commands to convert data from one type to another.
+## Command Type + +`built-in` + ## Signature ```> into {flags} ``` diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 11e657d6fe4..8add01edb57 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a binary primitive. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a binary primitive.
+## Command Type + +`built-in` + ## Signature ```> into binary {flags} ...rest``` diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index fa78a3ca6f4..96844fd5f63 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a boolean. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a boolean.
+## Command Type + +`built-in` + ## Signature ```> into bool {flags} ...rest``` diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 35a81e50cf0..2028ec057e3 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.115.0 +version: 0.115.1 conversions: | Convert value to a cell-path. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a cell-path.
+## Command Type + +`built-in` + ## Signature ```> into cell-path {flags} ``` diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 77e028b1646..97fe698dcbe 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert text or timestamp into a datetime. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert text or timestamp into a datetime.
+## Command Type + +`built-in` + ## Signature ```> into datetime {flags} ...rest``` diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index 61f18900059..0f9ccf2590c 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a duration. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a duration.
+## Command Type + +`built-in` + ## Signature ```> into duration {flags} ...rest``` diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 3908f7ebd1f..3436a6e376c 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a filesize.
+## Command Type + +`built-in` + ## Signature ```> into filesize {flags} ...rest``` diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index efe0d548e11..e88d39d2359 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert data into floating point number. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert data into floating point number.
+## Command Type + +`built-in` + ## Signature ```> into float {flags} ...rest``` diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 3dc4df48438..b1ae60f071f 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a glob pattern. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a glob pattern.
+## Command Type + +`built-in` + ## Signature ```> into glob {flags} ...rest``` diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index d6f2107c862..d286a44e8c6 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to an integer. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to an integer.
+## Command Type + +`built-in` + ## Signature ```> into int {flags} ...rest``` diff --git a/commands/docs/into_matrix.md b/commands/docs/into_matrix.md index f39bf726d74..4dd2856a5b3 100644 --- a/commands/docs/into_matrix.md +++ b/commands/docs/into_matrix.md @@ -2,7 +2,7 @@ title: into matrix categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert a nushell table or list of lists into a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a nushell table or list of lists into a matrix.
+## Command Type + +`built-in` + ## Signature ```> into matrix {flags} ``` diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index c7375c3e570..def32507329 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a record. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a record.
+## Command Type + +`built-in` + ## Signature ```> into record {flags} ``` diff --git a/commands/docs/into_semver-range.md b/commands/docs/into_semver-range.md index 99a48a6c921..11d1cae519f 100644 --- a/commands/docs/into_semver-range.md +++ b/commands/docs/into_semver-range.md @@ -2,7 +2,7 @@ title: into semver-range categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert a string to a semver range. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to a semver range.
+## Command Type + +`built-in` + ## Signature ```> into semver-range {flags} ``` diff --git a/commands/docs/into_semver.md b/commands/docs/into_semver.md index 2bf40096eb3..a1cd0334433 100644 --- a/commands/docs/into_semver.md +++ b/commands/docs/into_semver.md @@ -2,7 +2,7 @@ title: into semver categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert a value (string, record, or semver) to a semantic version. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a value (string, record, or semver) to a semantic version.
+## Command Type + +`built-in` + ## Signature ```> into semver {flags} ...rest``` diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 37f47d737ea..6255811033f 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert table into a SQLite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into a SQLite database.
+## Command Type + +`built-in` + ## Signature ```> into sqlite {flags} (file-name)``` diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index dda1680b435..4b9c44b4725 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert value to a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert value to a string.
+## Command Type + +`built-in` + ## Signature ```> into string {flags} ...rest``` diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 157c17d73e5..70da107b473 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert custom values into base values. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert custom values into base values.
+## Command Type + +`built-in` + ## Signature ```> into value {flags} ``` diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index e1906ab383b..f9cd3926860 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.115.0 +version: 0.115.1 core: | Check if nushell is running with administrator or root privileges. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if nushell is running with administrator or root privileges.
+## Command Type + +`built-in` + ## Signature ```> is-admin {flags} ``` diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index a1b86d027e6..92de44b2690 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Check for empty values. usage: | @@ -16,6 +16,10 @@ contributors: false
Check for empty values.
+## Command Type + +`built-in` + ## Signature ```> is-empty {flags} ...rest``` diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 701d1bd118e..0968baa6462 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.115.0 +version: 0.115.1 filters: | Check for non-empty values. usage: | @@ -16,6 +16,10 @@ contributors: false
Check for non-empty values.
+## Command Type + +`built-in` + ## Signature ```> is-not-empty {flags} ...rest``` diff --git a/commands/docs/is-redirected.md b/commands/docs/is-redirected.md index 36a235438a1..8fa95990301 100644 --- a/commands/docs/is-redirected.md +++ b/commands/docs/is-redirected.md @@ -2,7 +2,7 @@ title: is-redirected categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Check if the current custom command's return value is redirected away from display. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if the current custom command's return value is redirected away from display.
+## Command Type + +`built-in` + ## Signature ```> is-redirected {flags} ``` diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 73b1624bfb7..516c88c44c1 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Check if the process stdin, stdout, or stderr is attached to a terminal device. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if the process stdin, stdout, or stderr is attached to a terminal device.
+## Command Type + +`built-in` + ## Signature ```> is-terminal {flags} ``` diff --git a/commands/docs/items.md b/commands/docs/items.md index ad22e04bec8..b6a09eec173 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Given a record, iterate on each pair of column name and associated value. usage: | @@ -16,6 +16,10 @@ contributors: false
Given a record, iterate on each pair of column name and associated value.
+## Command Type + +`built-in` + ## Signature ```> items {flags} (closure)``` diff --git a/commands/docs/job.md b/commands/docs/job.md index 66ea7d1728f..d84ac21b845 100644 --- a/commands/docs/job.md +++ b/commands/docs/job.md @@ -2,7 +2,7 @@ title: job categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Various commands for working with background jobs. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with background jobs.
+## Command Type + +`built-in` + ## Signature ```> job {flags} ``` diff --git a/commands/docs/job_describe.md b/commands/docs/job_describe.md index eacf178c5e3..4d7c1f83b83 100644 --- a/commands/docs/job_describe.md +++ b/commands/docs/job_describe.md @@ -2,7 +2,7 @@ title: job describe categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Add a description to a background job. usage: | @@ -16,6 +16,10 @@ contributors: false
Add a description to a background job.
+## Command Type + +`built-in` + ## Signature ```> job describe {flags} (id) (description)``` diff --git a/commands/docs/job_flush.md b/commands/docs/job_flush.md index 80e5685c612..d1efa58cca8 100644 --- a/commands/docs/job_flush.md +++ b/commands/docs/job_flush.md @@ -2,7 +2,7 @@ title: job flush categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Clear this job's mailbox. usage: | @@ -16,6 +16,10 @@ contributors: false
Clear this job's mailbox.
+## Command Type + +`built-in` + ## Signature ```> job flush {flags} ``` diff --git a/commands/docs/job_id.md b/commands/docs/job_id.md index 67b954b8a9c..796893c8d75 100644 --- a/commands/docs/job_id.md +++ b/commands/docs/job_id.md @@ -2,7 +2,7 @@ title: job id categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Get id of current job. usage: | @@ -16,6 +16,10 @@ contributors: false
Get id of current job.
+## Command Type + +`built-in` + ## Signature ```> job id {flags} ``` diff --git a/commands/docs/job_kill.md b/commands/docs/job_kill.md index 4af27ed2fb3..155a4eb78f7 100644 --- a/commands/docs/job_kill.md +++ b/commands/docs/job_kill.md @@ -2,7 +2,7 @@ title: job kill categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Kill a background job. usage: | @@ -16,6 +16,10 @@ contributors: false
Kill a background job.
+## Command Type + +`built-in` + ## Signature ```> job kill {flags} (id)``` diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md index 6eb4407701d..a09af40b141 100644 --- a/commands/docs/job_list.md +++ b/commands/docs/job_list.md @@ -2,7 +2,7 @@ title: job list categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | List background jobs. usage: | @@ -16,6 +16,10 @@ contributors: false
List background jobs.
+## Command Type + +`built-in` + ## Signature ```> job list {flags} ``` diff --git a/commands/docs/job_recv.md b/commands/docs/job_recv.md index 2dd717bf835..722cab9415e 100644 --- a/commands/docs/job_recv.md +++ b/commands/docs/job_recv.md @@ -2,7 +2,7 @@ title: job recv categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Read a message from a job's mailbox. usage: | @@ -16,6 +16,10 @@ contributors: false
Read a message from a job's mailbox.
+## Command Type + +`built-in` + ## Signature ```> job recv {flags} ``` diff --git a/commands/docs/job_send.md b/commands/docs/job_send.md index a66548a427c..d47a3c0aa5e 100644 --- a/commands/docs/job_send.md +++ b/commands/docs/job_send.md @@ -2,7 +2,7 @@ title: job send categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Send a message to the mailbox of a job. usage: | @@ -16,6 +16,10 @@ contributors: false
Send a message to the mailbox of a job.
+## Command Type + +`built-in` + ## Signature ```> job send {flags} (id)``` diff --git a/commands/docs/job_spawn.md b/commands/docs/job_spawn.md index d3d02f4b1cd..972f54e9d81 100644 --- a/commands/docs/job_spawn.md +++ b/commands/docs/job_spawn.md @@ -2,7 +2,7 @@ title: job spawn categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Spawn a background job and retrieve its ID. usage: | @@ -16,6 +16,10 @@ contributors: false
Spawn a background job and retrieve its ID.
+## Command Type + +`built-in` + ## Signature ```> job spawn {flags} (closure)``` diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md index 5de57154cf9..3b2ba8df667 100644 --- a/commands/docs/job_unfreeze.md +++ b/commands/docs/job_unfreeze.md @@ -2,7 +2,7 @@ title: job unfreeze categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Unfreeze a frozen process job in foreground. usage: | @@ -16,6 +16,10 @@ contributors: false
Unfreeze a frozen process job in foreground.
+## Command Type + +`built-in` + ## Signature ```> job unfreeze {flags} (id)``` diff --git a/commands/docs/join.md b/commands/docs/join.md index db160640b79..0fea8efcefc 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Join two tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Join two tables.
+## Command Type + +`built-in` + ## Signature ```> join {flags} (right-table) (left-on) (right-on)``` diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 584fa26fc13..c4a378db99c 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Keybindings related commands. usage: | @@ -16,6 +16,10 @@ contributors: false
Keybindings related commands.
+## Command Type + +`built-in` + ## Signature ```> keybindings {flags} ``` diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 4cefd42f98a..aa844f62503 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | List default keybindings. usage: | @@ -16,6 +16,10 @@ contributors: false
List default keybindings.
+## Command Type + +`built-in` + ## Signature ```> keybindings default {flags} ``` diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index e2816a6e9b9..7b781afee60 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | List available options that can be used to create keybindings. usage: | @@ -16,6 +16,10 @@ contributors: false
List available options that can be used to create keybindings.
+## Command Type + +`built-in` + ## Signature ```> keybindings list {flags} ``` diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index cf0b0d23c65..899909fbdb0 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Get input from the user. usage: | @@ -16,6 +16,10 @@ contributors: false
Get input from the user.
+## Command Type + +`built-in` + ## Signature ```> keybindings listen {flags} ``` diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 5c37484dc35..edb836b3515 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Kill a process using its process ID. usage: | @@ -16,6 +16,10 @@ contributors: false
Kill a process using its process ID.
+## Command Type + +`built-in` + ## Signature ```> kill {flags} ...rest``` diff --git a/commands/docs/last.md b/commands/docs/last.md index e9e67310136..5e6e1a59832 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. For binary input, rows can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. For binary input, rows can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> last {flags} (rows)``` diff --git a/commands/docs/length.md b/commands/docs/length.md index 837314371df..51077836ed3 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Count the number of items in an input list, rows in a table, or bytes in binary data. usage: | @@ -16,6 +16,10 @@ contributors: false
Count the number of items in an input list, rows in a table, or bytes in binary data.
+## Command Type + +`built-in` + ## Signature ```> length {flags} ``` diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 5a756393b79..1bbeed71409 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.115.0 +version: 0.115.1 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | @@ -16,6 +16,10 @@ contributors: false
`let-env FOO = ...` has been removed, use `$env.FOO = ...` instead.
+## Command Type + +`built-in` + ## Signature ```> let-env {flags} (var_name) (initial_value)``` diff --git a/commands/docs/let.md b/commands/docs/let.md index 66ff524d1c4..26946b42883 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.115.0 +version: 0.115.1 core: | Create a variable and give it a value. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a variable and give it a value.
+## Command Type + +`keyword` + ## Signature ```> let {flags} (var_name) (initial_value)``` diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 996c8cc05b4..da8c6c3e037 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Converts input to lines. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts input to lines.
+## Command Type + +`built-in` + ## Signature ```> lines {flags} ``` diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 73d75f9fb71..8c3314f8307 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Loads an environment update from a record. usage: | @@ -16,6 +16,10 @@ contributors: false
Loads an environment update from a record.
+## Command Type + +`built-in` + ## Signature ```> load-env {flags} (update)``` diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 3b87874b59c..63b6bae7d54 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.115.0 +version: 0.115.1 core: | Run a block in a loop. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a block in a loop.
+## Command Type + +`keyword` + ## Signature ```> loop {flags} (block)``` diff --git a/commands/docs/ls.md b/commands/docs/ls.md index ed6c956cee4..488a0261e65 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | @@ -16,6 +16,10 @@ contributors: false
List the filenames, sizes, and modification times of items in a directory.
+## Command Type + +`built-in` + ## Signature ```> ls {flags} ...rest``` diff --git a/commands/docs/match.md b/commands/docs/match.md index 875de918c80..0fb3928c70e 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.115.0 +version: 0.115.1 core: | Conditionally run a block on a matched value. usage: | @@ -16,6 +16,10 @@ contributors: false
Conditionally run a block on a matched value.
+## Command Type + +`keyword` + ## Signature ```> match {flags} (value) (match_block)``` diff --git a/commands/docs/math.md b/commands/docs/math.md index 6eade8fc269..04abcd8617e 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.115.0 +version: 0.115.1 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Use mathematical functions as aggregate functions on a list of numbers or tables.
+## Command Type + +`built-in` + ## Signature ```> math {flags} ``` diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index d564ef8f441..59dc0e1bf53 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the absolute value of a number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the absolute value of a number.
+## Command Type + +`built-in` + ## Signature ```> math abs {flags} ...rest``` diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 9756e3199c4..78a7b7feeaf 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the arccosine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the arccosine of the number.
+## Command Type + +`built-in` + ## Signature ```> math arccos {flags} ``` diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index ab2ac771d32..1371ecb8f30 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the inverse of the hyperbolic cosine function. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the inverse of the hyperbolic cosine function.
+## Command Type + +`built-in` + ## Signature ```> math arccosh {flags} ``` diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index 124dedcb455..8d7affd9aa1 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the arcsine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the arcsine of the number.
+## Command Type + +`built-in` + ## Signature ```> math arcsin {flags} ``` diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 1cc0360e9f5..b1693c58ee7 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the inverse of the hyperbolic sine function. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the inverse of the hyperbolic sine function.
+## Command Type + +`built-in` + ## Signature ```> math arcsinh {flags} ``` diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index 660e7d7a79f..3bbb754f134 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the arctangent of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the arctangent of the number.
+## Command Type + +`built-in` + ## Signature ```> math arctan {flags} ``` diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 4fea1cd5455..36203378289 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the inverse of the hyperbolic tangent function. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the inverse of the hyperbolic tangent function.
+## Command Type + +`built-in` + ## Signature ```> math arctanh {flags} ``` diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 7dd68d8a1fc..5fe39fe0e2a 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the average of a list of numbers. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the average of a list of numbers.
+## Command Type + +`built-in` + ## Signature ```> math avg {flags} ...rest``` diff --git a/commands/docs/math_cbrt.md b/commands/docs/math_cbrt.md index 03bb336763d..551e2b4cf8f 100644 --- a/commands/docs/math_cbrt.md +++ b/commands/docs/math_cbrt.md @@ -2,7 +2,7 @@ title: math cbrt categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the real-valued cube root of the input number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the real-valued cube root of the input number.
+## Command Type + +`built-in` + ## Signature ```> math cbrt {flags} ...rest``` diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index 565a813b1e8..0da8ee5044e 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the ceil of a number (smallest integer greater than or equal to that number).
+## Command Type + +`built-in` + ## Signature ```> math ceil {flags} ...rest``` diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index 2d2e41dd445..ad5e3e936f5 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the cosine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the cosine of the number.
+## Command Type + +`built-in` + ## Signature ```> math cos {flags} ``` diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 5aed75426b9..07b46fe0f2b 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the hyperbolic cosine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the hyperbolic cosine of the number.
+## Command Type + +`built-in` + ## Signature ```> math cosh {flags} ``` diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 5de04af8c4a..c1339c8596a 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns e raised to the power of x. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns e raised to the power of x.
+## Command Type + +`built-in` + ## Signature ```> math exp {flags} ``` diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 8bc6eaf3ec4..3b232b8d46a 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the floor of a number (largest integer less than or equal to that number).
+## Command Type + +`built-in` + ## Signature ```> math floor {flags} ...rest``` diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 0b30b813948..f16f1904c9b 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the natural logarithm. Base: (math e). usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the natural logarithm. Base: (math e).
+## Command Type + +`built-in` + ## Signature ```> math ln {flags} ``` diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index b714539cf17..da2b567a818 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the logarithm for an arbitrary base. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the logarithm for an arbitrary base.
+## Command Type + +`built-in` + ## Signature ```> math log {flags} (base) ...rest``` diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 06717ebcf1c..57aece6b99c 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the maximum of a list of values, or of columns in a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the maximum of a list of values, or of columns in a table.
+## Command Type + +`built-in` + ## Signature ```> math max {flags} ...rest``` diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index 0e4462a7e45..3bfa873485a 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.115.0 +version: 0.115.1 math: | Computes the median of a list of numbers. usage: | @@ -16,6 +16,10 @@ contributors: false
Computes the median of a list of numbers.
+## Command Type + +`built-in` + ## Signature ```> math median {flags} ...rest``` diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index 245519f2b5e..f1f0d2ebc65 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.115.0 +version: 0.115.1 math: | Finds the minimum within a list of values or tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Finds the minimum within a list of values or tables.
+## Command Type + +`built-in` + ## Signature ```> math min {flags} ...rest``` diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index 4ac296aa831..431419e8caf 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the most frequent element(s) from a list of numbers or tables.
+## Command Type + +`built-in` + ## Signature ```> math mode {flags} ...rest``` diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index 01ea6398ed1..67028c54102 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the product of a list of numbers or the products of each column of a table.
+## Command Type + +`built-in` + ## Signature ```> math product {flags} ...rest``` diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index cf50396b8f7..2316c08fd61 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the input number rounded to the specified precision. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the input number rounded to the specified precision.
+## Command Type + +`built-in` + ## Signature ```> math round {flags} ...rest``` diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index 68e618aee2f..e8b4afe4e28 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the sine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the sine of the number.
+## Command Type + +`built-in` + ## Signature ```> math sin {flags} ``` diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index e8182880fa3..b28f0fb5b00 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the hyperbolic sine of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the hyperbolic sine of the number.
+## Command Type + +`built-in` + ## Signature ```> math sinh {flags} ``` diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 54376db1a72..13fe1e8229d 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the square root of the input number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the square root of the input number.
+## Command Type + +`built-in` + ## Signature ```> math sqrt {flags} ...rest``` diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index 6c5d60cf348..aa3167f099e 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the standard deviation of a list of numbers, or of each column in a table.
+## Command Type + +`built-in` + ## Signature ```> math stddev {flags} ...rest``` diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index c72e7ba040d..b92f77f85be 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the sum of a list of numbers or of each column in a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the sum of a list of numbers or of each column in a table.
+## Command Type + +`built-in` + ## Signature ```> math sum {flags} ...rest``` diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index e8117313f3b..27ffe82aa70 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the tangent of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the tangent of the number.
+## Command Type + +`built-in` + ## Signature ```> math tan {flags} ``` diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 1ea7196f12c..7b1c7e1a4cd 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the hyperbolic tangent of the number. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the hyperbolic tangent of the number.
+## Command Type + +`built-in` + ## Signature ```> math tanh {flags} ``` diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index ea50d35c06a..296b935d1d4 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.115.0 +version: 0.115.1 math: | Returns the variance of a list of numbers or of each column in a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns the variance of a list of numbers or of each column in a table.
+## Command Type + +`built-in` + ## Signature ```> math variance {flags} ...rest``` diff --git a/commands/docs/matrix.md b/commands/docs/matrix.md index ef1def9b43b..6f7f037c67d 100644 --- a/commands/docs/matrix.md +++ b/commands/docs/matrix.md @@ -2,7 +2,7 @@ title: matrix categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Various commands for working with matrices. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with matrices.
+## Command Type + +`built-in` + ## Signature ```> matrix {flags} ``` diff --git a/commands/docs/matrix_add.md b/commands/docs/matrix_add.md index e5007ebe88c..5a91c5e0a55 100644 --- a/commands/docs/matrix_add.md +++ b/commands/docs/matrix_add.md @@ -2,7 +2,7 @@ title: matrix add categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Add a matrix or scalar to a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Add a matrix or scalar to a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix add {flags} (other)``` diff --git a/commands/docs/matrix_get-col.md b/commands/docs/matrix_get-col.md index cd7ec1b7456..8dcd23a0cf2 100644 --- a/commands/docs/matrix_get-col.md +++ b/commands/docs/matrix_get-col.md @@ -2,7 +2,7 @@ title: matrix get-col categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Extract a column from a 2D matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Extract a column from a 2D matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix get-col {flags} (index)``` diff --git a/commands/docs/matrix_get-row.md b/commands/docs/matrix_get-row.md index f356159850a..0919b4916c6 100644 --- a/commands/docs/matrix_get-row.md +++ b/commands/docs/matrix_get-row.md @@ -2,7 +2,7 @@ title: matrix get-row categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Extract a row from a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Extract a row from a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix get-row {flags} (index)``` diff --git a/commands/docs/matrix_identity.md b/commands/docs/matrix_identity.md index a7e1970dd34..92b6361707c 100644 --- a/commands/docs/matrix_identity.md +++ b/commands/docs/matrix_identity.md @@ -2,7 +2,7 @@ title: matrix identity categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Create an identity matrix of the given size. usage: | @@ -16,6 +16,10 @@ contributors: false
Create an identity matrix of the given size.
+## Command Type + +`built-in` + ## Signature ```> matrix identity {flags} (size)``` diff --git a/commands/docs/matrix_into-nu.md b/commands/docs/matrix_into-nu.md index 2a64b651823..74054dd1c4b 100644 --- a/commands/docs/matrix_into-nu.md +++ b/commands/docs/matrix_into-nu.md @@ -2,7 +2,7 @@ title: matrix into-nu categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Convert a matrix to a nushell table (list of lists by default). usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a matrix to a nushell table (list of lists by default).
+## Command Type + +`built-in` + ## Signature ```> matrix into-nu {flags} ``` diff --git a/commands/docs/matrix_map.md b/commands/docs/matrix_map.md index 4bf2146d8fc..77cdbf78c14 100644 --- a/commands/docs/matrix_map.md +++ b/commands/docs/matrix_map.md @@ -2,7 +2,7 @@ title: matrix map categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Apply a closure to each element of a matrix and return a new matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Apply a closure to each element of a matrix and return a new matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix map {flags} (closure)``` diff --git a/commands/docs/matrix_max.md b/commands/docs/matrix_max.md index 03a25028fe0..a8751da7622 100644 --- a/commands/docs/matrix_max.md +++ b/commands/docs/matrix_max.md @@ -2,7 +2,7 @@ title: matrix max categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Find the maximum value in a matrix, or max along an axis. usage: | @@ -16,6 +16,10 @@ contributors: false
Find the maximum value in a matrix, or max along an axis.
+## Command Type + +`built-in` + ## Signature ```> matrix max {flags} ``` diff --git a/commands/docs/matrix_mean.md b/commands/docs/matrix_mean.md index d7e3a3a3764..96b42c84e82 100644 --- a/commands/docs/matrix_mean.md +++ b/commands/docs/matrix_mean.md @@ -2,7 +2,7 @@ title: matrix mean categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Compute the mean of all elements in a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Compute the mean of all elements in a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix mean {flags} ``` diff --git a/commands/docs/matrix_multiply.md b/commands/docs/matrix_multiply.md index 57a7851cdb3..29c1877b26f 100644 --- a/commands/docs/matrix_multiply.md +++ b/commands/docs/matrix_multiply.md @@ -2,7 +2,7 @@ title: matrix multiply categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Multiply two matrices using dot product. usage: | @@ -16,6 +16,10 @@ contributors: false
Multiply two matrices using dot product.
+## Command Type + +`built-in` + ## Signature ```> matrix multiply {flags} (other) ...rest``` diff --git a/commands/docs/matrix_reduce.md b/commands/docs/matrix_reduce.md index 1ebc353e304..5b00785a910 100644 --- a/commands/docs/matrix_reduce.md +++ b/commands/docs/matrix_reduce.md @@ -2,7 +2,7 @@ title: matrix reduce categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Reduce all elements of a matrix to a single value. usage: | @@ -16,6 +16,10 @@ contributors: false
Reduce all elements of a matrix to a single value.
+## Command Type + +`built-in` + ## Signature ```> matrix reduce {flags} (closure)``` diff --git a/commands/docs/matrix_reshape.md b/commands/docs/matrix_reshape.md index a69a0366b88..eba6e084590 100644 --- a/commands/docs/matrix_reshape.md +++ b/commands/docs/matrix_reshape.md @@ -2,7 +2,7 @@ title: matrix reshape categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Change the dimensions of a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Change the dimensions of a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix reshape {flags} (dimensions) ...rest``` diff --git a/commands/docs/matrix_scale.md b/commands/docs/matrix_scale.md index b9188ee0745..61097410d88 100644 --- a/commands/docs/matrix_scale.md +++ b/commands/docs/matrix_scale.md @@ -2,7 +2,7 @@ title: matrix scale categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Multiply all elements of a matrix by a scalar. usage: | @@ -16,6 +16,10 @@ contributors: false
Multiply all elements of a matrix by a scalar.
+## Command Type + +`built-in` + ## Signature ```> matrix scale {flags} (scalar)``` diff --git a/commands/docs/matrix_set-col.md b/commands/docs/matrix_set-col.md index 5897aae0cbe..b24d57004da 100644 --- a/commands/docs/matrix_set-col.md +++ b/commands/docs/matrix_set-col.md @@ -2,7 +2,7 @@ title: matrix set-col categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Replace a column in a 2D matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Replace a column in a 2D matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix set-col {flags} (index) (replacement)``` diff --git a/commands/docs/matrix_set-row.md b/commands/docs/matrix_set-row.md index f8870dc3f20..a7a407db00c 100644 --- a/commands/docs/matrix_set-row.md +++ b/commands/docs/matrix_set-row.md @@ -2,7 +2,7 @@ title: matrix set-row categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Replace a row in a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Replace a row in a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix set-row {flags} (index) (replacement)``` diff --git a/commands/docs/matrix_subtract.md b/commands/docs/matrix_subtract.md index 757fc87cc23..ce4aa8cab8b 100644 --- a/commands/docs/matrix_subtract.md +++ b/commands/docs/matrix_subtract.md @@ -2,7 +2,7 @@ title: matrix subtract categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Subtract a matrix or scalar from a matrix. usage: | @@ -16,6 +16,10 @@ contributors: false
Subtract a matrix or scalar from a matrix.
+## Command Type + +`built-in` + ## Signature ```> matrix subtract {flags} (other)``` diff --git a/commands/docs/matrix_sum.md b/commands/docs/matrix_sum.md index 055cdf7704f..4350a3cef06 100644 --- a/commands/docs/matrix_sum.md +++ b/commands/docs/matrix_sum.md @@ -2,7 +2,7 @@ title: matrix sum categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Sum all elements of a matrix, or sum along an axis. usage: | @@ -16,6 +16,10 @@ contributors: false
Sum all elements of a matrix, or sum along an axis.
+## Command Type + +`built-in` + ## Signature ```> matrix sum {flags} ``` diff --git a/commands/docs/matrix_transpose.md b/commands/docs/matrix_transpose.md index e7d594425c3..1587309a922 100644 --- a/commands/docs/matrix_transpose.md +++ b/commands/docs/matrix_transpose.md @@ -2,7 +2,7 @@ title: matrix transpose categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Transpose a matrix (swap rows and columns). For n-dimensional arrays, reverses all axes. usage: | @@ -16,6 +16,10 @@ contributors: false
Transpose a matrix (swap rows and columns). For n-dimensional arrays, reverses all axes.
+## Command Type + +`built-in` + ## Signature ```> matrix transpose {flags} ``` diff --git a/commands/docs/matrix_zeros.md b/commands/docs/matrix_zeros.md index a11223a626e..f75e4e028bf 100644 --- a/commands/docs/matrix_zeros.md +++ b/commands/docs/matrix_zeros.md @@ -2,7 +2,7 @@ title: matrix zeros categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Create a matrix filled with zeros. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a matrix filled with zeros.
+## Command Type + +`built-in` + ## Signature ```> matrix zeros {flags} (dimensions) ...rest``` diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 8849711084f..0f247281c57 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | @@ -16,6 +16,10 @@ contributors: false
Merge the input with a record or table, overwriting values in matching columns.
+## Command Type + +`built-in` + ## Signature ```> merge {flags} (value)``` diff --git a/commands/docs/merge_deep.md b/commands/docs/merge_deep.md index fd4ad762abe..2c66121b714 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Merge the input with a record or table, recursively merging values in matching columns. usage: | @@ -16,6 +16,10 @@ contributors: false
Merge the input with a record or table, recursively merging values in matching columns.
+## Command Type + +`built-in` + ## Signature ```> merge deep {flags} (value)``` diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index 46f038060d0..331110e097f 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Get the metadata for items in the stream. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the metadata for items in the stream.
+## Command Type + +`built-in` + ## Signature ```> metadata {flags} (expression)``` diff --git a/commands/docs/metadata_access.md b/commands/docs/metadata_access.md index 3e4a08f05cf..3b94b53f176 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Access the metadata for the input stream within a closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Access the metadata for the input stream within a closure.
+## Command Type + +`built-in` + ## Signature ```> metadata access {flags} (closure)``` diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index be7552bb53f..b91c7f8a5da 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Set the metadata for items in the stream. usage: | @@ -16,6 +16,10 @@ contributors: false
Set the metadata for items in the stream.
+## Command Type + +`built-in` + ## Signature ```> metadata set {flags} (closure)``` diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 689d11fa328..4a70d96b9ce 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | @@ -16,6 +16,10 @@ contributors: false
Create directories, with intermediary directories if required using uutils/coreutils mkdir.
+## Command Type + +`built-in` + ## Signature ```> mkdir {flags} ...rest``` diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 3d64ad3f5ad..955730bc35c 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | @@ -16,6 +16,10 @@ contributors: false
Create temporary files or directories using uutils/coreutils mktemp.
+## Command Type + +`built-in` + ## Signature ```> mktemp {flags} (template)``` diff --git a/commands/docs/module.md b/commands/docs/module.md index cfbbf89912c..b132db51a82 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.115.0 +version: 0.115.1 core: | Define a custom module. usage: | @@ -16,6 +16,10 @@ contributors: false
Define a custom module.
+## Command Type + +`keyword` + ## Signature ```> module {flags} (module) (block)``` diff --git a/commands/docs/move.md b/commands/docs/move.md index 36cd3dc2090..95fefd9ff3d 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Moves columns relative to other columns or make them the first/last columns. Flags are mutually exclusive. usage: | @@ -16,6 +16,10 @@ contributors: false
Moves columns relative to other columns or make them the first/last columns. Flags are mutually exclusive.
+## Command Type + +`built-in` + ## Signature ```> move {flags} ...rest``` diff --git a/commands/docs/mut.md b/commands/docs/mut.md index c3e7adf7d48..e959b7a09c8 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.115.0 +version: 0.115.1 core: | Create a mutable variable and give it a value. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a mutable variable and give it a value.
+## Command Type + +`keyword` + ## Signature ```> mut {flags} (var_name) (initial_value)``` diff --git a/commands/docs/mv.md b/commands/docs/mv.md index 6cc2d4e4d0c..0887285aff4 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Move files or directories using uutils/coreutils mv. usage: | @@ -16,6 +16,10 @@ contributors: false
Move files or directories using uutils/coreutils mv.
+## Command Type + +`built-in` + ## Signature ```> mv {flags} ...rest``` diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 61b6a62f989..f2e1c626a1e 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Validate and parse Nushell input content. usage: | @@ -16,6 +16,10 @@ contributors: false
Validate and parse Nushell input content.
+## Command Type + +`built-in` + ## Signature ```> nu-check {flags} (path)``` diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index fc52b564324..22815356a8e 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Syntax highlight the input string. usage: | @@ -16,6 +16,10 @@ contributors: false
Syntax highlight the input string.
+## Command Type + +`built-in` + ## Signature ```> nu-highlight {flags} ``` diff --git a/commands/docs/open.md b/commands/docs/open.md index 3d2d7054e26..87d94a6dcfc 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | @@ -16,6 +16,10 @@ contributors: false
Load a file into a cell, converting to table if possible (avoid by appending '--raw').
+## Command Type + +`built-in` + ## Signature ```> open {flags} ...rest``` diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index b648e288311..ae2ace1561d 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.115.0 +version: 0.115.1 core: | Commands for manipulating overlays. usage: | @@ -16,6 +16,10 @@ contributors: false
Commands for manipulating overlays.
+## Command Type + +`keyword` + ## Signature ```> overlay {flags} ``` diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index dbf6a69ea8f..129ad71da76 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.115.0 +version: 0.115.1 core: | Hide an active overlay. usage: | @@ -16,6 +16,10 @@ contributors: false
Hide an active overlay.
+## Command Type + +`keyword` + ## Signature ```> overlay hide {flags} (name)``` diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 61b46295a70..6c0d09bc160 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.115.0 +version: 0.115.1 core: | List all overlays with their active status. usage: | @@ -16,6 +16,10 @@ contributors: false
List all overlays with their active status.
+## Command Type + +`built-in` + ## Signature ```> overlay list {flags} ``` diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 4af4eb1a6a5..fc262536132 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.115.0 +version: 0.115.1 core: | Create an empty overlay. usage: | @@ -16,6 +16,10 @@ contributors: false
Create an empty overlay.
+## Command Type + +`keyword` + ## Signature ```> overlay new {flags} (name)``` diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 917ffb0fd66..4840200432a 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.115.0 +version: 0.115.1 core: | Use definitions from a module as an overlay. usage: | @@ -16,6 +16,10 @@ contributors: false
Use definitions from a module as an overlay.
+## Command Type + +`keyword` + ## Signature ```> overlay use {flags} (name) (as)``` diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 226fbd84f49..9f43f53a6a5 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Causes nushell to panic. usage: | @@ -16,6 +16,10 @@ contributors: false
Causes nushell to panic.
+## Command Type + +`built-in` + ## Signature ```> panic {flags} (msg)``` diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 7636e50c0f3..41548148b59 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a closure on each row of the input list in parallel, creating a new list with the results.
+## Command Type + +`built-in` + ## Signature ```> par-each {flags} (closure)``` diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 16908cbc29d..59b0d81e3c3 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Parse columns from string data using a simple pattern or a supplied regular expression. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse columns from string data using a simple pattern or a supplied regular expression.
+## Command Type + +`built-in` + ## Signature ```> parse {flags} (pattern)``` diff --git a/commands/docs/path.md b/commands/docs/path.md index b54ba6ae242..1316e6b02b6 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.115.0 +version: 0.115.1 path: | Explore and manipulate paths. usage: | @@ -16,6 +16,10 @@ contributors: false
Explore and manipulate paths.
+## Command Type + +`built-in` + ## Signature ```> path {flags} ``` diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 699dcc8db20..4c515c3a9ab 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.115.0 +version: 0.115.1 path: | Get the final component of a path. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the final component of a path.
+## Command Type + +`built-in` + ## Signature ```> path basename {flags} ``` diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index 71c962f1ee9..eeba78ecf12 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.115.0 +version: 0.115.1 path: | Get the parent directory of a path. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the parent directory of a path.
+## Command Type + +`built-in` + ## Signature ```> path dirname {flags} ``` diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 43f30d0672c..3150c352d06 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.115.0 +version: 0.115.1 path: | Check whether a path exists. usage: | @@ -16,6 +16,10 @@ contributors: false
Check whether a path exists.
+## Command Type + +`built-in` + ## Signature ```> path exists {flags} ``` diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index a0afc641571..8c80cffca78 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.115.0 +version: 0.115.1 path: | Try to expand a path to its absolute form. usage: | @@ -16,6 +16,10 @@ contributors: false
Try to expand a path to its absolute form.
+## Command Type + +`built-in` + ## Signature ```> path expand {flags} ``` diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index e864a03c68d..342fb180ef5 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.115.0 +version: 0.115.1 path: | Join a structured path or a list of path parts. usage: | @@ -16,6 +16,10 @@ contributors: false
Join a structured path or a list of path parts.
+## Command Type + +`built-in` + ## Signature ```> path join {flags} ...rest``` diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index c832f712ad0..b0f077dd9d6 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.115.0 +version: 0.115.1 path: | Convert a path into structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a path into structured data.
+## Command Type + +`built-in` + ## Signature ```> path parse {flags} ``` diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index 2a08ac7b254..a37805f426a 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.115.0 +version: 0.115.1 path: | Express a path as relative to another path. usage: | @@ -16,6 +16,10 @@ contributors: false
Express a path as relative to another path.
+## Command Type + +`built-in` + ## Signature ```> path relative-to {flags} (path)``` diff --git a/commands/docs/path_self.md b/commands/docs/path_self.md index ebec9a81eab..fac07355d0b 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.115.0 +version: 0.115.1 path: | Get the absolute path of the script or module containing this command at parse time. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the absolute path of the script or module containing this command at parse time.
+## Command Type + +`built-in` + ## Signature ```> path self {flags} (path)``` diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index 3a3794547c2..44be07e6fcb 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.115.0 +version: 0.115.1 path: | Split a path into a list based on the system's path separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a path into a list based on the system's path separator.
+## Command Type + +`built-in` + ## Signature ```> path split {flags} ``` diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index a16b555c034..080b3e31371 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.115.0 +version: 0.115.1 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | @@ -16,6 +16,10 @@ contributors: false
Get the type of the object a path refers to (e.g., file, dir, symlink).
+## Command Type + +`built-in` + ## Signature ```> path type {flags} ``` diff --git a/commands/docs/peek.md b/commands/docs/peek.md index d3f9200c3a5..98232e56ae5 100644 --- a/commands/docs/peek.md +++ b/commands/docs/peek.md @@ -2,7 +2,7 @@ title: peek categories: | default -version: 0.115.0 +version: 0.115.1 default: | Peek the first elements of a stream and store them in the metadata. usage: | @@ -16,6 +16,10 @@ contributors: false
Peek the first <n> elements of a stream and store them in the metadata.
+## Command Type + +`built-in` + ## Signature ```> peek {flags} (n)``` diff --git a/commands/docs/permutations.md b/commands/docs/permutations.md index 92d091bf767..76e9f3d0996 100644 --- a/commands/docs/permutations.md +++ b/commands/docs/permutations.md @@ -2,7 +2,7 @@ title: permutations categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Generates all permutations of the input list. usage: | @@ -16,6 +16,10 @@ contributors: false
Generates all permutations of the input list.
+## Command Type + +`built-in` + ## Signature ```> permutations {flags} ``` diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index f88709de665..1a0df55bc29 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | Commands for managing plugins. usage: | @@ -16,6 +16,10 @@ contributors: false
Commands for managing plugins.
+## Command Type + +`built-in` + ## Signature ```> plugin {flags} ``` diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index a87a0601680..2280de2a31a 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | Add a plugin to the plugin registry file. usage: | @@ -16,6 +16,10 @@ contributors: false
Add a plugin to the plugin registry file.
+## Command Type + +`built-in` + ## Signature ```> plugin add {flags} (filename)``` diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 1f8508db926..b8ef06e0e0d 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | List loaded and installed plugins. usage: | @@ -16,6 +16,10 @@ contributors: false
List loaded and installed plugins.
+## Command Type + +`built-in` + ## Signature ```> plugin list {flags} ``` @@ -37,48 +41,17 @@ contributors: false List installed plugins. ```nu > plugin list -╭───┬──────┬────────────────────┬─────────┬────────┬───────────────────────────────┬───────┬─────────────────╮ -│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ -├───┼──────┼────────────────────┼─────────┼────────┼───────────────────────────────┼───────┼─────────────────┤ -│ 0 │ inc │ 0.115.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────┬───╮ │ -│ │ │ │ │ │ │ │ │ # │ nam │ d │ │ -│ │ │ │ │ │ │ │ │ │ e │ e │ │ -│ │ │ │ │ │ │ │ │ │ │ s │ │ -│ │ │ │ │ │ │ │ │ │ │ c │ │ -│ │ │ │ │ │ │ │ │ │ │ r │ │ -│ │ │ │ │ │ │ │ │ │ │ i │ │ -│ │ │ │ │ │ │ │ │ │ │ p │ │ -│ │ │ │ │ │ │ │ │ │ │ t │ │ -│ │ │ │ │ │ │ │ │ │ │ i │ │ -│ │ │ │ │ │ │ │ │ │ │ o │ │ -│ │ │ │ │ │ │ │ │ │ │ n │ │ -│ │ │ │ │ │ │ │ ├───┼─────┼───┤ │ -│ │ │ │ │ │ │ │ │ 0 │ inc │ I │ │ -│ │ │ │ │ │ │ │ │ │ │ n │ │ -│ │ │ │ │ │ │ │ │ │ │ c │ │ -│ │ │ │ │ │ │ │ │ │ │ r │ │ -│ │ │ │ │ │ │ │ │ │ │ e │ │ -│ │ │ │ │ │ │ │ │ │ │ m │ │ -│ │ │ │ │ │ │ │ │ │ │ e │ │ -│ │ │ │ │ │ │ │ │ │ │ n │ │ -│ │ │ │ │ │ │ │ │ │ │ t │ │ -│ │ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ │ │ a │ │ -│ │ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ │ │ n │ │ -│ │ │ │ │ │ │ │ │ │ │ u │ │ -│ │ │ │ │ │ │ │ │ │ │ m │ │ -│ │ │ │ │ │ │ │ │ │ │ b │ │ -│ │ │ │ │ │ │ │ │ │ │ e │ │ -│ │ │ │ │ │ │ │ │ │ │ r │ │ -│ │ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ │ │ b │ │ -│ │ │ │ │ │ │ │ │ │ │ y │ │ -│ │ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ │ │ 1 │ │ -│ │ │ │ │ │ │ │ │ │ │ . │ │ -│ │ │ │ │ │ │ │ ╰───┴─────┴───╯ │ -╰───┴──────┴────────────────────┴─────────┴────────┴───────────────────────────────┴───────┴─────────────────╯ +╭───┬──────┬─────────┬─────────┬────────┬───────────────────────────────┬───────┬────────────────────────────╮ +│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ +├───┼──────┼─────────┼─────────┼────────┼───────────────────────────────┼───────┼────────────────────────────┤ +│ 0 │ inc │ 0.115.1 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬──────┬─────────────╮ │ +│ │ │ │ │ │ │ │ │ # │ name │ description │ │ +│ │ │ │ │ │ │ │ ├───┼──────┼─────────────┤ │ +│ │ │ │ │ │ │ │ │ 0 │ inc │ Increment a │ │ +│ │ │ │ │ │ │ │ │ │ │ number by │ │ +│ │ │ │ │ │ │ │ │ │ │ 1. │ │ +│ │ │ │ │ │ │ │ ╰───┴──────┴─────────────╯ │ +╰───┴──────┴─────────┴─────────┴────────┴───────────────────────────────┴───────┴────────────────────────────╯ ``` diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 1ba3f040da6..3443cbdaa3b 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | Remove a plugin from the plugin registry file. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove a plugin from the plugin registry file.
+## Command Type + +`built-in` + ## Signature ```> plugin rm {flags} (name)``` diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index 489bca6126b..8eba83bcfe1 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | Stop an installed plugin if it was running. usage: | @@ -16,6 +16,10 @@ contributors: false
Stop an installed plugin if it was running.
+## Command Type + +`built-in` + ## Signature ```> plugin stop {flags} (name)``` diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index 5234bf18698..e012d0b4acc 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.115.0 +version: 0.115.1 plugin: | Load a plugin from the plugin registry file into scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Load a plugin from the plugin registry file into scope.
+## Command Type + +`keyword` + ## Signature ```> plugin use {flags} (name)``` diff --git a/commands/docs/polars.md b/commands/docs/polars.md index 86068c991b0..2c5c0129efa 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Operate with data in a dataframe format. usage: | @@ -16,6 +16,17 @@ contributors: false
Operate with data in a dataframe format.
+::: warning This command requires a plugin +The `polars` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars {flags} ``` diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index e7037757bc6..e24cc4ba5ac 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -2,7 +2,7 @@ title: polars agg-groups categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates an agg_groups expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates an agg_groups expression.
+::: warning This command requires a plugin +The `polars agg-groups` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars agg-groups {flags} ``` diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 9f36a04bc1d..054ab006fdd 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -16,6 +16,17 @@ contributors: false
Performs a series of aggregations from a group-by.
+::: warning This command requires a plugin +The `polars agg` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars agg {flags} ...rest``` diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index 1c19a202eb5..a1e84158b52 100644 --- a/commands/docs/polars_all-false.md +++ b/commands/docs/polars_all-false.md @@ -2,7 +2,7 @@ title: polars all-false categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns true if all values are false. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns true if all values are false.
+::: warning This command requires a plugin +The `polars all-false` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars all-false {flags} ``` diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index a37343aa487..5a41e20ba84 100644 --- a/commands/docs/polars_all-true.md +++ b/commands/docs/polars_all-true.md @@ -2,7 +2,7 @@ title: polars all-true categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns true if all values are true. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns true if all values are true.
+::: warning This command requires a plugin +The `polars all-true` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars all-true {flags} ``` diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index f8f66a92dc6..ddb602acd7b 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Appends a new dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Appends a new dataframe.
+::: warning This command requires a plugin +The `polars append` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars append {flags} (other)``` diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 26f16474952..35c7ea68871 100644 --- a/commands/docs/polars_arg-max.md +++ b/commands/docs/polars_arg-max.md @@ -2,7 +2,7 @@ title: polars arg-max categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Return index for max value in series. usage: | @@ -16,6 +16,17 @@ contributors: false
Return index for max value in series.
+::: warning This command requires a plugin +The `polars arg-max` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-max {flags} ``` diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index f40f49647fe..f685ee99e85 100644 --- a/commands/docs/polars_arg-min.md +++ b/commands/docs/polars_arg-min.md @@ -2,7 +2,7 @@ title: polars arg-min categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Return index for min value in series. usage: | @@ -16,6 +16,17 @@ contributors: false
Return index for min value in series.
+::: warning This command requires a plugin +The `polars arg-min` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-min {flags} ``` diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index 51e3b8207d4..39fd49d7281 100644 --- a/commands/docs/polars_arg-sort.md +++ b/commands/docs/polars_arg-sort.md @@ -2,7 +2,7 @@ title: polars arg-sort categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns indexes for a sorted series. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns indexes for a sorted series.
+::: warning This command requires a plugin +The `polars arg-sort` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-sort {flags} ``` diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index 10aeb0eb875..523dfef7b67 100644 --- a/commands/docs/polars_arg-true.md +++ b/commands/docs/polars_arg-true.md @@ -2,7 +2,7 @@ title: polars arg-true categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns indexes where values are true. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns indexes where values are true.
+::: warning This command requires a plugin +The `polars arg-true` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-true {flags} ``` diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index bb19f138f5d..fe4cf7c63d5 100644 --- a/commands/docs/polars_arg-unique.md +++ b/commands/docs/polars_arg-unique.md @@ -2,7 +2,7 @@ title: polars arg-unique categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns indexes for unique values. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns indexes for unique values.
+::: warning This command requires a plugin +The `polars arg-unique` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-unique {flags} ``` diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index 211e04a39a1..528fde29957 100644 --- a/commands/docs/polars_arg-where.md +++ b/commands/docs/polars_arg-where.md @@ -2,7 +2,7 @@ title: polars arg-where categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates an expression that returns the arguments where expression is true. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates an expression that returns the arguments where expression is true.
+::: warning This command requires a plugin +The `polars arg-where` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars arg-where {flags} (column name)``` diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index daa8cf9063f..5cbb0fdd734 100644 --- a/commands/docs/polars_as-date.md +++ b/commands/docs/polars_as-date.md @@ -2,7 +2,7 @@ title: polars as-date categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts string to date. usage: | @@ -16,6 +16,17 @@ contributors: false
Converts string to date.
+::: warning This command requires a plugin +The `polars as-date` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars as-date {flags} (format)``` diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index d4fec777d6a..7a64917fecf 100644 --- a/commands/docs/polars_as-datetime.md +++ b/commands/docs/polars_as-datetime.md @@ -2,7 +2,7 @@ title: polars as-datetime categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts string to datetime. usage: | @@ -16,6 +16,17 @@ contributors: false
Converts string to datetime.
+::: warning This command requires a plugin +The `polars as-datetime` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars as-datetime {flags} (format)``` @@ -86,14 +97,14 @@ Converts string to datetime using the `--not-exact` flag even with excessive sym Converts string to datetime using the `--not-exact` flag even with excessive symbols in an expression ```nu > ["2025-11-02 00:00:00", "2025-11-02 01:00:00", "2025-11-02 02:00:00", "2025-11-02 03:00:00"] | polars into-df | polars select (polars col 0 | polars as-datetime "%Y-%m-%d %H:%M:%S") -╭───┬──────────────╮ -│ # │ datetime │ -├───┼──────────────┤ -│ 0 │ 9 months ago │ -│ 1 │ 9 months ago │ -│ 2 │ 9 months ago │ -│ 3 │ 9 months ago │ -╰───┴──────────────╯ +╭───┬───────────────╮ +│ # │ datetime │ +├───┼───────────────┤ +│ 0 │ 10 months ago │ +│ 1 │ 10 months ago │ +│ 2 │ 10 months ago │ +│ 3 │ 10 months ago │ +╰───┴───────────────╯ ``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 0e108004282..69bbb37a4a1 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates an alias expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates an alias expression.
+::: warning This command requires a plugin +The `polars as` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars as {flags} (Alias name)``` diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index 1788b024df5..3708e12a349 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Caches operations in a new LazyFrame. usage: | @@ -16,6 +16,17 @@ contributors: false
Caches operations in a new LazyFrame.
+::: warning This command requires a plugin +The `polars cache` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars cache {flags} ``` diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 9481707828e..7e2f56ccec3 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Cast a column to a different dtype. usage: | @@ -16,6 +16,17 @@ contributors: false
Cast a column to a different dtype.
+::: warning This command requires a plugin +The `polars cast` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars cast {flags} (dtype) (column)``` diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index acf55f2ca98..14d21956dd6 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a named column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a named column expression.
+::: warning This command requires a plugin +The `polars col` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars col {flags} (column name) ...rest``` diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 121a28260af..e90058f9bf8 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Collect lazy dataframe into eager dataframe.
+::: warning This command requires a plugin +The `polars collect` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars collect {flags} ``` diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index bee91e47850..19a7d212de0 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Show dataframe columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Show dataframe columns.
+::: warning This command requires a plugin +The `polars columns` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars columns {flags} ``` diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index c43213312f6..49494604015 100644 --- a/commands/docs/polars_concat-str.md +++ b/commands/docs/polars_concat-str.md @@ -2,7 +2,7 @@ title: polars concat-str categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a concat string expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a concat string expression.
+::: warning This command requires a plugin +The `polars concat-str` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars concat-str {flags} (separator) (concat expressions)``` diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index dd84ce9f1ea..e48a853fa91 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Concatenate two or more dataframes. usage: | @@ -16,6 +16,17 @@ contributors: false
Concatenate two or more dataframes.
+::: warning This command requires a plugin +The `polars concat` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars concat {flags} ...rest``` diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 32af67860cf..88bbed3d693 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -16,6 +16,17 @@ contributors: false
Checks if a pattern is contained in a string.
+::: warning This command requires a plugin +The `polars contains` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars contains {flags} (pattern)``` diff --git a/commands/docs/polars_convert-time-zone.md b/commands/docs/polars_convert-time-zone.md index c0571d7e556..08319dc9b17 100644 --- a/commands/docs/polars_convert-time-zone.md +++ b/commands/docs/polars_convert-time-zone.md @@ -2,7 +2,7 @@ title: polars convert-time-zone categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Convert datetime to target timezone. usage: | @@ -16,6 +16,17 @@ contributors: false
Convert datetime to target timezone.
+::: warning This command requires a plugin +The `polars convert-time-zone` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars convert-time-zone {flags} (time_zone)``` diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 97bc719f456..d7043bc498e 100644 --- a/commands/docs/polars_count-null.md +++ b/commands/docs/polars_count-null.md @@ -2,7 +2,7 @@ title: polars count-null categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Counts null values. usage: | @@ -16,6 +16,17 @@ contributors: false
Counts null values.
+::: warning This command requires a plugin +The `polars count-null` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars count-null {flags} ``` diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 6fe86d72855..9523968e137 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns the number of non-null values in the column. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns the number of non-null values in the column.
+::: warning This command requires a plugin +The `polars count` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars count {flags} ``` diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index ff10354f64b..03ee25d8f51 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Cumulative calculation for a column or series. usage: | @@ -16,6 +16,17 @@ contributors: false
Cumulative calculation for a column or series.
+::: warning This command requires a plugin +The `polars cumulative` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars cumulative {flags} (type)``` diff --git a/commands/docs/polars_cut.md b/commands/docs/polars_cut.md index 63852cf0f0b..625a3eba6e5 100644 --- a/commands/docs/polars_cut.md +++ b/commands/docs/polars_cut.md @@ -2,7 +2,7 @@ title: polars cut categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Bin continuous values into discrete categories for a series. usage: | @@ -16,6 +16,17 @@ contributors: false
Bin continuous values into discrete categories for a series.
+::: warning This command requires a plugin +The `polars cut` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars cut {flags} (breaks)``` diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index 564214baf2b..b45ab024f2a 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates an expression for capturing the specified datepart in a column.
+::: warning This command requires a plugin +The `polars datepart` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars datepart {flags} (Datepart name)``` diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index 40bd0c6dcab..4bf2c7f2900 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts a string column into a decimal column usage: | @@ -16,6 +16,17 @@ contributors: false
Converts a string column into a decimal column
+::: warning This command requires a plugin +The `polars decimal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars decimal {flags} (infer_length)``` diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index e2f0460efce..b661005dd47 100644 --- a/commands/docs/polars_drop-duplicates.md +++ b/commands/docs/polars_drop-duplicates.md @@ -2,7 +2,7 @@ title: polars drop-duplicates categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Drops duplicate values in dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Drops duplicate values in dataframe.
+::: warning This command requires a plugin +The `polars drop-duplicates` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars drop-duplicates {flags} (subset)``` diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index 7a083b60ae4..1cf6824581f 100644 --- a/commands/docs/polars_drop-nulls.md +++ b/commands/docs/polars_drop-nulls.md @@ -2,7 +2,7 @@ title: polars drop-nulls categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Drops null values in dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Drops null values in dataframe.
+::: warning This command requires a plugin +The `polars drop-nulls` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars drop-nulls {flags} (subset)``` diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index fa4ff08678e..700bdf3a0f3 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a new dataframe by dropping the selected columns.
+::: warning This command requires a plugin +The `polars drop` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars drop {flags} ...rest``` diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index cbd8d45d567..0279655b15f 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a new dataframe with dummy variables. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a new dataframe with dummy variables.
+::: warning This command requires a plugin +The `polars dummies` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars dummies {flags} ``` diff --git a/commands/docs/polars_entropy.md b/commands/docs/polars_entropy.md index 3c7674784d7..75cb473bc41 100644 --- a/commands/docs/polars_entropy.md +++ b/commands/docs/polars_entropy.md @@ -2,7 +2,7 @@ title: polars entropy categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities.
+::: warning This command requires a plugin +The `polars entropy` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars entropy {flags} ``` diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index f09e4cb337e..8be3d3caf24 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Explodes a dataframe or creates a explode expression.
+::: warning This command requires a plugin +The `polars explode` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars explode {flags} ...rest``` diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 0f5fca3d1b6..3cbbdad3802 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -2,7 +2,7 @@ title: polars expr-not categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a not expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a not expression.
+::: warning This command requires a plugin +The `polars expr-not` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars expr-not {flags} ``` diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index 2bf72dc07cb..ba37684e5df 100644 --- a/commands/docs/polars_fill-nan.md +++ b/commands/docs/polars_fill-nan.md @@ -2,7 +2,7 @@ title: polars fill-nan categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Replaces NaN values with the given expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Replaces NaN values with the given expression.
+::: warning This command requires a plugin +The `polars fill-nan` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars fill-nan {flags} (fill)``` diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index b45916ed3ca..c44cfbfd7df 100644 --- a/commands/docs/polars_fill-null.md +++ b/commands/docs/polars_fill-null.md @@ -2,7 +2,7 @@ title: polars fill-null categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Replaces NULL values with the given expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Replaces NULL values with the given expression.
+::: warning This command requires a plugin +The `polars fill-null` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars fill-null {flags} (fill)``` diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index 2985bf3f8f6..f3feebf7ae5 100644 --- a/commands/docs/polars_filter-with.md +++ b/commands/docs/polars_filter-with.md @@ -2,7 +2,7 @@ title: polars filter-with categories: | dataframe or lazyframe -version: 0.115.0 +version: 0.115.1 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | @@ -16,6 +16,17 @@ contributors: false
Filters dataframe using a mask or expression as reference.
+::: warning This command requires a plugin +The `polars filter-with` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars filter-with {flags} (mask or expression)``` diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index b79a9db9aaa..64c0d4b9c10 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Filter dataframe based in expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Filter dataframe based in expression.
+::: warning This command requires a plugin +The `polars filter` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars filter {flags} (filter expression)``` diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index 729712c1d88..25c5639abd4 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Show only the first number of rows or create a first expression usage: | @@ -16,6 +16,17 @@ contributors: false
Show only the first number of rows or create a first expression
+::: warning This command requires a plugin +The `polars first` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars first {flags} (rows)``` diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index 1c226feb204..0009c20b146 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | An alias for polars explode. usage: | @@ -16,6 +16,17 @@ contributors: false
An alias for polars explode.
+::: warning This command requires a plugin +The `polars flatten` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars flatten {flags} ...rest``` diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index 62c2916b1f0..d9234f1eee8 100644 --- a/commands/docs/polars_get-day.md +++ b/commands/docs/polars_get-day.md @@ -2,7 +2,7 @@ title: polars get-day categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets day from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets day from date.
+::: warning This command requires a plugin +The `polars get-day` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-day {flags} ``` diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 29aa2415078..e1e7b6bc3ce 100644 --- a/commands/docs/polars_get-hour.md +++ b/commands/docs/polars_get-hour.md @@ -2,7 +2,7 @@ title: polars get-hour categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets hour from datetime. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets hour from datetime.
+::: warning This command requires a plugin +The `polars get-hour` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-hour {flags} ``` diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 9de8f6e7dda..d2ed3a737ac 100644 --- a/commands/docs/polars_get-minute.md +++ b/commands/docs/polars_get-minute.md @@ -2,7 +2,7 @@ title: polars get-minute categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets minute from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets minute from date.
+::: warning This command requires a plugin +The `polars get-minute` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-minute {flags} ``` diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index e66cc144f28..df71b5f8996 100644 --- a/commands/docs/polars_get-month.md +++ b/commands/docs/polars_get-month.md @@ -2,7 +2,7 @@ title: polars get-month categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets month from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets month from date.
+::: warning This command requires a plugin +The `polars get-month` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-month {flags} ``` diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 3c7504665d1..6f15a7abdf9 100644 --- a/commands/docs/polars_get-nanosecond.md +++ b/commands/docs/polars_get-nanosecond.md @@ -2,7 +2,7 @@ title: polars get-nanosecond categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets nanosecond from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets nanosecond from date.
+::: warning This command requires a plugin +The `polars get-nanosecond` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-nanosecond {flags} ``` diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 80190a5767b..b4795396707 100644 --- a/commands/docs/polars_get-ordinal.md +++ b/commands/docs/polars_get-ordinal.md @@ -2,7 +2,7 @@ title: polars get-ordinal categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets ordinal from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets ordinal from date.
+::: warning This command requires a plugin +The `polars get-ordinal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-ordinal {flags} ``` diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 16dd815e458..aea1a5fd5d7 100644 --- a/commands/docs/polars_get-second.md +++ b/commands/docs/polars_get-second.md @@ -2,7 +2,7 @@ title: polars get-second categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets second from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets second from date.
+::: warning This command requires a plugin +The `polars get-second` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-second {flags} ``` diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index ab34e45f0ab..608879dec36 100644 --- a/commands/docs/polars_get-week.md +++ b/commands/docs/polars_get-week.md @@ -2,7 +2,7 @@ title: polars get-week categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets week from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets week from date.
+::: warning This command requires a plugin +The `polars get-week` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-week {flags} ``` diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 3ab03108dab..a851bd947fe 100644 --- a/commands/docs/polars_get-weekday.md +++ b/commands/docs/polars_get-weekday.md @@ -2,7 +2,7 @@ title: polars get-weekday categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets weekday from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets weekday from date.
+::: warning This command requires a plugin +The `polars get-weekday` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-weekday {flags} ``` diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index f7047dc63cb..dcecff78328 100644 --- a/commands/docs/polars_get-year.md +++ b/commands/docs/polars_get-year.md @@ -2,7 +2,7 @@ title: polars get-year categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets year from date. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets year from date.
+::: warning This command requires a plugin +The `polars get-year` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get-year {flags} ``` diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 0d8a99a8169..f8468a91cd3 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates dataframe with the selected columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates dataframe with the selected columns.
+::: warning This command requires a plugin +The `polars get` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars get {flags} ...rest``` diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index 6e9e8a2b9b5..8ec87d898d8 100644 --- a/commands/docs/polars_group-by.md +++ b/commands/docs/polars_group-by.md @@ -2,7 +2,7 @@ title: polars group-by categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a group-by object that can be used for other aggregations.
+::: warning This command requires a plugin +The `polars group-by` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars group-by {flags} ...rest``` diff --git a/commands/docs/polars_horizontal.md b/commands/docs/polars_horizontal.md index cebcb4507c1..ad5c2eb3389 100644 --- a/commands/docs/polars_horizontal.md +++ b/commands/docs/polars_horizontal.md @@ -2,7 +2,7 @@ title: polars horizontal categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Horizontal calculation across multiple columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Horizontal calculation across multiple columns.
+::: warning This command requires a plugin +The `polars horizontal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars horizontal {flags} (type) ...rest``` diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 3be23edb2f5..68cc4869a08 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Aggregates values into a list. usage: | @@ -16,6 +16,17 @@ contributors: false
Aggregates values into a list.
+::: warning This command requires a plugin +The `polars implode` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars implode {flags} ``` diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index 7d22d9ca861..5f88f70dd42 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts a string column into a integer column usage: | @@ -16,6 +16,17 @@ contributors: false
Converts a string column into a integer column
+::: warning This command requires a plugin +The `polars integer` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars integer {flags} (base) (dtype)``` diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index 8ac1454dc13..c6132138044 100644 --- a/commands/docs/polars_into-df.md +++ b/commands/docs/polars_into-df.md @@ -2,7 +2,7 @@ title: polars into-df categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts a list, table or record into a dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Converts a list, table or record into a dataframe.
+::: warning This command requires a plugin +The `polars into-df` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-df {flags} ``` diff --git a/commands/docs/polars_into-dtype.md b/commands/docs/polars_into-dtype.md index dd437ad1a28..c959dacc108 100644 --- a/commands/docs/polars_into-dtype.md +++ b/commands/docs/polars_into-dtype.md @@ -2,7 +2,7 @@ title: polars into-dtype categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Convert a string to a specific datatype. usage: | @@ -16,6 +16,17 @@ contributors: false
Convert a string to a specific datatype.
+::: warning This command requires a plugin +The `polars into-dtype` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-dtype {flags} ``` diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index f2b9b857624..960b1986121 100644 --- a/commands/docs/polars_into-lazy.md +++ b/commands/docs/polars_into-lazy.md @@ -2,7 +2,7 @@ title: polars into-lazy categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Converts a dataframe into a lazy dataframe.
+::: warning This command requires a plugin +The `polars into-lazy` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-lazy {flags} ``` diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index 220df522a54..a9139f00034 100644 --- a/commands/docs/polars_into-nu.md +++ b/commands/docs/polars_into-nu.md @@ -2,7 +2,7 @@ title: polars into-nu categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | @@ -16,6 +16,17 @@ contributors: false
Converts a dataframe or an expression into nushell value for access and exploration.
+::: warning This command requires a plugin +The `polars into-nu` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-nu {flags} ``` diff --git a/commands/docs/polars_into-repr.md b/commands/docs/polars_into-repr.md index 025ebc3ac99..79b17b98723 100644 --- a/commands/docs/polars_into-repr.md +++ b/commands/docs/polars_into-repr.md @@ -2,7 +2,7 @@ title: polars into-repr categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Display a dataframe in its repr format. usage: | @@ -16,6 +16,17 @@ contributors: false
Display a dataframe in its repr format.
+::: warning This command requires a plugin +The `polars into-repr` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-repr {flags} ``` diff --git a/commands/docs/polars_into-schema.md b/commands/docs/polars_into-schema.md index 46633aae885..ef50fc6917d 100644 --- a/commands/docs/polars_into-schema.md +++ b/commands/docs/polars_into-schema.md @@ -2,7 +2,7 @@ title: polars into-schema categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Convert a value to a polars schema object usage: | @@ -16,6 +16,17 @@ contributors: false
Convert a value to a polars schema object
+::: warning This command requires a plugin +The `polars into-schema` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars into-schema {flags} ``` diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 2f564cde90f..78a89bda83d 100644 --- a/commands/docs/polars_is-duplicated.md +++ b/commands/docs/polars_is-duplicated.md @@ -2,7 +2,7 @@ title: polars is-duplicated categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates mask indicating duplicated values. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates mask indicating duplicated values.
+::: warning This command requires a plugin +The `polars is-duplicated` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars is-duplicated {flags} ``` diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index e0d7e047a3f..543db5b7c45 100644 --- a/commands/docs/polars_is-in.md +++ b/commands/docs/polars_is-in.md @@ -2,7 +2,7 @@ title: polars is-in categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | @@ -16,6 +16,17 @@ contributors: false
Creates an is-in expression or checks to see if the elements are contained in the right series
+::: warning This command requires a plugin +The `polars is-in` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars is-in {flags} (list)``` diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index 15133540904..721b382b0af 100644 --- a/commands/docs/polars_is-not-null.md +++ b/commands/docs/polars_is-not-null.md @@ -2,7 +2,7 @@ title: polars is-not-null categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates mask where value is not null. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates mask where value is not null.
+::: warning This command requires a plugin +The `polars is-not-null` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars is-not-null {flags} ``` diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index c1ca9524ca3..d9ff6cfc986 100644 --- a/commands/docs/polars_is-null.md +++ b/commands/docs/polars_is-null.md @@ -2,7 +2,7 @@ title: polars is-null categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates mask where value is null. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates mask where value is null.
+::: warning This command requires a plugin +The `polars is-null` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars is-null {flags} ``` diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index ce3539fbc2e..558104c5719 100644 --- a/commands/docs/polars_is-unique.md +++ b/commands/docs/polars_is-unique.md @@ -2,7 +2,7 @@ title: polars is-unique categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates mask indicating unique values. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates mask indicating unique values.
+::: warning This command requires a plugin +The `polars is-unique` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars is-unique {flags} ``` diff --git a/commands/docs/polars_join-where.md b/commands/docs/polars_join-where.md index cb8cc9b5e39..246123f7b57 100644 --- a/commands/docs/polars_join-where.md +++ b/commands/docs/polars_join-where.md @@ -2,7 +2,7 @@ title: polars join-where categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Joins a lazy frame with other lazy frame based on conditions. usage: | @@ -16,6 +16,17 @@ contributors: false
Joins a lazy frame with other lazy frame based on conditions.
+::: warning This command requires a plugin +The `polars join-where` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars join-where {flags} (other) (condition)``` diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index b0992d64557..e62375a2500 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Joins a lazy frame with other lazy frame. usage: | @@ -16,6 +16,17 @@ contributors: false
Joins a lazy frame with other lazy frame.
+::: warning This command requires a plugin +The `polars join` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars join {flags} (other) (left_on) (right_on)``` diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 5b850bbb27f..ca6744cbdb3 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates new dataframe with tail rows or creates a last expression.
+::: warning This command requires a plugin +The `polars last` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars last {flags} (rows)``` diff --git a/commands/docs/polars_len.md b/commands/docs/polars_len.md index 6f05569e5e5..adf63e70fe5 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Return the number of rows in the context. This is similar to COUNT(*) in SQL. usage: | @@ -16,6 +16,17 @@ contributors: false
Return the number of rows in the context. This is similar to COUNT(*) in SQL.
+::: warning This command requires a plugin +The `polars len` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars len {flags} ``` diff --git a/commands/docs/polars_list-contains.md b/commands/docs/polars_list-contains.md index 85cb75473b5..b66f47836c2 100644 --- a/commands/docs/polars_list-contains.md +++ b/commands/docs/polars_list-contains.md @@ -2,7 +2,7 @@ title: polars list-contains categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Checks if an element is contained in a list. usage: | @@ -16,6 +16,17 @@ contributors: false
Checks if an element is contained in a list.
+::: warning This command requires a plugin +The `polars list-contains` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars list-contains {flags} (element)``` diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 75fb422692f..8579c4566e6 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a literal expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a literal expression.
+::: warning This command requires a plugin +The `polars lit` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars lit {flags} (literal)``` diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index 53bfc7b3276..3c227eb34e1 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Lowercase the strings in the column. usage: | @@ -16,6 +16,17 @@ contributors: false
Lowercase the strings in the column.
+::: warning This command requires a plugin +The `polars lowercase` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars lowercase {flags} ``` diff --git a/commands/docs/polars_map-batches.md b/commands/docs/polars_map-batches.md index 3a47f6d1dc9..87259e85ce8 100644 --- a/commands/docs/polars_map-batches.md +++ b/commands/docs/polars_map-batches.md @@ -2,7 +2,7 @@ title: polars map-batches categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Map a custom Nushell closure over one or more dataframe columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Map a custom Nushell closure over one or more dataframe columns.
+::: warning This command requires a plugin +The `polars map-batches` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars map-batches {flags} (closure) ...rest``` diff --git a/commands/docs/polars_math.md b/commands/docs/polars_math.md index 78a988b1f11..c0a42920e7f 100644 --- a/commands/docs/polars_math.md +++ b/commands/docs/polars_math.md @@ -2,7 +2,7 @@ title: polars math categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Collection of math functions to be applied on column expressions. usage: | @@ -16,6 +16,17 @@ contributors: false
Collection of math functions to be applied on column expressions.
+::: warning This command requires a plugin +The `polars math` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math {flags} ``` diff --git a/commands/docs/polars_math_abs.md b/commands/docs/polars_math_abs.md index 31e275929af..2441a70d7d4 100644 --- a/commands/docs/polars_math_abs.md +++ b/commands/docs/polars_math_abs.md @@ -2,7 +2,7 @@ title: polars math abs categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the absolute values of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the absolute values of a column expression.
+::: warning This command requires a plugin +The `polars math abs` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math abs {flags} ``` diff --git a/commands/docs/polars_math_bitwise-and.md b/commands/docs/polars_math_bitwise-and.md index efac9ae032e..a2cc9f52c8f 100644 --- a/commands/docs/polars_math_bitwise-and.md +++ b/commands/docs/polars_math_bitwise-and.md @@ -2,7 +2,7 @@ title: polars math bitwise-and categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Perform an aggregation of bitwise ANDs over a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Perform an aggregation of bitwise ANDs over a column expression.
+::: warning This command requires a plugin +The `polars math bitwise-and` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-and {flags} ``` diff --git a/commands/docs/polars_math_bitwise-count-ones.md b/commands/docs/polars_math_bitwise-count-ones.md index ed9b01c75cb..375180b3c09 100644 --- a/commands/docs/polars_math_bitwise-count-ones.md +++ b/commands/docs/polars_math_bitwise-count-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-count-ones categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of set bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of set bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-count-ones` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-count-ones {flags} ``` diff --git a/commands/docs/polars_math_bitwise-count-zeros.md b/commands/docs/polars_math_bitwise-count-zeros.md index c91dbec03c2..e89ffe31925 100644 --- a/commands/docs/polars_math_bitwise-count-zeros.md +++ b/commands/docs/polars_math_bitwise-count-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-count-zeros categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of unset bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of unset bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-count-zeros` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-count-zeros {flags} ``` diff --git a/commands/docs/polars_math_bitwise-leading-ones.md b/commands/docs/polars_math_bitwise-leading-ones.md index 95d77860886..39fa5374788 100644 --- a/commands/docs/polars_math_bitwise-leading-ones.md +++ b/commands/docs/polars_math_bitwise-leading-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-leading-ones categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of leading set bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of leading set bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-leading-ones` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-leading-ones {flags} ``` diff --git a/commands/docs/polars_math_bitwise-leading-zeros.md b/commands/docs/polars_math_bitwise-leading-zeros.md index 1cf30538e71..311c82fdf73 100644 --- a/commands/docs/polars_math_bitwise-leading-zeros.md +++ b/commands/docs/polars_math_bitwise-leading-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-leading-zeros categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of leading unset bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of leading unset bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-leading-zeros` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-leading-zeros {flags} ``` diff --git a/commands/docs/polars_math_bitwise-or.md b/commands/docs/polars_math_bitwise-or.md index 9a13158c6c0..0cccc9222e0 100644 --- a/commands/docs/polars_math_bitwise-or.md +++ b/commands/docs/polars_math_bitwise-or.md @@ -2,7 +2,7 @@ title: polars math bitwise-or categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Perform an aggregation of bitwise ORs over a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Perform an aggregation of bitwise ORs over a column expression.
+::: warning This command requires a plugin +The `polars math bitwise-or` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-or {flags} ``` diff --git a/commands/docs/polars_math_bitwise-trailing-ones.md b/commands/docs/polars_math_bitwise-trailing-ones.md index b9a02edd6d3..f3bd381ce74 100644 --- a/commands/docs/polars_math_bitwise-trailing-ones.md +++ b/commands/docs/polars_math_bitwise-trailing-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-trailing-ones categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of trailing set bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of trailing set bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-trailing-ones` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-trailing-ones {flags} ``` diff --git a/commands/docs/polars_math_bitwise-trailing-zeros.md b/commands/docs/polars_math_bitwise-trailing-zeros.md index 8d6340cf4ad..64b66b6d33f 100644 --- a/commands/docs/polars_math_bitwise-trailing-zeros.md +++ b/commands/docs/polars_math_bitwise-trailing-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-trailing-zeros categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the number of trailing unset bits for each element in an integer column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the number of trailing unset bits for each element in an integer column expression.
+::: warning This command requires a plugin +The `polars math bitwise-trailing-zeros` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-trailing-zeros {flags} ``` diff --git a/commands/docs/polars_math_bitwise-xor.md b/commands/docs/polars_math_bitwise-xor.md index fe01b69a71a..18119b4bac1 100644 --- a/commands/docs/polars_math_bitwise-xor.md +++ b/commands/docs/polars_math_bitwise-xor.md @@ -2,7 +2,7 @@ title: polars math bitwise-xor categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Perform an aggregation of bitwise XORs over a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Perform an aggregation of bitwise XORs over a column expression.
+::: warning This command requires a plugin +The `polars math bitwise-xor` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math bitwise-xor {flags} ``` diff --git a/commands/docs/polars_math_cos.md b/commands/docs/polars_math_cos.md index 78a37d0c6d0..b1658697362 100644 --- a/commands/docs/polars_math_cos.md +++ b/commands/docs/polars_math_cos.md @@ -2,7 +2,7 @@ title: polars math cos categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise cosine of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise cosine of a column expression.
+::: warning This command requires a plugin +The `polars math cos` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math cos {flags} ``` diff --git a/commands/docs/polars_math_dot.md b/commands/docs/polars_math_dot.md index c1d1a6228c6..24e9b5dd56e 100644 --- a/commands/docs/polars_math_dot.md +++ b/commands/docs/polars_math_dot.md @@ -2,7 +2,7 @@ title: polars math dot categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the dot product of two column expressions. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the dot product of two column expressions.
+::: warning This command requires a plugin +The `polars math dot` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math dot {flags} (other)``` diff --git a/commands/docs/polars_math_exp.md b/commands/docs/polars_math_exp.md index f019a1b47a5..1d45dda65f0 100644 --- a/commands/docs/polars_math_exp.md +++ b/commands/docs/polars_math_exp.md @@ -2,7 +2,7 @@ title: polars math exp categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute element-wise e raised to the power of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute element-wise e raised to the power of a column expression.
+::: warning This command requires a plugin +The `polars math exp` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math exp {flags} ``` diff --git a/commands/docs/polars_math_log.md b/commands/docs/polars_math_log.md index 50af9895d98..083b50dce66 100644 --- a/commands/docs/polars_math_log.md +++ b/commands/docs/polars_math_log.md @@ -2,7 +2,7 @@ title: polars math log categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise logarithm of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise logarithm of a column expression.
+::: warning This command requires a plugin +The `polars math log` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math log {flags} (base)``` diff --git a/commands/docs/polars_math_log1p.md b/commands/docs/polars_math_log1p.md index c3b05f07e20..37c3345aab0 100644 --- a/commands/docs/polars_math_log1p.md +++ b/commands/docs/polars_math_log1p.md @@ -2,7 +2,7 @@ title: polars math log1p categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise natural log of 1 + x for a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise natural log of 1 + x for a column expression.
+::: warning This command requires a plugin +The `polars math log1p` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math log1p {flags} ``` diff --git a/commands/docs/polars_math_sign.md b/commands/docs/polars_math_sign.md index 1d1d2479887..c8ef77fc517 100644 --- a/commands/docs/polars_math_sign.md +++ b/commands/docs/polars_math_sign.md @@ -2,7 +2,7 @@ title: polars math sign categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise sign of a column expression, returning -1, 0, or 1. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise sign of a column expression, returning -1, 0, or 1.
+::: warning This command requires a plugin +The `polars math sign` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math sign {flags} ``` diff --git a/commands/docs/polars_math_sin.md b/commands/docs/polars_math_sin.md index 7717d0d9686..c146583f0c5 100644 --- a/commands/docs/polars_math_sin.md +++ b/commands/docs/polars_math_sin.md @@ -2,7 +2,7 @@ title: polars math sin categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise sine of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise sine of a column expression.
+::: warning This command requires a plugin +The `polars math sin` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math sin {flags} ``` diff --git a/commands/docs/polars_math_sqrt.md b/commands/docs/polars_math_sqrt.md index 65462273393..411b1db0ff4 100644 --- a/commands/docs/polars_math_sqrt.md +++ b/commands/docs/polars_math_sqrt.md @@ -2,7 +2,7 @@ title: polars math sqrt categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Compute the element-wise square root of a column expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute the element-wise square root of a column expression.
+::: warning This command requires a plugin +The `polars math sqrt` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars math sqrt {flags} ``` diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 97e6b4f0b2a..3230c949acf 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a max expression or aggregates columns to their max value. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a max expression or aggregates columns to their max value.
+::: warning This command requires a plugin +The `polars max` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars max {flags} ``` diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 3f2b087d1e2..ee0b7da04c5 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a mean expression for an aggregation or aggregates columns to their mean value.
+::: warning This command requires a plugin +The `polars mean` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars mean {flags} ``` diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index 47aedf438fe..88d26348e26 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | @@ -16,6 +16,17 @@ contributors: false
Median value from columns in a dataframe or creates expression for an aggregation
+::: warning This command requires a plugin +The `polars median` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars median {flags} ``` diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index b9762d5c39c..bf40755901e 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a min expression or aggregates columns to their min value. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a min expression or aggregates columns to their min value.
+::: warning This command requires a plugin +The `polars min` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars min {flags} ``` diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index dbc55045555..d47bb44576b 100644 --- a/commands/docs/polars_n-unique.md +++ b/commands/docs/polars_n-unique.md @@ -2,7 +2,7 @@ title: polars n-unique categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Counts unique values. usage: | @@ -16,6 +16,17 @@ contributors: false
Counts unique values.
+::: warning This command requires a plugin +The `polars n-unique` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars n-unique {flags} ``` diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index c29f37307a8..5fef81406ee 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Inverts boolean mask. usage: | @@ -16,6 +16,17 @@ contributors: false
Inverts boolean mask.
+::: warning This command requires a plugin +The `polars not` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars not {flags} ``` diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 2d9f2808079..4c6f6e3cc07 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. usage: | @@ -16,6 +16,17 @@ contributors: false
Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported.
+::: warning This command requires a plugin +The `polars open` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars open {flags} (file)``` diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index b29e2f73f4a..021be70e8db 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Completes a when expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Completes a when expression.
+::: warning This command requires a plugin +The `polars otherwise` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars otherwise {flags} (otherwise expression)``` diff --git a/commands/docs/polars_over.md b/commands/docs/polars_over.md index 2c692bf5232..693d6fde760 100644 --- a/commands/docs/polars_over.md +++ b/commands/docs/polars_over.md @@ -2,7 +2,7 @@ title: polars over categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Compute expressions over a window group defined by partition expressions. usage: | @@ -16,6 +16,17 @@ contributors: false
Compute expressions over a window group defined by partition expressions.
+::: warning This command requires a plugin +The `polars over` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars over {flags} ...rest``` diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 9acb4f01bb0..647ed28c1da 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Pivot a DataFrame from long to wide format. usage: | @@ -16,6 +16,17 @@ contributors: false
Pivot a DataFrame from long to wide format.
+::: warning This command requires a plugin +The `polars pivot` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars pivot {flags} ``` diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index c51a71f9a09..03a62e9dca6 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Profile a lazy dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Profile a lazy dataframe.
+::: warning This command requires a plugin +The `polars profile` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars profile {flags} ``` diff --git a/commands/docs/polars_qcut.md b/commands/docs/polars_qcut.md index bdb71d50a69..fbe9f6a773f 100644 --- a/commands/docs/polars_qcut.md +++ b/commands/docs/polars_qcut.md @@ -2,7 +2,7 @@ title: polars qcut categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Bin continuous values into discrete categories based on their quantiles for a series. usage: | @@ -16,6 +16,17 @@ contributors: false
Bin continuous values into discrete categories based on their quantiles for a series.
+::: warning This command requires a plugin +The `polars qcut` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars qcut {flags} (quantiles)``` diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index db48201ded6..69ed0173bc2 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -16,6 +16,17 @@ contributors: false
Aggregates the columns to the selected quantile.
+::: warning This command requires a plugin +The `polars quantile` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars quantile {flags} (quantile)``` diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index 63fc4fd16f2..ee31d7c1b3f 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | @@ -16,6 +16,17 @@ contributors: false
Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause.
+::: warning This command requires a plugin +The `polars query` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars query {flags} (sql)``` diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index d51cde12443..efbe39ff28f 100644 --- a/commands/docs/polars_rename.md +++ b/commands/docs/polars_rename.md @@ -2,7 +2,7 @@ title: polars rename categories: | dataframe or lazyframe -version: 0.115.0 +version: 0.115.1 dataframe_or_lazyframe: | Rename a dataframe column. usage: | @@ -16,6 +16,17 @@ contributors: false
Rename a dataframe column.
+::: warning This command requires a plugin +The `polars rename` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars rename {flags} (columns) (new names)``` diff --git a/commands/docs/polars_replace-time-zone.md b/commands/docs/polars_replace-time-zone.md index e23b6106b4f..0a4527acb8b 100644 --- a/commands/docs/polars_replace-time-zone.md +++ b/commands/docs/polars_replace-time-zone.md @@ -2,7 +2,7 @@ title: polars replace-time-zone categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Replace the timezone information in a datetime column. usage: | @@ -16,6 +16,17 @@ contributors: false
Replace the timezone information in a datetime column.
+::: warning This command requires a plugin +The `polars replace-time-zone` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars replace-time-zone {flags} (time_zone)``` @@ -62,14 +73,14 @@ Apply timezone with ambiguous datetime | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S" --naive | polars select (polars col datetime | polars replace-time-zone "America/New_York" --ambiguous null) -╭───┬──────────────╮ -│ # │ datetime │ -├───┼──────────────┤ -│ 0 │ 9 months ago │ -│ 1 │ │ -│ 2 │ 9 months ago │ -│ 3 │ 9 months ago │ -╰───┴──────────────╯ +╭───┬───────────────╮ +│ # │ datetime │ +├───┼───────────────┤ +│ 0 │ 10 months ago │ +│ 1 │ │ +│ 2 │ 10 months ago │ +│ 3 │ 10 months ago │ +╰───┴───────────────╯ ``` @@ -79,13 +90,13 @@ Apply timezone with nonexistent datetime | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S" --naive | polars select (polars col datetime | polars replace-time-zone "America/New_York" --nonexistent null) -╭───┬────────────╮ -│ # │ datetime │ -├───┼────────────┤ -│ 0 │ a year ago │ -│ 1 │ │ -│ 2 │ a year ago │ -│ 3 │ a year ago │ -╰───┴────────────╯ +╭───┬─────────────╮ +│ # │ datetime │ +├───┼─────────────┤ +│ 0 │ 2 years ago │ +│ 1 │ │ +│ 2 │ 2 years ago │ +│ 3 │ 2 years ago │ +╰───┴─────────────╯ ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 0fd0fcf1e9d..5eb7277d27f 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Create an expression that replaces old values with new values usage: | @@ -16,6 +16,17 @@ contributors: false
Create an expression that replaces old values with new values
+::: warning This command requires a plugin +The `polars replace` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars replace {flags} (old) (new)``` diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 2fbf14072d1..6c340df1425 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Reverses the LazyFrame usage: | @@ -16,6 +16,17 @@ contributors: false
Reverses the LazyFrame
+::: warning This command requires a plugin +The `polars reverse` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars reverse {flags} ``` diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index d2a959e4abf..18f55d0925c 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Rolling calculation for a series or expression, or a rolling group-by for a lazyframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Rolling calculation for a series or expression, or a rolling group-by for a lazyframe.
+::: warning This command requires a plugin +The `polars rolling` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars rolling {flags} (type) (window)``` diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index df0da2f7f58..911e65703dc 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Create sample dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Create sample dataframe.
+::: warning This command requires a plugin +The `polars sample` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars sample {flags} ``` diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index 7b0deb32c8d..b0528361f07 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson). usage: | @@ -16,6 +16,17 @@ contributors: false
Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson).
+::: warning This command requires a plugin +The `polars save` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars save {flags} (path)``` diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index ffe371e42ce..5e08b400252 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Show schema for a dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Show schema for a dataframe.
+::: warning This command requires a plugin +The `polars schema` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars schema {flags} ``` diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 4fcf0eb5abd..44bd3666067 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Selects columns from lazyframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Selects columns from lazyframe.
+::: warning This command requires a plugin +The `polars select` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars select {flags} ...rest``` diff --git a/commands/docs/polars_selector.md b/commands/docs/polars_selector.md index 1eeeb99a972..bc55976f2d7 100644 --- a/commands/docs/polars_selector.md +++ b/commands/docs/polars_selector.md @@ -2,7 +2,7 @@ title: polars selector categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Create column selectors for use in polars commands. usage: | @@ -16,6 +16,17 @@ contributors: false
Create column selectors for use in polars commands.
+::: warning This command requires a plugin +The `polars selector` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector {flags} ``` diff --git a/commands/docs/polars_selector_all.md b/commands/docs/polars_selector_all.md index af12bc4b943..c1dc111c285 100644 --- a/commands/docs/polars_selector_all.md +++ b/commands/docs/polars_selector_all.md @@ -2,7 +2,7 @@ title: polars selector all categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a selector that selects all columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a selector that selects all columns.
+::: warning This command requires a plugin +The `polars selector all` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector all {flags} ``` diff --git a/commands/docs/polars_selector_alpha.md b/commands/docs/polars_selector_alpha.md index efbabacad31..8f9d31b8d96 100644 --- a/commands/docs/polars_selector_alpha.md +++ b/commands/docs/polars_selector_alpha.md @@ -2,7 +2,7 @@ title: polars selector alpha categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all columns with alphabetic names (eg: only letters). Matching column names cannot contain *any* non-alphabetic characters. Note that the definition of "alphabetic" consists of all valid Unicode alphabetic characters by default; this can be changed by setting `--ascii-only`. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all columns with alphabetic names (eg: only letters). Matching column names cannot contain *any* non-alphabetic characters. Note that the definition of "alphabetic" consists of all valid Unicode alphabetic characters by default; this can be changed by setting `--ascii-only`.
+::: warning This command requires a plugin +The `polars selector alpha` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector alpha {flags} ``` diff --git a/commands/docs/polars_selector_alphanumeric.md b/commands/docs/polars_selector_alphanumeric.md index 0d90efed909..78d0597fa85 100644 --- a/commands/docs/polars_selector_alphanumeric.md +++ b/commands/docs/polars_selector_alphanumeric.md @@ -2,7 +2,7 @@ title: polars selector alphanumeric categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all columns with alphanumeric names (eg: only letters). Matching column names cannot contain *any* non-alphanumeric characters. Note that the definition of "alphanumeric" consists of all valid Unicode alphanumeric characters by default; this can be changed by setting `ascii_only=true`. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all columns with alphanumeric names (eg: only letters). Matching column names cannot contain *any* non-alphanumeric characters. Note that the definition of "alphanumeric" consists of all valid Unicode alphanumeric characters by default; this can be changed by setting `ascii_only=true`.
+::: warning This command requires a plugin +The `polars selector alphanumeric` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector alphanumeric {flags} ``` diff --git a/commands/docs/polars_selector_array.md b/commands/docs/polars_selector_array.md index af037a160da..cc298415032 100644 --- a/commands/docs/polars_selector_array.md +++ b/commands/docs/polars_selector_array.md @@ -2,7 +2,7 @@ title: polars selector array categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all array columns. Optionally filter by fixed width. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all array columns. Optionally filter by fixed width.
+::: warning This command requires a plugin +The `polars selector array` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector array {flags} ``` diff --git a/commands/docs/polars_selector_binary.md b/commands/docs/polars_selector_binary.md index d54259228ac..a9f43638ef1 100644 --- a/commands/docs/polars_selector_binary.md +++ b/commands/docs/polars_selector_binary.md @@ -2,7 +2,7 @@ title: polars selector binary categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all binary columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all binary columns.
+::: warning This command requires a plugin +The `polars selector binary` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector binary {flags} ``` diff --git a/commands/docs/polars_selector_boolean.md b/commands/docs/polars_selector_boolean.md index f73479e4f9a..2fa0869a46e 100644 --- a/commands/docs/polars_selector_boolean.md +++ b/commands/docs/polars_selector_boolean.md @@ -2,7 +2,7 @@ title: polars selector boolean categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all boolean columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all boolean columns.
+::: warning This command requires a plugin +The `polars selector boolean` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector boolean {flags} ``` diff --git a/commands/docs/polars_selector_by-dtype.md b/commands/docs/polars_selector_by-dtype.md index d94550fd372..38a321966e6 100644 --- a/commands/docs/polars_selector_by-dtype.md +++ b/commands/docs/polars_selector_by-dtype.md @@ -2,7 +2,7 @@ title: polars selector by-dtype categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a selector that selects columns by data type. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a selector that selects columns by data type.
+::: warning This command requires a plugin +The `polars selector by-dtype` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector by-dtype {flags} ...rest``` diff --git a/commands/docs/polars_selector_by-index.md b/commands/docs/polars_selector_by-index.md index 4ca8a86aacc..0a48b805784 100644 --- a/commands/docs/polars_selector_by-index.md +++ b/commands/docs/polars_selector_by-index.md @@ -2,7 +2,7 @@ title: polars selector by-index categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select columns by their index position. Supports negative indices (e.g., -1 for the last column). usage: | @@ -16,6 +16,17 @@ contributors: false
Select columns by their index position. Supports negative indices (e.g., -1 for the last column).
+::: warning This command requires a plugin +The `polars selector by-index` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector by-index {flags} ...rest``` diff --git a/commands/docs/polars_selector_by-name.md b/commands/docs/polars_selector_by-name.md index d7f01e048a3..fe2078ce749 100644 --- a/commands/docs/polars_selector_by-name.md +++ b/commands/docs/polars_selector_by-name.md @@ -2,7 +2,7 @@ title: polars selector by-name categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a selector that selects columns by name. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a selector that selects columns by name.
+::: warning This command requires a plugin +The `polars selector by-name` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector by-name {flags} ...rest``` diff --git a/commands/docs/polars_selector_categorical.md b/commands/docs/polars_selector_categorical.md index 88971d63f97..daf9e77fe3a 100644 --- a/commands/docs/polars_selector_categorical.md +++ b/commands/docs/polars_selector_categorical.md @@ -2,7 +2,7 @@ title: polars selector categorical categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all categorical columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all categorical columns.
+::: warning This command requires a plugin +The `polars selector categorical` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector categorical {flags} ``` diff --git a/commands/docs/polars_selector_contains.md b/commands/docs/polars_selector_contains.md index 2a56a1c6d52..fab120fe874 100644 --- a/commands/docs/polars_selector_contains.md +++ b/commands/docs/polars_selector_contains.md @@ -2,7 +2,7 @@ title: polars selector contains categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select columns whose names contain the given literal substring(s). usage: | @@ -16,6 +16,17 @@ contributors: false
Select columns whose names contain the given literal substring(s).
+::: warning This command requires a plugin +The `polars selector contains` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector contains {flags} ...rest``` diff --git a/commands/docs/polars_selector_date.md b/commands/docs/polars_selector_date.md index a31f59ad18e..8394993ef40 100644 --- a/commands/docs/polars_selector_date.md +++ b/commands/docs/polars_selector_date.md @@ -2,7 +2,7 @@ title: polars selector date categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all date columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all date columns.
+::: warning This command requires a plugin +The `polars selector date` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector date {flags} ``` diff --git a/commands/docs/polars_selector_datetime.md b/commands/docs/polars_selector_datetime.md index 44433d72b8c..a088d8af97e 100644 --- a/commands/docs/polars_selector_datetime.md +++ b/commands/docs/polars_selector_datetime.md @@ -2,7 +2,7 @@ title: polars selector datetime categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone.
+::: warning This command requires a plugin +The `polars selector datetime` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector datetime {flags} ``` diff --git a/commands/docs/polars_selector_decimal.md b/commands/docs/polars_selector_decimal.md index a551062acfd..cd5915981c5 100644 --- a/commands/docs/polars_selector_decimal.md +++ b/commands/docs/polars_selector_decimal.md @@ -2,7 +2,7 @@ title: polars selector decimal categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all decimal columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all decimal columns.
+::: warning This command requires a plugin +The `polars selector decimal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector decimal {flags} ``` diff --git a/commands/docs/polars_selector_digit.md b/commands/docs/polars_selector_digit.md index 66a7f3708b6..30e68029a65 100644 --- a/commands/docs/polars_selector_digit.md +++ b/commands/docs/polars_selector_digit.md @@ -2,7 +2,7 @@ title: polars selector digit categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9. usage: | @@ -16,6 +16,17 @@ contributors: false
Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9.
+::: warning This command requires a plugin +The `polars selector digit` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector digit {flags} ``` diff --git a/commands/docs/polars_selector_duration.md b/commands/docs/polars_selector_duration.md index ff82ce9f6de..6842fe086b2 100644 --- a/commands/docs/polars_selector_duration.md +++ b/commands/docs/polars_selector_duration.md @@ -2,7 +2,7 @@ title: polars selector duration categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all duration columns. Optionally filter by time unit (ns, us, ms). usage: | @@ -16,6 +16,17 @@ contributors: false
Select all duration columns. Optionally filter by time unit (ns, us, ms).
+::: warning This command requires a plugin +The `polars selector duration` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector duration {flags} ``` diff --git a/commands/docs/polars_selector_empty.md b/commands/docs/polars_selector_empty.md index b5b34adcb06..5778bb842c5 100644 --- a/commands/docs/polars_selector_empty.md +++ b/commands/docs/polars_selector_empty.md @@ -2,7 +2,7 @@ title: polars selector empty categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Create an empty selector that matches no columns. Useful as a base for selector composition. usage: | @@ -16,6 +16,17 @@ contributors: false
Create an empty selector that matches no columns. Useful as a base for selector composition.
+::: warning This command requires a plugin +The `polars selector empty` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector empty {flags} ``` diff --git a/commands/docs/polars_selector_ends-with.md b/commands/docs/polars_selector_ends-with.md index e7ddfcab376..af8357b3a8a 100644 --- a/commands/docs/polars_selector_ends-with.md +++ b/commands/docs/polars_selector_ends-with.md @@ -2,7 +2,7 @@ title: polars selector ends-with categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select columns that end with the given substring(s). usage: | @@ -16,6 +16,17 @@ contributors: false
Select columns that end with the given substring(s).
+::: warning This command requires a plugin +The `polars selector ends-with` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector ends-with {flags} ...rest``` diff --git a/commands/docs/polars_selector_enum.md b/commands/docs/polars_selector_enum.md index 5e816250b2e..c24941b0d90 100644 --- a/commands/docs/polars_selector_enum.md +++ b/commands/docs/polars_selector_enum.md @@ -2,7 +2,7 @@ title: polars selector enum categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all enum columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all enum columns.
+::: warning This command requires a plugin +The `polars selector enum` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector enum {flags} ``` diff --git a/commands/docs/polars_selector_exclude.md b/commands/docs/polars_selector_exclude.md index 6afd10e7d7c..85bef2e428a 100644 --- a/commands/docs/polars_selector_exclude.md +++ b/commands/docs/polars_selector_exclude.md @@ -2,7 +2,7 @@ title: polars selector exclude categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`.
+::: warning This command requires a plugin +The `polars selector exclude` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector exclude {flags} ...rest``` diff --git a/commands/docs/polars_selector_first.md b/commands/docs/polars_selector_first.md index 35949722405..6f11b59a933 100644 --- a/commands/docs/polars_selector_first.md +++ b/commands/docs/polars_selector_first.md @@ -2,7 +2,7 @@ title: polars selector first categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a selector that selects the first column(s) by index. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a selector that selects the first column(s) by index.
+::: warning This command requires a plugin +The `polars selector first` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector first {flags} (n)``` diff --git a/commands/docs/polars_selector_float.md b/commands/docs/polars_selector_float.md index 7da98d197ce..f4b8a86bd29 100644 --- a/commands/docs/polars_selector_float.md +++ b/commands/docs/polars_selector_float.md @@ -2,7 +2,7 @@ title: polars selector float categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all float columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all float columns.
+::: warning This command requires a plugin +The `polars selector float` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector float {flags} ``` diff --git a/commands/docs/polars_selector_integer.md b/commands/docs/polars_selector_integer.md index 5b5793c14a8..c2ddf5e60c8 100644 --- a/commands/docs/polars_selector_integer.md +++ b/commands/docs/polars_selector_integer.md @@ -2,7 +2,7 @@ title: polars selector integer categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all integer columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all integer columns.
+::: warning This command requires a plugin +The `polars selector integer` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector integer {flags} ``` diff --git a/commands/docs/polars_selector_last.md b/commands/docs/polars_selector_last.md index e4fcf64735a..03e17c67519 100644 --- a/commands/docs/polars_selector_last.md +++ b/commands/docs/polars_selector_last.md @@ -2,7 +2,7 @@ title: polars selector last categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates a selector that selects the last column(s) by index. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a selector that selects the last column(s) by index.
+::: warning This command requires a plugin +The `polars selector last` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector last {flags} (n)``` diff --git a/commands/docs/polars_selector_list.md b/commands/docs/polars_selector_list.md index 65d1eb939cc..11ec0846bf5 100644 --- a/commands/docs/polars_selector_list.md +++ b/commands/docs/polars_selector_list.md @@ -2,7 +2,7 @@ title: polars selector list categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all list columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all list columns.
+::: warning This command requires a plugin +The `polars selector list` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector list {flags} ``` diff --git a/commands/docs/polars_selector_matches.md b/commands/docs/polars_selector_matches.md index b93bf367049..44d97811537 100644 --- a/commands/docs/polars_selector_matches.md +++ b/commands/docs/polars_selector_matches.md @@ -2,7 +2,7 @@ title: polars selector matches categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all columns that match the given regex pattern. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all columns that match the given regex pattern.
+::: warning This command requires a plugin +The `polars selector matches` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector matches {flags} (pattern)``` diff --git a/commands/docs/polars_selector_nested.md b/commands/docs/polars_selector_nested.md index c5f1e15356d..9d2ae0960db 100644 --- a/commands/docs/polars_selector_nested.md +++ b/commands/docs/polars_selector_nested.md @@ -2,7 +2,7 @@ title: polars selector nested categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all nested columns (list, array, or struct). usage: | @@ -16,6 +16,17 @@ contributors: false
Select all nested columns (list, array, or struct).
+::: warning This command requires a plugin +The `polars selector nested` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector nested {flags} ``` diff --git a/commands/docs/polars_selector_not.md b/commands/docs/polars_selector_not.md index d36f3c3376b..0655d031542 100644 --- a/commands/docs/polars_selector_not.md +++ b/commands/docs/polars_selector_not.md @@ -2,7 +2,7 @@ title: polars selector not categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Inverts selector. usage: | @@ -16,6 +16,17 @@ contributors: false
Inverts selector.
+::: warning This command requires a plugin +The `polars selector not` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector not {flags} ``` diff --git a/commands/docs/polars_selector_numeric.md b/commands/docs/polars_selector_numeric.md index fa8145518ec..b509cc9d980 100644 --- a/commands/docs/polars_selector_numeric.md +++ b/commands/docs/polars_selector_numeric.md @@ -2,7 +2,7 @@ title: polars selector numeric categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all numeric columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all numeric columns.
+::: warning This command requires a plugin +The `polars selector numeric` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector numeric {flags} ``` diff --git a/commands/docs/polars_selector_object.md b/commands/docs/polars_selector_object.md index abd181d5d11..beefe487066 100644 --- a/commands/docs/polars_selector_object.md +++ b/commands/docs/polars_selector_object.md @@ -2,7 +2,7 @@ title: polars selector object categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all object columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all object columns.
+::: warning This command requires a plugin +The `polars selector object` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector object {flags} ``` diff --git a/commands/docs/polars_selector_signed-integer.md b/commands/docs/polars_selector_signed-integer.md index bbc990ed81b..407a48df1c0 100644 --- a/commands/docs/polars_selector_signed-integer.md +++ b/commands/docs/polars_selector_signed-integer.md @@ -2,7 +2,7 @@ title: polars selector signed-integer categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all signed integer columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all signed integer columns.
+::: warning This command requires a plugin +The `polars selector signed-integer` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector signed-integer {flags} ``` diff --git a/commands/docs/polars_selector_starts-with.md b/commands/docs/polars_selector_starts-with.md index bce04ccaaf3..7caae4e72b8 100644 --- a/commands/docs/polars_selector_starts-with.md +++ b/commands/docs/polars_selector_starts-with.md @@ -2,7 +2,7 @@ title: polars selector starts-with categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select columns that start with the given substring(s). usage: | @@ -16,6 +16,17 @@ contributors: false
Select columns that start with the given substring(s).
+::: warning This command requires a plugin +The `polars selector starts-with` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector starts-with {flags} ...rest``` diff --git a/commands/docs/polars_selector_string.md b/commands/docs/polars_selector_string.md index 542e37416b5..273a06067ef 100644 --- a/commands/docs/polars_selector_string.md +++ b/commands/docs/polars_selector_string.md @@ -2,7 +2,7 @@ title: polars selector string categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all string columns. Use `--include-categorical` to also select categorical columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all string columns. Use `--include-categorical` to also select categorical columns.
+::: warning This command requires a plugin +The `polars selector string` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector string {flags} ``` diff --git a/commands/docs/polars_selector_struct.md b/commands/docs/polars_selector_struct.md index bee9356ae30..1f3a29506ab 100644 --- a/commands/docs/polars_selector_struct.md +++ b/commands/docs/polars_selector_struct.md @@ -2,7 +2,7 @@ title: polars selector struct categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all struct columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all struct columns.
+::: warning This command requires a plugin +The `polars selector struct` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector struct {flags} ``` diff --git a/commands/docs/polars_selector_temporal.md b/commands/docs/polars_selector_temporal.md index bc33abe0feb..540c4ef53e5 100644 --- a/commands/docs/polars_selector_temporal.md +++ b/commands/docs/polars_selector_temporal.md @@ -2,7 +2,7 @@ title: polars selector temporal categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all temporal columns (date, datetime, duration, and time). usage: | @@ -16,6 +16,17 @@ contributors: false
Select all temporal columns (date, datetime, duration, and time).
+::: warning This command requires a plugin +The `polars selector temporal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector temporal {flags} ``` diff --git a/commands/docs/polars_selector_unsigned-integer.md b/commands/docs/polars_selector_unsigned-integer.md index 628f4b2c2ad..028d6626214 100644 --- a/commands/docs/polars_selector_unsigned-integer.md +++ b/commands/docs/polars_selector_unsigned-integer.md @@ -2,7 +2,7 @@ title: polars selector unsigned-integer categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Select all unsigned integer columns. usage: | @@ -16,6 +16,17 @@ contributors: false
Select all unsigned integer columns.
+::: warning This command requires a plugin +The `polars selector unsigned-integer` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars selector unsigned-integer {flags} ``` diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index f92e39721f9..da7c3f0b861 100644 --- a/commands/docs/polars_set-with-idx.md +++ b/commands/docs/polars_set-with-idx.md @@ -2,7 +2,7 @@ title: polars set-with-idx categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Sets value in the given index. usage: | @@ -16,6 +16,17 @@ contributors: false
Sets value in the given index.
+::: warning This command requires a plugin +The `polars set-with-idx` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars set-with-idx {flags} (value)``` diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 0a8ac9fb697..f72bde5849e 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Sets value where given mask is true. usage: | @@ -16,6 +16,17 @@ contributors: false
Sets value where given mask is true.
+::: warning This command requires a plugin +The `polars set` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars set {flags} (value)``` diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index 48c05ed7dda..be387349bf0 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Shows column and row size for a dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Shows column and row size for a dataframe.
+::: warning This command requires a plugin +The `polars shape` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars shape {flags} ``` diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index a82c9f422cc..24cb52a96ba 100644 --- a/commands/docs/polars_shift.md +++ b/commands/docs/polars_shift.md @@ -2,7 +2,7 @@ title: polars shift categories: | dataframe or lazyframe -version: 0.115.0 +version: 0.115.1 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | @@ -16,6 +16,17 @@ contributors: false
Shifts the values by a given period.
+::: warning This command requires a plugin +The `polars shift` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars shift {flags} (period)``` diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index 5a8b15aef69..18b071e3dac 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates new dataframe from a slice of rows. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates new dataframe from a slice of rows.
+::: warning This command requires a plugin +The `polars slice` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars slice {flags} (offset) (size)``` diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index d00261730c1..846cef555e3 100644 --- a/commands/docs/polars_sort-by.md +++ b/commands/docs/polars_sort-by.md @@ -2,7 +2,7 @@ title: polars sort-by categories: | lazyframe -version: 0.115.0 +version: 0.115.1 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | @@ -16,6 +16,17 @@ contributors: false
Sorts a lazy dataframe based on expression(s).
+::: warning This command requires a plugin +The `polars sort-by` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars sort-by {flags} ...rest``` diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index 998964195fc..419a4b8bdce 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a std expression for an aggregation of std value from columns in a dataframe.
+::: warning This command requires a plugin +The `polars std` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars std {flags} ``` diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index d688dcdf173..0f1777a9460 100644 --- a/commands/docs/polars_store-get.md +++ b/commands/docs/polars_store-get.md @@ -2,7 +2,7 @@ title: polars store-get categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | @@ -16,6 +16,17 @@ contributors: false
Gets a Dataframe or other object from the plugin cache.
+::: warning This command requires a plugin +The `polars store-get` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars store-get {flags} (key)``` diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 18d7c38129d..d8611217f5c 100644 --- a/commands/docs/polars_store-ls.md +++ b/commands/docs/polars_store-ls.md @@ -2,7 +2,7 @@ title: polars store-ls categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Lists stored polars objects. usage: | @@ -16,6 +16,17 @@ contributors: false
Lists stored polars objects.
+::: warning This command requires a plugin +The `polars store-ls` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars store-ls {flags} ``` diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 1694860ee41..f666fddd487 100644 --- a/commands/docs/polars_store-rm.md +++ b/commands/docs/polars_store-rm.md @@ -2,7 +2,7 @@ title: polars store-rm categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | @@ -16,6 +16,17 @@ contributors: false
Removes a stored Dataframe or other object from the plugin cache.
+::: warning This command requires a plugin +The `polars store-rm` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars store-rm {flags} ...rest``` diff --git a/commands/docs/polars_str-join.md b/commands/docs/polars_str-join.md index f2ed6750cd3..4bffd5d8d31 100644 --- a/commands/docs/polars_str-join.md +++ b/commands/docs/polars_str-join.md @@ -2,7 +2,7 @@ title: polars str-join categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Concatenates strings within a column or dataframes usage: | @@ -16,6 +16,17 @@ contributors: false
Concatenates strings within a column or dataframes
+::: warning This command requires a plugin +The `polars str-join` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-join {flags} (other)``` diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index b15bff20ef6..99da0342921 100644 --- a/commands/docs/polars_str-lengths.md +++ b/commands/docs/polars_str-lengths.md @@ -2,7 +2,7 @@ title: polars str-lengths categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Get lengths of all strings. usage: | @@ -16,6 +16,17 @@ contributors: false
Get lengths of all strings.
+::: warning This command requires a plugin +The `polars str-lengths` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-lengths {flags} ``` diff --git a/commands/docs/polars_str-replace-all.md b/commands/docs/polars_str-replace-all.md index 830f11f5c1b..bc2d2548d52 100644 --- a/commands/docs/polars_str-replace-all.md +++ b/commands/docs/polars_str-replace-all.md @@ -2,7 +2,7 @@ title: polars str-replace-all categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -16,6 +16,17 @@ contributors: false
Replace all (sub)strings by a regex pattern.
+::: warning This command requires a plugin +The `polars str-replace-all` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-replace-all {flags} ``` diff --git a/commands/docs/polars_str-replace.md b/commands/docs/polars_str-replace.md index 275071c5173..11800d6287f 100644 --- a/commands/docs/polars_str-replace.md +++ b/commands/docs/polars_str-replace.md @@ -2,7 +2,7 @@ title: polars str-replace categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -16,6 +16,17 @@ contributors: false
Replace the leftmost (sub)string by a regex pattern.
+::: warning This command requires a plugin +The `polars str-replace` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-replace {flags} ``` diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index db40ca31c9d..fa26d8e41cd 100644 --- a/commands/docs/polars_str-slice.md +++ b/commands/docs/polars_str-slice.md @@ -2,7 +2,7 @@ title: polars str-slice categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -16,6 +16,17 @@ contributors: false
Slices the string from the start position until the selected length.
+::: warning This command requires a plugin +The `polars str-slice` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-slice {flags} (start)``` diff --git a/commands/docs/polars_str-split.md b/commands/docs/polars_str-split.md index 08ab6c45e5e..dedda4b7352 100644 --- a/commands/docs/polars_str-split.md +++ b/commands/docs/polars_str-split.md @@ -2,7 +2,7 @@ title: polars str-split categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Split the string by a substring. The resulting dtype is list. usage: | @@ -16,6 +16,17 @@ contributors: false
Split the string by a substring. The resulting dtype is list<str>.
+::: warning This command requires a plugin +The `polars str-split` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-split {flags} (expr)``` diff --git a/commands/docs/polars_str-strip-chars.md b/commands/docs/polars_str-strip-chars.md index 8c7e86a4a67..b303e244a4b 100644 --- a/commands/docs/polars_str-strip-chars.md +++ b/commands/docs/polars_str-strip-chars.md @@ -2,7 +2,7 @@ title: polars str-strip-chars categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Strips specified characters from strings in a column usage: | @@ -16,6 +16,17 @@ contributors: false
Strips specified characters from strings in a column
+::: warning This command requires a plugin +The `polars str-strip-chars` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars str-strip-chars {flags} (pattern)``` diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index cb04c142aa6..0c9ac26c97f 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Formats date based on string rule. usage: | @@ -16,6 +16,17 @@ contributors: false
Formats date based on string rule.
+::: warning This command requires a plugin +The `polars strftime` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars strftime {flags} (fmt)``` diff --git a/commands/docs/polars_struct-json-encode.md b/commands/docs/polars_struct-json-encode.md index 9269695d909..60e3df057a4 100644 --- a/commands/docs/polars_struct-json-encode.md +++ b/commands/docs/polars_struct-json-encode.md @@ -2,7 +2,7 @@ title: polars struct-json-encode categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Convert this struct to a string column with json values. usage: | @@ -16,6 +16,17 @@ contributors: false
Convert this struct to a string column with json values.
+::: warning This command requires a plugin +The `polars struct-json-encode` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars struct-json-encode {flags} ``` diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index 817bd48fd0c..ce63c6487db 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates a sum expression for an aggregation or aggregates columns to their sum value.
+::: warning This command requires a plugin +The `polars sum` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars sum {flags} ``` diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 90cdb16105b..471b39df328 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | @@ -16,6 +16,17 @@ contributors: false
For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns.
+::: warning This command requires a plugin +The `polars summary` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars summary {flags} ``` diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index b18a3ce2e04..8a0f7c8e75e 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Creates new dataframe using the given indices. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates new dataframe using the given indices.
+::: warning This command requires a plugin +The `polars take` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars take {flags} (indices)``` diff --git a/commands/docs/polars_truncate.md b/commands/docs/polars_truncate.md index 743d6d9c9ac..a20342967de 100644 --- a/commands/docs/polars_truncate.md +++ b/commands/docs/polars_truncate.md @@ -2,7 +2,7 @@ title: polars truncate categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Divide the date/datetime range into buckets. usage: | @@ -16,6 +16,17 @@ contributors: false
Divide the date/datetime range into buckets.
+::: warning This command requires a plugin +The `polars truncate` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars truncate {flags} (every)``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index f22eb9640cb..a45aeb7d910 100644 --- a/commands/docs/polars_unique.md +++ b/commands/docs/polars_unique.md @@ -2,7 +2,7 @@ title: polars unique categories: | dataframe or lazyframe -version: 0.115.0 +version: 0.115.1 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns unique values from a dataframe.
+::: warning This command requires a plugin +The `polars unique` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars unique {flags} ``` diff --git a/commands/docs/polars_unnest.md b/commands/docs/polars_unnest.md index 75c89bf9347..11337192910 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column. usage: | @@ -16,6 +16,17 @@ contributors: false
Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column.
+::: warning This command requires a plugin +The `polars unnest` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars unnest {flags} ...rest``` diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index 86c495aa604..e185345272b 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Unpivot a DataFrame from wide to long format. usage: | @@ -16,6 +16,17 @@ contributors: false
Unpivot a DataFrame from wide to long format.
+::: warning This command requires a plugin +The `polars unpivot` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars unpivot {flags} ``` diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index 33b2cb39753..b48ddf7eb6a 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Uppercase the strings in the column. usage: | @@ -16,6 +16,17 @@ contributors: false
Uppercase the strings in the column.
+::: warning This command requires a plugin +The `polars uppercase` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars uppercase {flags} ``` diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 1aa753484a0..5bc869f36dc 100644 --- a/commands/docs/polars_value-counts.md +++ b/commands/docs/polars_value-counts.md @@ -2,7 +2,7 @@ title: polars value-counts categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -16,6 +16,17 @@ contributors: false
Returns a dataframe with the counts for unique values in series.
+::: warning This command requires a plugin +The `polars value-counts` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars value-counts {flags} ``` diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 2c74f643304..ad7d1928b5d 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.115.0 +version: 0.115.1 dataframe: | Create a var expression for an aggregation. usage: | @@ -16,6 +16,17 @@ contributors: false
Create a var expression for an aggregation.
+::: warning This command requires a plugin +The `polars var` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars var {flags} ``` diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index 628de57631e..47664a572e3 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.115.0 +version: 0.115.1 expression: | Creates and modifies a when expression. usage: | @@ -16,6 +16,17 @@ contributors: false
Creates and modifies a when expression.
+::: warning This command requires a plugin +The `polars when` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars when {flags} (when expression) (then expression)``` diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index f0c16726671..c6c615f7097 100644 --- a/commands/docs/polars_with-column.md +++ b/commands/docs/polars_with-column.md @@ -2,7 +2,7 @@ title: polars with-column categories: | dataframe or lazyframe -version: 0.115.0 +version: 0.115.1 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | @@ -16,6 +16,17 @@ contributors: false
Adds a series to the dataframe.
+::: warning This command requires a plugin +The `polars with-column` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> polars with-column {flags} ...rest``` diff --git a/commands/docs/port.md b/commands/docs/port.md index 9aa4eb82231..1420a15a608 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.115.0 +version: 0.115.1 network: | Get a free TCP port from system. usage: | @@ -16,6 +16,10 @@ contributors: false
Get a free TCP port from system.
+## Command Type + +`built-in` + ## Signature ```> port {flags} (start) (end)``` diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index a6ed178ae6f..3f8c68c7a62 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Prepend any number of rows to a table. usage: | @@ -16,6 +16,10 @@ contributors: false
Prepend any number of rows to a table.
+## Command Type + +`built-in` + ## Signature ```> prepend {flags} (row)``` diff --git a/commands/docs/print.md b/commands/docs/print.md index 8b52b86f17c..704cdd90eb6 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Print the given values to stdout. usage: | @@ -16,6 +16,10 @@ contributors: false
Print the given values to stdout.
+## Command Type + +`built-in` + ## Signature ```> print {flags} ...rest``` diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 739ddcedcbb..7c308d3d3a2 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about system processes. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about system processes.
+## Command Type + +`built-in` + ## Signature ```> ps {flags} ``` diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 20776b3cc19..16e7a8afcaf 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.115.0 +version: 0.115.1 default: | Return the current working directory usage: | @@ -16,6 +16,10 @@ contributors: false
Return the current working directory
+## Command Type + +`custom` + ## Signature ```> pwd {flags} ``` diff --git a/commands/docs/query.md b/commands/docs/query.md index 91aa932ab31..4b86382f5b9 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Show all the query commands usage: | @@ -16,6 +16,17 @@ contributors: false
Show all the query commands
+::: warning This command requires a plugin +The `query` command resides in the `query` plugin. +To use this command, you must install and register `nu_plugin_query`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> query {flags} ``` diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index ec1f0de9213..432844e111b 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.115.0 +version: 0.115.1 database: | Query a SQLite database with SQL statements. usage: | @@ -16,6 +16,10 @@ contributors: false
Query a SQLite database with SQL statements.
+## Command Type + +`built-in` + ## Signature ```> query db {flags} (SQL)``` diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 38454054e32..2fdec42c4dd 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -16,6 +16,17 @@ contributors: false
execute json query on json file (open --raw <file> | query json 'query string')
+::: warning This command requires a plugin +The `query json` command resides in the `query` plugin. +To use this command, you must install and register `nu_plugin_query`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> query json {flags} (query)``` diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 2c034c5be30..913d2f98e3a 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.115.0 +version: 0.115.1 network: | execute selector query on html/web usage: | @@ -16,6 +16,17 @@ contributors: false
execute selector query on html/web
+::: warning This command requires a plugin +The `query web` command resides in the `query` plugin. +To use this command, you must install and register `nu_plugin_query`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> query web {flags} ``` diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index 3b845722b31..c1b70283e6d 100644 --- a/commands/docs/query_webpage-info.md +++ b/commands/docs/query_webpage-info.md @@ -2,7 +2,7 @@ title: query webpage-info categories: | network -version: 0.115.0 +version: 0.115.1 network: | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more usage: | @@ -16,6 +16,17 @@ contributors: false
uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more
+::: warning This command requires a plugin +The `query webpage-info` command resides in the `query` plugin. +To use this command, you must install and register `nu_plugin_query`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> query webpage-info {flags} ``` diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index c747f482d03..d618aef3c15 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Execute XPath 1.0 query on XML input usage: | @@ -16,6 +16,17 @@ contributors: false
Execute XPath 1.0 query on XML input
+::: warning This command requires a plugin +The `query xml` command resides in the `query` plugin. +To use this command, you must install and register `nu_plugin_query`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> query xml {flags} (query)``` diff --git a/commands/docs/random.md b/commands/docs/random.md index 9fd0994101f..884af7cce26 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a random value. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a random value.
+## Command Type + +`built-in` + ## Signature ```> random {flags} ``` diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index a0f3253522d..9a8ddaee211 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate random bytes. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate random bytes.
+## Command Type + +`built-in` + ## Signature ```> random binary {flags} (length)``` diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index c5e63687f0b..12239427895 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a random boolean value. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a random boolean value.
+## Command Type + +`built-in` + ## Signature ```> random bool {flags} ``` diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index fb2c21b3f58..bba030ab7d7 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9.
+## Command Type + +`built-in` + ## Signature ```> random chars {flags} ``` diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 5899582c64e..d487a3daf38 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a random float within a range [min..max]. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a random float within a range [min..max].
+## Command Type + +`built-in` + ## Signature ```> random float {flags} (range)``` diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 4dc7f7da0f5..f52f56b0cf4 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a random integer [min..max]. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a random integer [min..max].
+## Command Type + +`built-in` + ## Signature ```> random int {flags} (range)``` diff --git a/commands/docs/random_pass.md b/commands/docs/random_pass.md index b567e328129..8c7dfbab5a0 100644 --- a/commands/docs/random_pass.md +++ b/commands/docs/random_pass.md @@ -2,7 +2,7 @@ title: random pass categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a cryptologically secure password. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a cryptologically secure password.
+## Command Type + +`built-in` + ## Signature ```> random pass {flags} ``` diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index e2bd453dbad..71169473b83 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.115.0 +version: 0.115.1 random: | Generate a random uuid string of the specified version. usage: | @@ -16,6 +16,10 @@ contributors: false
Generate a random uuid string of the specified version.
+## Command Type + +`built-in` + ## Signature ```> random uuid {flags} ``` diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 1d422238c17..0d33e92f30c 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Aggregate a list (starting from the left) to a single value using an accumulator closure.
+## Command Type + +`built-in` + ## Signature ```> reduce {flags} (closure)``` diff --git a/commands/docs/registry.md b/commands/docs/registry.md index 1806950bbef..84760d572ab 100644 --- a/commands/docs/registry.md +++ b/commands/docs/registry.md @@ -2,7 +2,7 @@ title: registry categories: | system -version: 0.115.0 +version: 0.115.1 system: | Various commands for interacting with the system registry (Windows only). usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index a415cd16ee3..38c87f5d02e 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.115.0 +version: 0.115.1 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 0f73f162c76..8b082fa52bd 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove the given columns or rows from the table. Opposite of `select`.
+## Command Type + +`built-in` + ## Signature ```> reject {flags} ...rest``` diff --git a/commands/docs/rename.md b/commands/docs/rename.md index accfa168219..6980e152b17 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Creates a new table with columns renamed. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates a new table with columns renamed.
+## Command Type + +`built-in` + ## Signature ```> rename {flags} ...rest``` diff --git a/commands/docs/return.md b/commands/docs/return.md index e4b01884f22..5510e25bc99 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.115.0 +version: 0.115.1 core: | Return early from a custom command. usage: | @@ -16,6 +16,10 @@ contributors: false
Return early from a custom command.
+## Command Type + +`keyword` + ## Signature ```> return {flags} (return_value)``` diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 1992cfd79d7..23bd8e5c3e1 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Reverses the input list or table. usage: | @@ -16,6 +16,10 @@ contributors: false
Reverses the input list or table.
+## Command Type + +`built-in` + ## Signature ```> reverse {flags} ``` diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 88225783764..c58673d53f1 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Remove files and directories. usage: | @@ -16,6 +16,10 @@ contributors: false
Remove files and directories.
+## Command Type + +`built-in` + ## Signature ```> rm {flags} ...rest``` diff --git a/commands/docs/roll.md b/commands/docs/roll.md index f988ba51dce..05860013bdd 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Rolling commands for tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Rolling commands for tables.
+## Command Type + +`built-in` + ## Signature ```> roll {flags} ``` diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 5ffe8379bf2..b0cf0a744f0 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Roll table rows down. usage: | @@ -16,6 +16,10 @@ contributors: false
Roll table rows down.
+## Command Type + +`built-in` + ## Signature ```> roll down {flags} ``` diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 80a36e49fee..25b92447b65 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Roll record or table columns left. usage: | @@ -16,6 +16,10 @@ contributors: false
Roll record or table columns left.
+## Command Type + +`built-in` + ## Signature ```> roll left {flags} ``` diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 934e4ff5ed6..66ab5a113cc 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Roll table columns right. usage: | @@ -16,6 +16,10 @@ contributors: false
Roll table columns right.
+## Command Type + +`built-in` + ## Signature ```> roll right {flags} ``` diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 49a78549963..8146595a116 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Roll table rows up. usage: | @@ -16,6 +16,10 @@ contributors: false
Roll table rows up.
+## Command Type + +`built-in` + ## Signature ```> roll up {flags} ``` diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 19e0f147a1e..c0e611f75d1 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | @@ -16,6 +16,10 @@ contributors: false
Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag).
+## Command Type + +`built-in` + ## Signature ```> rotate {flags} ...rest``` diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index aa6a20254b4..6eb58a3d780 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.115.0 +version: 0.115.1 system: | Runs external command. usage: | @@ -16,6 +16,10 @@ contributors: false
Runs external command.
+## Command Type + +`built-in` + ## Signature ```> run-external {flags} ...rest``` diff --git a/commands/docs/run-internal.md b/commands/docs/run-internal.md index 3efa4dd8c41..10816680207 100644 --- a/commands/docs/run-internal.md +++ b/commands/docs/run-internal.md @@ -2,7 +2,7 @@ title: run-internal categories: | default -version: 0.115.0 +version: 0.115.1 default: | Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch. usage: | @@ -16,6 +16,10 @@ contributors: false
Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch.
+## Command Type + +`built-in` + ## Signature ```> run-internal {flags} (name) ...rest``` diff --git a/commands/docs/run.md b/commands/docs/run.md index d892f7973b8..7feb31e0a0e 100644 --- a/commands/docs/run.md +++ b/commands/docs/run.md @@ -2,7 +2,7 @@ title: run categories: | core -version: 0.115.0 +version: 0.115.1 core: | Runs a script file in an isolated scope as part of a pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Runs a script file in an isolated scope as part of a pipeline.
+## Command Type + +`keyword` + ## Signature ```> run {flags} (filename) ...rest``` diff --git a/commands/docs/save.md b/commands/docs/save.md index 4cf7f4b7891..f94ce78cac5 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Save a file. usage: | @@ -16,6 +16,10 @@ contributors: false
Save a file.
+## Command Type + +`built-in` + ## Signature ```> save {flags} (filename)``` diff --git a/commands/docs/schema.md b/commands/docs/schema.md index cb112f2963e..88a9e7d5858 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.115.0 +version: 0.115.1 database: | Show the schema of a SQLite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Show the schema of a SQLite database.
+## Command Type + +`built-in` + ## Signature ```> schema {flags} ``` diff --git a/commands/docs/scope.md b/commands/docs/scope.md index c15c72b4832..173d344d66c 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.115.0 +version: 0.115.1 core: | Commands for getting info about what is in scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Commands for getting info about what is in scope.
+## Command Type + +`built-in` + ## Signature ```> scope {flags} ``` diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index c799663a5fa..79068d07188 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.115.0 +version: 0.115.1 core: | Output info on the aliases in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Output info on the aliases in the current scope.
+## Command Type + +`built-in` + ## Signature ```> scope aliases {flags} ``` diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 3bd2dd4bcf0..b6060aa78e5 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.115.0 +version: 0.115.1 core: | Output info on the commands in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Output info on the commands in the current scope.
+## Command Type + +`built-in` + ## Signature ```> scope commands {flags} ``` diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index 72e9cfa0e99..6a8a3bf98fd 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.115.0 +version: 0.115.1 core: | Output stats on the engine in the current state, including interactive last-result size info. usage: | @@ -16,6 +16,10 @@ contributors: false
Output stats on the engine in the current state, including interactive last-result size info.
+## Command Type + +`built-in` + ## Signature ```> scope engine-stats {flags} ``` diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index 1434757a5bb..8b8f13d735d 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.115.0 +version: 0.115.1 core: | Output info on the known externals in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Output info on the known externals in the current scope.
+## Command Type + +`built-in` + ## Signature ```> scope externs {flags} ``` diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 208de44fc11..a61bdc92929 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.115.0 +version: 0.115.1 core: | Output info on the modules in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Output info on the modules in the current scope.
+## Command Type + +`built-in` + ## Signature ```> scope modules {flags} ``` diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index c06569e0489..b6040f7568a 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.115.0 +version: 0.115.1 core: | Output info on the variables in the current scope. usage: | @@ -16,6 +16,10 @@ contributors: false
Output info on the variables in the current scope.
+## Command Type + +`built-in` + ## Signature ```> scope variables {flags} ``` diff --git a/commands/docs/select.md b/commands/docs/select.md index be7feb24d2f..7f4f451624e 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | @@ -16,6 +16,10 @@ contributors: false
Select only these columns or rows from the input. Opposite of `reject`.
+## Command Type + +`built-in` + ## Signature ```> select {flags} ...rest``` diff --git a/commands/docs/semver.md b/commands/docs/semver.md index 6f719686eba..0cb9810b40c 100644 --- a/commands/docs/semver.md +++ b/commands/docs/semver.md @@ -2,7 +2,7 @@ title: semver categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Various commands for working with semantic versions. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with semantic versions.
+## Command Type + +`built-in` + ## Signature ```> semver {flags} ``` diff --git a/commands/docs/semver_bump.md b/commands/docs/semver_bump.md index 8c21e5ec3f1..7d79296fd22 100644 --- a/commands/docs/semver_bump.md +++ b/commands/docs/semver_bump.md @@ -2,7 +2,7 @@ title: semver bump categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Bump a semantic version to the next level. usage: | @@ -16,6 +16,10 @@ contributors: false
Bump a semantic version to the next level.
+## Command Type + +`built-in` + ## Signature ```> semver bump {flags} (level)``` diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 3a601b07a8b..24d7d02d5f7 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.115.0 +version: 0.115.1 generators: | Output sequences of numbers. usage: | @@ -16,6 +16,10 @@ contributors: false
Output sequences of numbers.
+## Command Type + +`built-in` + ## Signature ```> seq {flags} ...rest``` diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 08686631cdd..4ac7a4fe3bc 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.115.0 +version: 0.115.1 generators: | Print a sequence of ASCII characters. usage: | @@ -16,6 +16,10 @@ contributors: false
Print a sequence of ASCII characters.
+## Command Type + +`built-in` + ## Signature ```> seq char {flags} (start) (end)``` diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 9ad21d6165b..9d12d196f9a 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.115.0 +version: 0.115.1 generators: | Print sequences of dates. usage: | @@ -16,6 +16,10 @@ contributors: false
Print sequences of dates.
+## Command Type + +`built-in` + ## Signature ```> seq date {flags} ``` diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 30296b1cba6..864189a9e2b 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Shuffle rows randomly. usage: | @@ -16,6 +16,10 @@ contributors: false
Shuffle rows randomly.
+## Command Type + +`built-in` + ## Signature ```> shuffle {flags} ``` diff --git a/commands/docs/skip.md b/commands/docs/skip.md index ec9f3115f74..d86ce0d94fa 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. For binary input, n can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. For binary input, n can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> skip {flags} (n)``` diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 81ad2a0c5c9..9cefd001d9e 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Skip elements of the input until a predicate is true. usage: | @@ -16,6 +16,10 @@ contributors: false
Skip elements of the input until a predicate is true.
+## Command Type + +`built-in` + ## Signature ```> skip until {flags} (predicate)``` diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index 05d4c532ad2..7030c051277 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Skip elements of the input while a predicate is true. usage: | @@ -16,6 +16,10 @@ contributors: false
Skip elements of the input while a predicate is true.
+## Command Type + +`built-in` + ## Signature ```> skip while {flags} (predicate)``` diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index 8f64b6e9aac..370d43a4421 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Delay for a specified amount of time. usage: | @@ -16,6 +16,10 @@ contributors: false
Delay for a specified amount of time.
+## Command Type + +`built-in` + ## Signature ```> sleep {flags} (duration) ...rest``` diff --git a/commands/docs/slice.md b/commands/docs/slice.md index 15597edf44f..47b6d0fd570 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Return only the selected rows. usage: | @@ -16,6 +16,10 @@ contributors: false
Return only the selected rows.
+## Command Type + +`built-in` + ## Signature ```> slice {flags} (rows)``` diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index d00e2968328..e7631ce9112 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Sort by the given cell path or closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Sort by the given cell path or closure.
+## Command Type + +`built-in` + ## Signature ```> sort-by {flags} ...rest``` diff --git a/commands/docs/sort.md b/commands/docs/sort.md index d915d947701..dfece27bb4b 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Sort the input in increasing order. usage: | @@ -16,6 +16,10 @@ contributors: false
Sort the input in increasing order.
+## Command Type + +`built-in` + ## Signature ```> sort {flags} ``` diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 3f2fa4e4e16..07280cdf3ac 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.115.0 +version: 0.115.1 core: | Source the environment from a source file into the current environment. usage: | @@ -16,6 +16,10 @@ contributors: false
Source the environment from a source file into the current environment.
+## Command Type + +`keyword` + ## Signature ```> source-env {flags} (filename)``` diff --git a/commands/docs/source.md b/commands/docs/source.md index b4b988d2814..d102f37c631 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.115.0 +version: 0.115.1 core: | Runs a script file in the current context. usage: | @@ -16,6 +16,10 @@ contributors: false
Runs a script file in the current context.
+## Command Type + +`keyword` + ## Signature ```> source {flags} (filename)``` diff --git a/commands/docs/split.md b/commands/docs/split.md index 04b94d2a3e2..ecddee13644 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split contents across desired subcommand (like row, column) via the separator.
+## Command Type + +`built-in` + ## Signature ```> split {flags} ``` diff --git a/commands/docs/split_cell-path.md b/commands/docs/split_cell-path.md index aa515b44818..c12c88a2649 100644 --- a/commands/docs/split_cell-path.md +++ b/commands/docs/split_cell-path.md @@ -2,7 +2,7 @@ title: split cell-path categories: | conversions -version: 0.115.0 +version: 0.115.1 conversions: | Split a cell-path into its components. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a cell-path into its components.
+## Command Type + +`built-in` + ## Signature ```> split cell-path {flags} ``` diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 4bc9ca3e039..8fd80301bab 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Split a string into a list of characters. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a string into a list of characters.
+## Command Type + +`built-in` + ## Signature ```> split chars {flags} ``` diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index c451a84bf9a..a3ad7548bba 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Split a string into multiple columns using a separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a string into multiple columns using a separator.
+## Command Type + +`built-in` + ## Signature ```> split column {flags} (separator) ...rest``` diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index 22a92acf296..7ae6ddbfaaa 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Split a list into multiple lists using a separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a list into multiple lists using a separator.
+## Command Type + +`built-in` + ## Signature ```> split list {flags} (separator)``` diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index d12b69f2cf4..14d86f59668 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Split a string into multiple rows using a separator. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a string into multiple rows using a separator.
+## Command Type + +`built-in` + ## Signature ```> split row {flags} (separator)``` diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index e550138a650..b5c541e0c0d 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Split a string's words into separate rows. usage: | @@ -16,6 +16,10 @@ contributors: false
Split a string's words into separate rows.
+## Command Type + +`built-in` + ## Signature ```> split words {flags} ``` diff --git a/commands/docs/start.md b/commands/docs/start.md index eafd91263d9..0f0eb7d98df 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Open a folder, file, or website in the default application or viewer. usage: | @@ -16,6 +16,10 @@ contributors: false
Open a folder, file, or website in the default application or viewer.
+## Command Type + +`built-in` + ## Signature ```> start {flags} (path)``` diff --git a/commands/docs/stor.md b/commands/docs/stor.md index cd5a45bf04c..2768bf8178a 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.115.0 +version: 0.115.1 database: | Various commands for working with the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor {flags} ``` diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index c623fa84779..ed54a68521b 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.115.0 +version: 0.115.1 database: | Create a table in the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Create a table in the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor create {flags} ``` diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index 11a486497bf..bb094ff8f91 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.115.0 +version: 0.115.1 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Delete a table or specified rows in the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor delete {flags} ``` diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index 89e76c58d96..7e9208c2044 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.115.0 +version: 0.115.1 database: | Export the in-memory sqlite database to a sqlite database file. usage: | @@ -16,6 +16,10 @@ contributors: false
Export the in-memory sqlite database to a sqlite database file.
+## Command Type + +`built-in` + ## Signature ```> stor export {flags} ``` diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index d3d8b3bb667..632f46c50ac 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.115.0 +version: 0.115.1 database: | Import a sqlite database file into the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Import a sqlite database file into the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor import {flags} ``` diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index a326a80d286..0e29a154fe3 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.115.0 +version: 0.115.1 database: | Insert information into a specified table in the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Insert information into a specified table in the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor insert {flags} ``` diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index 1b8d8f7c1e5..48069888965 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.115.0 +version: 0.115.1 database: | Opens the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Opens the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor open {flags} ``` diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index c4e1311b243..f94f4603256 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.115.0 +version: 0.115.1 database: | Reset the in-memory database by dropping all tables. usage: | @@ -16,6 +16,10 @@ contributors: false
Reset the in-memory database by dropping all tables.
+## Command Type + +`built-in` + ## Signature ```> stor reset {flags} ``` diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index 16575037653..2370a1d3612 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.115.0 +version: 0.115.1 database: | Update information in a specified table in the in-memory sqlite database. usage: | @@ -16,6 +16,10 @@ contributors: false
Update information in a specified table in the in-memory sqlite database.
+## Command Type + +`built-in` + ## Signature ```> stor update {flags} ``` diff --git a/commands/docs/str.md b/commands/docs/str.md index 10fd2cf55ab..49e13ab801d 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Various commands for working with string data. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with string data.
+## Command Type + +`built-in` + ## Signature ```> str {flags} ``` diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 1444f97bb02..459ac8fef9d 100644 --- a/commands/docs/str_camel-case.md +++ b/commands/docs/str_camel-case.md @@ -2,7 +2,7 @@ title: str camel-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to camelCase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to camelCase.
+## Command Type + +`built-in` + ## Signature ```> str camel-case {flags} ...rest``` diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 9fd8723a67d..4be79c61db2 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Capitalize the first letter of text. usage: | @@ -16,6 +16,10 @@ contributors: false
Capitalize the first letter of text.
+## Command Type + +`built-in` + ## Signature ```> str capitalize {flags} ...rest``` diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index a8cdf947e63..a74d1ad6fa6 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Checks if string input contains a substring. usage: | @@ -16,6 +16,10 @@ contributors: false
Checks if string input contains a substring.
+## Command Type + +`built-in` + ## Signature ```> str contains {flags} (string) ...rest``` diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 6c647cfb82c..b3b25834f35 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | @@ -16,6 +16,10 @@ contributors: false
Compare two strings and return the edit distance/Levenshtein distance.
+## Command Type + +`built-in` + ## Signature ```> str distance {flags} (compare-string) ...rest``` diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index 1744a2e9b67..aaea4dfe52c 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert text to lowercase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert text to lowercase.
+## Command Type + +`built-in` + ## Signature ```> str downcase {flags} ...rest``` diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index f2fc038960f..a50ca4244eb 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.115.0 +version: 0.115.1 strings: | Check if an input ends with a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if an input ends with a string.
+## Command Type + +`built-in` + ## Signature ```> str ends-with {flags} (string) ...rest``` diff --git a/commands/docs/str_escape-regex.md b/commands/docs/str_escape-regex.md index 69f762a10a1..c28f103dfe4 100644 --- a/commands/docs/str_escape-regex.md +++ b/commands/docs/str_escape-regex.md @@ -2,7 +2,7 @@ title: str escape-regex categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Escapes special characters in the input string with '\'. usage: | @@ -16,6 +16,10 @@ contributors: false
Escapes special characters in the input string with '\'.
+## Command Type + +`built-in` + ## Signature ```> str escape-regex {flags} ...rest``` diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 9f7615cedc5..11184a9040e 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | @@ -16,6 +16,10 @@ contributors: false
Generates all possible combinations defined in brace expansion syntax.
+## Command Type + +`built-in` + ## Signature ```> str expand {flags} ``` diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index 57c87eaf6be..4dcb2cd47da 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.115.0 +version: 0.115.1 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns start index of first occurrence of string in input, or -1 if no match.
+## Command Type + +`built-in` + ## Signature ```> str index-of {flags} (string) ...rest``` diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index 8c89a19a1a6..de677fd5e7d 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | @@ -16,6 +16,10 @@ contributors: false
Concatenate multiple strings into a single string, with an optional separator between each.
+## Command Type + +`built-in` + ## Signature ```> str join {flags} (separator)``` diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index ca06f5f39cb..c1c2e4213f3 100644 --- a/commands/docs/str_kebab-case.md +++ b/commands/docs/str_kebab-case.md @@ -2,7 +2,7 @@ title: str kebab-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to kebab-case. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to kebab-case.
+## Command Type + +`built-in` + ## Signature ```> str kebab-case {flags} ...rest``` diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index c4b5de7644f..e987d3adcde 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Output the length of any strings in the pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Output the length of any strings in the pipeline.
+## Command Type + +`built-in` + ## Signature ```> str length {flags} ...rest``` diff --git a/commands/docs/str_lowercase.md b/commands/docs/str_lowercase.md index bd3c4a9ce32..2d1a7a56230 100644 --- a/commands/docs/str_lowercase.md +++ b/commands/docs/str_lowercase.md @@ -2,7 +2,7 @@ title: str lowercase categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert text to lowercase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert text to lowercase.
+## Command Type + +`built-in` + ## Signature ```> str lowercase {flags} ...rest``` diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 8428cc16ec6..f15396e1956 100644 --- a/commands/docs/str_pascal-case.md +++ b/commands/docs/str_pascal-case.md @@ -2,7 +2,7 @@ title: str pascal-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to PascalCase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to PascalCase.
+## Command Type + +`built-in` + ## Signature ```> str pascal-case {flags} ...rest``` diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 758cb913c1b..90cf5f37e46 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Find and replace text in the input string. usage: | @@ -16,6 +16,10 @@ contributors: false
Find and replace text in the input string.
+## Command Type + +`built-in` + ## Signature ```> str replace {flags} (find) (replace) ...rest``` diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index 0419bf64b99..afe339eb35a 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Reverse every string in the pipeline. usage: | @@ -16,6 +16,10 @@ contributors: false
Reverse every string in the pipeline.
+## Command Type + +`built-in` + ## Signature ```> str reverse {flags} ...rest``` diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index e78b36aa6d0..e5df039ebde 100644 --- a/commands/docs/str_screaming-snake-case.md +++ b/commands/docs/str_screaming-snake-case.md @@ -2,7 +2,7 @@ title: str screaming-snake-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to SCREAMING_SNAKE_CASE.
+## Command Type + +`built-in` + ## Signature ```> str screaming-snake-case {flags} ...rest``` diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index 8fdc69e4162..863e4220a42 100644 --- a/commands/docs/str_snake-case.md +++ b/commands/docs/str_snake-case.md @@ -2,7 +2,7 @@ title: str snake-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to snake_case. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to snake_case.
+## Command Type + +`built-in` + ## Signature ```> str snake-case {flags} ...rest``` diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index f09200087ab..f9b4cb18868 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.115.0 +version: 0.115.1 strings: | Check if an input starts with a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Check if an input starts with a string.
+## Command Type + +`built-in` + ## Signature ```> str starts-with {flags} (string) ...rest``` diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index ebbff838654..68ac98957c5 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Gather word count statistics on the text. usage: | @@ -16,6 +16,10 @@ contributors: false
Gather word count statistics on the text.
+## Command Type + +`built-in` + ## Signature ```> str stats {flags} ``` diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 194acc6de3f..938ca3b8bd0 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Get part of a string. Note that the first character of a string is index 0. usage: | @@ -16,6 +16,10 @@ contributors: false
Get part of a string. Note that the first character of a string is index 0.
+## Command Type + +`built-in` + ## Signature ```> str substring {flags} (range) ...rest``` diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index 58e87b70265..c563a135d31 100644 --- a/commands/docs/str_title-case.md +++ b/commands/docs/str_title-case.md @@ -2,7 +2,7 @@ title: str title-case categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert a string to Title Case. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a string to Title Case.
+## Command Type + +`built-in` + ## Signature ```> str title-case {flags} ...rest``` diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index b965ed401ba..f6cbcd8a993 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Trim whitespace or specific character. usage: | @@ -16,6 +16,10 @@ contributors: false
Trim whitespace or specific character.
+## Command Type + +`built-in` + ## Signature ```> str trim {flags} ...rest``` diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index ad952b2aeb9..c3543518fb4 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert text to uppercase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert text to uppercase.
+## Command Type + +`built-in` + ## Signature ```> str upcase {flags} ...rest``` diff --git a/commands/docs/str_uppercase.md b/commands/docs/str_uppercase.md index b88a965c540..401e57445b5 100644 --- a/commands/docs/str_uppercase.md +++ b/commands/docs/str_uppercase.md @@ -2,7 +2,7 @@ title: str uppercase categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Convert text to uppercase. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert text to uppercase.
+## Command Type + +`built-in` + ## Signature ```> str uppercase {flags} ...rest``` diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 7d0ba48ffe0..921f5b748cb 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system.
+## Command Type + +`built-in` + ## Signature ```> sys {flags} ``` diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 9eed2bcdcce..f146f63c50f 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system CPUs. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system CPUs.
+## Command Type + +`built-in` + ## Signature ```> sys cpu {flags} ``` diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index 3055b5eda17..ba25cedc700 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system disks. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system disks.
+## Command Type + +`built-in` + ## Signature ```> sys disks {flags} ``` diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 5530937bc6b..80a0daa0090 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system host. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system host.
+## Command Type + +`built-in` + ## Signature ```> sys host {flags} ``` diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index dcd43fe8537..c9119c7a880 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system memory. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system memory.
+## Command Type + +`built-in` + ## Signature ```> sys mem {flags} ``` diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index b832dada21d..a44db43967b 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the system network interfaces. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the system network interfaces.
+## Command Type + +`built-in` + ## Signature ```> sys net {flags} ``` diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md index 8cbe23fff5d..ba1d774f36f 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.115.0 +version: 0.115.1 system: | View the temperatures of system components. usage: | @@ -16,6 +16,10 @@ contributors: false
View the temperatures of system components.
+## Command Type + +`built-in` + ## Signature ```> sys temp {flags} ``` diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 31cda72ea9a..99667d3f80c 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.115.0 +version: 0.115.1 system: | View information about the users on the system. usage: | @@ -16,6 +16,10 @@ contributors: false
View information about the users on the system.
+## Command Type + +`built-in` + ## Signature ```> sys users {flags} ``` diff --git a/commands/docs/table.md b/commands/docs/table.md index f6d17e20e66..b2358885ebf 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.115.0 +version: 0.115.1 viewers: | Render the table. usage: | @@ -16,6 +16,10 @@ contributors: false
Render the table.
+## Command Type + +`built-in` + ## Signature ```> table {flags} ``` diff --git a/commands/docs/take.md b/commands/docs/take.md index 4c1b2d0923b..235c64e380f 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. For binary input, n can also be specified as a filesize. usage: | @@ -16,6 +16,10 @@ contributors: false
Take only the first n elements of a list, or the first n bytes of a binary value. For binary input, n can also be specified as a filesize.
+## Command Type + +`built-in` + ## Signature ```> take {flags} (n)``` diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 990a461a1ab..2b3ec43d9a6 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Take elements of the input until a predicate is true. usage: | @@ -16,6 +16,10 @@ contributors: false
Take elements of the input until a predicate is true.
+## Command Type + +`built-in` + ## Signature ```> take until {flags} (predicate)``` diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index 77e14842ec7..6f21aeaf429 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Take elements of the input while a predicate is true. usage: | @@ -16,6 +16,10 @@ contributors: false
Take elements of the input while a predicate is true.
+## Command Type + +`built-in` + ## Signature ```> take while {flags} (predicate)``` diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 7552b009cd6..e43a67185a3 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Copy a stream to another command in parallel. usage: | @@ -16,6 +16,10 @@ contributors: false
Copy a stream to another command in parallel.
+## Command Type + +`built-in` + ## Signature ```> tee {flags} (closure)``` diff --git a/commands/docs/term.md b/commands/docs/term.md index a3166df7c34..a47a064dc34 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Commands for querying information about the terminal. usage: | @@ -16,6 +16,10 @@ contributors: false
Commands for querying information about the terminal.
+## Command Type + +`built-in` + ## Signature ```> term {flags} ``` diff --git a/commands/docs/term_query.md b/commands/docs/term_query.md index d5004021d0e..ce329c400be 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Query the terminal for information. usage: | @@ -16,6 +16,10 @@ contributors: false
Query the terminal for information.
+## Command Type + +`built-in` + ## Signature ```> term query {flags} (query)``` diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index 51ad670a299..a4dd694b045 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns a record containing the number of columns (width) and rows (height) of the terminal.
+## Command Type + +`built-in` + ## Signature ```> term size {flags} ``` diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index 2b8f4e046bf..2012de3a1c4 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Time how long it takes a closure to run. usage: | @@ -16,6 +16,10 @@ contributors: false
Time how long it takes a closure to run.
+## Command Type + +`built-in` + ## Signature ```> timeit {flags} (command)``` diff --git a/commands/docs/to.md b/commands/docs/to.md index 2c66d50897e..6ba04e05729 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Translate structured data to various formats. usage: | @@ -16,6 +16,10 @@ contributors: false
Translate structured data to various formats.
+## Command Type + +`built-in` + ## Signature ```> to {flags} ``` diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 01ce7d8115c..63c4c013577 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into .csv text . usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into .csv text .
+## Command Type + +`built-in` + ## Signature ```> to csv {flags} ``` diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 1a27db7140c..56e59e06d73 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into simple HTML. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into simple HTML.
+## Command Type + +`built-in` + ## Signature ```> to html {flags} ``` diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index b02574aa315..c8d291b3173 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Converts table data into JSON text. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts table data into JSON text.
+## Command Type + +`built-in` + ## Signature ```> to json {flags} ``` diff --git a/commands/docs/to_kdl.md b/commands/docs/to_kdl.md index 776fe42bae7..e29ce0318f3 100644 --- a/commands/docs/to_kdl.md +++ b/commands/docs/to_kdl.md @@ -2,7 +2,7 @@ title: to kdl categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Converts structured data into KDL text. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts structured data into KDL text.
+## Command Type + +`built-in` + ## Signature ```> to kdl {flags} ``` diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index e5022179433..63f5a8a4994 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into simple Markdown. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into simple Markdown.
+## Command Type + +`built-in` + ## Signature ```> to md {flags} ``` diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index a4ff1c34ad1..1388a3ab229 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert Nu values into MessagePack. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert Nu values into MessagePack.
+## Command Type + +`built-in` + ## Signature ```> to msgpack {flags} ``` diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 24d4869f6b7..be5fe938e69 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert Nu values into brotli-compressed MessagePack.
+## Command Type + +`built-in` + ## Signature ```> to msgpackz {flags} ``` diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 4e8e268b134..3fb29d7f966 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts table data into Nuon (Nushell Object Notation) text.
+## Command Type + +`built-in` + ## Signature ```> to nuon {flags} ``` diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index e09ef5c3129..c595409fe8a 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert Nu values into plist usage: | @@ -16,6 +16,17 @@ contributors: false
Convert Nu values into plist
+::: warning This command requires a plugin +The `to plist` command resides in the `formats` plugin. +To use this command, you must install and register `nu_plugin_formats`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Command Type + +`plugin` + ## Signature ```> to plist {flags} ``` diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index dfb1db7a06e..a589db12ac9 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert data into plain text format. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert data into plain text format.
+## Command Type + +`built-in` + ## Signature ```> to text {flags} ``` diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 895e9b59fc6..31dcdfea476 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert record into .toml text. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert record into .toml text.
+## Command Type + +`built-in` + ## Signature ```> to toml {flags} ``` diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 345561a26a0..2ebfa692436 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into .tsv text. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into .tsv text.
+## Command Type + +`built-in` + ## Signature ```> to tsv {flags} ``` diff --git a/commands/docs/to_txt.md b/commands/docs/to_txt.md index 57d64658d02..d6f2a2fd022 100644 --- a/commands/docs/to_txt.md +++ b/commands/docs/to_txt.md @@ -2,7 +2,7 @@ title: to txt categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert data into plain text format. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert data into plain text format.
+## Command Type + +`built-in` + ## Signature ```> to txt {flags} ``` diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index a056651869f..c1381f6c9f4 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert special record structure into .xml text. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert special record structure into .xml text.
+## Command Type + +`built-in` + ## Signature ```> to xml {flags} ``` diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 18ae07d7cb0..0ce61c05176 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into .yaml/.yml text. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into .yaml/.yml text.
+## Command Type + +`built-in` + ## Signature ```> to yaml {flags} ``` diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md index 3601052c009..ed57adbb3c6 100644 --- a/commands/docs/to_yml.md +++ b/commands/docs/to_yml.md @@ -2,7 +2,7 @@ title: to yml categories: | formats -version: 0.115.0 +version: 0.115.1 formats: | Convert table into .yaml/.yml text. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert table into .yaml/.yml text.
+## Command Type + +`built-in` + ## Signature ```> to yml {flags} ``` diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 1710e7ecfc8..03f790bfb42 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Creates one or more files. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates one or more files.
+## Command Type + +`built-in` + ## Signature ```> touch {flags} ...rest``` diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index a587061171d..ae5a9ac7189 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | @@ -16,6 +16,10 @@ contributors: false
Transposes the table contents so rows become columns and columns become rows.
+## Command Type + +`built-in` + ## Signature ```> transpose {flags} ...rest``` diff --git a/commands/docs/try.md b/commands/docs/try.md index e082f984ace..3b7f985da84 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.115.0 +version: 0.115.1 core: | Try to run a block, if it fails optionally run a catch closure. usage: | @@ -16,6 +16,10 @@ contributors: false
Try to run a block, if it fails optionally run a catch closure.
+## Command Type + +`keyword` + ## Signature ```> try {flags} (try_block) (catch) (finally)``` diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index bdf933e31e0..2d0c31c65d2 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.115.0 +version: 0.115.1 misc: | Run the tutorial. To begin, run: tutor. usage: | @@ -16,6 +16,10 @@ contributors: false
Run the tutorial. To begin, run: tutor.
+## Command Type + +`built-in` + ## Signature ```> tutor {flags} (search)``` diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 7edc062147f..6b883f24116 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Set or get resource usage limits. usage: | @@ -16,6 +16,10 @@ contributors: false
Set or get resource usage limits.
+## Command Type + +`built-in` + ## Signature ```> ulimit {flags} (limit)``` diff --git a/commands/docs/umask.md b/commands/docs/umask.md index 2bb1b754d10..341544cb4df 100644 --- a/commands/docs/umask.md +++ b/commands/docs/umask.md @@ -2,7 +2,7 @@ title: umask categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Get or set default file creation permissions. usage: | @@ -16,6 +16,10 @@ contributors: false
Get or set default file creation permissions.
+## Command Type + +`built-in` + ## Signature ```> umask {flags} (permissions)``` diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 4a521045455..9775c15a938 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.115.0 +version: 0.115.1 system: | Print certain system information using uutils/coreutils uname. usage: | @@ -16,6 +16,10 @@ contributors: false
Print certain system information using uutils/coreutils uname.
+## Command Type + +`built-in` + ## Signature ```> uname {flags} ``` diff --git a/commands/docs/union.md b/commands/docs/union.md index 1d21e6ba616..4bdb560b5f0 100644 --- a/commands/docs/union.md +++ b/commands/docs/union.md @@ -2,7 +2,7 @@ title: union categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Returns a list of unique elements from both the input and the provided list. usage: | @@ -16,6 +16,10 @@ contributors: false
Returns a list of unique elements from both the input and the provided list.
+## Command Type + +`built-in` + ## Signature ```> union {flags} (other)``` diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index bf731db61c9..e41e4984d2f 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Return the distinct values in the input by the given column(s). usage: | @@ -16,6 +16,10 @@ contributors: false
Return the distinct values in the input by the given column(s).
+## Command Type + +`built-in` + ## Signature ```> uniq-by {flags} ...rest``` diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index a70b774e01f..08db534440f 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Return the distinct values in the input. usage: | @@ -16,6 +16,10 @@ contributors: false
Return the distinct values in the input.
+## Command Type + +`built-in` + ## Signature ```> uniq {flags} ``` diff --git a/commands/docs/unlet.md b/commands/docs/unlet.md index 78e29ccc806..565e3b051f3 100644 --- a/commands/docs/unlet.md +++ b/commands/docs/unlet.md @@ -2,7 +2,7 @@ title: unlet categories: | experimental -version: 0.115.0 +version: 0.115.1 experimental: | Delete variables from nushell memory, making them unrecoverable. usage: | @@ -16,6 +16,10 @@ contributors: false
Delete variables from nushell memory, making them unrecoverable.
+## Command Type + +`built-in` + ## Signature ```> unlet {flags} ...rest``` diff --git a/commands/docs/update.md b/commands/docs/update.md index aa335b26837..682af35fec8 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Update an existing column to have a new value. usage: | @@ -16,6 +16,10 @@ contributors: false
Update an existing column to have a new value.
+## Command Type + +`built-in` + ## Signature ```> update {flags} (field) (replacement value)``` diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index 37773397e2f..73a8bd65702 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Update the table cells. usage: | @@ -16,6 +16,10 @@ contributors: false
Update the table cells.
+## Command Type + +`built-in` + ## Signature ```> update cells {flags} (closure)``` diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 6c7a01e6b00..b2bcc8d9a98 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Update an existing column to have a new value, or insert a new column. usage: | @@ -16,6 +16,10 @@ contributors: false
Update an existing column to have a new value, or insert a new column.
+## Command Type + +`built-in` + ## Signature ```> upsert {flags} (field) (replacement value)``` diff --git a/commands/docs/url.md b/commands/docs/url.md index d5dc670f367..6f0c6cb2f49 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.115.0 +version: 0.115.1 network: | Various commands for working with URLs. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for working with URLs.
+## Command Type + +`built-in` + ## Signature ```> url {flags} ``` diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index b2a5c6d4155..ffedd7b9a97 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.115.0 +version: 0.115.1 network: | Converts record or table into query string applying percent-encoding. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts record or table into query string applying percent-encoding.
+## Command Type + +`built-in` + ## Signature ```> url build-query {flags} ``` diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index c0abd207851..7e14dbf200a 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Converts a percent-encoded web safe string to a string. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts a percent-encoded web safe string to a string.
+## Command Type + +`built-in` + ## Signature ```> url decode {flags} ...rest``` diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index 5f8f9c50796..3913a8d8f4a 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.115.0 +version: 0.115.1 strings: | Converts a string to a percent encoded web safe string. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts a string to a percent encoded web safe string.
+## Command Type + +`built-in` + ## Signature ```> url encode {flags} ...rest``` diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index bed93b744ff..27512003763 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.115.0 +version: 0.115.1 network: | Convert a record to a URL string. usage: | @@ -16,6 +16,10 @@ contributors: false
Convert a record to a URL string.
+## Command Type + +`built-in` + ## Signature ```> url join {flags} ``` diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index ad29181a59d..dbf20c549f9 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.115.0 +version: 0.115.1 network: | Parse a URL string into structured data. usage: | @@ -16,6 +16,10 @@ contributors: false
Parse a URL string into structured data.
+## Command Type + +`built-in` + ## Signature ```> url parse {flags} ...rest``` diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index 21ba86e430e..9b9059b87c0 100644 --- a/commands/docs/url_split-query.md +++ b/commands/docs/url_split-query.md @@ -2,7 +2,7 @@ title: url split-query categories: | network -version: 0.115.0 +version: 0.115.1 network: | Converts query string into table applying percent-decoding. usage: | @@ -16,6 +16,10 @@ contributors: false
Converts query string into table applying percent-decoding.
+## Command Type + +`built-in` + ## Signature ```> url split-query {flags} ``` diff --git a/commands/docs/use.md b/commands/docs/use.md index a233bb33cc9..9c10eaed21a 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.115.0 +version: 0.115.1 core: | Use definitions from a module, making them available in your shell. usage: | @@ -16,6 +16,10 @@ contributors: false
Use definitions from a module, making them available in your shell.
+## Command Type + +`keyword` + ## Signature ```> use {flags} (module) ...rest``` diff --git a/commands/docs/values.md b/commands/docs/values.md index e9b2489bb09..aa39cc820ec 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Given a record or table, produce a list of its columns' values. usage: | @@ -16,6 +16,10 @@ contributors: false
Given a record or table, produce a list of its columns' values.
+## Command Type + +`built-in` + ## Signature ```> values {flags} ``` diff --git a/commands/docs/version.md b/commands/docs/version.md index e414429af38..89f3f7b7ab5 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.115.0 +version: 0.115.1 core: | Display Nu version, and its build configuration. usage: | @@ -16,6 +16,10 @@ contributors: false
Display Nu version, and its build configuration.
+## Command Type + +`built-in` + ## Signature ```> version {flags} ``` diff --git a/commands/docs/version_check.md b/commands/docs/version_check.md index 928ff6d8e38..586f63d61ac 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Checks to see if you have the latest version of nushell. usage: | @@ -16,6 +16,10 @@ contributors: false
Checks to see if you have the latest version of nushell.
+## Command Type + +`built-in` + ## Signature ```> version check {flags} ``` diff --git a/commands/docs/view.md b/commands/docs/view.md index 7f6f70c7c47..4d53569bb0e 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | Various commands for viewing debug information. usage: | @@ -16,6 +16,10 @@ contributors: false
Various commands for viewing debug information.
+## Command Type + +`built-in` + ## Signature ```> view {flags} ``` diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index c3e17d5c228..d4735a5e611 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View the blocks registered in nushell's EngineState memory. usage: | @@ -16,6 +16,10 @@ contributors: false
View the blocks registered in nushell's EngineState memory.
+## Command Type + +`built-in` + ## Signature ```> view blocks {flags} ``` diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 7716938591e..7809511481e 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View the files registered in nushell's EngineState memory. usage: | @@ -16,6 +16,10 @@ contributors: false
View the files registered in nushell's EngineState memory.
+## Command Type + +`built-in` + ## Signature ```> view files {flags} ``` diff --git a/commands/docs/view_ir.md b/commands/docs/view_ir.md index 0ee4ed0c49c..c5d873c2d00 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View the compiled IR code for a block of code. usage: | @@ -16,6 +16,10 @@ contributors: false
View the compiled IR code for a block of code.
+## Command Type + +`built-in` + ## Signature ```> view ir {flags} (target)``` diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index 8e0b74230c0..fb79609a517 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View a block, module, or a definition. usage: | @@ -16,6 +16,10 @@ contributors: false
View a block, module, or a definition.
+## Command Type + +`built-in` + ## Signature ```> view source {flags} (item)``` diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 7ba828792ed..2aedc2ad4d8 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.115.0 +version: 0.115.1 debug: | View the contents of a span. usage: | @@ -16,6 +16,10 @@ contributors: false
View the contents of a span.
+## Command Type + +`built-in` + ## Signature ```> view span {flags} (start) (end)``` diff --git a/commands/docs/watch.md b/commands/docs/watch.md index 9fb41b30239..a9f928120fd 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.115.0 +version: 0.115.1 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | @@ -16,6 +16,10 @@ contributors: false
Watch for file changes and execute Nu code when they happen.
+## Command Type + +`built-in` + ## Signature ```> watch {flags} (path) (closure)``` diff --git a/commands/docs/where.md b/commands/docs/where.md index 93e655e53ef..c574552b9c6 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Filter values of an input list based on a condition. usage: | @@ -16,6 +16,10 @@ contributors: false
Filter values of an input list based on a condition.
+## Command Type + +`keyword` + ## Signature ```> where {flags} (condition)``` diff --git a/commands/docs/which.md b/commands/docs/which.md index d12b6d508d9..fa4e8fe3d0f 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.115.0 +version: 0.115.1 system: | Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned. usage: | @@ -16,6 +16,10 @@ contributors: false
Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned.
+## Command Type + +`built-in` + ## Signature ```> which {flags} ...rest``` diff --git a/commands/docs/while.md b/commands/docs/while.md index fb91ff72eab..81d9ce28cab 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.115.0 +version: 0.115.1 core: | Conditionally run a block in a loop. usage: | @@ -16,6 +16,10 @@ contributors: false
Conditionally run a block in a loop.
+## Command Type + +`keyword` + ## Signature ```> while {flags} (cond) (block)``` diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 81264522b9c..92908f18037 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.115.0 +version: 0.115.1 platform: | Get the current username using uutils/coreutils whoami. usage: | @@ -16,6 +16,10 @@ contributors: false
Get the current username using uutils/coreutils whoami.
+## Command Type + +`built-in` + ## Signature ```> whoami {flags} ``` diff --git a/commands/docs/window.md b/commands/docs/window.md index 37e929b82fa..ff9eec905dd 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | @@ -16,6 +16,10 @@ contributors: false
Creates a sliding window of `window_size` that slide by n rows/elements across input.
+## Command Type + +`built-in` + ## Signature ```> window {flags} (window_size)``` diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index b35c5bd0fd2..e48fc604758 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.115.0 +version: 0.115.1 env: | Runs a block with an environment variable set. usage: | @@ -16,6 +16,10 @@ contributors: false
Runs a block with an environment variable set.
+## Command Type + +`built-in` + ## Signature ```> with-env {flags} (variable) (block)``` diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index d2843686909..0ab82945e0f 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Wrap the value into a column. usage: | @@ -16,6 +16,10 @@ contributors: false
Wrap the value into a column.
+## Command Type + +`built-in` + ## Signature ```> wrap {flags} (name)``` diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 87daa86cfc2..5c195f28591 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.115.0 +version: 0.115.1 filters: | Combine a stream with the input. usage: | @@ -16,6 +16,10 @@ contributors: false
Combine a stream with the input.
+## Command Type + +`built-in` + ## Signature ```> zip {flags} (other)``` diff --git a/make_docs.nu b/make_docs.nu index 3c2a2ae275c..1c84d8e5613 100644 --- a/make_docs.nu +++ b/make_docs.nu @@ -35,7 +35,7 @@ def plugin-args [plugins: list] { def command-names [] { let plugins = (plugin-paths) let plugin_args = (plugin-args $plugins) - nu --no-config-file ...$plugin_args --commands $'scope commands | select name | to json' + run-external $nu.current-exe '--no-config-file' ...$plugin_args '--commands' 'scope commands | select name | to json' | from json } @@ -68,7 +68,7 @@ def make_docs [ let $nu_path = ($nu_path | default $nu.current-exe) let plugins = (plugin-paths $nu_path) let plugin_args = (plugin-args $plugins) - run-external $nu_path "--no-config-file" ...$plugin_args "make_docs.nu" + run-external $nu_path "--no-config-file" ...$plugin_args ($env.FILE_PWD | path join 'make_docs.nu') "generate" } # generate the YAML frontmatter of a command @@ -173,6 +173,12 @@ def command-doc [command] { } | str join " ") } + let command_type = $"## Command Type + +`($command.type)` + +" + let signatures = $"## Signature ```> ($command.name) {flags} ($sig)``` @@ -303,7 +309,16 @@ $"($example.description) ['', '## Subcommands:', '', $commands, ''] | str join (char newline) } else { '' } - let plugin_commands = (plugin list | flatten) + let plugin_commands = ( + plugin list + | update commands { each {|command| + match $command { + {name: $name} => $name + _ => $command + } + } } + | flatten + ) let plugin_warning = if ($command.name in $plugin_commands.commands) { let plugin = ($plugin_commands | where commands == $command.name | first) [ $"::: warning This command requires a plugin" @@ -319,7 +334,7 @@ $"($example.description) } let doc = ( - ($top + $plugin_warning + $signatures + $flags + $parameters + $in_out + $examples + $extra_description + $sub_commands) + ($top + $plugin_warning + $command_type + $signatures + $flags + $parameters + $in_out + $examples + $extra_description + $sub_commands) | lines | each {|line| ($line | str trim -r) } | str join (char newline) @@ -444,7 +459,12 @@ contributors: false } +# Start generation in a clean process with the bundled plugins loaded. def main [] { + make_docs +} + +def "main generate" [] { # Old commands are currently not deleted because some of them # are platform-specific (currently `exec`, `registry query`), and a single run of this script will not regenerate # all of them.