diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 8ec58438f5d..fff56562927 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -33,4 +33,4 @@ export const commandCategories = [ '/commands/categories/strings.md', '/commands/categories/system.md', '/commands/categories/viewers.md', -]; +]; \ No newline at end of file diff --git a/commands/docs/abbr.md b/commands/docs/abbr.md new file mode 100644 index 00000000000..0a7e9df603b --- /dev/null +++ b/commands/docs/abbr.md @@ -0,0 +1,36 @@ +--- +title: abbr +categories: | + platform +version: 0.113.0 +platform: | + Abbreviations related commands. +usage: | + Abbreviations related commands. +editLink: false +contributors: false +--- + + +# `abbr` for [platform](/commands/categories/platform.md) + +
Abbreviations related commands.
+ +## Signature + +```> abbr {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | +## Notes +You must use one of the following subcommands. Using this command as-is will only produce this help message. + +## Subcommands: + +| name | description | type | +| ------------------------------------------ | ------------------------------- | -------- | +| [`abbr list`](/commands/docs/abbr_list.md) | List all defined abbreviations. | built-in | \ No newline at end of file diff --git a/commands/docs/abbr_list.md b/commands/docs/abbr_list.md new file mode 100644 index 00000000000..2b55b835941 --- /dev/null +++ b/commands/docs/abbr_list.md @@ -0,0 +1,35 @@ +--- +title: abbr list +categories: | + platform +version: 0.113.0 +platform: | + List all defined abbreviations. +usage: | + List all defined abbreviations. +editLink: false +contributors: false +--- + + +# `abbr list` for [platform](/commands/categories/platform.md) + +
List all defined abbreviations.
+ +## Signature + +```> abbr list {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | +## Examples + +List all abbreviations +```nu +> abbr list + +``` diff --git a/commands/docs/alias.md b/commands/docs/alias.md index fc5a0250d1b..cf8b9c97c14 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.112.0 +version: 0.113.0 core: | Alias a command (with optional flags) to a new name. usage: | diff --git a/commands/docs/all.md b/commands/docs/all.md index 4b11164fe80..94bcc8d3c2c 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Test if every element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index e021dc72c34..d62b57e3e8e 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Output ANSI codes to change color and style of text. usage: | diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index ea68cc564f8..b704d749289 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | @@ -24,8 +24,11 @@ contributors: false - `--fgstart, -a {string}`: Foreground gradient start color in hex (0x123456). - `--fgend, -b {string}`: Foreground gradient end color in hex. + - `--fgnamed, -F {string}`: Named foreground gradient. - `--bgstart, -c {string}`: Background gradient start color in hex. - `--bgend, -d {string}`: Background gradient end color in hex. + - `--bgnamed, -B {string}`: Named background gradient. + - `--list, -l`: List available named gradients and show an example. ## Parameters @@ -40,28 +43,41 @@ contributors: false | list<string> | list<string> | | table | table | | record | record | +| nothing | string | ## Examples draw text in a gradient with foreground start and end colors ```nu > 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff' --fgend '0xe81cff' - +Hello, Nushell! This is a gradient. ``` draw text in a gradient with foreground start and end colors and background start and end colors ```nu > 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff' --fgend '0xe81cff' --bgstart '0xe81cff' --bgend '0x40c9ff' - +Hello, Nushell! This is a gradient. ``` draw text in a gradient by specifying foreground start color - end color is assumed to be black ```nu > 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart '0x40c9ff' - +Hello, Nushell! This is a gradient. ``` draw text in a gradient by specifying foreground end color - start color is assumed to be black ```nu > 'Hello, Nushell! This is a gradient.' | ansi gradient --fgend '0xe81cff' +Hello, Nushell! This is a gradient. +``` +draw text in a gradient using a named rainbow foreground gradient +```nu +> 'Hello, Nushell! This is a gradient.' | ansi gradient --fgnamed rainbow +Hello, Nushell! This is a gradient. +``` + +draw text in a gradient using a named forest background gradient +```nu +> 'Hello, Nushell! This is a gradient.' | ansi gradient --bgnamed forest +Hello, Nushell! This is a gradient. ``` diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index b0bc2268378..9902a2d08f3 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 0676983120c..b40f8b51c1f 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index fdddf4a401a..1bfe8a5b2df 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Tests if any element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/append.md b/commands/docs/append.md index 15191c7f8fd..606ffc02f2a 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index ccefc19879e..f72304a9e59 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/attr.md b/commands/docs/attr.md index 3ed3af7a265..a50443aacdd 100644 --- a/commands/docs/attr.md +++ b/commands/docs/attr.md @@ -2,7 +2,7 @@ title: attr categories: | core -version: 0.112.0 +version: 0.113.0 core: | Various attributes for custom commands. usage: | diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md index 24a68930239..b8ed749ca03 100644 --- a/commands/docs/attr_category.md +++ b/commands/docs/attr_category.md @@ -2,7 +2,7 @@ title: attr category categories: | core -version: 0.112.0 +version: 0.113.0 core: | Attribute for adding a category to custom commands. usage: | diff --git a/commands/docs/attr_complete.md b/commands/docs/attr_complete.md index bab2d9031d3..bcddcca4655 100644 --- a/commands/docs/attr_complete.md +++ b/commands/docs/attr_complete.md @@ -2,7 +2,7 @@ title: attr complete categories: | core -version: 0.112.0 +version: 0.113.0 core: | Attribute for using another command as a completion source for all arguments. usage: | diff --git a/commands/docs/attr_complete_external.md b/commands/docs/attr_complete_external.md index c60ca84f74e..76cae4d4d8b 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.112.0 +version: 0.113.0 core: | Attribute for enabling use of the external completer for internal commands. usage: | diff --git a/commands/docs/attr_deprecated.md b/commands/docs/attr_deprecated.md index e927656a4be..afa7bbdb751 100644 --- a/commands/docs/attr_deprecated.md +++ b/commands/docs/attr_deprecated.md @@ -2,7 +2,7 @@ title: attr deprecated categories: | core -version: 0.112.0 +version: 0.113.0 core: | Attribute for marking a command or flag as deprecated. usage: | diff --git a/commands/docs/attr_example.md b/commands/docs/attr_example.md index d9bc13a4ab0..51af82242c7 100644 --- a/commands/docs/attr_example.md +++ b/commands/docs/attr_example.md @@ -2,7 +2,7 @@ title: attr example categories: | core -version: 0.112.0 +version: 0.113.0 core: | Attribute for adding examples to custom commands. usage: | diff --git a/commands/docs/attr_search-terms.md b/commands/docs/attr_search-terms.md index bf4695c752c..2784d463d02 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.112.0 +version: 0.113.0 core: | Attribute for adding search terms to custom commands. usage: | diff --git a/commands/docs/banner.md b/commands/docs/banner.md index c561be39563..b75c2cc2653 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.112.0 +version: 0.113.0 default: | Print a banner for Nushell with information about the project usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 9787085da71..09982547992 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index f78764ddd94..7c21b957558 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Performs bitwise and for ints or binary values. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index be4e61a7a0b..3ee41ec647b 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 25d93f1b5bb..193808c6453 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Performs bitwise or for ints or binary values. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 0f6d9c21333..7a30e8d006d 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Bitwise rotate left for ints or binary values. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index d2768f4eb91..34c71232d6f 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Bitwise rotate right for ints or binary values. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index ba4b1cbb9f5..23a068e296f 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Bitwise shift left for ints or binary values. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index bf277482fda..ae9aa386300 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Bitwise shift right for ints or binary values. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index 62c0c4f37b0..a21028c504b 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.112.0 +version: 0.113.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 208278f86d3..489c40968d3 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.112.0 +version: 0.113.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 27c39a5f05b..3037e64e5b7 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index d9e049ec4ee..f3d45f53077 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Add specified bytes to the binary input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index deaeb0e2f3a..0dc7dc124e2 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Get bytes from the input defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 73ff9563894..995247caf54 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Create a binary value from the provided arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index 341cc01974c..66eb8496e01 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 68e8049b271..825c9a23528 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.112.0 +version: 0.113.0 bytes: | Check if binary data ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index d5d7a1ecb03..3652db89bd0 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.112.0 +version: 0.113.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index f75b2a95d7d..081b29999bf 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Output the length of any bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index c7c8d40edc2..8ee66e83b7c 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Remove specified bytes from the input. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 5b7fe5f057a..4876e1e513c 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Find and replace bytes in binary data. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 0a7aec253ad..68033abfff7 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index 9e05288d863..13de1bbfac9 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.112.0 +version: 0.113.0 bytes: | Split input into multiple items using a separator. usage: | diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index 96a490e38e7..052749e5102 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.112.0 +version: 0.113.0 bytes: | Check if binary data starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 9b80dd33975..4cd3eda5927 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.112.0 +version: 0.113.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 5567a4c1535..21adc2ec1b0 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Change the current working directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 0706aa281f3..d1a673c5e1b 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index 2f823ca350a..2cff3cf3860 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Divides a sequence into sub-sequences based on a closure. usage: | diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index 5fa412825d8..54e88600b08 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Divide a list, table or binary input into chunks of `chunk_size`. usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 4d2aef3acd2..7c1160d1895 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Clear the terminal screen. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 22e8034fefa..e1e80c05674 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | core -version: 0.112.0 +version: 0.113.0 core: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index a010ceacf74..a56ffe457c8 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Given a record or table, produce a list of its columns' names. usage: | diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index 293181030d3..4116dc736f1 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.112.0 +version: 0.113.0 core: | View the current command line input buffer. usage: | diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index a93d06e7ac9..f526a2a22c9 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.112.0 +version: 0.113.0 core: | Modify the current command line input buffer. usage: | diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 5e6b2054950..f65c27e044f 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.112.0 +version: 0.113.0 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 243bf951a28..7480ea3f1a7 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.112.0 +version: 0.113.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 424f2eb8693..b505e55f945 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index bd4c534102c..6c69a6e87d4 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.112.0 +version: 0.113.0 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | diff --git a/commands/docs/config.md b/commands/docs/config.md index d918e67e30a..c0f2cd017ab 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.112.0 +version: 0.113.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 64083904bd5..d65f77bb03e 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.112.0 +version: 0.113.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index b1413252763..50777aceec8 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Show the current configuration in a flattened form. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index bac5c1b46de..6bad7d5534e 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.112.0 +version: 0.113.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index da263bd3ddb..720fce78a62 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.112.0 +version: 0.113.0 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | diff --git a/commands/docs/config_use-colors.md b/commands/docs/config_use-colors.md index 3d7b5e50a98..758424dd8f3 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.112.0 +version: 0.113.0 env: | Get the configuration for color output. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index cf09c6b4379..31fb089e6e9 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.112.0 +version: 0.113.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index b4480bd3d47..737a54efffb 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.112.0 +version: 0.113.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index e2c94860707..2c010426c70 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Copy files using uutils/coreutils cp. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--recursive, -r`: Copy directories recursively. + - `--no-dereference, -P`: Copy symbolic links as symbolic links instead of their targets. - `--verbose, -v`: Explicitly state what is being done. - `--force, -f`: If an existing destination file cannot be opened, remove it and try again (this option is ignored when the -n option is also used). @@ -91,6 +92,12 @@ Copy file erasing all attributes. ``` +Copy a symbolic link without copying the target. +```nu +> cp --no-dereference link-to-file newlink + +``` + Copy file to a directory three levels above its current location. ```nu > cp myfile .... diff --git a/commands/docs/date.md b/commands/docs/date.md index 7f66bdd692d..330a5b48d17 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.112.0 +version: 0.113.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 29b49935f9d..8b2c40970dc 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.112.0 +version: 0.113.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_from-human.md b/commands/docs/date_from-human.md index e4be0e4f033..e0f3dd2104a 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.112.0 +version: 0.113.0 date: | Convert a human readable datetime string to a datetime. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index acd5d96f02e..1978ead8eb4 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.112.0 +version: 0.113.0 date: | Print a 'humanized' format for the date, relative to now. usage: | diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index 25b612ec910..8f3e37ffaa5 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.112.0 +version: 0.113.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 10e466c4434..8c4a51423f9 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.112.0 +version: 0.113.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 6463418365f..594d21824f4 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.112.0 +version: 0.113.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index d2bea86b8d8..bab57510724 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_env.md b/commands/docs/debug_env.md index 3810774b625..24920260b61 100644 --- a/commands/docs/debug_env.md +++ b/commands/docs/debug_env.md @@ -2,7 +2,7 @@ title: debug env categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Show environment variables as external commands would get it. usage: | diff --git a/commands/docs/debug_experimental-options.md b/commands/docs/debug_experimental-options.md index 8a0f76bca87..23d2c993cbe 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.112.0 +version: 0.113.0 debug: | Show all experimental options. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 511868fe944..5cc84bd522e 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 0187945ed79..6f36d249767 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 1d6c613a827..d1269649933 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 0af4c73fd20..4e43803e5f3 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Decode a Base32-encoded value. usage: | diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index e58484be519..1763af766f3 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Encode a base32hex value. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index ae87afa7baa..69e211f894b 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Decode a Base64-encoded value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 8d97f9f6347..8b0787ef305 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Decode a hex-encoded value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index 8c32860703b..ec8f05925d0 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.112.0 +version: 0.113.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 72aaf21f92c..7e3c9a55104 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Sets a default value if a row's column is missing or null. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 022d5bcb582..3752814f51e 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.112.0 +version: 0.113.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -106,7 +106,7 @@ Describe the type of a record in a detailed way. │ │ │ │ │ detailed_type │ datetime │ │ │ │ │ │ │ │ rust_type │ chrono::datetime::DateTime │ │ │ -│ │ │ │ │ value │ 6 years ago │ │ │ +│ │ │ │ │ value │ 7 years ago │ │ │ │ │ │ │ ╰───────────────┴─────────────────────────────────────────────────────╯ │ │ │ │ │ │ ╭───────────────┬────────────╮ │ │ │ │ │ my_duration │ │ type │ duration │ │ │ diff --git a/commands/docs/detect.md b/commands/docs/detect.md index ee31016fd23..3164bfb3c48 100644 --- a/commands/docs/detect.md +++ b/commands/docs/detect.md @@ -2,7 +2,7 @@ title: detect categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Various commands for detecting things. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index fded4b48751..279a86317a7 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/detect_type.md b/commands/docs/detect_type.md index cded78f49b9..7c55ecb38d4 100644 --- a/commands/docs/detect_type.md +++ b/commands/docs/detect_type.md @@ -2,7 +2,7 @@ title: detect type categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Infer Nushell datatype from a string. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index 9ff5afeaed6..0f625c3065a 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.112.0 +version: 0.113.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 36155b2ca25..0fcc557bd8f 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index e0cc5a53fa8..1ac84983fdd 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index c1c8fc07d45..41fe26f53c4 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 9f4a6eaf6e5..f9b98e0773b 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index 027cab968c7..dab9653eeb0 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index fdc04a53ccd..d667f99029e 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.112.0 +version: 0.113.0 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: | diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 0070c0fdaf9..8f53f62d23b 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.112.0 +version: 0.113.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index babeeb24c68..e719a0f2f01 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index 202ddaa0a97..efddb7258e0 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Encode a string or binary value using Base32. usage: | diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md index aa7fdf7b9e1..d6035e4bec8 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Encode a binary value or a string using base32hex. usage: | diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index aaef63417c7..380071245d3 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Encode a string or binary value using Base64. usage: | diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 02837f9fd14..59b3dc22e18 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index c6e156d6c3d..185ff27fad1 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error.md b/commands/docs/error.md index 15888336775..e8dadd7e354 100644 --- a/commands/docs/error.md +++ b/commands/docs/error.md @@ -2,7 +2,7 @@ title: error categories: | core -version: 0.112.0 +version: 0.113.0 core: | Various commands for working with errors. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 80ca067a8a5..fc8f21a040a 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.112.0 +version: 0.113.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index d71a10791d2..1dd9cc93ee8 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Show (or skip) every n-th row, starting from the first one. usage: | diff --git a/commands/docs/exec.md b/commands/docs/exec.md index 81b7bb7149d..b30da59b8a7 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.112.0 +version: 0.113.0 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 46dfdf39540..0dc8ae9efa8 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.112.0 +version: 0.113.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 7c9676e887a..75884573b44 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index b92c54a9cf7..71c3d594003 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.112.0 +version: 0.113.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | diff --git a/commands/docs/explore_config.md b/commands/docs/explore_config.md index 88ddad2aebe..abdd465c32f 100644 --- a/commands/docs/explore_config.md +++ b/commands/docs/explore_config.md @@ -2,7 +2,7 @@ title: explore config categories: | viewers -version: 0.112.0 +version: 0.113.0 viewers: | Launch a TUI to view and edit the nushell configuration interactively. usage: | diff --git a/commands/docs/explore_regex.md b/commands/docs/explore_regex.md index b7c3ec2596a..3794f38b857 100644 --- a/commands/docs/explore_regex.md +++ b/commands/docs/explore_regex.md @@ -2,7 +2,7 @@ title: explore regex categories: | viewers -version: 0.112.0 +version: 0.113.0 viewers: | Launch a TUI to create and explore regular expressions interactively. usage: | diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 8e618e6d71b..16c3f89b9f3 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.112.0 +version: 0.113.0 env: | Run a block and preserve its environment in a current scope. usage: | diff --git a/commands/docs/export.md b/commands/docs/export.md index 4b0d7bb45c3..cac2af6bcde 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.112.0 +version: 0.113.0 core: | Export definitions or environment variables from a module. usage: | diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 1df5d3a7756..9edec86e166 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.112.0 +version: 0.113.0 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index 8119f3d5c29..d87fa79daad 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.112.0 +version: 0.113.0 core: | Use parse-time constant from a module and export them from this module. usage: | diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index 517b6bc2ca9..bee7be637f2 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.112.0 +version: 0.113.0 core: | Define a custom command and export it from a module. usage: | diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index 4d9d5f0b737..20e550b24fa 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.112.0 +version: 0.113.0 core: | Define an extern and export it from a module. usage: | diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index 1be18fc96f1..081660ce423 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.112.0 +version: 0.113.0 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 42715c19dab..5d41906fb05 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.112.0 +version: 0.113.0 core: | Use definitions from a module and export them from this module. usage: | diff --git a/commands/docs/extern.md b/commands/docs/extern.md index 3df078f04ff..abfb04bafb7 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.112.0 +version: 0.113.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index fb2e532645a..7fb0990d027 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Fill and align text in columns. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index cf66a560801..99a56f0a33f 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index bac4f82c44c..77876d9bf26 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Search for terms in the input data. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index c1e06a2d86d..099057cd2fe 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 83adfe513a9..8d1a09d8c99 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Flatten a table by extracting nested values. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index efd10fbe2d6..30749f80b5b 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.112.0 +version: 0.113.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index 7ec098dec6a..a93eefc8b38 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index 53834c4fb29..a9beb5b4d72 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a string of binary data represented by 0 and 1. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 4a0724765b0..586e91fe580 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 4d9dc74279d..40862a2c317 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Outputs duration with a specified unit of time. usage: | diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index 0a1fdad94c1..0d0725f0815 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/format_number.md b/commands/docs/format_number.md index 2140b7c6963..f1e5b8e643a 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Format a number. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index b2afc7afcfe..aaa23d914ab 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 46fb074a641..ac6a8cfeed2 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse a string or binary data into structured data. usage: | @@ -38,7 +38,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`from ics`](/commands/docs/from_ics.md) | Parse text as .ics and create table. | plugin | | [`from ini`](/commands/docs/from_ini.md) | Parse text as .ini and create table. | plugin | | [`from json`](/commands/docs/from_json.md) | Convert JSON text into structured data. | built-in | -| [`from md`](/commands/docs/from_md.md) | Convert markdown text into structured data. | built-in | +| [`from md`](/commands/docs/from_md.md) | Convert markdown text into human-friendly structured rows. Use --verbose for the full AST. | built-in | | [`from msgpack`](/commands/docs/from_msgpack.md) | Convert MessagePack data into Nu values. | built-in | | [`from msgpackz`](/commands/docs/from_msgpackz.md) | Convert brotli-compressed MessagePack data into Nu values. | built-in | | [`from nuon`](/commands/docs/from_nuon.md) | Convert from nuon to structured data. | built-in | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index e28aed68096..5f5bf68cae4 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index b549d8060cf..fc5f4682e87 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .eml and create record. usage: | diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index 61b34172261..aabff0fa039 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .ics and create table. usage: | diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index caabf9797d1..07802bdf94d 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .ini and create table. usage: | diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index c7d2227c98b..7cdd83fcffa 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert JSON text into structured data. usage: | diff --git a/commands/docs/from_md.md b/commands/docs/from_md.md index 86308522b8b..c8f97a9d817 100644 --- a/commands/docs/from_md.md +++ b/commands/docs/from_md.md @@ -2,11 +2,11 @@ title: from md categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | - Convert markdown text into structured data. + Convert markdown text into human-friendly structured rows. Use --verbose for the full AST. usage: | - Convert markdown text into structured data. + Convert markdown text into human-friendly structured rows. Use --verbose for the full AST. editLink: false contributors: false --- @@ -14,12 +14,16 @@ contributors: false # `from md` for [formats](/commands/categories/formats.md) -
Convert markdown text into structured data.
+
Convert markdown text into human-friendly structured rows. Use --verbose for the full AST.
## Signature ```> from md {flags} ``` +## Flags + + - `--verbose, -v`: Return the full AST with type, position, attrs, and children fields. + ## Input/output types: @@ -28,31 +32,29 @@ contributors: false | string | table | ## Examples -Parse markdown and return key node fields. +Reduced mode promotes child rows; heading text is represented as a text element. ```nu -> '# Title' | from md | select type position attrs -╭───┬──────┬────────────────────────────┬───────────────╮ -│ # │ type │ position │ attrs │ -├───┼──────┼────────────────────────────┼───────────────┤ -│ 0 │ h1 │ ╭───────┬────────────────╮ │ ╭───────┬───╮ │ -│ │ │ │ │ ╭────────┬───╮ │ │ │ depth │ 1 │ │ -│ │ │ │ start │ │ line │ 1 │ │ │ │ level │ 1 │ │ -│ │ │ │ │ │ column │ 1 │ │ │ ╰───────┴───╯ │ -│ │ │ │ │ ╰────────┴───╯ │ │ │ -│ │ │ │ │ ╭────────┬───╮ │ │ │ -│ │ │ │ end │ │ line │ 1 │ │ │ │ -│ │ │ │ │ │ column │ 8 │ │ │ │ -│ │ │ │ │ ╰────────┴───╯ │ │ │ -│ │ │ ╰───────┴────────────────╯ │ │ -╰───┴──────┴────────────────────────────┴───────────────╯ +> '# Title' | from md | get 0.element +text +``` +Get the text content of the first element. +```nu +> '# Title' | from md | get 0.content +Title ``` -Parse markdown frontmatter as a dedicated node. +Parse markdown frontmatter as a dedicated yaml element. ```nu > '--- title: Demo --- -# A' | from md | get 0.type +# A' | from md | get 0.element yaml ``` + +Use --verbose to get the full AST; the first node type is h1. +```nu +> '# Title' | from md --verbose | get 0.type +h1 +``` diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index f2106d1ca99..a0946779229 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert MessagePack data into Nu values. usage: | @@ -62,7 +62,7 @@ Read a table from MessagePack. │ # │ event_name │ time │ ├───┼──────────────────────┼──────────────┤ │ 0 │ Apollo 11 Landing │ 56 years ago │ -│ 1 │ Nushell first commit │ 6 years ago │ +│ 1 │ Nushell first commit │ 7 years ago │ ╰───┴──────────────────────┴──────────────╯ ``` diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index a455fbb99d8..22cc89afb6c 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert brotli-compressed MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index f74a0764564..4db31479906 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 0ec638eb22c..43c3b1bb3d8 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_plist.md b/commands/docs/from_plist.md index ad93d5e620c..74b804b2f22 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 2c6f29b85d9..c83cfb6c6b8 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index b70b54a4b57..7bd8fbf2e07 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index fb448cbf35d..323ab49c1f6 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index e81c5812b53..980432a1035 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index ecc1f7d37ea..70000a87d09 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .vcf and create table. usage: | diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 41255428c46..5c85bf5d6da 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--sheets, -s {list}`: Only convert specified sheets. + - `--header-row, -r {oneof}`: Specify row (0-indexed) to designate the header (default first non-empty row) or null for no header ## Input/output types: @@ -43,3 +44,9 @@ Convert binary .xlsx data to a table, specifying the tables. > open --raw test.xlsx | from xlsx --sheets [Spreadsheet1] ``` + +Convert binary .xlsx data to a table, specifying the tables and specifying no header row. +```nu +> open --raw test.xlsx | from xlsx --sheets [Spreadsheet1] --header-row null + +``` diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 6ffb2f9cf55..5bef80a76d2 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 86d4c968f02..ca4a2d25b38 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index fbd8a38dfce..29cd9388c62 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 9de76001f41..ee5d5b6d080 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.112.0 +version: 0.113.0 generators: | Generate a list of values by successively invoking a closure. usage: | diff --git a/commands/docs/get.md b/commands/docs/get.md index d302b23121d..d26cff6c449 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index fbe5576af77..1b44ba140fd 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | diff --git a/commands/docs/grid.md b/commands/docs/grid.md index 1f64eba5384..c4fb017f139 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.112.0 +version: 0.113.0 viewers: | Renders the output to a textual terminal grid. usage: | @@ -18,7 +18,7 @@ contributors: false ## Signature -```> grid {flags} ``` +```> grid {flags} (column)``` ## Flags @@ -27,6 +27,10 @@ contributors: false - `--icons, -i`: Draw output with icons (assumes nerd font is used). - `--separator, -s {string}`: Character to separate grid with. +## Parameters + + - `column`: Format this column in a grid. + ## Input/output types: @@ -45,12 +49,12 @@ Render a simple list to a grid The above example is the same as: ```nu -> [1 2 3 a b c] | wrap name | grid +> [1 2 3 a b c] | wrap name | grid name 1 │ 2 │ 3 │ a │ b │ c ``` -Render a record to a grid +Render a record to a grid (deprecated) ```nu > {name: 'foo', b: 1, c: 2} | grid foo @@ -59,28 +63,25 @@ foo Render a list of records to a grid ```nu -> [{name: 'A', v: 1} {name: 'B', v: 2} {name: 'C', v: 3}] | grid +> [{name: 'A', v: 1} {name: 'B', v: 2} {name: 'C', v: 3}] | grid name A │ B │ C ``` Render a table with 'name' column in it to a grid ```nu -> [[name patch]; [0.1.0 false] [0.1.1 true] [0.2.0 false]] | grid +> [[name patch]; [0.1.0 false] [0.1.1 true] [0.2.0 false]] | grid name 0.1.0 │ 0.1.1 │ 0.2.0 ``` Render a table with 'name' column in it to a grid with icons and colors ```nu -> [[name patch]; [Cargo.toml false] [README.md true] [SECURITY.md false]] | grid --icons --color +> ls | grid --icons --color name ``` ## Notes -grid was built to give a concise gridded layout for ls. however, -it determines what to put in the grid by looking for a column named -'name'. this works great for tables and records but for lists we -need to do something different. such as with '[one two three] | grid' -it creates a fake column called 'name' for these values so that it -prints out the list properly. \ No newline at end of file +The `grid` command creates a concise gridded layout for the input. It +prints every item of the list in a grid layout. However, for table, +you need to provide the name of the column you want to put in the grid. \ No newline at end of file diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index c8871c1e433..e1fa082c400 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 166608a2722..268d985396f 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.112.0 +version: 0.113.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 96c6b5a2694..23f1a0eb062 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.112.0 +version: 0.113.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 68c5b30cbdf..d7628294d72 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.112.0 +version: 0.113.0 hash: | Hash a value using the md5 hash algorithm. usage: | diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index 4d91d06a23e..66a77c76a2c 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.112.0 +version: 0.113.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 2c1552524c7..9a50fb90d5e 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Use the first row of the table as column names. usage: | diff --git a/commands/docs/help.md b/commands/docs/help.md index 17489de7981..6776e2f8a1a 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.112.0 +version: 0.113.0 core: | Display help information about different parts of Nushell. usage: | diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index c52672193dd..7f3084cf18e 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index e80f011953e..49f697b6b5a 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index feec130748f..81bf4c53c46 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index a5be6b37159..1db6bd592d6 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index a70b0b5a4d2..170b5a78a9a 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 1fd5bcd4d82..63570c2ebe4 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.112.0 +version: 0.113.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/help_pipe-and-redirect.md b/commands/docs/help_pipe-and-redirect.md index 7306456381c..ac0375d4009 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.112.0 +version: 0.113.0 core: | Show help on nushell pipes and redirects. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 0874f531f90..dce2ae149b4 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.112.0 +version: 0.113.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 67d687af149..1e77cfcba86 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.112.0 +version: 0.113.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index d19ea749905..c22c80d51fa 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.112.0 +version: 0.113.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | diff --git a/commands/docs/history.md b/commands/docs/history.md index 2a630394bc4..8f2be1b34f5 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.112.0 +version: 0.113.0 history: | Get the command history. usage: | diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index c43f180066e..b052a3ae290 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,7 +2,7 @@ title: history import categories: | history -version: 0.112.0 +version: 0.113.0 history: | Import command line history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 8c2476c9c07..0522e1dfa70 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.112.0 +version: 0.113.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index c6f07bf5732..214120b2d80 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.112.0 +version: 0.113.0 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 5924ff09a19..731727ccf41 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.112.0 +version: 0.113.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 954c572b008..512a78a00ad 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.112.0 +version: 0.113.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 76540e6ddc3..6dffa9c1573 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.112.0 +version: 0.113.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 78ef6a0b4ad..758a246dd07 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.112.0 +version: 0.113.0 network: | Requests permitted communication options for a given URL. usage: | diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index c361cf513a3..e3103a7536e 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.112.0 +version: 0.113.0 network: | Send a PATCH request to a URL with a request body. usage: | diff --git a/commands/docs/http_pool.md b/commands/docs/http_pool.md index 063fe948d6c..af93586144a 100644 --- a/commands/docs/http_pool.md +++ b/commands/docs/http_pool.md @@ -2,7 +2,7 @@ title: http pool categories: | network -version: 0.112.0 +version: 0.113.0 network: | Configure and reset builtin http connection pool. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 688b0bd306b..7e25c3c8739 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.112.0 +version: 0.113.0 network: | Send a POST request to a URL with a request body. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 1deac10b1ff..2c2423bacd1 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.112.0 +version: 0.113.0 network: | Send a PUT request to a URL with a request body. usage: | diff --git a/commands/docs/idx.md b/commands/docs/idx.md new file mode 100644 index 00000000000..1839c9ae2d3 --- /dev/null +++ b/commands/docs/idx.md @@ -0,0 +1,44 @@ +--- +title: idx +categories: | + filesystem +version: 0.113.0 +filesystem: | + Manage in-memory file index state. +usage: | + Manage in-memory file index state. +editLink: false +contributors: false +--- + + +# `idx` for [filesystem](/commands/categories/filesystem.md) + +
Manage in-memory file index state.
+ +## Signature + +```> idx {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | +## Notes +Use one of the subcommands: init, status, find, search, export, import, drop, dirs, files. Watch mode keeps the index warm as files change; disable it when you only need a snapshot of the current tree. + +## Subcommands: + +| name | description | type | +| -------------------------------------------- | ----------------------------------------------------------------------- | -------- | +| [`idx dirs`](/commands/docs/idx_dirs.md) | List indexed directories from idx state. | built-in | +| [`idx drop`](/commands/docs/idx_drop.md) | Drop the current idx runtime from memory. | built-in | +| [`idx export`](/commands/docs/idx_export.md) | Persist idx state to disk. | built-in | +| [`idx files`](/commands/docs/idx_files.md) | List indexed files, or lookup a specific indexed path. | built-in | +| [`idx find`](/commands/docs/idx_find.md) | Search idx with fuzzy matching across files and directories by default. | built-in | +| [`idx import`](/commands/docs/idx_import.md) | Import idx state from disk. | built-in | +| [`idx init`](/commands/docs/idx_init.md) | Initialize the in-memory idx index for a path. | built-in | +| [`idx search`](/commands/docs/idx_search.md) | Search indexed file contents. | built-in | +| [`idx status`](/commands/docs/idx_status.md) | Show status information for the global in-memory idx runtime. | built-in | \ No newline at end of file diff --git a/commands/docs/idx_dirs.md b/commands/docs/idx_dirs.md new file mode 100644 index 00000000000..46e6f808a7c --- /dev/null +++ b/commands/docs/idx_dirs.md @@ -0,0 +1,35 @@ +--- +title: idx dirs +categories: | + filesystem +version: 0.113.0 +filesystem: | + List indexed directories from idx state. +usage: | + List indexed directories from idx state. +editLink: false +contributors: false +--- + + +# `idx dirs` for [filesystem](/commands/categories/filesystem.md) + +
List indexed directories from idx state.
+ +## Signature + +```> idx dirs {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list<record> | +## Examples + +List all indexed directories +```nu +> idx dirs + +``` diff --git a/commands/docs/idx_drop.md b/commands/docs/idx_drop.md new file mode 100644 index 00000000000..35ba0641f1e --- /dev/null +++ b/commands/docs/idx_drop.md @@ -0,0 +1,30 @@ +--- +title: idx drop +categories: | + filesystem +version: 0.113.0 +filesystem: | + Drop the current idx runtime from memory. +usage: | + Drop the current idx runtime from memory. +editLink: false +contributors: false +--- + + +# `idx drop` for [filesystem](/commands/categories/filesystem.md) + +
Drop the current idx runtime from memory.
+ +## Signature + +```> idx drop {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | +## Notes +Use this when you want to free the in-memory index completely before reinitializing or restoring a different snapshot. \ No newline at end of file diff --git a/commands/docs/idx_export.md b/commands/docs/idx_export.md new file mode 100644 index 00000000000..75a61b6aae7 --- /dev/null +++ b/commands/docs/idx_export.md @@ -0,0 +1,42 @@ +--- +title: idx export +categories: | + filesystem +version: 0.113.0 +filesystem: | + Persist idx state to disk. +usage: | + Persist idx state to disk. +editLink: false +contributors: false +--- + + +# `idx export` for [filesystem](/commands/categories/filesystem.md) + +
Persist idx state to disk.
+ +## Signature + +```> idx export {flags} (filepath)``` + +## Parameters + + - `filepath`: Path where idx snapshot should be stored. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | +## Examples + +Save the current idx index to disk +```nu +> idx export ~/my-index.db + +``` + +## Notes +The snapshot is stored as a SQLite database. Use `idx import` to reload it. \ No newline at end of file diff --git a/commands/docs/idx_files.md b/commands/docs/idx_files.md new file mode 100644 index 00000000000..d79d99cbad9 --- /dev/null +++ b/commands/docs/idx_files.md @@ -0,0 +1,45 @@ +--- +title: idx files +categories: | + filesystem +version: 0.113.0 +filesystem: | + List indexed files, or lookup a specific indexed path. +usage: | + List indexed files, or lookup a specific indexed path. +editLink: false +contributors: false +--- + + +# `idx files` for [filesystem](/commands/categories/filesystem.md) + +
List indexed files, or lookup a specific indexed path.
+ +## Signature + +```> idx files {flags} (path)``` + +## Parameters + + - `path`: Optional path to lookup in index. + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list<record> | +## Examples + +List all indexed files +```nu +> idx files + +``` + +Lookup a specific file path in the index +```nu +> idx files src/main.rs + +``` diff --git a/commands/docs/idx_find.md b/commands/docs/idx_find.md new file mode 100644 index 00000000000..eea70a89491 --- /dev/null +++ b/commands/docs/idx_find.md @@ -0,0 +1,61 @@ +--- +title: idx find +categories: | + filesystem +version: 0.113.0 +filesystem: | + Search idx with fuzzy matching across files and directories by default. +usage: | + Search idx with fuzzy matching across files and directories by default. +editLink: false +contributors: false +--- + + +# `idx find` for [filesystem](/commands/categories/filesystem.md) + +
Search idx with fuzzy matching across files and directories by default.
+ +## Signature + +```> idx find {flags} (query)``` + +## Flags + + - `--verbose, -v`: Include verbose scoring details. + - `--dirs, -d`: Search directories only. + - `--files, -f`: Search files only. + - `--limit, -l {int}`: Maximum number of rows to return. + +## Parameters + + - `query`: Freeform fuzzy query. + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list<record> | +## Examples + +Fuzzy search for files and directories matching 'main' +```nu +> idx find main + +``` + +Search only files with verbose scoring output +```nu +> idx find config --files --verbose + +``` + +Search only directories, limited to top 10 results +```nu +> idx find src --dirs --limit 10 + +``` + +## Notes +`idx find` searches both files and directories unless you narrow it with `--files` or `--dirs`. \ No newline at end of file diff --git a/commands/docs/idx_import.md b/commands/docs/idx_import.md new file mode 100644 index 00000000000..9c614199a12 --- /dev/null +++ b/commands/docs/idx_import.md @@ -0,0 +1,42 @@ +--- +title: idx import +categories: | + filesystem +version: 0.113.0 +filesystem: | + Import idx state from disk. +usage: | + Import idx state from disk. +editLink: false +contributors: false +--- + + +# `idx import` for [filesystem](/commands/categories/filesystem.md) + +
Import idx state from disk.
+ +## Signature + +```> idx import {flags} (filepath)``` + +## Parameters + + - `filepath`: Path to a stored idx snapshot. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | +## Examples + +Restore an idx index from a snapshot on disk +```nu +> idx import ~/my-index.db + +``` + +## Notes +Reads a SQLite snapshot created by `idx export` and hydrates the runtime from stored rows. Watch mode is not restored from the snapshot. \ No newline at end of file diff --git a/commands/docs/idx_init.md b/commands/docs/idx_init.md new file mode 100644 index 00000000000..cac761c99e8 --- /dev/null +++ b/commands/docs/idx_init.md @@ -0,0 +1,52 @@ +--- +title: idx init +categories: | + filesystem +version: 0.113.0 +filesystem: | + Initialize the in-memory idx index for a path. +usage: | + Initialize the in-memory idx index for a path. +editLink: false +contributors: false +--- + + +# `idx init` for [filesystem](/commands/categories/filesystem.md) + +
Initialize the in-memory idx index for a path.
+ +## Signature + +```> idx init {flags} (path)``` + +## Flags + + - `--wait, -w`: Block until the initial scan completes before returning. + +## Parameters + + - `path`: Path to index. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | +## Examples + +Initialize idx for the current directory +```nu +> idx init . + +``` + +Initialize idx and wait for the initial scan to complete +```nu +> idx init . --wait + +``` + +## Notes +By default idx init returns immediately and indexing continues in the background. Use `idx status` to check when scanning completes. Pass `--wait` to block until the initial scan finishes. \ No newline at end of file diff --git a/commands/docs/idx_search.md b/commands/docs/idx_search.md new file mode 100644 index 00000000000..872855d11de --- /dev/null +++ b/commands/docs/idx_search.md @@ -0,0 +1,60 @@ +--- +title: idx search +categories: | + filesystem +version: 0.113.0 +filesystem: | + Search indexed file contents. +usage: | + Search indexed file contents. +editLink: false +contributors: false +--- + + +# `idx search` for [filesystem](/commands/categories/filesystem.md) + +
Search indexed file contents.
+ +## Signature + +```> idx search {flags} ...rest``` + +## Flags + + - `--regex, -r`: Use regular-expression matching mode. + - `--fuzzy, -f`: Use fuzzy line-matching mode. + - `--limit, -l {int}`: Maximum number of matches to collect. + +## Parameters + + - `...rest`: One or more search patterns. + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list<record> | +## Examples + +Search indexed file contents for a plain text pattern +```nu +> idx search hello + +``` + +Search using a regular expression +```nu +> idx search --regex 'fn \w+' + +``` + +Search with multiple patterns simultaneously +```nu +> idx search TODO FIXME HACK + +``` + +## Notes +Mode selection: plain text is the default and treats each pattern literally, `--regex` evaluates the patterns as regular expressions, and `--fuzzy` performs approximate line matching. \ No newline at end of file diff --git a/commands/docs/idx_status.md b/commands/docs/idx_status.md new file mode 100644 index 00000000000..4f0102d2e18 --- /dev/null +++ b/commands/docs/idx_status.md @@ -0,0 +1,35 @@ +--- +title: idx status +categories: | + filesystem +version: 0.113.0 +filesystem: | + Show status information for the global in-memory idx runtime. +usage: | + Show status information for the global in-memory idx runtime. +editLink: false +contributors: false +--- + + +# `idx status` for [filesystem](/commands/categories/filesystem.md) + +
Show status information for the global in-memory idx runtime.
+ +## Signature + +```> idx status {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | +## Examples + +Show the current idx runtime status +```nu +> idx status + +``` diff --git a/commands/docs/if.md b/commands/docs/if.md index d3e0d2fead2..657a02adf6c 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.112.0 +version: 0.113.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 0af8440674d..9581ac8fb46 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.112.0 +version: 0.113.0 core: | Ignore the output of the previous command in the pipeline. usage: | diff --git a/commands/docs/inc.md b/commands/docs/inc.md index e075befc746..5b17fc694a2 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.112.0 +version: 0.113.0 default: | Increment a value or version. Optionally use the column of a table. usage: | diff --git a/commands/docs/input.md b/commands/docs/input.md index 60ba7f45f09..8affea8bcd8 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Get input from the user via the terminal. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index d9ddda7e5e3..325358d4c4c 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Display an interactive list for user selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 0394867b79c..492ef23aa68 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Listen for user interface events. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 372ffe7eb18..671845203b0 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 0143100ad93..744e9f05ef8 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index d846fa5057b..1b65c170012 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index 542220e2d82..17c75c2ee18 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Commands to convert data from one type to another. usage: | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 3c7e442c78a..ec1d4be58bc 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index fdb7888cd47..4ebb7db9479 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 7534355f9dc..d06c355563e 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.112.0 +version: 0.113.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index efa60fd713b..653cbf0218e 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -100,7 +100,7 @@ Convert list of timestamps to datetimes. > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime ╭───┬─────────────╮ │ 0 │ 3 years ago │ -│ 1 │ 2 years ago │ +│ 1 │ 3 years ago │ │ 2 │ 2 years ago │ ╰───┴─────────────╯ diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index 8b4871df2e3..4fe9086a21c 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 9442e471509..1b7cc606a1f 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 6f93f69e057..74129a9457e 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index acfe2e48c1f..a6f67bb8d06 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a glob pattern. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 111a51d706e..18e67cdc715 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to an integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index d61bb2cd8e2..5e820dd8707 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 4882a76e2ab..d589e0dbaf7 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 520dcbcbc13..7303d1d4761 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert value to a string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 3f4c3eac463..ee26d1512ca 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | conversions -version: 0.112.0 +version: 0.113.0 conversions: | Convert custom values into base values. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 365c3ca8167..65d6ccb9d09 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.112.0 +version: 0.113.0 core: | Check if nushell is running with administrator or root privileges. usage: | diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index d22afd21cff..5527b3ffa8a 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 03598a09dc5..f26a4e12c60 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.112.0 +version: 0.113.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 1d13159a01e..66e89124eac 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index d8d0a48b726..c6cb5e9a065 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/job.md b/commands/docs/job.md index 5fa9d3b0085..81ace15cdde 100644 --- a/commands/docs/job.md +++ b/commands/docs/job.md @@ -2,7 +2,7 @@ title: job categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Various commands for working with background jobs. usage: | diff --git a/commands/docs/job_describe.md b/commands/docs/job_describe.md index e3e94862ab7..5e1e075d07f 100644 --- a/commands/docs/job_describe.md +++ b/commands/docs/job_describe.md @@ -2,7 +2,7 @@ title: job describe categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Add a description to a background job. usage: | diff --git a/commands/docs/job_flush.md b/commands/docs/job_flush.md index 31a8cbb2864..50773854b93 100644 --- a/commands/docs/job_flush.md +++ b/commands/docs/job_flush.md @@ -2,7 +2,7 @@ title: job flush categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Clear this job's mailbox. usage: | diff --git a/commands/docs/job_id.md b/commands/docs/job_id.md index 4fb2847e8b4..b6470467329 100644 --- a/commands/docs/job_id.md +++ b/commands/docs/job_id.md @@ -2,7 +2,7 @@ title: job id categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Get id of current job. usage: | diff --git a/commands/docs/job_kill.md b/commands/docs/job_kill.md index f4a424e7801..8d4252d41ba 100644 --- a/commands/docs/job_kill.md +++ b/commands/docs/job_kill.md @@ -2,7 +2,7 @@ title: job kill categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Kill a background job. usage: | diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md index c2df916190d..8a4e02bddbe 100644 --- a/commands/docs/job_list.md +++ b/commands/docs/job_list.md @@ -2,7 +2,7 @@ title: job list categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | List background jobs. usage: | diff --git a/commands/docs/job_recv.md b/commands/docs/job_recv.md index 82abb7b9c68..c4dda1e5ed8 100644 --- a/commands/docs/job_recv.md +++ b/commands/docs/job_recv.md @@ -2,7 +2,7 @@ title: job recv categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Read a message from a job's mailbox. usage: | diff --git a/commands/docs/job_send.md b/commands/docs/job_send.md index 144ce8b424f..d63dab0db87 100644 --- a/commands/docs/job_send.md +++ b/commands/docs/job_send.md @@ -2,7 +2,7 @@ title: job send categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Send a message to the mailbox of a job. usage: | diff --git a/commands/docs/job_spawn.md b/commands/docs/job_spawn.md index 6bfc3ff0216..d5df3e09b4a 100644 --- a/commands/docs/job_spawn.md +++ b/commands/docs/job_spawn.md @@ -2,7 +2,7 @@ title: job spawn categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Spawn a background job and retrieve its ID. usage: | diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md index a0ac4af95ee..e51502d9fbf 100644 --- a/commands/docs/job_unfreeze.md +++ b/commands/docs/job_unfreeze.md @@ -2,7 +2,7 @@ title: job unfreeze categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Unfreeze a frozen process job in foreground. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 7ab0092d87c..07e4ae38730 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 55483518873..b8074f66313 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index b33aac5eacf..dc068985999 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 7a9a7254cbb..5a24579c424 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | List available options that can be used to create keybindings. usage: | diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index 48f0dded491..bf087798741 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 28b1e5bcbc8..516efea7052 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Kill a process using its process ID. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 2af78f5677e..a045ed1ac44 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index a4ab6e0c062..77cf7dabf47 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Count the number of items in an input list, rows in a table, or bytes in binary data. usage: | diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 0920d2b814b..573df780207 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.112.0 +version: 0.113.0 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | diff --git a/commands/docs/let.md b/commands/docs/let.md index f02a2e99408..cfe143b801d 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.112.0 +version: 0.113.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 33feef1bb1f..c916584287a 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 664ca422db5..19c0c8371bb 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index de7c5d13bea..9a774a0ebe7 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.112.0 +version: 0.113.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index f3951de7d8a..b6c0411fd4e 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | diff --git a/commands/docs/match.md b/commands/docs/match.md index 133e2385720..c22fde9623c 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.112.0 +version: 0.113.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index f8d44d23f1a..f4e5350017b 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.112.0 +version: 0.113.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index cc0400222ae..c0d846adac9 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 343828568a8..5147ab0ea15 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 5331c288006..afe5294e076 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index 785c5d3b5a9..aa3e83a5405 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 1cf9f84460c..b7c5f3a32b7 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the inverse of the hyperbolic sine function. usage: | diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index bfdd5eda3c2..17f5758781e 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 36c4f8966ec..0fc08b263d1 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 61a73e074bf..490134beda2 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the average of a list of numbers. usage: | diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index c0e0ef9850e..17a9a791a8b 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index 77a43f2f06f..8a2e0d41269 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index d39fc8cbf59..49e4c5752d1 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 172df90c83e..df6fd2f13e9 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns e raised to the power of x. usage: | diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 1af1a48831c..019ed3df943 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 540e7cd464b..1f3756dcab3 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 1acb6cb9a02..6f657f0cf3c 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index f4d88461421..e288ee2021b 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the maximum of a list of values, or of columns in a table. usage: | diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index 0c302317c02..218ae18c151 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.112.0 +version: 0.113.0 math: | Computes the median of a list of numbers. usage: | diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index 89dbfba14d2..30a18aba3d3 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.112.0 +version: 0.113.0 math: | Finds the minimum within a list of values or tables. usage: | diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index 9e8b1056742..4f3f43c2f04 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index 588d51b4998..2fadef2385c 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index f12e4eaaac1..f630ca5f084 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the input number rounded to the specified precision. usage: | diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index 89ccb3b136f..e007490e096 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 26517b3629c..a83b08d0551 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 433ffbb0c94..74361608243 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the square root of the input number. usage: | diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index 721d63e1d0c..99b61c5cb3e 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index ff8fb3014e4..6789e90f0a3 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the sum of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index 6ca1bf7ed20..7a468d13937 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index c4892eac3da..88168424366 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index d08e8d90275..49a1cd2c7f0 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.112.0 +version: 0.113.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 2b60f25afb1..3afdead013e 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | diff --git a/commands/docs/merge_deep.md b/commands/docs/merge_deep.md index 3dc9c99186e..7a325894d76 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Merge the input with a record or table, recursively merging values in matching columns. usage: | diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index d77f5a221ad..7029942764d 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/metadata_access.md b/commands/docs/metadata_access.md index 85ceb3f8643..341549ec8a2 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Access the metadata for the input stream within a closure. usage: | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index cf6e32c90cf..da6a8c97b35 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Set the metadata for items in the stream. usage: | @@ -22,7 +22,6 @@ contributors: false ## Flags - - `--datasource-ls, -l`: (DEPRECATED) Assign the DataSource::Ls metadata to the input. - `--datasource-filepath, -f {path}`: Assign the DataSource::FilePath metadata to the input. - `--path-columns, -p {list}`: A list of columns in the input for which path metadata will be assigned. - `--content-type, -c {oneof}`: Assign content type metadata to the input. diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 20060a64566..1a686fc6744 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | @@ -31,9 +31,10 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------- | -| nothing | nothing | +| input | output | +| ------- | ----------------------------------------------------------------- | +| nothing | nothing | +| nothing | table<path: string, created: bool, error: oneof<nothing, string>> | ## Examples Make a directory named foo. @@ -45,5 +46,11 @@ Make a directory named foo. Make multiple directories and show the paths created. ```nu > mkdir -v foo/bar foo2 +╭───┬─────────┬─────────┬───────╮ +│ # │ path │ created │ error │ +├───┼─────────┼─────────┼───────┤ +│ 0 │ foo/bar │ true │ │ +│ 1 │ foo2 │ true │ │ +╰───┴─────────┴─────────┴───────╯ ``` diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 30e8a421028..3724575e647 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 3dda35493ec..e5d7113e37d 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.112.0 +version: 0.113.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 48b9d568d0d..d253de1f252 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Moves columns relative to other columns or make them the first/last columns. Flags are mutually exclusive. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index 1eab430325d..8b2f80e467f 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.112.0 +version: 0.113.0 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index 69139f73e23..11e2bf7acd9 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | @@ -37,9 +37,10 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------- | -| nothing | nothing | +| input | output | +| ------- | ----------------------------------------------------------- | +| nothing | table<source: string, destination: string, message: string> | +| nothing | nothing | ## Examples Rename a file. @@ -71,3 +72,14 @@ Move a file into the "my" directory two levels up in the directory tree. > mv test.txt .../my/ ``` + +Move a file and show what is being done. +```nu +> mv -v before.txt after.txt +╭───┬────────────┬─────────────┬──────────╮ +│ # │ source │ destination │ message │ +├───┼────────────┼─────────────┼──────────┤ +│ 0 │ before.txt │ after.txt │ renamed │ +╰───┴────────────┴─────────────┴──────────╯ + +``` diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 5eeaa7114ad..13ac9e95b4a 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Validate and parse Nushell input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index d81fadaa678..dd5b91dd767 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 5fd9c0d319d..5ff3a3ff384 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index 1b68b10e30f..7a559e0403b 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.112.0 +version: 0.113.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 3bf520cd684..a7b8aae375f 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.112.0 +version: 0.113.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 52665e9708e..bfbb3bb8b9f 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.112.0 +version: 0.113.0 core: | List all overlays with their active status. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 704a293ec9e..b1fe93774e1 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.112.0 +version: 0.113.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 120ced94920..03c02380e2f 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.112.0 +version: 0.113.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 022b033e92b..174807657c6 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 4e31689815c..47cb1bbd72b 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 5884d956fd0..8040285c909 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Parse columns from string data using a simple pattern or a supplied regular expression. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index b01eec262a5..5ece58e7e57 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.112.0 +version: 0.113.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 65c84f0ca55..c548c655fc3 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.112.0 +version: 0.113.0 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index c8530d5de25..6b675264695 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.112.0 +version: 0.113.0 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 3661926c254..e42c52e1bd8 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.112.0 +version: 0.113.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index a49f9d35c20..17d6f05f45b 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.112.0 +version: 0.113.0 path: | Try to expand a path to its absolute form. usage: | diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index 0f20d35a3cb..5d0c37cf806 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.112.0 +version: 0.113.0 path: | Join a structured path or a list of path parts. usage: | diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index f780cbedf25..8c1cfde6ddf 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.112.0 +version: 0.113.0 path: | Convert a path into structured data. usage: | diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index 8ae48699867..67a2aa61902 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.112.0 +version: 0.113.0 path: | Express a path as relative to another path. usage: | diff --git a/commands/docs/path_self.md b/commands/docs/path_self.md index 4dce92ffcfc..6bc4a5ceccd 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.112.0 +version: 0.113.0 path: | Get the absolute path of the script or module containing this command at parse time. usage: | diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index 6268587302c..03dbd9dea70 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.112.0 +version: 0.113.0 path: | Split a path into a list based on the system's path separator. usage: | diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index 614794d73ed..542ce5376ab 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.112.0 +version: 0.113.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/peek.md b/commands/docs/peek.md new file mode 100644 index 00000000000..6b02c156d36 --- /dev/null +++ b/commands/docs/peek.md @@ -0,0 +1,78 @@ +--- +title: peek +categories: | + default +version: 0.113.0 +default: | + Peek the first elements of a stream and store them in the metadata. +usage: | + Peek the first elements of a stream and store them in the metadata. +editLink: false +contributors: false +--- + + +# `peek` for [default](/commands/categories/default.md) + +
Peek the first <n> elements of a stream and store them in the metadata.
+ +## Signature + +```> peek {flags} (n)``` + +## Parameters + + - `n`: Number of elements to peek, if the input is a stream or list. + + +## Input/output types: + +| input | output | +| --------- | --------- | +| list<any> | list<any> | +| table | table | +| any | any | +## Examples + +Peek the first 2 elements of a stream. +```nu +> seq 1 5 | peek 2 | metadata | $in.peek +╭────────┬───────────╮ +│ type │ list │ +│ stream │ true │ +│ │ ╭───┬───╮ │ +│ value │ │ 0 │ 1 │ │ +│ │ │ 1 │ 2 │ │ +│ │ ╰───┴───╯ │ +╰────────┴───────────╯ +``` + +Lists can also be peeked. +```nu +> [1, 2, 3] | peek 1 | metadata | $in.peek +╭────────┬───────────╮ +│ type │ list │ +│ stream │ false │ +│ │ ╭───┬───╮ │ +│ value │ │ 0 │ 1 │ │ +│ │ ╰───┴───╯ │ +╰────────┴───────────╯ +``` + +Peeking non-list values won't return any values. +```nu +> 'hello' | peek 1 | metadata | $in.peek +╭────────┬───────╮ +│ type │ value │ +│ stream │ false │ +╰────────┴───────╯ +``` + +Peeking non-list streams (text streams, binary streams, external byte streams) won't return any values. +```nu +> [0x[11] 0x[13 15]] | bytes collect | peek | metadata | $in.peek +╭────────┬────────╮ +│ type │ binary │ +│ stream │ true │ +╰────────┴────────╯ +``` diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index 817557451f1..7f0eb4058a5 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 72a476d8772..4e7b4bf4f61 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | Add a plugin to the plugin registry file. usage: | diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 65124c06f25..1658dd449c0 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | List loaded and installed plugins. usage: | @@ -40,7 +40,7 @@ List installed plugins. ╭────┬───────┬─────────────────────┬──────────┬────────┬───────────────────────────────┬───────┬─────────────╮ │ # │ name │ version │ status │ pid │ filename │ shell │ commands │ ├────┼───────┼─────────────────────┼──────────┼────────┼───────────────────────────────┼───────┼─────────────┤ -│ 0 │ inc │ 0.112.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ 0 │ inc │ 0.113.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ │ │ │ │ │ │ │ │ │ 0 │ inc │ │ │ │ │ │ │ │ │ │ ╰───┴─────╯ │ ╰────┴───────┴─────────────────────┴──────────┴────────┴───────────────────────────────┴───────┴─────────────╯ diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 298682673df..273434fb34e 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | Remove a plugin from the plugin registry file. usage: | diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index 423a1c87577..c8d6cfb9807 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | Stop an installed plugin if it was running. usage: | diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index 2ae0267fb0b..7b410913002 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.112.0 +version: 0.113.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | diff --git a/commands/docs/polars.md b/commands/docs/polars.md index 855ac6f5052..0c19236ce57 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -45,150 +45,172 @@ to the `polars agg` command with some column expressions for aggregation which t ## Subcommands: -| name | description | type | -| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | -| [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | -| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | -| [`polars all-false`](/commands/docs/polars_all-false.md) | Returns true if all values are false. | plugin | -| [`polars all-true`](/commands/docs/polars_all-true.md) | Returns true if all values are true. | plugin | -| [`polars append`](/commands/docs/polars_append.md) | Appends a new dataframe. | plugin | -| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Return index for max value in series. | plugin | -| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Return index for min value in series. | plugin | -| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Returns indexes for a sorted series. | plugin | -| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Returns indexes where values are true. | plugin | -| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Returns indexes for unique values. | plugin | -| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Creates an expression that returns the arguments where expression is true. | plugin | -| [`polars as`](/commands/docs/polars_as.md) | Creates an alias expression. | plugin | -| [`polars as-date`](/commands/docs/polars_as-date.md) | Converts string to date. | plugin | -| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Converts string to datetime. | plugin | -| [`polars cache`](/commands/docs/polars_cache.md) | Caches operations in a new LazyFrame. | plugin | -| [`polars cast`](/commands/docs/polars_cast.md) | Cast a column to a different dtype. | plugin | -| [`polars col`](/commands/docs/polars_col.md) | Creates a named column expression. | plugin | -| [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | -| [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | -| [`polars concat`](/commands/docs/polars_concat.md) | Concatenate two or more dataframes. | plugin | -| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | -| [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | -| [`polars convert-time-zone`](/commands/docs/polars_convert-time-zone.md) | Convert datetime to target timezone. | plugin | -| [`polars count`](/commands/docs/polars_count.md) | Returns the number of non-null values in the column. | plugin | -| [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | -| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a column or series. | plugin | -| [`polars cut`](/commands/docs/polars_cut.md) | Bin continuous values into discrete categories for a series. | plugin | -| [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | -| [`polars decimal`](/commands/docs/polars_decimal.md) | Converts a string column into a decimal column | plugin | -| [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | -| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | -| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | -| [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | -| [`polars entropy`](/commands/docs/polars_entropy.md) | Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities. | plugin | -| [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | -| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | -| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | -| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | -| [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | -| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Filters dataframe using a mask or expression as reference. | plugin | -| [`polars first`](/commands/docs/polars_first.md) | Show only the first number of rows or create a first expression | plugin | -| [`polars flatten`](/commands/docs/polars_flatten.md) | An alias for polars explode. | plugin | -| [`polars get`](/commands/docs/polars_get.md) | Creates dataframe with the selected columns. | plugin | -| [`polars get-day`](/commands/docs/polars_get-day.md) | Gets day from date. | plugin | -| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Gets hour from datetime. | plugin | -| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Gets minute from date. | plugin | -| [`polars get-month`](/commands/docs/polars_get-month.md) | Gets month from date. | plugin | -| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Gets nanosecond from date. | plugin | -| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Gets ordinal from date. | plugin | -| [`polars get-second`](/commands/docs/polars_get-second.md) | Gets second from date. | plugin | -| [`polars get-week`](/commands/docs/polars_get-week.md) | Gets week from date. | plugin | -| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | -| [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | -| [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | -| [`polars horizontal`](/commands/docs/polars_horizontal.md) | Horizontal calculation across multiple columns. | plugin | -| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates values into a list. | plugin | -| [`polars integer`](/commands/docs/polars_integer.md) | Converts a string column into a integer column | plugin | -| [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | -| [`polars into-dtype`](/commands/docs/polars_into-dtype.md) | Convert a string to a specific datatype. | plugin | -| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | -| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into nushell value for access and exploration. | plugin | -| [`polars into-repr`](/commands/docs/polars_into-repr.md) | Display a dataframe in its repr format. | plugin | -| [`polars into-schema`](/commands/docs/polars_into-schema.md) | Convert a value to a polars schema object | plugin | -| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Creates mask indicating duplicated values. | plugin | -| [`polars is-in`](/commands/docs/polars_is-in.md) | Creates an is-in expression or checks to see if the elements are contained in the right series | plugin | -| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Creates mask where value is not null. | plugin | -| [`polars is-null`](/commands/docs/polars_is-null.md) | Creates mask where value is null. | plugin | -| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | -| [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | -| [`polars join-where`](/commands/docs/polars_join-where.md) | Joins a lazy frame with other lazy frame based on conditions. | plugin | -| [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | plugin | -| [`polars len`](/commands/docs/polars_len.md) | Return the number of rows in the context. This is similar to COUNT(*) in SQL. | plugin | -| [`polars list-contains`](/commands/docs/polars_list-contains.md) | Checks if an element is contained in a list. | plugin | -| [`polars lit`](/commands/docs/polars_lit.md) | Creates a literal expression. | plugin | -| [`polars lowercase`](/commands/docs/polars_lowercase.md) | Lowercase the strings in the column. | plugin | -| [`polars math`](/commands/docs/polars_math.md) | Collection of math functions to be applied on one or more column expressions | plugin | -| [`polars max`](/commands/docs/polars_max.md) | Creates a max expression or aggregates columns to their max value. | plugin | -| [`polars mean`](/commands/docs/polars_mean.md) | Creates a mean expression for an aggregation or aggregates columns to their mean value. | plugin | -| [`polars median`](/commands/docs/polars_median.md) | Median value from columns in a dataframe or creates expression for an aggregation | plugin | -| [`polars min`](/commands/docs/polars_min.md) | Creates a min expression or aggregates columns to their min value. | plugin | -| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Counts unique values. | plugin | -| [`polars not`](/commands/docs/polars_not.md) | Inverts boolean mask. | plugin | -| [`polars open`](/commands/docs/polars_open.md) | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. | plugin | -| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Completes a when expression. | plugin | -| [`polars over`](/commands/docs/polars_over.md) | Compute expressions over a window group defined by partition expressions. | plugin | -| [`polars pivot`](/commands/docs/polars_pivot.md) | Pivot a DataFrame from long to wide format. | plugin | -| [`polars profile`](/commands/docs/polars_profile.md) | Profile a lazy dataframe. | plugin | -| [`polars qcut`](/commands/docs/polars_qcut.md) | Bin continuous values into discrete categories based on their quantiles for a series. | plugin | -| [`polars quantile`](/commands/docs/polars_quantile.md) | Aggregates the columns to the selected quantile. | plugin | -| [`polars query`](/commands/docs/polars_query.md) | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | plugin | -| [`polars rename`](/commands/docs/polars_rename.md) | Rename a dataframe column. | plugin | -| [`polars replace`](/commands/docs/polars_replace.md) | Create an expression that replaces old values with new values | plugin | -| [`polars replace-time-zone`](/commands/docs/polars_replace-time-zone.md) | Replace the timezone information in a datetime column. | plugin | -| [`polars reverse`](/commands/docs/polars_reverse.md) | Reverses the LazyFrame | plugin | -| [`polars rolling`](/commands/docs/polars_rolling.md) | Rolling calculation for a series. | plugin | -| [`polars sample`](/commands/docs/polars_sample.md) | Create sample dataframe. | plugin | -| [`polars save`](/commands/docs/polars_save.md) | 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). | plugin | -| [`polars schema`](/commands/docs/polars_schema.md) | Show schema for a dataframe. | plugin | -| [`polars select`](/commands/docs/polars_select.md) | Selects columns from lazyframe. | plugin | -| [`polars selector`](/commands/docs/polars_selector.md) | Create column selectors for use in polars commands. | plugin | -| [`polars selector all`](/commands/docs/polars_selector_all.md) | Creates a selector that selects all columns. | plugin | -| [`polars selector by-dtype`](/commands/docs/polars_selector_by-dtype.md) | Creates a selector that selects columns by data type. | plugin | -| [`polars selector by-name`](/commands/docs/polars_selector_by-name.md) | Creates a selector that selects columns by name. | plugin | -| [`polars selector ends-with`](/commands/docs/polars_selector_ends-with.md) | Select columns that end with the given substring(s). | plugin | -| [`polars selector first`](/commands/docs/polars_selector_first.md) | Creates a selector that selects the first column(s) by index. | plugin | -| [`polars selector float`](/commands/docs/polars_selector_float.md) | Select all float columns. | plugin | -| [`polars selector integer`](/commands/docs/polars_selector_integer.md) | Select all integer columns. | plugin | -| [`polars selector last`](/commands/docs/polars_selector_last.md) | Creates a selector that selects the last column(s) by index. | plugin | -| [`polars selector matches`](/commands/docs/polars_selector_matches.md) | Select all columns that match the given regex pattern. | plugin | -| [`polars selector not`](/commands/docs/polars_selector_not.md) | Inverts selector. | plugin | -| [`polars selector numeric`](/commands/docs/polars_selector_numeric.md) | Select all numeric columns. | plugin | -| [`polars selector signed-integer`](/commands/docs/polars_selector_signed-integer.md) | Select all signed integer columns. | plugin | -| [`polars selector starts-with`](/commands/docs/polars_selector_starts-with.md) | Select columns that start with the given substring(s). | plugin | -| [`polars selector unsigned-integer`](/commands/docs/polars_selector_unsigned-integer.md) | Select all unsigned integer columns. | plugin | -| [`polars set`](/commands/docs/polars_set.md) | Sets value where given mask is true. | plugin | -| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Sets value in the given index. | plugin | -| [`polars shape`](/commands/docs/polars_shape.md) | Shows column and row size for a dataframe. | plugin | -| [`polars shift`](/commands/docs/polars_shift.md) | Shifts the values by a given period. | plugin | -| [`polars slice`](/commands/docs/polars_slice.md) | Creates new dataframe from a slice of rows. | plugin | -| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Sorts a lazy dataframe based on expression(s). | plugin | -| [`polars std`](/commands/docs/polars_std.md) | Creates a std expression for an aggregation of std value from columns in a dataframe. | plugin | -| [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | -| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored polars objects. | plugin | -| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | -| [`polars str-join`](/commands/docs/polars_str-join.md) | Concatenates strings within a column or dataframes | plugin | -| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | -| [`polars str-replace`](/commands/docs/polars_str-replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | -| [`polars str-replace-all`](/commands/docs/polars_str-replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | -| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | -| [`polars str-split`](/commands/docs/polars_str-split.md) | Split the string by a substring. The resulting dtype is list\\. | plugin | -| [`polars str-strip-chars`](/commands/docs/polars_str-strip-chars.md) | Strips specified characters from strings in a column | plugin | -| [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | -| [`polars struct-json-encode`](/commands/docs/polars_struct-json-encode.md) | Convert this struct to a string column with json values. | plugin | -| [`polars sum`](/commands/docs/polars_sum.md) | Creates a sum expression for an aggregation or aggregates columns to their sum value. | plugin | -| [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | -| [`polars take`](/commands/docs/polars_take.md) | Creates new dataframe using the given indices. | plugin | -| [`polars truncate`](/commands/docs/polars_truncate.md) | Divide the date/datetime range into buckets. | plugin | -| [`polars unique`](/commands/docs/polars_unique.md) | Returns unique values from a dataframe. | plugin | -| [`polars unnest`](/commands/docs/polars_unnest.md) | 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. | plugin | -| [`polars unpivot`](/commands/docs/polars_unpivot.md) | Unpivot a DataFrame from wide to long format. | plugin | -| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | -| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | -| [`polars var`](/commands/docs/polars_var.md) | Create a var expression for an aggregation. | plugin | -| [`polars when`](/commands/docs/polars_when.md) | Creates and modifies a when expression. | plugin | -| [`polars with-column`](/commands/docs/polars_with-column.md) | Adds a series to the dataframe. | plugin | \ No newline at end of file +| name | description | type | +| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | +| [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | +| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | +| [`polars all-false`](/commands/docs/polars_all-false.md) | Returns true if all values are false. | plugin | +| [`polars all-true`](/commands/docs/polars_all-true.md) | Returns true if all values are true. | plugin | +| [`polars append`](/commands/docs/polars_append.md) | Appends a new dataframe. | plugin | +| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Return index for max value in series. | plugin | +| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Return index for min value in series. | plugin | +| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Returns indexes for a sorted series. | plugin | +| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Returns indexes where values are true. | plugin | +| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Returns indexes for unique values. | plugin | +| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Creates an expression that returns the arguments where expression is true. | plugin | +| [`polars as`](/commands/docs/polars_as.md) | Creates an alias expression. | plugin | +| [`polars as-date`](/commands/docs/polars_as-date.md) | Converts string to date. | plugin | +| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Converts string to datetime. | plugin | +| [`polars cache`](/commands/docs/polars_cache.md) | Caches operations in a new LazyFrame. | plugin | +| [`polars cast`](/commands/docs/polars_cast.md) | Cast a column to a different dtype. | plugin | +| [`polars col`](/commands/docs/polars_col.md) | Creates a named column expression. | plugin | +| [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | +| [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | +| [`polars concat`](/commands/docs/polars_concat.md) | Concatenate two or more dataframes. | plugin | +| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | +| [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | +| [`polars convert-time-zone`](/commands/docs/polars_convert-time-zone.md) | Convert datetime to target timezone. | plugin | +| [`polars count`](/commands/docs/polars_count.md) | Returns the number of non-null values in the column. | plugin | +| [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | +| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a column or series. | plugin | +| [`polars cut`](/commands/docs/polars_cut.md) | Bin continuous values into discrete categories for a series. | plugin | +| [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | +| [`polars decimal`](/commands/docs/polars_decimal.md) | Converts a string column into a decimal column | plugin | +| [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | +| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | +| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | +| [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | +| [`polars entropy`](/commands/docs/polars_entropy.md) | Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities. | plugin | +| [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | +| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | +| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | +| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | +| [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | +| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Filters dataframe using a mask or expression as reference. | plugin | +| [`polars first`](/commands/docs/polars_first.md) | Show only the first number of rows or create a first expression | plugin | +| [`polars flatten`](/commands/docs/polars_flatten.md) | An alias for polars explode. | plugin | +| [`polars get`](/commands/docs/polars_get.md) | Creates dataframe with the selected columns. | plugin | +| [`polars get-day`](/commands/docs/polars_get-day.md) | Gets day from date. | plugin | +| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Gets hour from datetime. | plugin | +| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Gets minute from date. | plugin | +| [`polars get-month`](/commands/docs/polars_get-month.md) | Gets month from date. | plugin | +| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Gets nanosecond from date. | plugin | +| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Gets ordinal from date. | plugin | +| [`polars get-second`](/commands/docs/polars_get-second.md) | Gets second from date. | plugin | +| [`polars get-week`](/commands/docs/polars_get-week.md) | Gets week from date. | plugin | +| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | +| [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | +| [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | +| [`polars horizontal`](/commands/docs/polars_horizontal.md) | Horizontal calculation across multiple columns. | plugin | +| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates values into a list. | plugin | +| [`polars integer`](/commands/docs/polars_integer.md) | Converts a string column into a integer column | plugin | +| [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | +| [`polars into-dtype`](/commands/docs/polars_into-dtype.md) | Convert a string to a specific datatype. | plugin | +| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | +| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into nushell value for access and exploration. | plugin | +| [`polars into-repr`](/commands/docs/polars_into-repr.md) | Display a dataframe in its repr format. | plugin | +| [`polars into-schema`](/commands/docs/polars_into-schema.md) | Convert a value to a polars schema object | plugin | +| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Creates mask indicating duplicated values. | plugin | +| [`polars is-in`](/commands/docs/polars_is-in.md) | Creates an is-in expression or checks to see if the elements are contained in the right series | plugin | +| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Creates mask where value is not null. | plugin | +| [`polars is-null`](/commands/docs/polars_is-null.md) | Creates mask where value is null. | plugin | +| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | +| [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | +| [`polars join-where`](/commands/docs/polars_join-where.md) | Joins a lazy frame with other lazy frame based on conditions. | plugin | +| [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | plugin | +| [`polars len`](/commands/docs/polars_len.md) | Return the number of rows in the context. This is similar to COUNT(*) in SQL. | plugin | +| [`polars list-contains`](/commands/docs/polars_list-contains.md) | Checks if an element is contained in a list. | plugin | +| [`polars lit`](/commands/docs/polars_lit.md) | Creates a literal expression. | plugin | +| [`polars lowercase`](/commands/docs/polars_lowercase.md) | Lowercase the strings in the column. | plugin | +| [`polars math`](/commands/docs/polars_math.md) | Collection of math functions to be applied on one or more column expressions | plugin | +| [`polars max`](/commands/docs/polars_max.md) | Creates a max expression or aggregates columns to their max value. | plugin | +| [`polars mean`](/commands/docs/polars_mean.md) | Creates a mean expression for an aggregation or aggregates columns to their mean value. | plugin | +| [`polars median`](/commands/docs/polars_median.md) | Median value from columns in a dataframe or creates expression for an aggregation | plugin | +| [`polars min`](/commands/docs/polars_min.md) | Creates a min expression or aggregates columns to their min value. | plugin | +| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Counts unique values. | plugin | +| [`polars not`](/commands/docs/polars_not.md) | Inverts boolean mask. | plugin | +| [`polars open`](/commands/docs/polars_open.md) | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. | plugin | +| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Completes a when expression. | plugin | +| [`polars over`](/commands/docs/polars_over.md) | Compute expressions over a window group defined by partition expressions. | plugin | +| [`polars pivot`](/commands/docs/polars_pivot.md) | Pivot a DataFrame from long to wide format. | plugin | +| [`polars profile`](/commands/docs/polars_profile.md) | Profile a lazy dataframe. | plugin | +| [`polars qcut`](/commands/docs/polars_qcut.md) | Bin continuous values into discrete categories based on their quantiles for a series. | plugin | +| [`polars quantile`](/commands/docs/polars_quantile.md) | Aggregates the columns to the selected quantile. | plugin | +| [`polars query`](/commands/docs/polars_query.md) | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | plugin | +| [`polars rename`](/commands/docs/polars_rename.md) | Rename a dataframe column. | plugin | +| [`polars replace`](/commands/docs/polars_replace.md) | Create an expression that replaces old values with new values | plugin | +| [`polars replace-time-zone`](/commands/docs/polars_replace-time-zone.md) | Replace the timezone information in a datetime column. | plugin | +| [`polars reverse`](/commands/docs/polars_reverse.md) | Reverses the LazyFrame | plugin | +| [`polars rolling`](/commands/docs/polars_rolling.md) | Rolling calculation for a series. | plugin | +| [`polars sample`](/commands/docs/polars_sample.md) | Create sample dataframe. | plugin | +| [`polars save`](/commands/docs/polars_save.md) | 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). | plugin | +| [`polars schema`](/commands/docs/polars_schema.md) | Show schema for a dataframe. | plugin | +| [`polars select`](/commands/docs/polars_select.md) | Selects columns from lazyframe. | plugin | +| [`polars selector`](/commands/docs/polars_selector.md) | Create column selectors for use in polars commands. | plugin | +| [`polars selector all`](/commands/docs/polars_selector_all.md) | Creates a selector that selects all columns. | plugin | +| [`polars selector alpha`](/commands/docs/polars_selector_alpha.md) | 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`. | plugin | +| [`polars selector alphanumeric`](/commands/docs/polars_selector_alphanumeric.md) | 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`. | plugin | +| [`polars selector array`](/commands/docs/polars_selector_array.md) | Select all array columns. Optionally filter by fixed width. | plugin | +| [`polars selector binary`](/commands/docs/polars_selector_binary.md) | Select all binary columns. | plugin | +| [`polars selector boolean`](/commands/docs/polars_selector_boolean.md) | Select all boolean columns. | plugin | +| [`polars selector by-dtype`](/commands/docs/polars_selector_by-dtype.md) | Creates a selector that selects columns by data type. | plugin | +| [`polars selector by-index`](/commands/docs/polars_selector_by-index.md) | Select columns by their index position. Supports negative indices (e.g., -1 for the last column). | plugin | +| [`polars selector by-name`](/commands/docs/polars_selector_by-name.md) | Creates a selector that selects columns by name. | plugin | +| [`polars selector categorical`](/commands/docs/polars_selector_categorical.md) | Select all categorical columns. | plugin | +| [`polars selector contains`](/commands/docs/polars_selector_contains.md) | Select columns whose names contain the given literal substring(s). | plugin | +| [`polars selector date`](/commands/docs/polars_selector_date.md) | Select all date columns. | plugin | +| [`polars selector datetime`](/commands/docs/polars_selector_datetime.md) | Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone. | plugin | +| [`polars selector decimal`](/commands/docs/polars_selector_decimal.md) | Select all decimal columns. | plugin | +| [`polars selector digit`](/commands/docs/polars_selector_digit.md) | Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9. | plugin | +| [`polars selector duration`](/commands/docs/polars_selector_duration.md) | Select all duration columns. Optionally filter by time unit (ns, us, ms). | plugin | +| [`polars selector empty`](/commands/docs/polars_selector_empty.md) | Create an empty selector that matches no columns. Useful as a base for selector composition. | plugin | +| [`polars selector ends-with`](/commands/docs/polars_selector_ends-with.md) | Select columns that end with the given substring(s). | plugin | +| [`polars selector enum`](/commands/docs/polars_selector_enum.md) | Select all enum columns. | plugin | +| [`polars selector exclude`](/commands/docs/polars_selector_exclude.md) | Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`. | plugin | +| [`polars selector first`](/commands/docs/polars_selector_first.md) | Creates a selector that selects the first column(s) by index. | plugin | +| [`polars selector float`](/commands/docs/polars_selector_float.md) | Select all float columns. | plugin | +| [`polars selector integer`](/commands/docs/polars_selector_integer.md) | Select all integer columns. | plugin | +| [`polars selector last`](/commands/docs/polars_selector_last.md) | Creates a selector that selects the last column(s) by index. | plugin | +| [`polars selector list`](/commands/docs/polars_selector_list.md) | Select all list columns. | plugin | +| [`polars selector matches`](/commands/docs/polars_selector_matches.md) | Select all columns that match the given regex pattern. | plugin | +| [`polars selector nested`](/commands/docs/polars_selector_nested.md) | Select all nested columns (list, array, or struct). | plugin | +| [`polars selector not`](/commands/docs/polars_selector_not.md) | Inverts selector. | plugin | +| [`polars selector numeric`](/commands/docs/polars_selector_numeric.md) | Select all numeric columns. | plugin | +| [`polars selector object`](/commands/docs/polars_selector_object.md) | Select all object columns. | plugin | +| [`polars selector signed-integer`](/commands/docs/polars_selector_signed-integer.md) | Select all signed integer columns. | plugin | +| [`polars selector starts-with`](/commands/docs/polars_selector_starts-with.md) | Select columns that start with the given substring(s). | plugin | +| [`polars selector string`](/commands/docs/polars_selector_string.md) | Select all string columns. Use `--include-categorical` to also select categorical columns. | plugin | +| [`polars selector struct`](/commands/docs/polars_selector_struct.md) | Select all struct columns. | plugin | +| [`polars selector temporal`](/commands/docs/polars_selector_temporal.md) | Select all temporal columns (date, datetime, duration, and time). | plugin | +| [`polars selector unsigned-integer`](/commands/docs/polars_selector_unsigned-integer.md) | Select all unsigned integer columns. | plugin | +| [`polars set`](/commands/docs/polars_set.md) | Sets value where given mask is true. | plugin | +| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Sets value in the given index. | plugin | +| [`polars shape`](/commands/docs/polars_shape.md) | Shows column and row size for a dataframe. | plugin | +| [`polars shift`](/commands/docs/polars_shift.md) | Shifts the values by a given period. | plugin | +| [`polars slice`](/commands/docs/polars_slice.md) | Creates new dataframe from a slice of rows. | plugin | +| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Sorts a lazy dataframe based on expression(s). | plugin | +| [`polars std`](/commands/docs/polars_std.md) | Creates a std expression for an aggregation of std value from columns in a dataframe. | plugin | +| [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | +| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored polars objects. | plugin | +| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | +| [`polars str-join`](/commands/docs/polars_str-join.md) | Concatenates strings within a column or dataframes | plugin | +| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | +| [`polars str-replace`](/commands/docs/polars_str-replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | +| [`polars str-replace-all`](/commands/docs/polars_str-replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | +| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | +| [`polars str-split`](/commands/docs/polars_str-split.md) | Split the string by a substring. The resulting dtype is list\\. | plugin | +| [`polars str-strip-chars`](/commands/docs/polars_str-strip-chars.md) | Strips specified characters from strings in a column | plugin | +| [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | +| [`polars struct-json-encode`](/commands/docs/polars_struct-json-encode.md) | Convert this struct to a string column with json values. | plugin | +| [`polars sum`](/commands/docs/polars_sum.md) | Creates a sum expression for an aggregation or aggregates columns to their sum value. | plugin | +| [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | +| [`polars take`](/commands/docs/polars_take.md) | Creates new dataframe using the given indices. | plugin | +| [`polars truncate`](/commands/docs/polars_truncate.md) | Divide the date/datetime range into buckets. | plugin | +| [`polars unique`](/commands/docs/polars_unique.md) | Returns unique values from a dataframe. | plugin | +| [`polars unnest`](/commands/docs/polars_unnest.md) | 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. | plugin | +| [`polars unpivot`](/commands/docs/polars_unpivot.md) | Unpivot a DataFrame from wide to long format. | plugin | +| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | +| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | +| [`polars var`](/commands/docs/polars_var.md) | Create a var expression for an aggregation. | plugin | +| [`polars when`](/commands/docs/polars_when.md) | Creates and modifies a when expression. | plugin | +| [`polars with-column`](/commands/docs/polars_with-column.md) | Adds a series to the dataframe. | plugin | \ No newline at end of file diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index 93ec6df049c..a867f144036 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.112.0 +version: 0.113.0 dataframe: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index ed5102eedda..af2bd473c79 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index ffc62590685..a95e2aef7d7 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.112.0 +version: 0.113.0 dataframe: | Returns true if all values are false. usage: | diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index d7280e402c7..a7533c313fc 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.112.0 +version: 0.113.0 dataframe: | Returns true if all values are true. usage: | diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index 2264c3dfdf5..4c198150e5b 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 5caeedf80d0..99030841357 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.112.0 +version: 0.113.0 dataframe: | Return index for max value in series. usage: | diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index 4cbf2c721e8..53e874469e7 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.112.0 +version: 0.113.0 dataframe: | Return index for min value in series. usage: | diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index 5a4ddc4f12e..1212ed53b34 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.112.0 +version: 0.113.0 dataframe: | Returns indexes for a sorted series. usage: | diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index c64ec33c8e0..d776cb74b54 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.112.0 +version: 0.113.0 dataframe: | Returns indexes where values are true. usage: | diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 9014c9184c5..8eae9ca5406 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.112.0 +version: 0.113.0 dataframe: | Returns indexes for unique values. usage: | diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index 5470aeaa242..b47d4d4604a 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.112.0 +version: 0.113.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index 6f7b38725d0..f07f2e48452 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.112.0 +version: 0.113.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 144a29dac1b..a50a165affc 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.112.0 +version: 0.113.0 dataframe: | Converts string to datetime. usage: | @@ -88,10 +88,10 @@ Converts string to datetime using the `--not-exact` flag even with excessive sym ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 5 months ago │ -│ 1 │ 5 months ago │ -│ 2 │ 5 months ago │ -│ 3 │ 5 months ago │ +│ 0 │ 6 months ago │ +│ 1 │ 6 months ago │ +│ 2 │ 6 months ago │ +│ 3 │ 6 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index fe2d87f1384..086218ee8c9 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index b8ce4fac1e3..5227e05bc99 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 48d34d07046..5ccd6bf8178 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Cast a column to a different dtype. usage: | diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index 7077aed5f34..e856fc4651b 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index bf8f9f6e1d4..452a5c35337 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index 49c2227df89..767ca6b51c7 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 0156489cc73..2650eb5df71 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.112.0 +version: 0.113.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index c0fc444d5ca..1268bc8bb3a 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Concatenate two or more dataframes. usage: | diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index d512c19e111..6a2fee108ac 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/polars_convert-time-zone.md b/commands/docs/polars_convert-time-zone.md index d78e84d69b9..d482958f830 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.112.0 +version: 0.113.0 dataframe: | Convert datetime to target timezone. usage: | diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index c4030099cca..80e303194fc 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.112.0 +version: 0.113.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 3947324a7e6..56e070fe438 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Returns the number of non-null values in the column. usage: | diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 8f816d1d9d3..68e2e631379 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Cumulative calculation for a column or series. usage: | diff --git a/commands/docs/polars_cut.md b/commands/docs/polars_cut.md index 134df8f322e..5aa587b8741 100644 --- a/commands/docs/polars_cut.md +++ b/commands/docs/polars_cut.md @@ -2,7 +2,7 @@ title: polars cut categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Bin continuous values into discrete categories for a series. usage: | diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index 344d56e3f0d..a89d11fcf7b 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index 519497c24a6..7e0708f7eff 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Converts a string column into a decimal column usage: | diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index eaf5648cc4f..616ddda684a 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.112.0 +version: 0.113.0 dataframe: | Drops duplicate values in dataframe. usage: | diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index 66fb9a1b07a..986dd541e1e 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.112.0 +version: 0.113.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index 569ff7f42ef..fd3e23a5b89 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index 7c3a916a514..650a6210b75 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/polars_entropy.md b/commands/docs/polars_entropy.md index 46074ee3e46..e9244f441b2 100644 --- a/commands/docs/polars_entropy.md +++ b/commands/docs/polars_entropy.md @@ -2,7 +2,7 @@ title: polars entropy categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities. usage: | diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index d53622ebbf7..f428983c9a6 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 834a5bb1aaa..8fe273e976a 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.112.0 +version: 0.113.0 dataframe: | Creates a not expression. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index f1aba0ec733..b92e868eae6 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.112.0 +version: 0.113.0 lazyframe: | Replaces NaN values with the given expression. usage: | diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index 20ee94ed87c..d69665fc7c6 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.112.0 +version: 0.113.0 lazyframe: | Replaces NULL values with the given expression. usage: | diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index 7842a7bde55..f6da8168c86 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.112.0 +version: 0.113.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 7dd5ce3e20f..7c3d723a838 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index d0ce9f535f8..e92f9b3ca01 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Show only the first number of rows or create a first expression usage: | diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index 06ab065d5d6..5c9b8c115a6 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | An alias for polars explode. usage: | diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index 5819299ce4f..6f17f2f6ba0 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.112.0 +version: 0.113.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index a77a7d8297b..22c92aec737 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.112.0 +version: 0.113.0 dataframe: | Gets hour from datetime. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 78efffb97e9..7ead6331be3 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.112.0 +version: 0.113.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index 3a19f5cb47c..3cd0154391a 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.112.0 +version: 0.113.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 35a247fde08..b62b1316050 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.112.0 +version: 0.113.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 0053c7007e1..8fdc06bcea4 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.112.0 +version: 0.113.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 95372749037..d67cee120a1 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.112.0 +version: 0.113.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index f43ad2a759c..b2607ad9dee 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.112.0 +version: 0.113.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 68f71f810b2..2c104633b7b 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.112.0 +version: 0.113.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 84a7c4720ec..ffcf3836e93 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.112.0 +version: 0.113.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index d7d4be1540a..80b3d1389bb 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates dataframe with the selected columns. usage: | diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index 00d192485fc..34cfda089cf 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.112.0 +version: 0.113.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/polars_horizontal.md b/commands/docs/polars_horizontal.md index c0ea1be74c0..891bc7f3ae1 100644 --- a/commands/docs/polars_horizontal.md +++ b/commands/docs/polars_horizontal.md @@ -2,7 +2,7 @@ title: polars horizontal categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Horizontal calculation across multiple columns. usage: | diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 42cbb4ebf40..6f1170ad46f 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Aggregates values into a list. usage: | diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index 718720646fe..97fa8ab0378 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Converts a string column into a integer column usage: | diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index 9154fd2fd88..06cd2a13ec1 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.112.0 +version: 0.113.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/polars_into-dtype.md b/commands/docs/polars_into-dtype.md index e2a1fcce3cb..f373308ae34 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.112.0 +version: 0.113.0 dataframe: | Convert a string to a specific datatype. usage: | diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 341d9b768a9..ca97e1eb841 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.112.0 +version: 0.113.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index 3a77b58d8fd..47ae2a52970 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.112.0 +version: 0.113.0 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | diff --git a/commands/docs/polars_into-repr.md b/commands/docs/polars_into-repr.md index 2dddcd684d1..531b2292e50 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.112.0 +version: 0.113.0 dataframe: | Display a dataframe in its repr format. usage: | diff --git a/commands/docs/polars_into-schema.md b/commands/docs/polars_into-schema.md index 9d84b90b7f0..e3cb175be65 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.112.0 +version: 0.113.0 dataframe: | Convert a value to a polars schema object usage: | diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index ee53118aee0..47fa5a488fb 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.112.0 +version: 0.113.0 dataframe: | Creates mask indicating duplicated values. usage: | diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index 7d887262b7b..419daaa9cc0 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.112.0 +version: 0.113.0 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index e8b105bc57d..5353d0b38f4 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.112.0 +version: 0.113.0 dataframe: | Creates mask where value is not null. usage: | diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index 9571698f965..d137ee98a06 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.112.0 +version: 0.113.0 dataframe: | Creates mask where value is null. usage: | diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index 34938c43c5b..a84b6243344 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.112.0 +version: 0.113.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/polars_join-where.md b/commands/docs/polars_join-where.md index a5b22686ed9..5f246d50ff8 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.112.0 +version: 0.113.0 lazyframe: | Joins a lazy frame with other lazy frame based on conditions. usage: | diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index 6e93f7e7d1d..7c5dfb8f14c 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 82c1c0e7bf4..6a27b6611c9 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/polars_len.md b/commands/docs/polars_len.md index e72c1554999..c61f1ce7d1f 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Return the number of rows in the context. This is similar to COUNT(*) in SQL. usage: | @@ -28,7 +28,7 @@ contributors: false | any | polars_expression | ## Examples -Count the number of rows in the the dataframe. +Count the number of rows in the dataframe. ```nu > [[a b]; [1 2] [3 4]] | polars into-df | polars select (polars len) | polars collect ╭───┬─────╮ diff --git a/commands/docs/polars_list-contains.md b/commands/docs/polars_list-contains.md index da502a3a56f..672ff23c438 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.112.0 +version: 0.113.0 dataframe: | Checks if an element is contained in a list. usage: | diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index fe843d55855..8d27a1de869 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index e5588243360..6bfd63e502b 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/polars_math.md b/commands/docs/polars_math.md index d08de9b81d8..875bed4c69c 100644 --- a/commands/docs/polars_math.md +++ b/commands/docs/polars_math.md @@ -2,7 +2,7 @@ title: polars math categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Collection of math functions to be applied on one or more column expressions usage: | diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index ca96ee6dc3a..4b4dcb0af99 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a max expression or aggregates columns to their max value. usage: | diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 45ee26e428f..caa1006faae 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index 00e583c8ff9..c2781d71f6f 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 8eeb93ce372..e92fa045ddc 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a min expression or aggregates columns to their min value. usage: | diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index dd3c79dddf1..47d82467246 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.112.0 +version: 0.113.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 186cf9b7a15..c6c02ce72ee 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 11cdd8a4a50..d94cf81a394 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.112.0 +version: 0.113.0 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: | diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index d9f65e56f31..f65131b87b6 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_over.md b/commands/docs/polars_over.md index 069bf2117c3..df5c2734916 100644 --- a/commands/docs/polars_over.md +++ b/commands/docs/polars_over.md @@ -2,7 +2,7 @@ title: polars over categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Compute expressions over a window group defined by partition expressions. usage: | diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 48f5211a9be..439c452b363 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Pivot a DataFrame from long to wide format. usage: | @@ -62,6 +62,27 @@ Given a set of test scores, reshape so we have one row per student, with differe ``` +Given a set of test scores, reshape so we have one row per student, with different subjects as columns, and their `test_1` scores as values, without specifying --on-cols +```nu +> { + "name": ["Cady", "Cady", "Karen", "Karen"], + "subject": ["maths", "physics", "maths", "physics"], + "test_1": [98, 99, 61, 58], + "test_2": [100, 100, 60, 60], + } | + polars into-df --as-columns | + polars pivot --on subject --index name --values test_1 | + polars sort-by name maths physics | + polars collect +╭───┬───────┬───────┬─────────╮ +│ # │ name │ maths │ physics │ +├───┼───────┼───────┼─────────┤ +│ 0 │ Cady │ 98 │ 99 │ +│ 1 │ Karen │ 61 │ 58 │ +╰───┴───────┴───────┴─────────╯ + +``` + Given a set of test scores, reshape so we have one row per student, utilize a selector for the values come to include all test scores ```nu > { diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index ff7cc3b4704..ace61916db1 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Profile a lazy dataframe. usage: | diff --git a/commands/docs/polars_qcut.md b/commands/docs/polars_qcut.md index e5a89f8861c..0698608e69c 100644 --- a/commands/docs/polars_qcut.md +++ b/commands/docs/polars_qcut.md @@ -2,7 +2,7 @@ title: polars qcut categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Bin continuous values into discrete categories based on their quantiles for a series. usage: | diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index 767379ce479..9c42c781cfb 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index 826914f9d93..0ee268942ed 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index 8e05997b630..5812cc40abf 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.112.0 +version: 0.113.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/polars_replace-time-zone.md b/commands/docs/polars_replace-time-zone.md index f85bb1eb564..7bf0a595bae 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.112.0 +version: 0.113.0 dataframe: | Replace the timezone information in a datetime column. usage: | @@ -65,10 +65,10 @@ Apply timezone with ambiguous datetime ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 5 months ago │ +│ 0 │ 6 months ago │ │ 1 │ │ -│ 2 │ 5 months ago │ -│ 3 │ 5 months ago │ +│ 2 │ 6 months ago │ +│ 3 │ 6 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index f14a112838e..f0348502c89 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Create an expression that replaces old values with new values usage: | diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 340b7d18c4e..8ec4b6a7fbd 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 3214cd53cc1..7daf857d194 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index c202bfdef39..10c98035212 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index 0b077d68e95..8a9bc3fd17d 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.112.0 +version: 0.113.0 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: | diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 213f13191df..6f8c8a3d969 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 97d681e93e0..486af93c49f 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.112.0 +version: 0.113.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_selector.md b/commands/docs/polars_selector.md index afae66fb1a2..4376401ba35 100644 --- a/commands/docs/polars_selector.md +++ b/commands/docs/polars_selector.md @@ -2,7 +2,7 @@ title: polars selector categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Create column selectors for use in polars commands. usage: | diff --git a/commands/docs/polars_selector_all.md b/commands/docs/polars_selector_all.md index 269819b2521..55054112635 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.112.0 +version: 0.113.0 expression: | Creates a selector that selects all columns. usage: | diff --git a/commands/docs/polars_selector_alpha.md b/commands/docs/polars_selector_alpha.md new file mode 100644 index 00000000000..061df2dbca1 --- /dev/null +++ b/commands/docs/polars_selector_alpha.md @@ -0,0 +1,158 @@ +--- +title: polars selector alpha +categories: | + expression +version: 0.113.0 +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: | + 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`. +editLink: false +contributors: false +--- + + +# `polars selector alpha` for [expression](/commands/categories/expression.md) + +
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`.
+ +## Signature + +```> polars selector alpha {flags} ``` + +## Flags + + - `--ascii-only, -a`: Indicate whether to consider only ASCII alphabetic characters, or the full Unicode range of valid letters (accented, idiographic, etc). + - `--ignore-spaces, -s`: Indicate whether to ignore the presence of spaces in column names; if so, only the other (non-space) characters are considered. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select columns with alphabetic names; note that accented characters and kanji are recognised as alphabetic here. +```nu +> + { + "no1": [100, 200, 300], + "café": ["espresso", "latte", "mocha"], + "t or f": [true, false, null], + "hmm": ["aaa", "bbb", "ccc"], + "都市": ["東京", "大阪", "京都"], + } | + polars into-df --as-columns | + polars select (polars selector alpha) | + polars sort-by café hmm 都市 | + polars collect + +╭───┬──────────┬─────┬──────╮ +│ # │ café │ hmm │ 都市 │ +├───┼──────────┼─────┼──────┤ +│ 0 │ espresso │ aaa │ 東京 │ +│ 1 │ latte │ bbb │ 大阪 │ +│ 2 │ mocha │ ccc │ 京都 │ +╰───┴──────────┴─────┴──────╯ + +``` + +Constrain the definition of "alphabetic" to ASCII characters only. +```nu +> + { + "no1": [100, 200, 300], + "café": ["espresso", "latte", "mocha"], + "t or f": [true, false, null], + "hmm": ["aaa", "bbb", "ccc"], + "都市": ["東京", "大阪", "京都"], + } | + polars into-df --as-columns | + polars select (polars selector alpha --ascii-only) | + polars collect + +╭───┬─────╮ +│ # │ hmm │ +├───┼─────┤ +│ 0 │ aaa │ +│ 1 │ bbb │ +│ 2 │ ccc │ +╰───┴─────╯ + +``` + +Constrain the definition of "alphabetic" to ASCII characters only and ignore whitespace. +```nu +> + { + "no1": [100, 200, 300], + "café": ["espresso", "latte", "mocha"], + "t or f": [true, false, null], + "hmm": ["aaa", "bbb", "ccc"], + "都市": ["東京", "大阪", "京都"], + } | + polars into-df --as-columns | + polars select (polars selector alpha --ascii-only --ignore-spaces) | + polars sort-by "t or f" hmm | + polars collect + +╭───┬────────┬─────╮ +│ # │ t or f │ hmm │ +├───┼────────┼─────┤ +│ 0 │ │ ccc │ +│ 1 │ false │ bbb │ +│ 2 │ true │ aaa │ +╰───┴────────┴─────╯ + +``` + +Select all columns *except* for those with alphabetic names. +```nu +> + { + "no1": [100, 200, 300], + "café": ["espresso", "latte", "mocha"], + "t or f": [true, false, null], + "hmm": ["aaa", "bbb", "ccc"], + "都市": ["東京", "大阪", "京都"], + } | + polars into-df --as-columns | + polars select (polars selector alpha | polars selector not) | + polars sort-by no1 "t or f"| + polars collect + +╭───┬─────┬────────╮ +│ # │ no1 │ t or f │ +├───┼─────┼────────┤ +│ 0 │ 100 │ true │ +│ 1 │ 200 │ false │ +│ 2 │ 300 │ │ +╰───┴─────┴────────╯ + +``` + +Select all columns *except* for those with alphabetic names and do not have spaces. +```nu +> + { + "no1": [100, 200, 300], + "café": ["espresso", "latte", "mocha"], + "t or f": [true, false, null], + "hmm": ["aaa", "bbb", "ccc"], + "都市": ["東京", "大阪", "京都"], + } | + polars into-df --as-columns | + polars select (polars selector alpha --ignore-spaces | polars selector not) | + polars sort-by no1 | + polars collect + +╭───┬─────╮ +│ # │ no1 │ +├───┼─────┤ +│ 0 │ 100 │ +│ 1 │ 200 │ +│ 2 │ 300 │ +╰───┴─────╯ + +``` diff --git a/commands/docs/polars_selector_alphanumeric.md b/commands/docs/polars_selector_alphanumeric.md new file mode 100644 index 00000000000..fc9549c4e18 --- /dev/null +++ b/commands/docs/polars_selector_alphanumeric.md @@ -0,0 +1,129 @@ +--- +title: polars selector alphanumeric +categories: | + expression +version: 0.113.0 +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: | + 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`. +editLink: false +contributors: false +--- + + +# `polars selector alphanumeric` for [expression](/commands/categories/expression.md) + +
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`.
+ +## Signature + +```> polars selector alphanumeric {flags} ``` + +## Flags + + - `--ascii-only, -a`: Indicate whether to consider only ASCII alphanumeric characters, or the full Unicode range of valid letters (accented, idiographic, etc). + - `--ignore-spaces, -s`: Indicate whether to ignore the presence of spaces in column names; if so, only the other (non-space) characters are considered. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select columns with alphanumeric names. +```nu +> + { + "1st_col": [100, 200, 300], + "flagged": [true, false, true], + "00prefix": ["01:aa", "02:bb", "03:cc"], + "last col": ["x", "y", "z"], + } | + polars into-df --as-columns | + polars select (polars selector alphanumeric) | + polars sort-by 00prefix flagged | + polars collect + +╭───┬─────────┬──────────╮ +│ # │ flagged │ 00prefix │ +├───┼─────────┼──────────┤ +│ 0 │ true │ 01:aa │ +│ 1 │ false │ 02:bb │ +│ 2 │ true │ 03:cc │ +╰───┴─────────┴──────────╯ + +``` + +Select columns with alphanumeric names ignoring spaces. +```nu +> + { + "1st_col": [100, 200, 300], + "flagged": [true, false, true], + "00prefix": ["01:aa", "02:bb", "03:cc"], + "last col": ["x", "y", "z"], + } | + polars into-df --as-columns | + polars select (polars selector alphanumeric --ignore-spaces) | + polars sort-by 00prefix 'last col' flagged | + polars collect + +╭───┬─────────┬──────────┬──────────╮ +│ # │ flagged │ 00prefix │ last col │ +├───┼─────────┼──────────┼──────────┤ +│ 0 │ true │ 01:aa │ x │ +│ 1 │ false │ 02:bb │ y │ +│ 2 │ true │ 03:cc │ z │ +╰───┴─────────┴──────────┴──────────╯ + +``` + +Select all columns *except* for those with alphanumeric names. +```nu +> + { + "1st_col": [100, 200, 300], + "flagged": [true, false, true], + "00prefix": ["01:aa", "02:bb", "03:cc"], + "last col": ["x", "y", "z"], + } | + polars into-df --as-columns | + polars select (polars selector alphanumeric | polars selector not) | + polars sort-by '1st_col' 'last col' | + polars collect + +╭───┬─────────┬──────────╮ +│ # │ 1st_col │ last col │ +├───┼─────────┼──────────┤ +│ 0 │ 100 │ x │ +│ 1 │ 200 │ y │ +│ 2 │ 300 │ z │ +╰───┴─────────┴──────────╯ + +``` + +Select all columns *except* for those with alphanumeric names, ignoring spaces. +```nu +> + { + "1st_col": [100, 200, 300], + "flagged": [true, false, true], + "00prefix": ["01:aa", "02:bb", "03:cc"], + "last col": ["x", "y", "z"], + } | + polars into-df --as-columns | + polars select (polars selector alphanumeric --ignore-spaces | polars selector not) | + polars collect + +╭───┬─────────╮ +│ # │ 1st_col │ +├───┼─────────┤ +│ 0 │ 100 │ +│ 1 │ 200 │ +│ 2 │ 300 │ +╰───┴─────────╯ + +``` diff --git a/commands/docs/polars_selector_array.md b/commands/docs/polars_selector_array.md new file mode 100644 index 00000000000..220bfa2d98d --- /dev/null +++ b/commands/docs/polars_selector_array.md @@ -0,0 +1,45 @@ +--- +title: polars selector array +categories: | + expression +version: 0.113.0 +expression: | + Select all array columns. Optionally filter by fixed width. +usage: | + Select all array columns. Optionally filter by fixed width. +editLink: false +contributors: false +--- + + +# `polars selector array` for [expression](/commands/categories/expression.md) + +
Select all array columns. Optionally filter by fixed width.
+ +## Signature + +```> polars selector array {flags} ``` + +## Flags + + - `--width {int}`: Only select arrays with this fixed width. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for all array columns +```nu +> polars selector array + +``` + +Create a selector for fixed-width arrays of size 3 +```nu +> polars selector array --width 3 + +``` diff --git a/commands/docs/polars_selector_binary.md b/commands/docs/polars_selector_binary.md new file mode 100644 index 00000000000..1f44b5eafcb --- /dev/null +++ b/commands/docs/polars_selector_binary.md @@ -0,0 +1,35 @@ +--- +title: polars selector binary +categories: | + expression +version: 0.113.0 +expression: | + Select all binary columns. +usage: | + Select all binary columns. +editLink: false +contributors: false +--- + + +# `polars selector binary` for [expression](/commands/categories/expression.md) + +
Select all binary columns.
+ +## Signature + +```> polars selector binary {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for binary columns +```nu +> polars selector binary + +``` diff --git a/commands/docs/polars_selector_boolean.md b/commands/docs/polars_selector_boolean.md new file mode 100644 index 00000000000..7c6505e78d7 --- /dev/null +++ b/commands/docs/polars_selector_boolean.md @@ -0,0 +1,48 @@ +--- +title: polars selector boolean +categories: | + expression +version: 0.113.0 +expression: | + Select all boolean columns. +usage: | + Select all boolean columns. +editLink: false +contributors: false +--- + + +# `polars selector boolean` for [expression](/commands/categories/expression.md) + +
Select all boolean columns.
+ +## Signature + +```> polars selector boolean {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all boolean columns +```nu +> { + "name": ["Alice", "Bob"], + "active": [true, false], + "score": [1, 2], +} | +polars into-df --as-columns | +polars select (polars selector boolean) | +polars collect +╭───┬────────╮ +│ # │ active │ +├───┼────────┤ +│ 0 │ true │ +│ 1 │ false │ +╰───┴────────╯ + +``` diff --git a/commands/docs/polars_selector_by-dtype.md b/commands/docs/polars_selector_by-dtype.md index cd7825599c0..8c81783de73 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.112.0 +version: 0.113.0 expression: | Creates a selector that selects columns by data type. usage: | diff --git a/commands/docs/polars_selector_by-index.md b/commands/docs/polars_selector_by-index.md new file mode 100644 index 00000000000..61ff0f8e7eb --- /dev/null +++ b/commands/docs/polars_selector_by-index.md @@ -0,0 +1,67 @@ +--- +title: polars selector by-index +categories: | + expression +version: 0.113.0 +expression: | + Select columns by their index position. Supports negative indices (e.g., -1 for the last column). +usage: | + Select columns by their index position. Supports negative indices (e.g., -1 for the last column). +editLink: false +contributors: false +--- + + +# `polars selector by-index` for [expression](/commands/categories/expression.md) + +
Select columns by their index position. Supports negative indices (e.g., -1 for the last column).
+ +## Signature + +```> polars selector by-index {flags} ...rest``` + +## Flags + + - `--not-strict`: Allow out-of-range indices without error. + +## Parameters + + - `...rest`: Column index positions to select (negative indices count from the end). + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select first and third columns by index +```nu +> [[a b c]; [1 2 3] [4 5 6]] + | polars into-df + | polars select (polars selector by-index 0 2) + | polars collect +╭───┬───┬───╮ +│ # │ a │ c │ +├───┼───┼───┤ +│ 0 │ 1 │ 3 │ +│ 1 │ 4 │ 6 │ +╰───┴───┴───╯ + +``` + +Select the last column using a negative index +```nu +> [[a b c]; [1 2 3] [4 5 6]] + | polars into-df + | polars select (polars selector by-index -1) + | polars collect +╭───┬───╮ +│ # │ c │ +├───┼───┤ +│ 0 │ 3 │ +│ 1 │ 6 │ +╰───┴───╯ + +``` diff --git a/commands/docs/polars_selector_by-name.md b/commands/docs/polars_selector_by-name.md index 8900763d5b7..f17b461fd3d 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.112.0 +version: 0.113.0 expression: | Creates a selector that selects columns by name. usage: | diff --git a/commands/docs/polars_selector_categorical.md b/commands/docs/polars_selector_categorical.md new file mode 100644 index 00000000000..f3c20e0d5d8 --- /dev/null +++ b/commands/docs/polars_selector_categorical.md @@ -0,0 +1,35 @@ +--- +title: polars selector categorical +categories: | + expression +version: 0.113.0 +expression: | + Select all categorical columns. +usage: | + Select all categorical columns. +editLink: false +contributors: false +--- + + +# `polars selector categorical` for [expression](/commands/categories/expression.md) + +
Select all categorical columns.
+ +## Signature + +```> polars selector categorical {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for categorical columns +```nu +> polars selector categorical + +``` diff --git a/commands/docs/polars_selector_contains.md b/commands/docs/polars_selector_contains.md new file mode 100644 index 00000000000..2eb71d0d14c --- /dev/null +++ b/commands/docs/polars_selector_contains.md @@ -0,0 +1,73 @@ +--- +title: polars selector contains +categories: | + expression +version: 0.113.0 +expression: | + Select columns whose names contain the given literal substring(s). +usage: | + Select columns whose names contain the given literal substring(s). +editLink: false +contributors: false +--- + + +# `polars selector contains` for [expression](/commands/categories/expression.md) + +
Select columns whose names contain the given literal substring(s).
+ +## Signature + +```> polars selector contains {flags} ...rest``` + +## Parameters + + - `...rest`: Literal substring(s) to search for in column names. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select columns whose names contain 'foo' +```nu +> { + "foo_bar": [1.0, 2.0], + "foo_baz": [3.0, 4.0], + "qux": [5, 6], +} | +polars into-df --as-columns | +polars select (polars selector contains foo) | +polars sort-by foo_bar foo_baz | +polars collect +╭───┬─────────┬─────────╮ +│ # │ foo_bar │ foo_baz │ +├───┼─────────┼─────────┤ +│ 0 │ 1.00 │ 3.00 │ +│ 1 │ 2.00 │ 4.00 │ +╰───┴─────────┴─────────╯ + +``` + +Select columns whose names contain 'foo' or 'bar' +```nu +> { + "foo_x": [1, 2], + "bar_x": [3, 4], + "baz": [5, 6], +} | +polars into-df --as-columns | +polars select (polars selector contains foo bar) | +polars sort-by foo_x bar_x | +polars collect +╭───┬───────┬───────╮ +│ # │ foo_x │ bar_x │ +├───┼───────┼───────┤ +│ 0 │ 1 │ 3 │ +│ 1 │ 2 │ 4 │ +╰───┴───────┴───────╯ + +``` diff --git a/commands/docs/polars_selector_date.md b/commands/docs/polars_selector_date.md new file mode 100644 index 00000000000..fd5a9df899c --- /dev/null +++ b/commands/docs/polars_selector_date.md @@ -0,0 +1,35 @@ +--- +title: polars selector date +categories: | + expression +version: 0.113.0 +expression: | + Select all date columns. +usage: | + Select all date columns. +editLink: false +contributors: false +--- + + +# `polars selector date` for [expression](/commands/categories/expression.md) + +
Select all date columns.
+ +## Signature + +```> polars selector date {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for date columns +```nu +> polars selector date + +``` diff --git a/commands/docs/polars_selector_datetime.md b/commands/docs/polars_selector_datetime.md new file mode 100644 index 00000000000..780974661dd --- /dev/null +++ b/commands/docs/polars_selector_datetime.md @@ -0,0 +1,52 @@ +--- +title: polars selector datetime +categories: | + expression +version: 0.113.0 +expression: | + Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone. +usage: | + Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone. +editLink: false +contributors: false +--- + + +# `polars selector datetime` for [expression](/commands/categories/expression.md) + +
Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone.
+ +## Signature + +```> polars selector datetime {flags} ``` + +## Flags + + - `--time-unit {list}`: Filter by time unit(s): ns (nanoseconds), us (microseconds), ms (milliseconds). + - `--time-zone {list}`: Filter by timezone(s). Use "*" to match any set timezone, or "unset" to match columns without a timezone. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for all datetime columns +```nu +> polars selector datetime + +``` + +Create a selector for nanosecond or microsecond datetime columns +```nu +> polars selector datetime --time-unit [ns us] + +``` + +Create a selector for nanosecond datetime columns with UTC timezone +```nu +> polars selector datetime --time-unit [ns] --time-zone [UTC] + +``` diff --git a/commands/docs/polars_selector_decimal.md b/commands/docs/polars_selector_decimal.md new file mode 100644 index 00000000000..6db47628230 --- /dev/null +++ b/commands/docs/polars_selector_decimal.md @@ -0,0 +1,35 @@ +--- +title: polars selector decimal +categories: | + expression +version: 0.113.0 +expression: | + Select all decimal columns. +usage: | + Select all decimal columns. +editLink: false +contributors: false +--- + + +# `polars selector decimal` for [expression](/commands/categories/expression.md) + +
Select all decimal columns.
+ +## Signature + +```> polars selector decimal {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for decimal columns +```nu +> polars selector decimal + +``` diff --git a/commands/docs/polars_selector_digit.md b/commands/docs/polars_selector_digit.md new file mode 100644 index 00000000000..2d8ecec10fc --- /dev/null +++ b/commands/docs/polars_selector_digit.md @@ -0,0 +1,71 @@ +--- +title: polars selector digit +categories: | + expression +version: 0.113.0 +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: | + Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9. +editLink: false +contributors: false +--- + + +# `polars selector digit` for [expression](/commands/categories/expression.md) + +
Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9.
+ +## Signature + +```> polars selector digit {flags} ``` + +## Flags + + - `--ascii-only, -a`: Restrict to ASCII digit characters (0-9) only. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select columns whose names consist entirely of digits +```nu +> { + "123": [1, 2], + "abc": [3, 4], + "4": [5, 6], +} | +polars into-df --as-columns | +polars select (polars selector digit) | +polars sort-by "123" "4" | +polars collect +╭───┬─────┬───╮ +│ # │ 123 │ 4 │ +├───┼─────┼───┤ +│ 0 │ 1 │ 5 │ +│ 1 │ 2 │ 6 │ +╰───┴─────┴───╯ + +``` + +Select digit-named columns using ASCII digits only +```nu +> { + "123": [1, 2], + "abc": [3, 4], +} | +polars into-df --as-columns | +polars select (polars selector digit --ascii-only) | +polars collect +╭───┬─────╮ +│ # │ 123 │ +├───┼─────┤ +│ 0 │ 1 │ +│ 1 │ 2 │ +╰───┴─────╯ + +``` diff --git a/commands/docs/polars_selector_duration.md b/commands/docs/polars_selector_duration.md new file mode 100644 index 00000000000..9650f0e16a7 --- /dev/null +++ b/commands/docs/polars_selector_duration.md @@ -0,0 +1,45 @@ +--- +title: polars selector duration +categories: | + expression +version: 0.113.0 +expression: | + Select all duration columns. Optionally filter by time unit (ns, us, ms). +usage: | + Select all duration columns. Optionally filter by time unit (ns, us, ms). +editLink: false +contributors: false +--- + + +# `polars selector duration` for [expression](/commands/categories/expression.md) + +
Select all duration columns. Optionally filter by time unit (ns, us, ms).
+ +## Signature + +```> polars selector duration {flags} ``` + +## Flags + + - `--time-unit {list}`: Filter by time unit(s): ns (nanoseconds), us (microseconds), ms (milliseconds). + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for all duration columns +```nu +> polars selector duration + +``` + +Create a selector for nanosecond or microsecond duration columns +```nu +> polars selector duration --time-unit [ns us] + +``` diff --git a/commands/docs/polars_selector_empty.md b/commands/docs/polars_selector_empty.md new file mode 100644 index 00000000000..dd639dc4ec3 --- /dev/null +++ b/commands/docs/polars_selector_empty.md @@ -0,0 +1,35 @@ +--- +title: polars selector empty +categories: | + expression +version: 0.113.0 +expression: | + Create an empty selector that matches no columns. Useful as a base for selector composition. +usage: | + Create an empty selector that matches no columns. Useful as a base for selector composition. +editLink: false +contributors: false +--- + + +# `polars selector empty` for [expression](/commands/categories/expression.md) + +
Create an empty selector that matches no columns. Useful as a base for selector composition.
+ +## Signature + +```> polars selector empty {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create an empty selector that matches no columns +```nu +> polars selector empty + +``` diff --git a/commands/docs/polars_selector_ends-with.md b/commands/docs/polars_selector_ends-with.md index 4c4cbb1996e..ba0464163e4 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.112.0 +version: 0.113.0 expression: | Select columns that end with the given substring(s). usage: | diff --git a/commands/docs/polars_selector_enum.md b/commands/docs/polars_selector_enum.md new file mode 100644 index 00000000000..48d32d6421c --- /dev/null +++ b/commands/docs/polars_selector_enum.md @@ -0,0 +1,35 @@ +--- +title: polars selector enum +categories: | + expression +version: 0.113.0 +expression: | + Select all enum columns. +usage: | + Select all enum columns. +editLink: false +contributors: false +--- + + +# `polars selector enum` for [expression](/commands/categories/expression.md) + +
Select all enum columns.
+ +## Signature + +```> polars selector enum {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for enum columns +```nu +> polars selector enum + +``` diff --git a/commands/docs/polars_selector_exclude.md b/commands/docs/polars_selector_exclude.md new file mode 100644 index 00000000000..67801114c0d --- /dev/null +++ b/commands/docs/polars_selector_exclude.md @@ -0,0 +1,61 @@ +--- +title: polars selector exclude +categories: | + expression +version: 0.113.0 +expression: | + Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`. +usage: | + Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`. +editLink: false +contributors: false +--- + + +# `polars selector exclude` for [expression](/commands/categories/expression.md) + +
Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`.
+ +## Signature + +```> polars selector exclude {flags} ...rest``` + +## Parameters + + - `...rest`: Column name(s) to exclude from the selection. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all columns except 'a' and 'b' +```nu +> { + "a": [1.0, 2.0], + "b": [3.0, 4.0], + "c": [5, 6], +} | +polars into-df --as-columns | +polars select (polars selector exclude a b) | +polars collect +╭───┬───╮ +│ # │ c │ +├───┼───┤ +│ 0 │ 5 │ +│ 1 │ 6 │ +╰───┴───╯ + +``` + +Select all columns except 'c' +```nu +> [[a b c]; [1 2 3] [4 5 6]] + | polars into-df + | polars select (polars selector exclude c) + | polars collect + +``` diff --git a/commands/docs/polars_selector_first.md b/commands/docs/polars_selector_first.md index 369503bf8f3..e0c5df1b8be 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.112.0 +version: 0.113.0 expression: | Creates a selector that selects the first column(s) by index. usage: | diff --git a/commands/docs/polars_selector_float.md b/commands/docs/polars_selector_float.md index eaed502c2dd..8a03e300b0b 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.112.0 +version: 0.113.0 expression: | Select all float columns. usage: | diff --git a/commands/docs/polars_selector_integer.md b/commands/docs/polars_selector_integer.md index 875506d2216..87f0ebeeb02 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.112.0 +version: 0.113.0 expression: | Select all integer columns. usage: | diff --git a/commands/docs/polars_selector_last.md b/commands/docs/polars_selector_last.md index 9ba7fb1f734..2733f53c542 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.112.0 +version: 0.113.0 expression: | Creates a selector that selects the last column(s) by index. usage: | diff --git a/commands/docs/polars_selector_list.md b/commands/docs/polars_selector_list.md new file mode 100644 index 00000000000..04bf719744b --- /dev/null +++ b/commands/docs/polars_selector_list.md @@ -0,0 +1,35 @@ +--- +title: polars selector list +categories: | + expression +version: 0.113.0 +expression: | + Select all list columns. +usage: | + Select all list columns. +editLink: false +contributors: false +--- + + +# `polars selector list` for [expression](/commands/categories/expression.md) + +
Select all list columns.
+ +## Signature + +```> polars selector list {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for list columns +```nu +> polars selector list + +``` diff --git a/commands/docs/polars_selector_matches.md b/commands/docs/polars_selector_matches.md index e9120b229e7..677eaea48d0 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.112.0 +version: 0.113.0 expression: | Select all columns that match the given regex pattern. usage: | diff --git a/commands/docs/polars_selector_nested.md b/commands/docs/polars_selector_nested.md new file mode 100644 index 00000000000..6181969448b --- /dev/null +++ b/commands/docs/polars_selector_nested.md @@ -0,0 +1,35 @@ +--- +title: polars selector nested +categories: | + expression +version: 0.113.0 +expression: | + Select all nested columns (list, array, or struct). +usage: | + Select all nested columns (list, array, or struct). +editLink: false +contributors: false +--- + + +# `polars selector nested` for [expression](/commands/categories/expression.md) + +
Select all nested columns (list, array, or struct).
+ +## Signature + +```> polars selector nested {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for nested columns (list, array, or struct) +```nu +> polars selector nested + +``` diff --git a/commands/docs/polars_selector_not.md b/commands/docs/polars_selector_not.md index 031fc669f9c..f73bf270982 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.112.0 +version: 0.113.0 expression: | Inverts selector. usage: | diff --git a/commands/docs/polars_selector_numeric.md b/commands/docs/polars_selector_numeric.md index 92ecd56ddab..f81ccc52c52 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.112.0 +version: 0.113.0 expression: | Select all numeric columns. usage: | diff --git a/commands/docs/polars_selector_object.md b/commands/docs/polars_selector_object.md new file mode 100644 index 00000000000..5bd6d9a5ec7 --- /dev/null +++ b/commands/docs/polars_selector_object.md @@ -0,0 +1,35 @@ +--- +title: polars selector object +categories: | + expression +version: 0.113.0 +expression: | + Select all object columns. +usage: | + Select all object columns. +editLink: false +contributors: false +--- + + +# `polars selector object` for [expression](/commands/categories/expression.md) + +
Select all object columns.
+ +## Signature + +```> polars selector object {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for object columns +```nu +> polars selector object + +``` diff --git a/commands/docs/polars_selector_signed-integer.md b/commands/docs/polars_selector_signed-integer.md index 6d3f0c99ee8..a9b29c5610a 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.112.0 +version: 0.113.0 expression: | Select all signed integer columns. usage: | diff --git a/commands/docs/polars_selector_starts-with.md b/commands/docs/polars_selector_starts-with.md index 6ce6b5120a3..b527b6b881e 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.112.0 +version: 0.113.0 expression: | Select columns that start with the given substring(s). usage: | diff --git a/commands/docs/polars_selector_string.md b/commands/docs/polars_selector_string.md new file mode 100644 index 00000000000..aeb3b39c4c5 --- /dev/null +++ b/commands/docs/polars_selector_string.md @@ -0,0 +1,58 @@ +--- +title: polars selector string +categories: | + expression +version: 0.113.0 +expression: | + Select all string columns. Use `--include-categorical` to also select categorical columns. +usage: | + Select all string columns. Use `--include-categorical` to also select categorical columns. +editLink: false +contributors: false +--- + + +# `polars selector string` for [expression](/commands/categories/expression.md) + +
Select all string columns. Use `--include-categorical` to also select categorical columns.
+ +## Signature + +```> polars selector string {flags} ``` + +## Flags + + - `--include-categorical, -c`: Also include categorical columns in the selection. + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all string columns +```nu +> { + "name": ["Alice", "Bob"], + "age": [30, 25], + "active": [true, false], +} | +polars into-df --as-columns | +polars select (polars selector string) | +polars collect +╭───┬───────╮ +│ # │ name │ +├───┼───────┤ +│ 0 │ Alice │ +│ 1 │ Bob │ +╰───┴───────╯ + +``` + +Create a selector for string and categorical columns +```nu +> polars selector string --include-categorical + +``` diff --git a/commands/docs/polars_selector_struct.md b/commands/docs/polars_selector_struct.md new file mode 100644 index 00000000000..adddf77e305 --- /dev/null +++ b/commands/docs/polars_selector_struct.md @@ -0,0 +1,35 @@ +--- +title: polars selector struct +categories: | + expression +version: 0.113.0 +expression: | + Select all struct columns. +usage: | + Select all struct columns. +editLink: false +contributors: false +--- + + +# `polars selector struct` for [expression](/commands/categories/expression.md) + +
Select all struct columns.
+ +## Signature + +```> polars selector struct {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for struct columns +```nu +> polars selector struct + +``` diff --git a/commands/docs/polars_selector_temporal.md b/commands/docs/polars_selector_temporal.md new file mode 100644 index 00000000000..b028b158f22 --- /dev/null +++ b/commands/docs/polars_selector_temporal.md @@ -0,0 +1,35 @@ +--- +title: polars selector temporal +categories: | + expression +version: 0.113.0 +expression: | + Select all temporal columns (date, datetime, duration, and time). +usage: | + Select all temporal columns (date, datetime, duration, and time). +editLink: false +contributors: false +--- + + +# `polars selector temporal` for [expression](/commands/categories/expression.md) + +
Select all temporal columns (date, datetime, duration, and time).
+ +## Signature + +```> polars selector temporal {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Create a selector for temporal columns (date, datetime, duration, time) +```nu +> polars selector temporal + +``` diff --git a/commands/docs/polars_selector_unsigned-integer.md b/commands/docs/polars_selector_unsigned-integer.md index b218a77a7be..1f4e0d6808a 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.112.0 +version: 0.113.0 expression: | Select all unsigned integer columns. usage: | diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index cc18cccebef..eee961d15bd 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.112.0 +version: 0.113.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 90858865630..5f40b9a82a5 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Sets value where given mask is true. usage: | diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index a366475a6a7..5672ede8c8b 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Shows column and row size for a dataframe. usage: | diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index ef11861148c..4c37f7ace20 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.112.0 +version: 0.113.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index 69fe64f0970..8b2d29920c9 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates new dataframe from a slice of rows. usage: | diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index 2bed787f697..8a30272a9c6 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.112.0 +version: 0.113.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index 4b6e3ed8e49..2be9d18208c 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index e7ac2524328..c384dfb3d70 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.112.0 +version: 0.113.0 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 429d0f3a70e..99aac236a71 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.112.0 +version: 0.113.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index c2dc8a6df24..433574c0aff 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.112.0 +version: 0.113.0 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_str-join.md b/commands/docs/polars_str-join.md index 5d196141f14..a4353f0cc83 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.112.0 +version: 0.113.0 dataframe: | Concatenates strings within a column or dataframes usage: | diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 1a73c6c77f4..ebff8ae9470 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.112.0 +version: 0.113.0 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/polars_str-replace-all.md b/commands/docs/polars_str-replace-all.md index 3d710252490..c83a552470c 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.112.0 +version: 0.113.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/polars_str-replace.md b/commands/docs/polars_str-replace.md index e2c1694b4fd..20ad77605f0 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.112.0 +version: 0.113.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index 67f40e03266..6eb564bb5ff 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.112.0 +version: 0.113.0 dataframe: | Slices the string from the start position until the selected length. usage: | diff --git a/commands/docs/polars_str-split.md b/commands/docs/polars_str-split.md index bd36bb9dcf3..16441cd9872 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.112.0 +version: 0.113.0 dataframe: | Split the string by a substring. The resulting dtype is list. usage: | diff --git a/commands/docs/polars_str-strip-chars.md b/commands/docs/polars_str-strip-chars.md index 96c6309e96b..c3a4af3178c 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.112.0 +version: 0.113.0 dataframe: | Strips specified characters from strings in a column usage: | diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index e061956ccd4..f47dc01ab42 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/polars_struct-json-encode.md b/commands/docs/polars_struct-json-encode.md index 83f44dcbc69..cdf17e0c327 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.112.0 +version: 0.113.0 dataframe: | Convert this struct to a string column with json values. usage: | diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index ad0516f4d01..90b57cc5e07 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 204db9eca33..23d35d19a03 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index 1c2a0f2b6ef..1406702fb81 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/polars_truncate.md b/commands/docs/polars_truncate.md index 90a4c3ce77f..a3550d058aa 100644 --- a/commands/docs/polars_truncate.md +++ b/commands/docs/polars_truncate.md @@ -2,7 +2,7 @@ title: polars truncate categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Divide the date/datetime range into buckets. usage: | @@ -36,14 +36,14 @@ contributors: false Truncate a series of dates by period length ```nu > seq date -b 2025-01-01 --periods 4 --increment 6wk -o "%Y-%m-%d %H:%M:%S" | polars into-df | polars as-datetime "%F %H:%M:%S" --naive | polars select datetime (polars col datetime | polars truncate 5d37m | polars as truncated) -╭───┬───────────────┬───────────────╮ -│ # │ datetime │ truncated │ -├───┼───────────────┼───────────────┤ -│ 0 │ a year ago │ a year ago │ -│ 1 │ a year ago │ a year ago │ -│ 2 │ a year ago │ a year ago │ -│ 3 │ 11 months ago │ 11 months ago │ -╰───┴───────────────┴───────────────╯ +╭───┬────────────┬────────────╮ +│ # │ datetime │ truncated │ +├───┼────────────┼────────────┤ +│ 0 │ a year ago │ a year ago │ +│ 1 │ a year ago │ a year ago │ +│ 2 │ a year ago │ a year ago │ +│ 3 │ a year ago │ a year ago │ +╰───┴────────────┴────────────╯ ``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index 0f3ab86627c..02cb2cb4f18 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.112.0 +version: 0.113.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/polars_unnest.md b/commands/docs/polars_unnest.md index ac2b871c26e..144a1f671b7 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.112.0 +version: 0.113.0 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: | diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index a12f3bf9aa1..93ccf5433a3 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index 1fdf00ae0a2..40fdfe6e76c 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Uppercase the strings in the column. usage: | diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index bc281098191..425f93b7322 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.112.0 +version: 0.113.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 434fdda8e1b..c0685cd35ea 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.112.0 +version: 0.113.0 dataframe: | Create a var expression for an aggregation. usage: | diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index f05c975a8c7..13e30ad7a3d 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.112.0 +version: 0.113.0 expression: | Creates and modifies a when expression. usage: | diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index 9d964a27f1a..fe4f2f6c352 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.112.0 +version: 0.113.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index 7eb96ac3010..706b50acc9b 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.112.0 +version: 0.113.0 network: | Get a free TCP port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 56e6192ef65..fb7d1dad867 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 20f387d88d3..839f4bc0d30 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 2db040a4f07..f1c10c48b3f 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index a882538fd98..5118d6d244e 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.112.0 +version: 0.113.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 7ae2ab91973..58ae4bf0924 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index e997129dfd3..d1b2da83688 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.112.0 +version: 0.113.0 database: | Query a SQLite database with SQL statements. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 867b2dcfe42..79947358a8b 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index b193c987be2..ed9380a5298 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.112.0 +version: 0.113.0 network: | execute selector query on html/web usage: | @@ -39,8 +39,7 @@ Retrieve all `
` elements from phoronix.com website Retrieve a html table from Wikipedia and parse it into a nushell table using table headers as guides ```nu -> http get https://en.wikipedia.org/wiki/List_of_cities_in_India_by_population | - query web --as-table [City 'Population(2011)[3]' 'Population(2001)[3][a]' 'State or unionterritory' 'Reference'] +> http get https://en.wikipedia.org/wiki/List_of_terminal_emulators | query web --as-table ['Name', 'Type', 'Connectivity', 'User Interface', 'Operating System'] ``` diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index a2dd8de0ca2..c6af48a51d1 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.112.0 +version: 0.113.0 network: | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more usage: | diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index 98959a2949f..ccf5d623929 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Execute XPath 1.0 query on XML input usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 1b79d7aea7f..6376ef482e3 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate a random value. usage: | diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index d3dafe95004..4ea440ac2fc 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 3e235033292..cfccad2630d 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 3ac2dae6b5e..6bc8356933e 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 666305ccd4a..f7eccdefdf9 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate a random float within a range [min..max]. usage: | diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 7ad34f5710d..e3edb9b18db 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 12b9c9931c5..7d9511eef33 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.112.0 +version: 0.113.0 random: | Generate a random uuid string of the specified version. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index d1e3606c0d2..7bf8266c054 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry.md b/commands/docs/registry.md index d33f69f4936..b9cde37888b 100644 --- a/commands/docs/registry.md +++ b/commands/docs/registry.md @@ -2,7 +2,7 @@ title: registry categories: | system -version: 0.112.0 +version: 0.113.0 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 8e691e44d3f..360cd27cfde 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.112.0 +version: 0.113.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index d2d13aa86b5..75e110ad8c6 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | diff --git a/commands/docs/rename.md b/commands/docs/rename.md index a26d89cf551..9945995af50 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index b05bb26f517..660c0c413c9 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.112.0 +version: 0.113.0 core: | Return early from a custom command. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 50206efe8f1..a301e74aa34 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 537602e4753..63b87c54707 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Remove files and directories. usage: | @@ -26,7 +26,7 @@ contributors: false - `--permanent, -p`: Delete permanently, ignoring the 'always_trash' config option. always enabled on android and ios. - `--recursive, -r`: Delete subdirectories recursively. - `--force, -f`: Suppress error when no file. - - `--verbose, -v`: Print names of deleted files. + - `--verbose, -v`: Return a table for each processed path. - `--interactive, -i`: Ask user to confirm action. - `--interactive-once, -I`: Ask user to confirm action only once. - `--all, -a`: Remove hidden files if '*' is provided. @@ -38,9 +38,10 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------- | -| nothing | nothing | +| input | output | +| ------- | ----------------------------------------------------------------- | +| nothing | nothing | +| nothing | table<path: string, deleted: bool, error: oneof<nothing, string>> | ## Examples Delete, or move a file to the trash (based on the 'always_trash' config option). diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 69f10f5a34a..2335c2bb154 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 17705c0832e..9814e897d43 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index f35f43ab5c3..a10f61e902d 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 5a4a2852c37..db61cb4e844 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 9ae74da32af..b0bd824ed8f 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 8c7fa9ae77c..e45d884ae4d 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index e8e15ed26eb..29cbcb57c53 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.112.0 +version: 0.113.0 system: | Runs external command. usage: | diff --git a/commands/docs/run-internal.md b/commands/docs/run-internal.md new file mode 100644 index 00000000000..59cd36e0f04 --- /dev/null +++ b/commands/docs/run-internal.md @@ -0,0 +1,33 @@ +--- +title: run-internal +categories: | + default +version: 0.113.0 +default: | + Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch. +usage: | + Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch. +editLink: false +contributors: false +--- + + +# `run-internal` for [default](/commands/categories/default.md) + +
Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch.
+ +## Signature + +```> run-internal {flags} (name) ...rest``` + +## Parameters + + - `name`: The name of the built-in command to run. + - `...rest`: Arguments to pass to the built-in command. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | \ No newline at end of file diff --git a/commands/docs/save.md b/commands/docs/save.md index 3f6ed5e816c..dc313e49030 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index fea45d77512..6344e53ad76 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.112.0 +version: 0.113.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index aa641f1530f..c6b4bafa710 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.112.0 +version: 0.113.0 core: | Commands for getting info about what is in scope. usage: | diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index 1cc73731bed..6e6deed7ba0 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.112.0 +version: 0.113.0 core: | Output info on the aliases in the current scope. usage: | diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 6fc7c3922c5..4a9917f49ba 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.112.0 +version: 0.113.0 core: | Output info on the commands in the current scope. usage: | diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index e844fc6d386..f2b51cefa57 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.112.0 +version: 0.113.0 core: | Output stats on the engine in the current state. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index ce2f344b071..9e0ab753434 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.112.0 +version: 0.113.0 core: | Output info on the known externals in the current scope. usage: | diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 999dd375f70..d1e2d747a16 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.112.0 +version: 0.113.0 core: | Output info on the modules in the current scope. usage: | diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index 20a2990c40e..90aef62c5d4 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.112.0 +version: 0.113.0 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index 767243900e2..87216fe3040 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 0ca2ac9c307..3262d6410ca 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.112.0 +version: 0.113.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index ef20f1849d2..6ef0f4b6a11 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.112.0 +version: 0.113.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index a82c53c852d..133747235d0 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.112.0 +version: 0.113.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 9f25dd05b69..5bcdb03c4c4 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 9d209440f81..0c62f7d6436 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index a21b46fe42d..91e562c35bc 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Skip elements of the input until a predicate is true. usage: | diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index 70e59fb5aa1..85e820887c7 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Skip elements of the input while a predicate is true. usage: | diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index feee28dc7b6..bc15718feb6 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/slice.md b/commands/docs/slice.md index b9fcd045be1..9d05f1da6d0 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index cf3c9e12e4b..3caf037bc4f 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 6d903128468..66bd982672c 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Sort the input in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index c1bd574450c..bb31259b46f 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.112.0 +version: 0.113.0 core: | Source the environment from a source file into the current environment. usage: | diff --git a/commands/docs/source.md b/commands/docs/source.md index 8dac03d9bdd..4ddbe97ed7e 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.112.0 +version: 0.113.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 7edb040a96b..0b96d9a6df7 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | diff --git a/commands/docs/split_cell-path.md b/commands/docs/split_cell-path.md index 22be1e30734..b1818ff1c11 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.112.0 +version: 0.113.0 conversions: | Split a cell-path into its components. usage: | diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 6450033d68f..f9bc0ad63c3 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Split a string into a list of characters. usage: | diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index 87ab825fb32..323a0c8d40f 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Split a string into multiple columns using a separator. usage: | diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index d287b80a9f7..ba4a76541cf 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index d21c6e1fd6a..f3aece3ed1f 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Split a string into multiple rows using a separator. usage: | diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index 0bdd5d407eb..df3da3897b6 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 19509612230..43179b13b5a 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Open a folder, file, or website in the default application or viewer. usage: | diff --git a/commands/docs/stor.md b/commands/docs/stor.md index c039b4d5aab..c6c0e06fae3 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.112.0 +version: 0.113.0 database: | Various commands for working with the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index bc7cd32f4ac..fe6cea01e0a 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.112.0 +version: 0.113.0 database: | Create a table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index 31ca3b7b31c..8f8f3ed9cfa 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.112.0 +version: 0.113.0 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index 363a171a1d5..98a6ec151cc 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.112.0 +version: 0.113.0 database: | Export the in-memory sqlite database to a sqlite database file. usage: | diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index e4cd06ab476..d7acf4b58cf 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.112.0 +version: 0.113.0 database: | Import a sqlite database file into the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index 63441e497aa..a8dd368d6b7 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.112.0 +version: 0.113.0 database: | Insert information into a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index 8f91407db21..7f215d95032 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.112.0 +version: 0.113.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index a78fc38a12d..18eb47480a0 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.112.0 +version: 0.113.0 database: | Reset the in-memory database by dropping all tables. usage: | diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index e3de3ca4e26..ee3de7867bc 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.112.0 +version: 0.113.0 database: | Update information in a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/str.md b/commands/docs/str.md index 1b5f588eeca..170924f48f0 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Various commands for working with string data. usage: | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index c0b74b6406d..517cf1a0fa9 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.112.0 +version: 0.113.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index cb3ba5e3d7e..fbd22038f48 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Capitalize the first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index a46faa4d4d1..092c8d6c56d 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 9bc3b7e3a4a..760f25903ec 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index 18c7a07fe44..20165a9f58f 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Convert text to lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 27df0fb4e46..32f5abb2f53 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.112.0 +version: 0.113.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_escape-regex.md b/commands/docs/str_escape-regex.md index c505a9b7215..ecd1383951f 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.112.0 +version: 0.113.0 strings: | Escapes special characters in the input string with '\'. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 80c93a8d53b..294639f2a86 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index f2aa9561030..8fc09900e54 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.112.0 +version: 0.113.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index c6a80425209..844cafa22d1 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index 2f00a0bdcb7..a9305a81650 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.112.0 +version: 0.113.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index feba21d227d..118735c7fdf 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index e8182b7d23f..a9bcf5d4c06 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.112.0 +version: 0.113.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 6e19d7cd455..df2880ecfec 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Find and replace text in the input string. usage: | @@ -138,7 +138,7 @@ end ## Notes The pattern to find can be a substring (default) or a regular expression (with `--regex`). -The replacement can be a a string, possibly containing references to numbered (`$1` etc) or -named capture groups (`$name`), or it can be closure that is invoked for each match. +The replacement can be a string, possibly containing references to numbered (`$1` etc) or +named capture groups (`$name`), or it can be a closure that is invoked for each match. In the latter case, the closure is invoked with the entire match as its input and any capture groups as its argument. It must return a string that will be used as a replacement for the match. diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index 24d092e2db2..6c6174f98ed 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Reverse every string in the pipeline. usage: | diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index dadc44a8b90..91b12ec5b37 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.112.0 +version: 0.113.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index 88e171a4223..41734f37edc 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.112.0 +version: 0.113.0 strings: | Convert a string to snake_case. usage: | diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index 89c92a2ace8..78bb2f5e1ce 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.112.0 +version: 0.113.0 strings: | Check if an input starts with a string. usage: | diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index 55fd39c3b9b..9e8855c4623 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 97de5b6709d..f4e7638de0c 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Get part of a string. Note that the first character of a string is index 0. usage: | diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index 2e3567e57fc..8d75e5e569d 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.112.0 +version: 0.113.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 3d4509527f8..2978285b715 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 5984e22d13b..0e7992dd497 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Convert text to uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 6a179d8eb65..65bbda8c726 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 47d6d7f7ef3..7a8b7ff9915 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index 43f696e8a33..6ceade0d4f8 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 019b29455ef..6cdb0be6deb 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index 25718ef3baa..2d55534ce0f 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index 42fd32769d7..bb3275eca27 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the system network interfaces. usage: | diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md index cd63c040c21..dea4a43e52d 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.112.0 +version: 0.113.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 25333738300..96aa58f1bf7 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.112.0 +version: 0.113.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 532baf4c4dd..85c56409602 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.112.0 +version: 0.113.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index cf2a4f1029d..15aa85d3d69 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 23c9c3c46a6..e6ce7128c61 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Take elements of the input until a predicate is true. usage: | diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index 3163da6769a..1e051ce97a9 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Take elements of the input while a predicate is true. usage: | diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 7ad0c128b45..42d5dbc80ba 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term.md b/commands/docs/term.md index 72b7acd4f42..c290a1823d9 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Commands for querying information about the terminal. usage: | diff --git a/commands/docs/term_query.md b/commands/docs/term_query.md index dc423a0f0b9..9ec93bc249d 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Query the terminal for information. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index b9bc8397bc9..8f1d3c24896 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index fc1a1ca55d9..994d6442426 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Time how long it takes a closure to run. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 6f573a88f65..e0f304453db 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Translate structured data to various formats. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 56da8280426..87fc83871e7 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 0a553dd921a..b699651c964 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 1a27896a577..81b037b5d06 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 8732f747548..acdcfd83838 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 295c12e8fca..2e601a7a31e 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 92746d4c922..6596d27cd51 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 74fd69c0b2d..7510fed3774 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | @@ -28,6 +28,7 @@ contributors: false - `--serialize, -s`: Serialize nushell types that cannot be deserialized. - `--raw-strings, -R`: Use raw string syntax (r#'...'#) for strings with quotes or backslashes. - `--list-of-records, -l`: Serialize table values as list-of-records instead of table syntax. + - `--no-commas, -c`: Do not use commas between items in tables and lists. ## Input/output types: @@ -101,3 +102,15 @@ Serialize table values as list of records with pretty indentation. {a: 3, b: 4} ] ``` + +Output a list without commas between items. +```nu +> [1 2 3] | to nuon --no-commas +[1 2 3] +``` + +Output a record without commas between fields. +```nu +> {a: 1, b: 2} | to nuon --no-commas +{a: 1 b: 2} +``` diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index e73191dbd5e..d07c8c82cb2 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 6512f1e6713..9faf4a0cc24 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert data into plain text format. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index ba9dc40b003..91a1b142832 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index fc9ecf3b8f5..1762f41faf5 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 636bcf4c4e3..22632b61ad4 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 6a561fe94bf..5b61bb48aea 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md index e8f7c305f73..7e60d649a58 100644 --- a/commands/docs/to_yml.md +++ b/commands/docs/to_yml.md @@ -2,7 +2,7 @@ title: to yml categories: | formats -version: 0.112.0 +version: 0.113.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 7a59c1ea4e0..d5ef7c2f60e 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index a6e33e7238e..e18c3e56f5b 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | diff --git a/commands/docs/try.md b/commands/docs/try.md index e55a161ec9d..6fc62307e5e 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.112.0 +version: 0.113.0 core: | Try to run a block, if it fails optionally run a catch closure. usage: | diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index b1e0fb10fa3..107bdf6258e 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.112.0 +version: 0.113.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index d5c07122bf9..c4c29da1acc 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/umask.md b/commands/docs/umask.md index 3cc513d00f7..40098b83012 100644 --- a/commands/docs/umask.md +++ b/commands/docs/umask.md @@ -2,7 +2,7 @@ title: umask categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Get or set default file creation permissions. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 86920f474c1..ef9b6be19b2 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.112.0 +version: 0.113.0 system: | Print certain system information using uutils/coreutils uname. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index f02850defcc..d7412805a23 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Return the distinct values in the input by the given column(s). usage: | diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index 140efda7626..a8fff6d933e 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/unlet.md b/commands/docs/unlet.md index 3cf0a1fb628..4223c18cb41 100644 --- a/commands/docs/unlet.md +++ b/commands/docs/unlet.md @@ -2,7 +2,7 @@ title: unlet categories: | experimental -version: 0.112.0 +version: 0.113.0 experimental: | Delete variables from nushell memory, making them unrecoverable. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 972ee59b449..3a99ffffa6b 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Update an existing column to have a new value. usage: | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index 5b4458c6c07..63c4ad21a2e 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 878bc40e069..79572c676d9 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | diff --git a/commands/docs/url.md b/commands/docs/url.md index f2e418180d5..2a257948fdc 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.112.0 +version: 0.113.0 network: | Various commands for working with URLs. usage: | diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 55d44223f9c..e95911f32d2 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.112.0 +version: 0.113.0 network: | Converts record or table into query string applying percent-encoding. usage: | diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index c16445e246c..803a1c48c2b 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Converts a percent-encoded web safe string to a string. usage: | diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index 50f77c76477..05359fc3b5a 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.112.0 +version: 0.113.0 strings: | Converts a string to a percent encoded web safe string. usage: | diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index 4864fee9787..d4ccf0f7d3a 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.112.0 +version: 0.113.0 network: | Convert a record to a URL string. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index a03ccca684d..c9c7e9ad2fb 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.112.0 +version: 0.113.0 network: | Parse a URL string into structured data. usage: | diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index cd5a42b2cdb..39243f7f446 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.112.0 +version: 0.113.0 network: | Converts query string into table applying percent-decoding. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 67a0d5fba19..e7014e42ea1 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.112.0 +version: 0.113.0 core: | Use definitions from a module, making them available in your shell. usage: | diff --git a/commands/docs/values.md b/commands/docs/values.md index 6b2e7af77dc..2d28a93a77f 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Given a record or table, produce a list of its columns' values. usage: | diff --git a/commands/docs/version.md b/commands/docs/version.md index 7f35b114e2a..c16978d93be 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.112.0 +version: 0.113.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/version_check.md b/commands/docs/version_check.md index 65558afcaae..0773c170a89 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Checks to see if you have the latest version of nushell. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 13cd6374738..7caf99ae423 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index 8c7ceba76a8..6637e2615e5 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View the blocks registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 0bfc3651655..ea616bb60dc 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_ir.md b/commands/docs/view_ir.md index ae69eba20ea..98fa44c963c 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View the compiled IR code for a block of code. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index e5eeb8085a8..991007a645e 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 8968e172869..55513c0cec7 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.112.0 +version: 0.113.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index 18c32738522..711e5090874 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.112.0 +version: 0.113.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | @@ -31,30 +31,30 @@ contributors: false ## Parameters - `path`: The path to watch. Can be a file or directory. - - `closure`: Some Nu code to run whenever a file changes. The closure will be passed `operation`, `path`, and `new_path` (for renames only) arguments in that order. + - `closure`: Some Nu code to run whenever a file changes. The closure will be passed `operation`, `path`, and `new_path` (for renames only) arguments in that order (deprecated). ## Input/output types: -| input | output | -| ------- | -------------------------------------------------------- | -| nothing | nothing | -| nothing | table<operation: string, path: string, new_path: string> | +| input | output | +| ------- | ---------------------------------------------------------------------------------------- | +| nothing | nothing | +| nothing | table<operation: string, path: oneof<string, nothing>, new_path: oneof<string, nothing>> | ## Examples Run `cargo test` whenever a Rust file changes. ```nu -> watch . --glob=**/*.rs {|| cargo test } +> for _ in (watch . --glob=**/*.rs) { cargo test } ``` Watch all changes in the current directory. ```nu -> watch . { |op, path, new_path| $"($op) ($path) ($new_path)"} +> watch . | each { print } ``` -`watch` (when run without a closure) can also emit a stream of events it detects. +Filter, limit and modify `watch`'s output by using it as part of a pipeline. ```nu > watch /foo/bar | where operation == Create @@ -67,7 +67,7 @@ Watch all changes in the current directory. Print file changes with a debounce time of 5 minutes. ```nu -> watch /foo/bar --debounce 5min { |op, path| $"Registered ($op) on ($path)" | print } +> watch /foo/bar --debounce 5min | each {|e| $"Registered ($e.operation) on ($e.path)" | print } ``` @@ -77,5 +77,11 @@ Note: if you are looking to run a command every N units of time, this can be acc ``` +Run `cargo test` whenever a Rust file changes (with the deprecated closure argument). +```nu +> watch . --glob=**/*.rs {|| cargo test } + +``` + ## Notes When run without a closure, `watch` returns a stream of events instead. \ No newline at end of file diff --git a/commands/docs/where.md b/commands/docs/where.md index beb93d8c3ff..c2cb9f34dfa 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Filter values of an input list based on a condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 2da3c7459fd..d86c7624be4 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.112.0 +version: 0.113.0 system: | Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 88f3a85bcb4..3a2a858ec61 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.112.0 +version: 0.113.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index e706c68f121..5ed03a9238f 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.112.0 +version: 0.113.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index f5c5e47e6dd..9492e65b066 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index a1a3f76e6bf..cecd27d25a1 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.112.0 +version: 0.113.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index e573b345444..eb4fe9c2136 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index b106060e7f2..ce57bf7c39f 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.112.0 +version: 0.113.0 filters: | Combine a stream with the input. usage: |