diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 94763799e57..fc5a0250d1b 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.111.0 +version: 0.112.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 11eb494f24a..4b11164fe80 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.111.0 +version: 0.112.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 a380889e65b..e021dc72c34 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.111.0 +version: 0.112.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 cec11276c74..ea68cc564f8 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index f1eee99ada5..b0bc2268378 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.111.0 +version: 0.112.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 62fa5b135c1..0676983120c 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index e9500762de4..fdddf4a401a 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.111.0 +version: 0.112.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 941366d8e99..15191c7f8fd 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 4262373e234..ccefc19879e 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | @@ -96,7 +96,7 @@ Print the ast of a pipeline flattened. ╭───┬─────────┬────────────────────┬────────────────╮ │ # │ content │ shape │ span │ ├───┼─────────┼────────────────────┼────────────────┤ -│ 0 │ ls │ shape_external │ ╭───────┬───╮ │ +│ 0 │ ls │ shape_internalcall │ ╭───────┬───╮ │ │ │ │ │ │ start │ 0 │ │ │ │ │ │ │ end │ 2 │ │ │ │ │ │ ╰───────┴───╯ │ diff --git a/commands/docs/attr.md b/commands/docs/attr.md index a98b9fa5a9d..3ed3af7a265 100644 --- a/commands/docs/attr.md +++ b/commands/docs/attr.md @@ -2,7 +2,7 @@ title: attr categories: | core -version: 0.111.0 +version: 0.112.0 core: | Various attributes for custom commands. usage: | diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md index f6d38841a05..24a68930239 100644 --- a/commands/docs/attr_category.md +++ b/commands/docs/attr_category.md @@ -2,7 +2,7 @@ title: attr category categories: | core -version: 0.111.0 +version: 0.112.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 ee7253fc542..bab2d9031d3 100644 --- a/commands/docs/attr_complete.md +++ b/commands/docs/attr_complete.md @@ -2,7 +2,7 @@ title: attr complete categories: | core -version: 0.111.0 +version: 0.112.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 b5be90da3ca..c60ca84f74e 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.111.0 +version: 0.112.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 083a1815fb2..e927656a4be 100644 --- a/commands/docs/attr_deprecated.md +++ b/commands/docs/attr_deprecated.md @@ -2,7 +2,7 @@ title: attr deprecated categories: | core -version: 0.111.0 +version: 0.112.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 ae4f8e0d0b0..d9bc13a4ab0 100644 --- a/commands/docs/attr_example.md +++ b/commands/docs/attr_example.md @@ -2,7 +2,7 @@ title: attr example categories: | core -version: 0.111.0 +version: 0.112.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 23de0499b3d..bf4695c752c 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.111.0 +version: 0.112.0 core: | Attribute for adding search terms to custom commands. usage: | diff --git a/commands/docs/banner.md b/commands/docs/banner.md index 8acc620ad2d..c561be39563 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.111.0 +version: 0.112.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 eb79f42ee4e..9787085da71 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 5eaa847044e..f78764ddd94 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Performs bitwise and for ints or binary values. usage: | @@ -48,7 +48,7 @@ Apply bitwise and to two numbers Apply bitwise and to two binary values ```nu > 0x[ab cd] | bits and 0x[99 99] -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 89 89 ×× ``` @@ -77,7 +77,7 @@ Apply bitwise and to a list of binary data Apply bitwise and to binary data of varying lengths with specified endianness ```nu > 0x[c0 ff ee] | bits and 0x[ff] --endian big -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 00 00 ee 00× ``` @@ -85,7 +85,7 @@ Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii Apply bitwise and to input binary data smaller than the operand ```nu > 0x[ff] | bits and 0x[12 34 56] --endian little -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 12 00 00 •00 ``` diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index fda3a1d79ce..be4e61a7a0b 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Performs logical negation on each bit. usage: | @@ -72,7 +72,7 @@ Apply logical negation to a list of numbers, treat input as signed number Apply logical negation to binary data ```nu > 0x[ff 00 7f] | bits not -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 00 ff 80 0×× ``` diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 37951e565e0..25d93f1b5bb 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Performs bitwise or for ints or binary values. usage: | @@ -59,7 +59,7 @@ Apply bitwise or to a list of numbers Apply bitwise or to binary data ```nu > 0x[88 cc] | bits or 0x[42 32] -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ca fe ×× ``` @@ -67,7 +67,7 @@ Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii Apply bitwise or to binary data of varying lengths with specified endianness ```nu > 0x[c0 ff ee] | bits or 0x[ff] --endian big -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: c0 ff ff ××× ``` @@ -75,7 +75,7 @@ Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii Apply bitwise or to input binary data smaller than the operor ```nu > 0x[ff] | bits or 0x[12 34 56] --endian little -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff 34 56 ×4V ``` diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 993f3b7a3a0..0f6d9c21333 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Bitwise rotate left for ints or binary values. usage: | @@ -60,7 +60,7 @@ Rotate left a list of numbers with 2 bits rotate left binary data ```nu > 0x[c0 ff ee] | bits rol 10 -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff bb 03 ×ו ``` diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 3df6d53fc24..d2768f4eb91 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Bitwise rotate right for ints or binary values. usage: | @@ -60,7 +60,7 @@ rotate right a list of numbers of two bytes rotate right binary data ```nu > 0x[ff bb 03] | bits ror 10 -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: c0 ff ee ××× ``` diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index c9b906956a8..ba4b1cbb9f5 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Bitwise shift left for ints or binary values. usage: | @@ -72,7 +72,7 @@ Shift left a list of numbers Shift left a binary value ```nu > 0x[4f f4] | bits shl 4 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff 40 ×@ ``` diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 13e2e89aeba..bf277482fda 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Bitwise shift right for ints or binary values. usage: | @@ -60,7 +60,7 @@ Shift right a list of numbers Shift right a binary value ```nu > 0x[4f f4] | bits shr 4 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 04 ff •× ``` diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index 77ab448a27a..62c0c4f37b0 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.111.0 +version: 0.112.0 bits: | Performs bitwise xor for ints or binary values. usage: | @@ -59,7 +59,7 @@ Apply bitwise xor to a list of numbers Apply bitwise xor to binary data ```nu > 0x[ca fe] | bits xor 0x[ba be] -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 70 40 p@ ``` @@ -67,7 +67,7 @@ Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii Apply bitwise xor to binary data of varying lengths with specified endianness ```nu > 0x[ca fe] | bits xor 0x[aa] --endian big -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ca 54 ×T ``` @@ -75,7 +75,7 @@ Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii Apply bitwise xor to input binary data smaller than the operand ```nu > 0x[ff] | bits xor 0x[12 34 56] --endian little -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ed 34 56 ×4V ``` diff --git a/commands/docs/break.md b/commands/docs/break.md index 84d27cbb11c..208278f86d3 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.111.0 +version: 0.112.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 823e2a58bce..27c39a5f05b 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.111.0 +version: 0.112.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 cf8bc343320..d9e049ec4ee 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Add specified bytes to the binary input. usage: | @@ -44,7 +44,7 @@ contributors: false Add bytes `0x[AA]` to `0x[1F FF AA AA]`. ```nu > 0x[1F FF AA AA] | bytes add 0x[AA] -Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +Length: 5 (0x5) bytes | null_char printable whitespace ascii_other non_ascii 00000000: aa 1f ff aa aa ו××× ``` @@ -52,7 +52,7 @@ Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[AA BB]` to `0x[1F FF AA AA]` at index 1. ```nu > 0x[1F FF AA AA] | bytes add 0x[AA BB] --index 1 -Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii +Length: 6 (0x6) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 1f aa bb ff aa aa •××××× ``` @@ -60,7 +60,7 @@ Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[11]` to `0x[FF AA AA]` at the end. ```nu > 0x[FF AA AA] | bytes add 0x[11] --end -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff aa aa 11 ××ו ``` @@ -68,7 +68,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[11 22 33]` to `0x[FF AA AA]` at the end, at index 1(the index is start from end). ```nu > 0x[FF AA BB] | bytes add 0x[11 22 33] --end --index 1 -Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii +Length: 6 (0x6) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff aa 11 22 33 bb ×ו"3× ``` diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 069138e9f41..deaeb0e2f3a 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Get bytes from the input defined by a range. usage: | @@ -47,7 +47,7 @@ Extract bytes starting from a specific index. Slice out `0x[10 01 13]` from `0x[33 44 55 10 01 13]`. ```nu > 0x[33 44 55 10 01 13] | bytes at 3..5 -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 10 01 13 ••• ``` @@ -55,7 +55,7 @@ Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii Extract bytes from the start up to a specific index. ```nu > 0x[33 44 55 10 01 13 10] | bytes at ..4 -Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +Length: 5 (0x5) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 33 44 55 10 01 3DU•• ``` @@ -63,7 +63,7 @@ Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii Extract byte `0x[10]` using an exclusive end index. ```nu > 0x[33 44 55 10 01 13 10] | bytes at 3..<4 -Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +Length: 1 (0x1) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 10 • ``` @@ -71,7 +71,7 @@ Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii Extract bytes up to a negative index (inclusive). ```nu > 0x[33 44 55 10 01 13 10] | bytes at ..-4 -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 33 44 55 10 3DU• ``` @@ -90,7 +90,7 @@ Slice bytes across multiple table columns. Extract the last three bytes using a negative start index. ```nu > 0x[33 44 55 10 01 13 10] | bytes at (-3).. -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 13 10 ••• ``` diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 36c3c5ba47a..73ff9563894 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Create a binary value from the provided arguments. usage: | @@ -35,7 +35,7 @@ contributors: false Builds binary data from 0x[01 02], 0x[03], 0x[04]. ```nu > bytes build 0x[01 02] 0x[03] 0x[04] -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 02 03 04 •••• ``` @@ -43,7 +43,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Builds binary data from byte numbers. ```nu > bytes build 255 254 253 252 -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff fe fd fc ×××× ``` diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index bac5afe80d3..341cc01974c 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | @@ -30,12 +30,13 @@ contributors: false | input | output | | ------------ | ------ | | list<binary> | binary | +| table | binary | ## Examples Create a byte array from input. ```nu > [0x[11] 0x[13 15]] | bytes collect -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 11 13 15 ••• ``` @@ -43,7 +44,7 @@ Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii Create a byte array from input with a separator. ```nu > [0x[11] 0x[33] 0x[44]] | bytes collect 0x[01] -Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +Length: 5 (0x5) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 11 01 33 01 44 ••3•D ``` diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 3aaa4848112..68e8049b271 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.111.0 +version: 0.112.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 6f92672beac..d5d7a1ecb03 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.111.0 +version: 0.112.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 eba16aaedec..f75b2a95d7d 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.111.0 +version: 0.112.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 4de80aaf3a9..c7c8d40edc2 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Remove specified bytes from the input. usage: | @@ -43,7 +43,7 @@ contributors: false Remove contents. ```nu > 0x[10 AA FF AA FF] | bytes remove 0x[10 AA] -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff aa ff ××× ``` @@ -59,7 +59,7 @@ Remove all occurrences of find binary in record field. Remove occurrences of find binary from end. ```nu > 0x[10 AA 10 BB CC AA 10] | bytes remove --end 0x[10] -Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii +Length: 6 (0x6) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 10 aa 10 bb cc aa •×•××× ``` @@ -67,7 +67,7 @@ Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii Remove find binary from end not found. ```nu > 0x[10 AA 10 BB CC AA 10] | bytes remove --end 0x[11] -Length: 7 (0x7) bytes | printable whitespace ascii_other non_ascii +Length: 7 (0x7) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 10 aa 10 bb cc aa 10 •×•××ו ``` diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index c8e837d8c96..5b7fe5f057a 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Find and replace bytes in binary data. usage: | @@ -43,7 +43,7 @@ contributors: false Find and replace contents. ```nu > 0x[10 AA FF AA FF] | bytes replace 0x[10 AA] 0x[FF] -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff ff aa ff ×××× ``` @@ -51,7 +51,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Find and replace all occurrences of find binary. ```nu > 0x[10 AA 10 BB 10] | bytes replace --all 0x[10] 0x[A0] -Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +Length: 5 (0x5) bytes | null_char printable whitespace ascii_other non_ascii 00000000: a0 aa a0 bb a0 ××××× ``` diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index e8f9356bb5a..0a7aec253ad 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.111.0 +version: 0.112.0 bytes: | Reverse the bytes in the pipeline. usage: | @@ -37,7 +37,7 @@ contributors: false Reverse bytes `0x[1F FF AA AA]`. ```nu > 0x[1F FF AA AA] | bytes reverse -Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +Length: 4 (0x4) bytes | null_char printable whitespace ascii_other non_ascii 00000000: aa aa ff 1f ××ו ``` @@ -45,7 +45,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Reverse bytes `0x[FF AA AA]`. ```nu > 0x[FF AA AA] | bytes reverse -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: aa aa ff ××× ``` diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index 209fe81187f..9e05288d863 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.111.0 +version: 0.112.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 c5c7bf5fa5b..96a490e38e7 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.111.0 +version: 0.112.0 bytes: | Check if binary data starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index f1b58b8ecce..9b80dd33975 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.111.0 +version: 0.112.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index afb59ee424d..5567a4c1535 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Change the current working directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 8d22d2c1722..0706aa281f3 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index a93fac8e2e0..2f823ca350a 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.111.0 +version: 0.112.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 4f274a1c937..5fa412825d8 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.111.0 +version: 0.112.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 314b46547bc..4d2aef3acd2 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Clear the terminal screen. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index bf1177c34b6..22e8034fefa 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | core -version: 0.111.0 +version: 0.112.0 core: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index c44c60c62bf..a010ceacf74 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.111.0 +version: 0.112.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 d7f35b1a31a..293181030d3 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.111.0 +version: 0.112.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 27c2a4007e8..a93d06e7ac9 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.111.0 +version: 0.112.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 e0a2052663a..5e6b2054950 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.111.0 +version: 0.112.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 0b782be9468..243bf951a28 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.111.0 +version: 0.112.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index b1ae336ec90..424f2eb8693 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 5da89cf1678..bd4c534102c 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.111.0 +version: 0.112.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 732fd1d5d50..d918e67e30a 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.111.0 +version: 0.112.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 56709ce8863..64083904bd5 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.111.0 +version: 0.112.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index 1617b59af79..b1413252763 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.111.0 +version: 0.112.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 6693d382a18..bac5c1b46de 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.111.0 +version: 0.112.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 9bc6b0dd6cb..da263bd3ddb 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.111.0 +version: 0.112.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 1edb6da2112..3d7b5e50a98 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.111.0 +version: 0.112.0 env: | Get the configuration for color output. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 7106993a841..cf09c6b4379 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.111.0 +version: 0.112.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 95a9c1d4634..b4480bd3d47 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.111.0 +version: 0.112.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 7fc433d09b3..e2c94860707 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index 6f5bec14555..7f66bdd692d 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.111.0 +version: 0.112.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 438c59fb2b9..29b49935f9d 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.111.0 +version: 0.112.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 3683ad9424f..e4be0e4f033 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.111.0 +version: 0.112.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 fcc29c86902..acd5d96f02e 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.111.0 +version: 0.112.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 2029e39f6fd..25b612ec910 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.111.0 +version: 0.112.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 3f819a2b255..10e466c4434 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.111.0 +version: 0.112.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 28d5781682f..6463418365f 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.111.0 +version: 0.112.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 98d62cb58e6..d2bea86b8d8 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.111.0 +version: 0.112.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 bebb35e6526..3810774b625 100644 --- a/commands/docs/debug_env.md +++ b/commands/docs/debug_env.md @@ -2,7 +2,7 @@ title: debug env categories: | debug -version: 0.111.0 +version: 0.112.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 b6349b5b45a..8a0f76bca87 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.111.0 +version: 0.112.0 debug: | Show all experimental options. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 7b8300b247c..511868fe944 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index b1200f7c620..0187945ed79 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index c48b731e341..1d6c613a827 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 7df64e37c82..0af4c73fd20 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Decode a Base32-encoded value. usage: | @@ -35,7 +35,7 @@ contributors: false Decode arbitrary binary data ```nu > "AEBAGBAF" | decode base32 -Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +Length: 5 (0x5) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 02 03 04 05 ••••• ``` @@ -49,7 +49,7 @@ Decode an encoded string Parse a string without padding ```nu > "NBUQ" | decode base32 --nopad -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 68 69 hi ``` diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 786fb90e83d..e58484be519 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Encode a base32hex value. usage: | @@ -35,7 +35,7 @@ contributors: false Decode arbitrary binary data ```nu > "ATNAQ===" | decode base32hex -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 57 6e ad Wn× ``` @@ -49,7 +49,7 @@ Decode an encoded string Parse a string without padding ```nu > "ATNAQ" | decode base32hex --nopad -Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +Length: 3 (0x3) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 57 6e ad Wn× ``` diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 7703bbd396f..ae87afa7baa 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Decode a Base64-encoded value. usage: | @@ -42,7 +42,7 @@ Decode a Base64 string Decode arbitrary data ```nu > "/w==" | decode base64 -Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +Length: 1 (0x1) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff × ``` @@ -50,7 +50,7 @@ Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii Decode a URL-safe Base64 string ```nu > "_w==" | decode base64 --url -Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +Length: 1 (0x1) bytes | null_char printable whitespace ascii_other non_ascii 00000000: ff × ``` diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 6ad73e1ad8f..8d97f9f6347 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Decode a hex-encoded value. usage: | @@ -31,7 +31,7 @@ contributors: false Decode arbitrary binary data ```nu > "09FD" | decode hex -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 09 fd _× ``` @@ -39,7 +39,7 @@ Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii Lowercase Hex is also accepted ```nu > "09fd" | decode hex -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 09 fd _× ``` diff --git a/commands/docs/def.md b/commands/docs/def.md index 2ef2e56a75e..8c32860703b 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.111.0 +version: 0.112.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 84f72b7178f..72aaf21f92c 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.111.0 +version: 0.112.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 993f02ac4af..022d5bcb582 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.111.0 +version: 0.112.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -41,11 +41,11 @@ string Describe the type of a record in a detailed way. ```nu -> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d +> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d ╭───────────────┬────────────────────────────────────────────────────────────────────────────────────────────╮ │ type │ record │ │ detailed_type │ record, fib: list, on_save: closure, first_commit: datetime, my_duration: duration> │ +│ │ int>, fib: list, first_commit: datetime, my_duration: duration> │ │ │ ╭──────────────┬─────────────────────────────────────────────────────────────────────────╮ │ │ columns │ │ │ ╭───────────────┬────────────────────────╮ │ │ │ │ │ shell │ │ type │ string │ │ │ @@ -102,17 +102,6 @@ Describe the type of a record in a detailed way. │ │ │ │ │ │ ╰───┴──────┴───────────────┴───────────┴───────╯ │ │ │ │ │ │ │ ╰─────────────────┴───────────────────────────────────────────────────╯ │ │ │ │ │ │ ╭───────────────┬─────────────────────────────────────────────────────╮ │ │ -│ │ │ on_save │ │ type │ closure │ │ │ -│ │ │ │ │ detailed_type │ closure │ │ │ -│ │ │ │ │ rust_type │ &alloc::boxed::Box │ │ │ -│ │ │ │ │ value │ closure_1 │ │ │ -│ │ │ │ │ │ ╭──────────┬─────────╮ │ │ │ -│ │ │ │ │ signature │ │ name │ │ │ │ │ -│ │ │ │ │ │ │ category │ default │ │ │ │ -│ │ │ │ │ │ ╰──────────┴─────────╯ │ │ │ -│ │ │ │ ╰───────────────┴─────────────────────────────────────────────────────╯ │ │ -│ │ │ │ ╭───────────────┬─────────────────────────────────────────────────────╮ │ │ │ │ │ first_commit │ │ type │ datetime │ │ │ │ │ │ │ │ detailed_type │ datetime │ │ │ │ │ │ │ │ rust_type │ chrono::datetime::DateTime "負けると知って戦うのが、遥かに美しいのだ" | encode shift-jis -Length: 40 (0x28) bytes | printable whitespace ascii_other non_ascii +Length: 40 (0x28) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 95 89 82 af 82 e9 82 c6 92 6d 82 c1 82 c4 90 ed ×××××××××m×××××× 00000010: 82 a4 82 cc 82 aa 81 41 97 79 82 a9 82 c9 94 fc ×××××××A×y×××××× 00000020: 82 b5 82 a2 82 cc 82 be ×××××××× @@ -49,7 +49,7 @@ Length: 40 (0x28) bytes | printable whitespace ascii_other non_ascii Replace characters with HTML entities if they can't be encoded ```nu > "🎈" | encode --ignore-errors shift-jis -Length: 9 (0x9) bytes | printable whitespace ascii_other non_ascii +Length: 9 (0x9) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 26 23 31 32 37 38 38 30 3b 🎈 ``` diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index 8e202464393..202ddaa0a97 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.111.0 +version: 0.112.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 167befa64cb..aa7fdf7b9e1 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.111.0 +version: 0.112.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 81a3b4ba429..aaef63417c7 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.111.0 +version: 0.112.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 64229c06ce9..02837f9fd14 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 5e28cf759b3..c6e156d6c3d 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error.md b/commands/docs/error.md index f886a98d11e..15888336775 100644 --- a/commands/docs/error.md +++ b/commands/docs/error.md @@ -2,7 +2,7 @@ title: error categories: | core -version: 0.111.0 +version: 0.112.0 core: | Various commands for working with errors. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 14038731d78..80ca067a8a5 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.111.0 +version: 0.112.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 7d0518efef6..d71a10791d2 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.111.0 +version: 0.112.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 605c8d8033e..81b7bb7149d 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.111.0 +version: 0.112.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 b9152325edb..46dfdf39540 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.111.0 +version: 0.112.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index e0cb70d2b5b..7c9676e887a 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 039dfb6d12c..b92c54a9cf7 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.111.0 +version: 0.112.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 9c67b03bb09..88ddad2aebe 100644 --- a/commands/docs/explore_config.md +++ b/commands/docs/explore_config.md @@ -2,7 +2,7 @@ title: explore config categories: | viewers -version: 0.111.0 +version: 0.112.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 3233dd4381f..b7c3ec2596a 100644 --- a/commands/docs/explore_regex.md +++ b/commands/docs/explore_regex.md @@ -2,7 +2,7 @@ title: explore regex categories: | viewers -version: 0.111.0 +version: 0.112.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 70520ccdd1d..8e618e6d71b 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.111.0 +version: 0.112.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 bd6216dc0a0..4b0d7bb45c3 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.111.0 +version: 0.112.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 c1a59eb4250..1df5d3a7756 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.111.0 +version: 0.112.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 b26aae3b9b2..8119f3d5c29 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.111.0 +version: 0.112.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 a02076b5521..517b6bc2ca9 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.111.0 +version: 0.112.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 cb857de0ca7..4d9d5f0b737 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.111.0 +version: 0.112.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 54d01f5fa1f..1be18fc96f1 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.111.0 +version: 0.112.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 8d5bc348df3..42715c19dab 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.111.0 +version: 0.112.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 d2a41eed57c..3df078f04ff 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.111.0 +version: 0.112.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index c65f34ae727..fb2e532645a 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Fill and align text in columns. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 7273cba7b3b..cf66a560801 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 7f8eebd062e..bac4f82c44c 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Search for terms in the input data. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index 6c6f1820aa8..c1e06a2d86d 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | @@ -57,7 +57,7 @@ Return the first 2 items of a list/table. Return the first 2 bytes of a binary value. ```nu > 0x[01 23 45] | first 2 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 23 •# ``` diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 9928a6a718a..83adfe513a9 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Flatten a table by extracting nested values. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index 001aa3ca9c7..efd10fbe2d6 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.111.0 +version: 0.112.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index bbafedf3d33..7ec098dec6a 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index fac0e93685d..53834c4fb29 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.111.0 +version: 0.112.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 6a8da52747b..4a0724765b0 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.111.0 +version: 0.112.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 d5af5f03945..4d9dc74279d 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.111.0 +version: 0.112.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 6001c2617e0..0a1fdad94c1 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.111.0 +version: 0.112.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 2224330c038..2140b7c6963 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Format a number. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 859aa77f131..b2afc7afcfe 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.111.0 +version: 0.112.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 f812320ff8d..46fb074a641 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Parse a string or binary data into structured data. usage: | @@ -38,6 +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 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 518043bd15d..e28aed68096 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.111.0 +version: 0.112.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 4d18baff378..b549d8060cf 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.111.0 +version: 0.112.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 eaf57b1f4d1..61b34172261 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.111.0 +version: 0.112.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 bbae63eda0c..caabf9797d1 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.111.0 +version: 0.112.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 a9eb4649a77..c7d2227c98b 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert JSON text into structured data. usage: | diff --git a/commands/docs/from_md.md b/commands/docs/from_md.md new file mode 100644 index 00000000000..86308522b8b --- /dev/null +++ b/commands/docs/from_md.md @@ -0,0 +1,58 @@ +--- +title: from md +categories: | + formats +version: 0.112.0 +formats: | + Convert markdown text into structured data. +usage: | + Convert markdown text into structured data. +editLink: false +contributors: false +--- + + +# `from md` for [formats](/commands/categories/formats.md) + +
Convert markdown text into structured data.
+ +## Signature + +```> from md {flags} ``` + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | table | +## Examples + +Parse markdown and return key node fields. +```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 │ │ │ │ +│ │ │ │ │ ╰────────┴───╯ │ │ │ +│ │ │ ╰───────┴────────────────╯ │ │ +╰───┴──────┴────────────────────────────┴───────────────╯ + +``` + +Parse markdown frontmatter as a dedicated node. +```nu +> '--- +title: Demo +--- +# A' | from md | get 0.type +yaml +``` diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 3b5317c266a..f2106d1ca99 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index 632784176b8..a455fbb99d8 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.111.0 +version: 0.112.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 14227f93fa9..f74a0764564 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index e3fb2665ac4..0ec638eb22c 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.111.0 +version: 0.112.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 81b1fe81122..ad93d5e620c 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 1c8662e9d12..2c6f29b85d9 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.111.0 +version: 0.112.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 31ef8fa1911..b70b54a4b57 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.111.0 +version: 0.112.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 1e786399f68..fb448cbf35d 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.111.0 +version: 0.112.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 005c1f2f72a..e81c5812b53 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.111.0 +version: 0.112.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 a752b508d26..ecc1f7d37ea 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.111.0 +version: 0.112.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 3a7ed2375fc..41255428c46 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 17fcd7f01cb..6ffb2f9cf55 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.111.0 +version: 0.112.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 88ad91afea5..86d4c968f02 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.111.0 +version: 0.112.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 15f1ec37ea0..fbd8a38dfce 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Parse text as .yaml/.yml and create table. usage: | @@ -30,7 +30,7 @@ contributors: false Converts yaml formatted string to table. ```nu -> 'a: 1' | from yaml +> 'a: 1' | from yml ╭───┬───╮ │ a │ 1 │ ╰───┴───╯ @@ -38,7 +38,7 @@ Converts yaml formatted string to table. Converts yaml formatted string to table. ```nu -> '[ a: 1, b: [1, 2] ]' | from yaml +> '[ a: 1, b: [1, 2] ]' | from yml ╭───┬────┬───────────╮ │ # │ a │ b │ ├───┼────┼───────────┤ diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 57a54cf689d..9de76001f41 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.111.0 +version: 0.112.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 d7495b3a627..d302b23121d 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index a1c4ccb1c99..fbe5576af77 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.111.0 +version: 0.112.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 ef4012d1af4..1f64eba5384 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.111.0 +version: 0.112.0 viewers: | Renders the output to a textual terminal grid. usage: | diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index 516bd43c11f..c8871c1e433 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--to-table`: Return a table with "groups" and "items" columns. + - `--prune`: Remove a column after grouping, if applicable. ## Parameters @@ -191,7 +192,7 @@ Group items by column and delete the original. [jt, rs, "2019"], [storm, rs, "2021"] ] - | group-by lang | update cells { reject lang } + | group-by lang --prune ╭────┬───────────────────────╮ │ │ ╭───┬────────┬──────╮ │ │ rb │ │ # │ name │ year │ │ diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index ca836be0942..166608a2722 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.111.0 +version: 0.112.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index feb4f497fb8..96c6b5a2694 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.111.0 +version: 0.112.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 8db94099cbe..68c5b30cbdf 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.111.0 +version: 0.112.0 hash: | Hash a value using the md5 hash algorithm. usage: | @@ -31,12 +31,12 @@ contributors: false ## Input/output types: -| input | output | -| ------ | ------ | -| string | any | -| binary | any | -| table | table | -| record | record | +| input | output | +| ------ | --------------------- | +| string | oneof<string, binary> | +| binary | oneof<string, binary> | +| table | table | +| record | record | ## Examples Return the md5 hash of a string, hex-encoded @@ -48,7 +48,7 @@ c3fcd3d76192e4007dfb496cca67e13b Return the md5 hash of a string, as binary ```nu > 'abcdefghijklmnopqrstuvwxyz' | hash md5 --binary -Length: 16 (0x10) bytes | printable whitespace ascii_other non_ascii +Length: 16 (0x10) bytes | null_char printable whitespace ascii_other non_ascii 00000000: c3 fc d3 d7 61 92 e4 00 7d fb 49 6c ca 67 e1 3b ××××a××0}×Il×g×; ``` diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index e8269e01c5c..4d91d06a23e 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.111.0 +version: 0.112.0 hash: | Hash a value using the sha256 hash algorithm. usage: | @@ -31,12 +31,12 @@ contributors: false ## Input/output types: -| input | output | -| ------ | ------ | -| string | any | -| binary | any | -| table | table | -| record | record | +| input | output | +| ------ | --------------------- | +| string | oneof<string, binary> | +| binary | oneof<string, binary> | +| table | table | +| record | record | ## Examples Return the sha256 hash of a string, hex-encoded @@ -48,7 +48,7 @@ Return the sha256 hash of a string, hex-encoded Return the sha256 hash of a string, as binary ```nu > 'abcdefghijklmnopqrstuvwxyz' | hash sha256 --binary -Length: 32 (0x20) bytes | printable whitespace ascii_other non_ascii +Length: 32 (0x20) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 71 c4 80 df 93 d6 ae 2f 1e fa d1 44 7c 66 c9 52 q××××××/•××D|f×R 00000010: 5e 31 62 18 cf 51 fc 8d 9e d8 32 f2 da f1 8b 73 ^1b•×Q××××2××××s diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 5c5a74e0cd0..2c1552524c7 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.111.0 +version: 0.112.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 0b1a35d85ee..17489de7981 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.111.0 +version: 0.112.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 af829d980ec..c52672193dd 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.111.0 +version: 0.112.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 69cd64d8530..e80f011953e 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.111.0 +version: 0.112.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 4f7a15e38ed..feec130748f 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.111.0 +version: 0.112.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 5e5695aaf6f..a5be6b37159 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.111.0 +version: 0.112.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 384537a71df..a70b0b5a4d2 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.111.0 +version: 0.112.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 9d9ef4a396b..1fd5bcd4d82 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.111.0 +version: 0.112.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 c1905f783ef..7306456381c 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.111.0 +version: 0.112.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 3a72bec23db..0874f531f90 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.111.0 +version: 0.112.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 49708cea520..67d687af149 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.111.0 +version: 0.112.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index 44e61d38143..d19ea749905 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.111.0 +version: 0.112.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 35d4590a169..2a630394bc4 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.111.0 +version: 0.112.0 history: | Get the command history. usage: | diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index a5cebd1ae54..c43f180066e 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,7 +2,7 @@ title: history import categories: | history -version: 0.111.0 +version: 0.112.0 history: | Import command line history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 094ad8fa936..8c2476c9c07 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.111.0 +version: 0.112.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index fcd210f939a..c6f07bf5732 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.111.0 +version: 0.112.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 50e4df5a3a1..5924ff09a19 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.111.0 +version: 0.112.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 20090c76c1f..954c572b008 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.111.0 +version: 0.112.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 4f5d7a7d0e5..76540e6ddc3 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.111.0 +version: 0.112.0 network: | Get the headers from a URL. usage: | @@ -26,7 +26,9 @@ contributors: false - `--password, -p {any}`: The password when authenticating. - `--max-time, -m {duration}`: Max duration before timeout occurs. - `--headers, -H {any}`: Custom headers you want to add. + - `--full, -f`: Returns the full response instead of only the headers. - `--insecure, -k`: Allow insecure server connections when using SSL. + - `--allow-errors, -e`: Do not fail if the server returns an error code. - `--pool`: Using a global pool as a client. - `--redirect-mode, -R {string}`: What to do when encountering redirects. Default: 'follow'. Valid options: 'follow' ('f'), 'manual' ('m'), 'error' ('e'). - `--unix-socket, -U {path}`: Connect to the specified Unix socket instead of using TCP. diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 92f57a41b5f..78ef6a0b4ad 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.111.0 +version: 0.112.0 network: | Requests permitted communication options for a given URL. usage: | @@ -26,6 +26,7 @@ contributors: false - `--password, -p {any}`: The password when authenticating. - `--max-time, -m {duration}`: Max duration before timeout occurs. - `--headers, -H {any}`: Custom headers you want to add. + - `--full, -f`: Returns the full response instead of only the headers. - `--insecure, -k`: Allow insecure server connections when using SSL. - `--allow-errors, -e`: Do not fail if the server returns an error code. - `--pool`: Using a global pool as a client. @@ -49,6 +50,12 @@ Get options from example.com. ``` +Get the full OPTIONS response record (status, headers, etc.). +```nu +> http options --full https://www.example.com + +``` + Get options from example.com, with username and password. ```nu > http options --user myuser --password mypass https://www.example.com diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index eed70d0fbee..c361cf513a3 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.111.0 +version: 0.112.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 f8a17943696..063fe948d6c 100644 --- a/commands/docs/http_pool.md +++ b/commands/docs/http_pool.md @@ -2,7 +2,7 @@ title: http pool categories: | network -version: 0.111.0 +version: 0.112.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 ed3a8f293ae..688b0bd306b 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.111.0 +version: 0.112.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 43148f40cf8..1deac10b1ff 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.111.0 +version: 0.112.0 network: | Send a PUT request to a URL with a request body. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index 9b979aef33c..d3e0d2fead2 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.111.0 +version: 0.112.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 3c0e0f85003..0af8440674d 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.111.0 +version: 0.112.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 ba6eb4dd714..e075befc746 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.111.0 +version: 0.112.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 644e4e70d07..60ba7f45f09 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.111.0 +version: 0.112.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 e8725385c11..d9ddda7e5e3 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Display an interactive list for user selection. usage: | @@ -158,7 +158,7 @@ The closure receives each item and should return the string to display and searc The original value is always returned when selected, regardless of what --display shows. Keyboard shortcuts: -- Up/Down, j/k: Navigate items +- Up/Down, j/k, Ctrl+n/p: Navigate items - Left/Right, h/l: Scroll columns horizontally (table mode, single/multi) - Shift+Left/Right: Scroll columns horizontally (fuzzy mode) - Home/End: Jump to first/last item diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index e4b4c1ed519..0394867b79c 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Listen for user interface events. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index cb59b4eb839..372ffe7eb18 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | @@ -96,20 +96,16 @@ Insert a new value at the end of a list Insert into a nested path, creating new values as needed ```nu > [{} {a: [{}]}] | insert a.0.b "value" -╭───┬───────────────╮ -│ # │ a │ -├───┼───────────────┤ -│ 0 │ ╭───┬───────╮ │ -│ │ │ # │ b │ │ -│ │ ├───┼───────┤ │ -│ │ │ 0 │ value │ │ -│ │ ╰───┴───────╯ │ -│ 1 │ ╭───┬───────╮ │ -│ │ │ # │ b │ │ -│ │ ├───┼───────┤ │ -│ │ │ 0 │ value │ │ -│ │ ╰───┴───────╯ │ -╰───┴───────────────╯ +╭───┬───────────────────────────╮ +│ # │ a │ +├───┼───────────────────────────┤ +│ 0 │ ╭───┬───────╮ │ +│ │ │ b │ value │ │ +│ │ ╰───┴───────╯ │ +│ 1 │ ╭───┬───────────────────╮ │ +│ │ │ 0 │ {record 0 fields} │ │ +│ │ ╰───┴───────────────────╯ │ +╰───┴───────────────────────────╯ ``` diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index d18fb6d402e..0143100ad93 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 42f4fa82ba1..d846fa5057b 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.111.0 +version: 0.112.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 746656a12a9..542220e2d82 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.111.0 +version: 0.112.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 648e6406711..3c7e442c78a 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a binary primitive. usage: | @@ -48,7 +48,7 @@ contributors: false convert string to a nushell binary primitive. ```nu > 'This is a string that is exactly 52 characters long.' | into binary -Length: 52 (0x34) bytes | printable whitespace ascii_other non_ascii +Length: 52 (0x34) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 54 68 69 73 20 69 73 20 61 20 73 74 72 69 6e 67 This is a string 00000010: 20 74 68 61 74 20 69 73 20 65 78 61 63 74 6c 79 that is exactly 00000020: 20 35 32 20 63 68 61 72 61 63 74 65 72 73 20 6c 52 characters l @@ -59,7 +59,7 @@ Length: 52 (0x34) bytes | printable whitespace ascii_other non_ascii convert a number to a nushell binary primitive. ```nu > 1 | into binary -Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii +Length: 8 (0x8) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 00 00 00 00 00 00 00 •0000000 ``` @@ -67,7 +67,7 @@ Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii convert a number to a nushell binary primitive (big endian). ```nu > 258 | into binary --endian big -Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii +Length: 8 (0x8) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 00 00 00 00 00 00 01 02 000000•• ``` @@ -75,7 +75,7 @@ Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii convert a number to a nushell binary primitive (little endian). ```nu > 258 | into binary --endian little -Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii +Length: 8 (0x8) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 02 01 00 00 00 00 00 00 ••000000 ``` @@ -83,7 +83,7 @@ Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii convert a boolean to a nushell binary primitive. ```nu > true | into binary -Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii +Length: 8 (0x8) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 00 00 00 00 00 00 00 •0000000 ``` @@ -103,7 +103,7 @@ convert a filepath to a nushell binary primitive. convert a float to a nushell binary primitive. ```nu > 1.234 | into binary -Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii +Length: 8 (0x8) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 58 39 b4 c8 76 be f3 3f X9××v××? ``` @@ -111,7 +111,7 @@ Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii convert an int to a nushell binary primitive with compact enabled. ```nu > 10 | into binary --compact -Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +Length: 1 (0x1) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 0a _ ``` diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 089e41475eb..fdb7888cd47 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.111.0 +version: 0.112.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 b76f424acd2..7534355f9dc 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.111.0 +version: 0.112.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index ab34ed87c52..efa60fd713b 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -22,8 +22,8 @@ contributors: false ## Flags - - `--timezone, -z {string}`: Specify timezone if the input is a Unix timestamp. Valid options: 'UTC' ('u') or 'LOCAL' ('l'). - - `--offset, -o {int}`: Specify timezone by offset from UTC if the input is a Unix timestamp, like '+8', '-4'. + - `--timezone, -z {string}`: Specify timezone to interpret timestamps and formatted datetime input. Valid options: 'UTC' ('u') or 'LOCAL' ('l'). + - `--offset, -o {int}`: Specify timezone by offset from UTC to interpret timestamps and formatted datetime input, like '+8', '-4'. - `--format, -f {string}`: Specify expected format of INPUT string to parse to datetime. Use --list to see options. - `--list, -l`: Show all possible variables for use in --format flag. @@ -92,14 +92,14 @@ Sat, 27 Feb 2021 13:55:40 +0000 (5 years ago) Using a record as input. ```nu > {year: 2025, month: 3, day: 30, hour: 12, minute: 15, second: 59, timezone: '+02:00'} | into datetime -Sun, 30 Mar 2025 10:15:59 +0000 (11 months ago) +Sun, 30 Mar 2025 10:15:59 +0000 (a year ago) ``` Convert list of timestamps to datetimes. ```nu > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime ╭───┬─────────────╮ -│ 0 │ 2 years ago │ +│ 0 │ 3 years ago │ │ 1 │ 2 years ago │ │ 2 │ 2 years ago │ ╰───┴─────────────╯ diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index c2ae9b873b7..8b4871df2e3 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a duration. usage: | @@ -75,6 +75,18 @@ Convert duration to duration. 7min ``` +Convert `hh:mm:ss`-style string to duration +```nu +> '3:34:00' | into duration +3hr 34min +``` + +Convert `hh:mm:ss.f`-style string to duration +```nu +> '2:45:31.2' | into duration +2hr 45min 31sec 200ms +``` + Convert a number of ns to duration. ```nu > 1_234_567 | into duration diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 28b1fbcaea4..9442e471509 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 37b30d20c24..6f93f69e057 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 3c8f7ab3904..acfe2e48c1f 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a glob pattern. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index ca4b4ece390..111a51d706e 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to an integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index fe66d8d5832..d61bb2cd8e2 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 44998087486..4882a76e2ab 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index f39a9474d9e..520dcbcbc13 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert value to a string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 45520295797..3f4c3eac463 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | conversions -version: 0.111.0 +version: 0.112.0 conversions: | Convert custom values into base values. usage: | @@ -20,11 +20,6 @@ contributors: false ```> into value {flags} ``` -## Flags - - - `--columns, -c {list}`: List of columns to update. - - `--prefer-filesizes, -f`: For ints display them as human-readable file sizes. - ## Input/output types: diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 024f374051e..365c3ca8167 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.111.0 +version: 0.112.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 87261e37484..d22afd21cff 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 3b5add13093..03598a09dc5 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.111.0 +version: 0.112.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index e407e2dbd82..1d13159a01e 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.111.0 +version: 0.112.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 e2a10f1a8c8..d8d0a48b726 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.111.0 +version: 0.112.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 c2423065908..5fa9d3b0085 100644 --- a/commands/docs/job.md +++ b/commands/docs/job.md @@ -2,7 +2,7 @@ title: job categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Various commands for working with background jobs. usage: | @@ -33,6 +33,7 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | ------------------------------------------------ | -------------------------------------------- | -------- | +| [`job describe`](/commands/docs/job_describe.md) | Add a description to a background job. | built-in | | [`job flush`](/commands/docs/job_flush.md) | Clear this job's mailbox. | built-in | | [`job id`](/commands/docs/job_id.md) | Get id of current job. | built-in | | [`job kill`](/commands/docs/job_kill.md) | Kill a background job. | built-in | @@ -40,5 +41,4 @@ You must use one of the following subcommands. Using this command as-is will onl | [`job recv`](/commands/docs/job_recv.md) | Read a message from a job's mailbox. | built-in | | [`job send`](/commands/docs/job_send.md) | Send a message to the mailbox of a job. | built-in | | [`job spawn`](/commands/docs/job_spawn.md) | Spawn a background job and retrieve its ID. | built-in | -| [`job tag`](/commands/docs/job_tag.md) | Add a description tag to a background job. | built-in | | [`job unfreeze`](/commands/docs/job_unfreeze.md) | Unfreeze a frozen process job in foreground. | built-in | \ No newline at end of file diff --git a/commands/docs/job_describe.md b/commands/docs/job_describe.md new file mode 100644 index 00000000000..e3e94862ab7 --- /dev/null +++ b/commands/docs/job_describe.md @@ -0,0 +1,46 @@ +--- +title: job describe +categories: | + experimental +version: 0.112.0 +experimental: | + Add a description to a background job. +usage: | + Add a description to a background job. +editLink: false +contributors: false +--- + + +# `job describe` for [experimental](/commands/categories/experimental.md) + +
Add a description to a background job.
+ +## Signature + +```> job describe {flags} (id) (description)``` + +## Parameters + + - `id`: The id of the job to describe. + - `description`: The description to assign to the job. + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | +## Examples + +Describe a newly spawned job. +```nu +> let id = job spawn { sleep 10sec }; job describe $id abc + +``` + +Remove the description of a job. +```nu +> let id = job spawn { sleep 10sec }; job describe $id abc; job describe $id null + +``` diff --git a/commands/docs/job_flush.md b/commands/docs/job_flush.md index a41bc1d73ab..31a8cbb2864 100644 --- a/commands/docs/job_flush.md +++ b/commands/docs/job_flush.md @@ -2,7 +2,7 @@ title: job flush categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Clear this job's mailbox. usage: | diff --git a/commands/docs/job_id.md b/commands/docs/job_id.md index 709f5181c37..4fb2847e8b4 100644 --- a/commands/docs/job_id.md +++ b/commands/docs/job_id.md @@ -2,7 +2,7 @@ title: job id categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Get id of current job. usage: | diff --git a/commands/docs/job_kill.md b/commands/docs/job_kill.md index 5c6ced79be8..f4a424e7801 100644 --- a/commands/docs/job_kill.md +++ b/commands/docs/job_kill.md @@ -2,7 +2,7 @@ title: job kill categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Kill a background job. usage: | diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md index 625b411740f..c2df916190d 100644 --- a/commands/docs/job_list.md +++ b/commands/docs/job_list.md @@ -2,7 +2,7 @@ title: job list categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | List background jobs. usage: | diff --git a/commands/docs/job_recv.md b/commands/docs/job_recv.md index bfc85ea9600..82abb7b9c68 100644 --- a/commands/docs/job_recv.md +++ b/commands/docs/job_recv.md @@ -2,7 +2,7 @@ title: job recv categories: | experimental -version: 0.111.0 +version: 0.112.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 62799d9d771..144ce8b424f 100644 --- a/commands/docs/job_send.md +++ b/commands/docs/job_send.md @@ -2,7 +2,7 @@ title: job send categories: | experimental -version: 0.111.0 +version: 0.112.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 22ebb4ff95b..6bfc3ff0216 100644 --- a/commands/docs/job_spawn.md +++ b/commands/docs/job_spawn.md @@ -2,7 +2,7 @@ title: job spawn categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Spawn a background job and retrieve its ID. usage: | @@ -22,7 +22,7 @@ contributors: false ## Flags - - `--tag, -t {string}`: An optional description tag for this job. + - `--description, -d {string}`: An optional description for this job. ## Parameters diff --git a/commands/docs/job_tag.md b/commands/docs/job_tag.md deleted file mode 100644 index 3e189ea2370..00000000000 --- a/commands/docs/job_tag.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: job tag -categories: | - experimental -version: 0.111.0 -experimental: | - Add a description tag to a background job. -usage: | - Add a description tag to a background job. -editLink: false -contributors: false ---- - - -# `job tag` for [experimental](/commands/categories/experimental.md) - -
Add a description tag to a background job.
- -## Signature - -```> job tag {flags} (id) (tag)``` - -## Parameters - - - `id`: The id of the job to tag. - - `tag`: The tag to assign to the job. - - -## Input/output types: - -| input | output | -| ------- | ------- | -| nothing | nothing | -## Examples - -Tag a newly spawned job. -```nu -> let id = job spawn { sleep 10sec }; job tag $id abc - -``` - -Remove the tag of a job. -```nu -> let id = job spawn { sleep 10sec }; job tag $id abc; job tag $id null - -``` diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md index 50d807e580e..a0ac4af95ee 100644 --- a/commands/docs/job_unfreeze.md +++ b/commands/docs/job_unfreeze.md @@ -2,7 +2,7 @@ title: job unfreeze categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Unfreeze a frozen process job in foreground. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 76588c31aed..7ab0092d87c 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 5403d262bf7..55483518873 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 3ec4a6f0728..b33aac5eacf 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index d5867c7741e..7a9a7254cbb 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.111.0 +version: 0.112.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 c3738f89368..48f0dded491 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 6edd2b2d5f7..28b1e5bcbc8 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Kill a process using its process ID. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 3fa400b9bfd..2af78f5677e 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | @@ -57,7 +57,7 @@ Return the last item of a list/table. Return the last 2 bytes of a binary value. ```nu > 0x[01 23 45] | last 2 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 23 45 #E ``` diff --git a/commands/docs/length.md b/commands/docs/length.md index f66a3172c2f..a4ab6e0c062 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.111.0 +version: 0.112.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 dc1a92d12c4..0920d2b814b 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.111.0 +version: 0.112.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 e07d5c05cad..f02a2e99408 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.111.0 +version: 0.112.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 50da348387a..33feef1bb1f 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index e498a95ac2d..664ca422db5 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 8d9022a0ef9..de7c5d13bea 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.111.0 +version: 0.112.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index c4676c104b4..f3951de7d8a 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.111.0 +version: 0.112.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 aef11b5ed56..133e2385720 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.111.0 +version: 0.112.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 5ec1a39e59f..f8d44d23f1a 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.111.0 +version: 0.112.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 0a866523deb..cc0400222ae 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.111.0 +version: 0.112.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 a274e83a4de..343828568a8 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 9135d4afe3a..5331c288006 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.111.0 +version: 0.112.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 c72a7c790ac..785c5d3b5a9 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index de8b2efac14..1cf9f84460c 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.111.0 +version: 0.112.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 daee35cdc23..bfdd5eda3c2 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 19940f572de..36c4f8966ec 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.111.0 +version: 0.112.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 3d1547df41e..61a73e074bf 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.111.0 +version: 0.112.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 232cfd5915a..c0e0ef9850e 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.111.0 +version: 0.112.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 90a40796e6e..77a43f2f06f 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 7d9af55fe14..d39fc8cbf59 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.111.0 +version: 0.112.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 29748d4ea8f..172df90c83e 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.111.0 +version: 0.112.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 6e0cdd7c94d..1af1a48831c 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.111.0 +version: 0.112.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 1be846c466c..540e7cd464b 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.111.0 +version: 0.112.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 5f1010fa6e3..1acb6cb9a02 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.111.0 +version: 0.112.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 957d6ac7528..f4d88461421 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.111.0 +version: 0.112.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 db391b2ef55..0c302317c02 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.111.0 +version: 0.112.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 90e12734dc0..89dbfba14d2 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.111.0 +version: 0.112.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 c38354d4f1d..9e8b1056742 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.111.0 +version: 0.112.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 f8ebf6bb655..588d51b4998 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.111.0 +version: 0.112.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 594bc1eb274..f12e4eaaac1 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.111.0 +version: 0.112.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 6af59e6f622..89ccb3b136f 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 18a7db25eda..26517b3629c 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.111.0 +version: 0.112.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 6ad353c40f5..433ffbb0c94 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.111.0 +version: 0.112.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 2d881219c1f..721d63e1d0c 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.111.0 +version: 0.112.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 16c72e1f3e5..ff8fb3014e4 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.111.0 +version: 0.112.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 e0d130c6c7e..6ca1bf7ed20 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.111.0 +version: 0.112.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 818fc9bf01a..c4892eac3da 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.111.0 +version: 0.112.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 54177d57cf9..d08e8d90275 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.111.0 +version: 0.112.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 5d738b88ffe..2b60f25afb1 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.111.0 +version: 0.112.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 8bc0105fc48..3dc9c99186e 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.111.0 +version: 0.112.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 c1818f9cbe2..d77f5a221ad 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.111.0 +version: 0.112.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 7ed9105d952..85ceb3f8643 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.111.0 +version: 0.112.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 b47b56a931b..cf6e32c90cf 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Set the metadata for items in the stream. usage: | @@ -24,9 +24,8 @@ contributors: false - `--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}`: Assign path columns metadata to the input. - - `--content-type, -c {string}`: Assign content type metadata to the input. - - `--merge, -m {record}`: Merge arbitrary metadata fields. + - `--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. ## Parameters @@ -58,10 +57,10 @@ Set the content type metadata. text/plain ``` -Set custom metadata. +Merge custom metadata. ```nu -> "data" | metadata set --merge {custom_key: "value"} | metadata | get custom_key -value +> "data" | metadata set {|| merge {custom_key: "value"}} | metadata | get custom_key + ``` Set metadata using a closure. diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 91fc423c418..20060a64566 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 53766c53bbc..30e8a421028 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.111.0 +version: 0.112.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 2843f01cee0..3dda35493ec 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.111.0 +version: 0.112.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index d3064b3c850..48b9d568d0d 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.111.0 +version: 0.112.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 bc7df59f5d9..1eab430325d 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.111.0 +version: 0.112.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 3fb3c8759cc..69139f73e23 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index d3a1d3fe363..5eeaa7114ad 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Validate and parse Nushell input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 3cb9ec0fe11..d81fadaa678 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 0d97f82b963..5fd9c0d319d 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.111.0 +version: 0.112.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 a2e38148470..1b68b10e30f 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.111.0 +version: 0.112.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 7c5ada4a9d4..3bf520cd684 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.111.0 +version: 0.112.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 72149cd0bc8..52665e9708e 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.111.0 +version: 0.112.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 c5678c9e5e7..704a293ec9e 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.111.0 +version: 0.112.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 9bbdefae892..120ced94920 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.111.0 +version: 0.112.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 5a9eac85568..022b033e92b 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 3303e4aa8c7..4e31689815c 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.111.0 +version: 0.112.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 5473d0176f1..5884d956fd0 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.111.0 +version: 0.112.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 cb9e6fd065d..b01eec262a5 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.111.0 +version: 0.112.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 256c02ae8a7..65c84f0ca55 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.111.0 +version: 0.112.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 0124cd6b46a..c8530d5de25 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.111.0 +version: 0.112.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 bb386ca7837..3661926c254 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.111.0 +version: 0.112.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 0bf856de9ef..a49f9d35c20 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.111.0 +version: 0.112.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 1cde7f2876b..0f20d35a3cb 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.111.0 +version: 0.112.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 6049004c05c..f780cbedf25 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.111.0 +version: 0.112.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 4afe613584c..8ae48699867 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.111.0 +version: 0.112.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 44b34d8342d..4dce92ffcfc 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.111.0 +version: 0.112.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 6b0bcbb1720..6268587302c 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.111.0 +version: 0.112.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 28af5f49649..614794d73ed 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.111.0 +version: 0.112.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index ff3966aa2fa..817557451f1 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.111.0 +version: 0.112.0 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 4ca77331516..72a476d8772 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.111.0 +version: 0.112.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 135da29ce4e..65124c06f25 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.111.0 +version: 0.112.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.111.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ 0 │ inc │ 0.112.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 fe46e785d31..298682673df 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.111.0 +version: 0.112.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 351af31c5bd..423a1c87577 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.111.0 +version: 0.112.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 4d7d60388e2..2ae0267fb0b 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.111.0 +version: 0.112.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 b3c75ea15c5..855ac6f5052 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -45,141 +45,150 @@ 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 first`](/commands/docs/polars_selector_first.md) | Creates a selector that selects the first column(s) by index. | plugin | -| [`polars selector last`](/commands/docs/polars_selector_last.md) | Creates a selector that selects the last column(s) by index. | 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 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 diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index 3fb87d3d1f1..93ec6df049c 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.111.0 +version: 0.112.0 dataframe: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 6a957960041..ed5102eedda 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.111.0 +version: 0.112.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 94640407ab6..ffc62590685 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.111.0 +version: 0.112.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 21e5d2b993f..d7280e402c7 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.111.0 +version: 0.112.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 49aadd3f7ab..2264c3dfdf5 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 774c9541d73..5caeedf80d0 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.111.0 +version: 0.112.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 c10372f104e..4cbf2c721e8 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.111.0 +version: 0.112.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 3ce694ce02b..5a4ddc4f12e 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.111.0 +version: 0.112.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 0566c6ec828..c64ec33c8e0 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.111.0 +version: 0.112.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 67c41514a8f..9014c9184c5 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.111.0 +version: 0.112.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 425fdfb6ad3..5470aeaa242 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.111.0 +version: 0.112.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 4ce2e0ce25a..6f7b38725d0 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.111.0 +version: 0.112.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 11d21ec46e6..144a29dac1b 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.111.0 +version: 0.112.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 │ 3 months ago │ -│ 1 │ 3 months ago │ -│ 2 │ 3 months ago │ -│ 3 │ 3 months ago │ +│ 0 │ 5 months ago │ +│ 1 │ 5 months ago │ +│ 2 │ 5 months ago │ +│ 3 │ 5 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 9a1150856fd..fe2d87f1384 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index 01c631f79e7..b8ce4fac1e3 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 86922f871f4..48d34d07046 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.111.0 +version: 0.112.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 c4a92d8ad3c..7077aed5f34 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 5fa2014d557..bf8f9f6e1d4 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.111.0 +version: 0.112.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index 62e36321a65..49c2227df89 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 94df801a7ac..0156489cc73 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.111.0 +version: 0.112.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index 9425ec7dfe5..c0fc444d5ca 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Concatenate two or more dataframes. usage: | diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 9dca42fb357..d512c19e111 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.111.0 +version: 0.112.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 71774525551..d78e84d69b9 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.111.0 +version: 0.112.0 dataframe: | Convert datetime to target timezone. usage: | @@ -38,12 +38,12 @@ Convert timezone for timezone-aware datetime > ["2025-04-10 09:30:00 -0400" "2025-04-10 10:30:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z" | polars select (polars col datetime | polars convert-time-zone "Europe/Lisbon") -╭───┬───────────────╮ -│ # │ datetime │ -├───┼───────────────┤ -│ 0 │ 10 months ago │ -│ 1 │ 10 months ago │ -╰───┴───────────────╯ +╭───┬────────────╮ +│ # │ datetime │ +├───┼────────────┤ +│ 0 │ a year ago │ +│ 1 │ a year ago │ +╰───┴────────────╯ ``` @@ -52,11 +52,11 @@ Timezone conversions for timezone-naive datetime will assume the original timezo > ["2025-04-10 09:30:00" "2025-04-10 10:30:00"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S" --naive | polars select (polars col datetime | polars convert-time-zone "America/New_York") -╭───┬───────────────╮ -│ # │ datetime │ -├───┼───────────────┤ -│ 0 │ 10 months ago │ -│ 1 │ 10 months ago │ -╰───┴───────────────╯ +╭───┬────────────╮ +│ # │ datetime │ +├───┼────────────┤ +│ 0 │ a year ago │ +│ 1 │ a year ago │ +╰───┴────────────╯ ``` diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index f5fdc187609..c4030099cca 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.111.0 +version: 0.112.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 9236c7df8e9..3947324a7e6 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.111.0 +version: 0.112.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 13e01cfa260..8f816d1d9d3 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.111.0 +version: 0.112.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 4a784aa7c95..134df8f322e 100644 --- a/commands/docs/polars_cut.md +++ b/commands/docs/polars_cut.md @@ -2,7 +2,7 @@ title: polars cut categories: | dataframe -version: 0.111.0 +version: 0.112.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 7591a41c3c2..344d56e3f0d 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.111.0 +version: 0.112.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 25eebd0982b..519497c24a6 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.111.0 +version: 0.112.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 ab333ee13d9..eaf5648cc4f 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.111.0 +version: 0.112.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 6696d3387fb..66fb9a1b07a 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.111.0 +version: 0.112.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index bf76f08fdcf..569ff7f42ef 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.111.0 +version: 0.112.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 7da94656385..7c3a916a514 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.111.0 +version: 0.112.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 bfcf20306f5..46074ee3e46 100644 --- a/commands/docs/polars_entropy.md +++ b/commands/docs/polars_entropy.md @@ -2,7 +2,7 @@ title: polars entropy categories: | dataframe -version: 0.111.0 +version: 0.112.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 bea348fad65..d53622ebbf7 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.111.0 +version: 0.112.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -20,9 +20,14 @@ contributors: false ```> polars explode {flags} ...rest``` +## Flags + + - `--empty-as-null`: Explode an empty list into a `null` + - `--keep-nulls`: Explode a `null` into a `null` + ## Parameters - - `...rest`: Columns to explode, only applicable for dataframes. + - `...rest`: A polars selector or columns to explode, only applicable for dataframes ## Input/output types: diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 38f8b04c10c..834a5bb1aaa 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.111.0 +version: 0.112.0 dataframe: | Creates a not expression. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index e0ebe785ac6..f1aba0ec733 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.111.0 +version: 0.112.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 ff7cb3c2cd6..20ee94ed87c 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.111.0 +version: 0.112.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 853d196210b..7842a7bde55 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.111.0 +version: 0.112.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 996aac42f99..7dd5ce3e20f 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.111.0 +version: 0.112.0 lazyframe: | Filter dataframe based in expression. usage: | @@ -49,12 +49,12 @@ Filter dataframe using an expression Filter dataframe for rows where dt is within the last 2 days of the maximum dt value ```nu > [[dt val]; [2025-04-01 1] [2025-04-02 2] [2025-04-03 3] [2025-04-04 4]] | polars into-df | polars filter ((polars col dt) > ((polars col dt | polars max | $in - 2day))) -╭───┬───────────────┬─────╮ -│ # │ dt │ val │ -├───┼───────────────┼─────┤ -│ 0 │ 11 months ago │ 3 │ -│ 1 │ 11 months ago │ 4 │ -╰───┴───────────────┴─────╯ +╭───┬────────────┬─────╮ +│ # │ dt │ val │ +├───┼────────────┼─────┤ +│ 0 │ a year ago │ 3 │ +│ 1 │ a year ago │ 4 │ +╰───┴────────────┴─────╯ ``` diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index 6ac9373ca4b..d0ce9f535f8 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.111.0 +version: 0.112.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 07d929c8448..06ab065d5d6 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.111.0 +version: 0.112.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 7570e44d73f..5819299ce4f 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.111.0 +version: 0.112.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 62e22b058d3..a77a7d8297b 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.111.0 +version: 0.112.0 dataframe: | Gets hour from datetime. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 71911a4830e..78efffb97e9 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.111.0 +version: 0.112.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index dde89af55b1..3a19f5cb47c 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.111.0 +version: 0.112.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index fa426f4f551..35a247fde08 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.111.0 +version: 0.112.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 3e8682125e1..0053c7007e1 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.111.0 +version: 0.112.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 352c9e9f5fa..95372749037 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.111.0 +version: 0.112.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 550a4edaab3..f43ad2a759c 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.111.0 +version: 0.112.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 2f33bdcba5c..68f71f810b2 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.111.0 +version: 0.112.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 5809db12c86..84a7c4720ec 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.111.0 +version: 0.112.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 8ea74d83232..d7d4be1540a 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.111.0 +version: 0.112.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 be94b464008..00d192485fc 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.111.0 +version: 0.112.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 6f71deceb05..c0ea1be74c0 100644 --- a/commands/docs/polars_horizontal.md +++ b/commands/docs/polars_horizontal.md @@ -2,7 +2,7 @@ title: polars horizontal categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Horizontal calculation across multiple columns. usage: | diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index f3a9f5b262f..42cbb4ebf40 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Aggregates values into a list. usage: | diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index c89a60077bc..718720646fe 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.111.0 +version: 0.112.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 f64e2fb77e6..9154fd2fd88 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.111.0 +version: 0.112.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 ae71f3d4cac..e2a1fcce3cb 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.111.0 +version: 0.112.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 261ec9d9c44..341d9b768a9 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.111.0 +version: 0.112.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 cb6cf558696..3a77b58d8fd 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.111.0 +version: 0.112.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 f518bdb6fe2..2dddcd684d1 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.111.0 +version: 0.112.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 a24d4e1c32a..9d84b90b7f0 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.111.0 +version: 0.112.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 b2e8c62ab73..ee53118aee0 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.111.0 +version: 0.112.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 8aff1641cbc..7d887262b7b 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.111.0 +version: 0.112.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 c58c30d29d7..e8b105bc57d 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.111.0 +version: 0.112.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 ba87a002bcc..9571698f965 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.111.0 +version: 0.112.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 cd92221684a..34938c43c5b 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.111.0 +version: 0.112.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 cb711e1fb37..a5b22686ed9 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.111.0 +version: 0.112.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 b18d6f3a18c..6e93f7e7d1d 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.111.0 +version: 0.112.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 4c548f0b6e1..82c1c0e7bf4 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.111.0 +version: 0.112.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 4d541cff75d..e72c1554999 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Return the number of rows in the context. This is similar to COUNT(*) in SQL. usage: | diff --git a/commands/docs/polars_list-contains.md b/commands/docs/polars_list-contains.md index 868e9038b72..da502a3a56f 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.111.0 +version: 0.112.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 ef875a8504c..fe843d55855 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index 5d6c37e0f5a..e5588243360 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/polars_math.md b/commands/docs/polars_math.md index b6b720ad6cf..d08de9b81d8 100644 --- a/commands/docs/polars_math.md +++ b/commands/docs/polars_math.md @@ -2,7 +2,7 @@ title: polars math categories: | dataframe -version: 0.111.0 +version: 0.112.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 23131e28738..ca96ee6dc3a 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.111.0 +version: 0.112.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 a08be3fcfc3..45ee26e428f 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.111.0 +version: 0.112.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 ddbf84e4ca6..00e583c8ff9 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.111.0 +version: 0.112.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 f4c5025dff9..8eeb93ce372 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.111.0 +version: 0.112.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 46b3ca1edd0..dd3c79dddf1 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.111.0 +version: 0.112.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index c8dd9eb4c51..186cf9b7a15 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 10100f70755..11cdd8a4a50 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.111.0 +version: 0.112.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 cdefa8775f9..d9f65e56f31 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_over.md b/commands/docs/polars_over.md index ec838cb9be7..069bf2117c3 100644 --- a/commands/docs/polars_over.md +++ b/commands/docs/polars_over.md @@ -2,7 +2,7 @@ title: polars over categories: | lazyframe -version: 0.111.0 +version: 0.112.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 b60e0e5c79b..48f5211a9be 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Pivot a DataFrame from long to wide format. usage: | @@ -22,13 +22,14 @@ contributors: false ## Flags - - `--on, -o {list}`: Column names for pivoting. - - `--index, -i {list}`: Column names for indexes. - - `--values, -v {list}`: Column names used as value columns. + - `--on, -o {any}`: Column names for pivoting. + - `--on-cols, -c {any}`: column names used as value columns + - `--index, -i {any}`: Selector or column names for indexes. + - `--values {any}`: Selector or column names used as value columns. - `--aggregate, -a {any}`: Aggregation to apply when pivoting. The following are supported: first, sum, min, max, mean, median, count, last, or a custom expression. - `--separator, -p {string}`: Delimiter in generated column names in case of multiple `values` columns (default '_'). - - `--sort, -s`: Sort columns. - - `--streamable, -t`: Whether or not to use the polars streaming engine. Only valid for lazy dataframes. + - `--maintain-order`: Maintain Order. + - `--streamable, -t`: Whether or not to use the polars streaming engine. Only valid for lazy dataframes - `--stable`: Perform a stable pivot. @@ -40,26 +41,65 @@ contributors: false | polars_lazyframe | polars_lazyframe | ## Examples -Perform a pivot in order to show individuals test score by subject +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 ```nu -> [[name subject date test_1 test_2]; [Cady maths 2025-04-01 98 100] [Cady physics 2025-04-01 99 100] [Karen maths 2025-04-02 61 60] [Karen physics 2025-04-02 58 60]] | polars into-df | polars pivot --on [subject] --index [name date] --values [test_1] -╭───┬───────┬───────────────┬───────┬─────────╮ -│ # │ name │ date │ maths │ physics │ -├───┼───────┼───────────────┼───────┼─────────┤ -│ 0 │ Cady │ 11 months ago │ 98 │ 99 │ -│ 1 │ Karen │ 11 months ago │ 61 │ 58 │ -╰───┴───────┴───────────────┴───────┴─────────╯ +> { + "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 --on-cols [maths physics] --index name --values test_1 | + polars sort-by name maths physics | + polars collect +╭───┬───────┬───────┬─────────╮ +│ # │ name │ maths │ physics │ +├───┼───────┼───────┼─────────┤ +│ 0 │ Cady │ 98 │ 99 │ +│ 1 │ Karen │ 61 │ 58 │ +╰───┴───────┴───────┴─────────╯ ``` -Perform a pivot with multiple `values` columns with a separator +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 -> [[name subject date test_1 test_2 grade_1 grade_2]; [Cady maths 2025-04-01 98 100 A A] [Cady physics 2025-04-01 99 100 A A] [Karen maths 2025-04-02 61 60 D D] [Karen physics 2025-04-02 58 60 D D]] | polars into-df | polars pivot --on [subject] --index [name] --values [test_1 grade_1] --separator / -╭───┬───────┬──────────────┬────────────────┬───────────────┬─────────────────╮ -│ # │ name │ test_1/maths │ test_1/physics │ grade_1/maths │ grade_1/physics │ -├───┼───────┼──────────────┼────────────────┼───────────────┼─────────────────┤ -│ 0 │ Cady │ 98 │ 99 │ A │ A │ -│ 1 │ Karen │ 61 │ 58 │ D │ D │ -╰───┴───────┴──────────────┴────────────────┴───────────────┴─────────────────╯ +> { + "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 --on-cols [maths physics] --index name --values (polars selector starts-with test) | + polars sort-by name test_1_maths test_1_physics test_2_maths test_2_physics | + polars collect +╭───┬───────┬──────────────┬────────────────┬──────────────┬────────────────╮ +│ # │ name │ test_1_maths │ test_1_physics │ test_2_maths │ test_2_physics │ +├───┼───────┼──────────────┼────────────────┼──────────────┼────────────────┤ +│ 0 │ Cady │ 98 │ 99 │ 100 │ 100 │ +│ 1 │ Karen │ 61 │ 58 │ 60 │ 60 │ +╰───┴───────┴──────────────┴────────────────┴──────────────┴────────────────╯ + +``` + +Given a DataFrame with duplicate entries for the pivot columns, use the `aggregate` flag to specify how to aggregate values for those duplicates. In this example, we sum the `foo` and `bar` values for rows with the same `ix` and `col` values. +```nu +> { + "ix": [1, 1, 2, 2, 1, 2], + "col": ["a", "a", "a", "a", "b", "b"], + "foo": [0, 1, 2, 2, 7, 1], + "bar": [0, 2, 0, 0, 9, 4], + } | + polars into-df --as-columns | + polars pivot --on col --on-cols [a b] --index ix --aggregate sum | + polars sort-by ix foo_a foo_b bar_a bar_b | + polars collect +╭───┬────┬───────┬───────┬───────┬───────╮ +│ # │ ix │ foo_a │ foo_b │ bar_a │ bar_b │ +├───┼────┼───────┼───────┼───────┼───────┤ +│ 0 │ 1 │ 1 │ 7 │ 2 │ 9 │ +│ 1 │ 2 │ 4 │ 1 │ 0 │ 4 │ +╰───┴────┴───────┴───────┴───────┴───────╯ ``` diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index 1e29ad97806..ff7cc3b4704 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Profile a lazy dataframe. usage: | diff --git a/commands/docs/polars_qcut.md b/commands/docs/polars_qcut.md index 1b618bbc324..e5a89f8861c 100644 --- a/commands/docs/polars_qcut.md +++ b/commands/docs/polars_qcut.md @@ -2,7 +2,7 @@ title: polars qcut categories: | dataframe -version: 0.111.0 +version: 0.112.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 36e452fde3a..767379ce479 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.111.0 +version: 0.112.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 5ede4d5dc07..826914f9d93 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.111.0 +version: 0.112.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 0de16cbf07b..8e05997b630 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.111.0 +version: 0.112.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 32fd70b5f71..f85bb1eb564 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.111.0 +version: 0.112.0 dataframe: | Replace the timezone information in a datetime column. usage: | @@ -65,10 +65,10 @@ Apply timezone with ambiguous datetime ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 3 months ago │ +│ 0 │ 5 months ago │ │ 1 │ │ -│ 2 │ 3 months ago │ -│ 3 │ 3 months ago │ +│ 2 │ 5 months ago │ +│ 3 │ 5 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 346cbe33355..f14a112838e 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | expression -version: 0.111.0 +version: 0.112.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 227d2ca68ee..340b7d18c4e 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 405f6660ec8..3214cd53cc1 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index 8d84fda063a..c202bfdef39 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index c8864d2f826..0b077d68e95 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.111.0 +version: 0.112.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 ac41b385246..213f13191df 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.111.0 +version: 0.112.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index c575bf3d172..97d681e93e0 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.111.0 +version: 0.112.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_selector.md b/commands/docs/polars_selector.md index fc8812c60c9..afae66fb1a2 100644 --- a/commands/docs/polars_selector.md +++ b/commands/docs/polars_selector.md @@ -2,7 +2,7 @@ title: polars selector categories: | expression -version: 0.111.0 +version: 0.112.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 93c712ac317..269819b2521 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.111.0 +version: 0.112.0 expression: | Creates a selector that selects all columns. usage: | diff --git a/commands/docs/polars_selector_by-dtype.md b/commands/docs/polars_selector_by-dtype.md index 0befe2042d3..cd7825599c0 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.111.0 +version: 0.112.0 expression: | Creates a selector that selects columns by data type. usage: | diff --git a/commands/docs/polars_selector_by-name.md b/commands/docs/polars_selector_by-name.md index 16415a295e9..8900763d5b7 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.111.0 +version: 0.112.0 expression: | Creates a selector that selects columns by name. usage: | @@ -20,6 +20,10 @@ contributors: false ```> polars selector by-name {flags} ...rest``` +## Flags + + - `--strict`: If set, the selector will error if any specified column names do not exist. + ## Parameters - `...rest`: Names of columns to select. diff --git a/commands/docs/polars_selector_ends-with.md b/commands/docs/polars_selector_ends-with.md new file mode 100644 index 00000000000..4c4cbb1996e --- /dev/null +++ b/commands/docs/polars_selector_ends-with.md @@ -0,0 +1,96 @@ +--- +title: polars selector ends-with +categories: | + expression +version: 0.112.0 +expression: | + Select columns that end with the given substring(s). +usage: | + Select columns that end with the given substring(s). +editLink: false +contributors: false +--- + + +# `polars selector ends-with` for [expression](/commands/categories/expression.md) + +
Select columns that end with the given substring(s).
+ +## Signature + +```> polars selector ends-with {flags} ...rest``` + +## Parameters + + - `...rest`: Select columns that end with the given substring(s). + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Match columns ending with a 'z' +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [false, true], + } | + polars into-df --as-columns | + polars select (polars selector ends-with z) | + polars sort-by baz | + polars collect +╭───┬──────╮ +│ # │ baz │ +├───┼──────┤ +│ 0 │ 2.00 │ +│ 1 │ 5.50 │ +╰───┴──────╯ + +``` + +Match columns ending with *either* the letter 'z' or 'r' +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [false, true], + } | + polars into-df --as-columns | + polars select (polars selector ends-with z r) | + polars sort-by bar baz | + polars collect +╭───┬─────┬──────╮ +│ # │ bar │ baz │ +├───┼─────┼──────┤ +│ 0 │ 123 │ 2.00 │ +│ 1 │ 456 │ 5.50 │ +╰───┴─────┴──────╯ + +``` + +Match columns ending with *except* the letter 'z' +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [false, true], + } | + polars into-df --as-columns | + polars select (polars selector ends-with z | polars selector not) | + polars sort-by foo bar zap | + polars collect +╭───┬─────┬─────┬───────╮ +│ # │ foo │ bar │ zap │ +├───┼─────┼─────┼───────┤ +│ 0 │ x │ 123 │ false │ +│ 1 │ y │ 456 │ true │ +╰───┴─────┴─────┴───────╯ + +``` diff --git a/commands/docs/polars_selector_first.md b/commands/docs/polars_selector_first.md index e86934f5685..369503bf8f3 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.111.0 +version: 0.112.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 new file mode 100644 index 00000000000..eaed502c2dd --- /dev/null +++ b/commands/docs/polars_selector_float.md @@ -0,0 +1,50 @@ +--- +title: polars selector float +categories: | + expression +version: 0.112.0 +expression: | + Select all float columns. +usage: | + Select all float columns. +editLink: false +contributors: false +--- + + +# `polars selector float` for [expression](/commands/categories/expression.md) + +
Select all float columns.
+ +## Signature + +```> polars selector float {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all float columns +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "qux": [3.1, 2.7], + } | + polars into-df --as-columns | + polars select (polars selector float) | + polars sort-by baz qux | + polars collect +╭───┬──────┬──────╮ +│ # │ baz │ qux │ +├───┼──────┼──────┤ +│ 0 │ 2.00 │ 3.10 │ +│ 1 │ 5.50 │ 2.70 │ +╰───┴──────┴──────╯ + +``` diff --git a/commands/docs/polars_selector_integer.md b/commands/docs/polars_selector_integer.md new file mode 100644 index 00000000000..875506d2216 --- /dev/null +++ b/commands/docs/polars_selector_integer.md @@ -0,0 +1,50 @@ +--- +title: polars selector integer +categories: | + expression +version: 0.112.0 +expression: | + Select all integer columns. +usage: | + Select all integer columns. +editLink: false +contributors: false +--- + + +# `polars selector integer` for [expression](/commands/categories/expression.md) + +
Select all integer columns.
+ +## Signature + +```> polars selector integer {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all integer columns +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [0, 0], + } | + polars into-df --as-columns | + polars select (polars selector integer) | + polars sort-by bar zap | + polars collect +╭───┬─────┬─────╮ +│ # │ bar │ zap │ +├───┼─────┼─────┤ +│ 0 │ 123 │ 0 │ +│ 1 │ 456 │ 0 │ +╰───┴─────┴─────╯ + +``` diff --git a/commands/docs/polars_selector_last.md b/commands/docs/polars_selector_last.md index 49f728202d1..9ba7fb1f734 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.111.0 +version: 0.112.0 expression: | Creates a selector that selects the last column(s) by index. usage: | diff --git a/commands/docs/polars_selector_matches.md b/commands/docs/polars_selector_matches.md new file mode 100644 index 00000000000..e9120b229e7 --- /dev/null +++ b/commands/docs/polars_selector_matches.md @@ -0,0 +1,79 @@ +--- +title: polars selector matches +categories: | + expression +version: 0.112.0 +expression: | + Select all columns that match the given regex pattern. +usage: | + Select all columns that match the given regex pattern. +editLink: false +contributors: false +--- + + +# `polars selector matches` for [expression](/commands/categories/expression.md) + +
Select all columns that match the given regex pattern.
+ +## Signature + +```> polars selector matches {flags} (pattern)``` + +## Parameters + + - `pattern`: A valid regular expression pattern, compatible with the rust `regex crate + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Match column names containing an 'a', preceded by a character that is not 'z' +```nu +> + { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [0, 1], + } | + polars into-df --as-columns | + polars select (polars selector matches "[^z]a") | + polars sort-by bar baz | + polars collect + +╭───┬─────┬──────╮ +│ # │ bar │ baz │ +├───┼─────┼──────┤ +│ 0 │ 123 │ 2.00 │ +│ 1 │ 456 │ 5.50 │ +╰───┴─────┴──────╯ + +``` + +Do not match column names ending in 'R' or 'z' (case-insensitively) +```nu +> + { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [0, 1], + } | + polars into-df --as-columns | + polars select (polars selector matches "(?i)R|z$" | polars selector not) | + polars sort-by foo zap | + polars collect + +╭───┬─────┬─────╮ +│ # │ foo │ zap │ +├───┼─────┼─────┤ +│ 0 │ x │ 0 │ +│ 1 │ y │ 1 │ +╰───┴─────┴─────╯ + +``` diff --git a/commands/docs/polars_selector_not.md b/commands/docs/polars_selector_not.md new file mode 100644 index 00000000000..031fc669f9c --- /dev/null +++ b/commands/docs/polars_selector_not.md @@ -0,0 +1,35 @@ +--- +title: polars selector not +categories: | + expression +version: 0.112.0 +expression: | + Inverts selector. +usage: | + Inverts selector. +editLink: false +contributors: false +--- + + +# `polars selector not` for [expression](/commands/categories/expression.md) + +
Inverts selector.
+ +## Signature + +```> polars selector not {flags} ``` + + +## Input/output types: + +| input | output | +| --------------- | --------------- | +| polars_selector | polars_selector | +## Examples + +Inverts selector +```nu +> polars selector first | polars selector not + +``` diff --git a/commands/docs/polars_selector_numeric.md b/commands/docs/polars_selector_numeric.md new file mode 100644 index 00000000000..92ecd56ddab --- /dev/null +++ b/commands/docs/polars_selector_numeric.md @@ -0,0 +1,50 @@ +--- +title: polars selector numeric +categories: | + expression +version: 0.112.0 +expression: | + Select all numeric columns. +usage: | + Select all numeric columns. +editLink: false +contributors: false +--- + + +# `polars selector numeric` for [expression](/commands/categories/expression.md) + +
Select all numeric columns.
+ +## Signature + +```> polars selector numeric {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all numeric columns +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [0, 0], + } | + polars into-df --as-columns | + polars select (polars selector numeric) | + polars sort-by bar baz zap | + polars collect +╭───┬─────┬──────┬─────╮ +│ # │ bar │ baz │ zap │ +├───┼─────┼──────┼─────┤ +│ 0 │ 123 │ 2.00 │ 0 │ +│ 1 │ 456 │ 5.50 │ 0 │ +╰───┴─────┴──────┴─────╯ + +``` diff --git a/commands/docs/polars_selector_signed-integer.md b/commands/docs/polars_selector_signed-integer.md new file mode 100644 index 00000000000..6d3f0c99ee8 --- /dev/null +++ b/commands/docs/polars_selector_signed-integer.md @@ -0,0 +1,50 @@ +--- +title: polars selector signed-integer +categories: | + expression +version: 0.112.0 +expression: | + Select all signed integer columns. +usage: | + Select all signed integer columns. +editLink: false +contributors: false +--- + + +# `polars selector signed-integer` for [expression](/commands/categories/expression.md) + +
Select all signed integer columns.
+ +## Signature + +```> polars selector signed-integer {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all signed integer columns +```nu +> { + "foo": ["x", "y"], + "bar": [123, 456], + "baz": [2.0, 5.5], + "zap": [-1, -2], + } | + polars into-df --as-columns | + polars select (polars selector signed-integer) | + polars sort-by bar zap | + polars collect +╭───┬─────┬─────╮ +│ # │ bar │ zap │ +├───┼─────┼─────┤ +│ 0 │ 123 │ -1 │ +│ 1 │ 456 │ -2 │ +╰───┴─────┴─────╯ + +``` diff --git a/commands/docs/polars_selector_starts-with.md b/commands/docs/polars_selector_starts-with.md new file mode 100644 index 00000000000..6ce6b5120a3 --- /dev/null +++ b/commands/docs/polars_selector_starts-with.md @@ -0,0 +1,75 @@ +--- +title: polars selector starts-with +categories: | + expression +version: 0.112.0 +expression: | + Select columns that start with the given substring(s). +usage: | + Select columns that start with the given substring(s). +editLink: false +contributors: false +--- + + +# `polars selector starts-with` for [expression](/commands/categories/expression.md) + +
Select columns that start with the given substring(s).
+ +## Signature + +```> polars selector starts-with {flags} ...rest``` + +## Parameters + + - `...rest`: Select columns that start with the given substring(s). + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Match columns starting with a 'b' +```nu +> { + "foo": [1.0, 2.0], + "bar": [3.0, 4.0], + "baz": [5, 6], + "zap": [7, 8], + } | + polars into-df --as-columns | + polars select (polars selector starts-with b) | + polars sort-by bar baz | + polars collect +╭───┬──────┬─────╮ +│ # │ bar │ baz │ +├───┼──────┼─────┤ +│ 0 │ 3.00 │ 5 │ +│ 1 │ 4.00 │ 6 │ +╰───┴──────┴─────╯ + +``` + +Match columns starting with *either* the letter 'b' or 'z' +```nu +> { + "foo": [1.0, 2.0], + "bar": [3.0, 4.0], + "baz": [5, 6], + "zap": [7, 8], + } | + polars into-df --as-columns | + polars select (polars selector starts-with b z) | + polars sort-by bar baz zap | + polars collect +╭───┬──────┬─────┬─────╮ +│ # │ bar │ baz │ zap │ +├───┼──────┼─────┼─────┤ +│ 0 │ 3.00 │ 5 │ 7 │ +│ 1 │ 4.00 │ 6 │ 8 │ +╰───┴──────┴─────┴─────╯ + +``` diff --git a/commands/docs/polars_selector_unsigned-integer.md b/commands/docs/polars_selector_unsigned-integer.md new file mode 100644 index 00000000000..b218a77a7be --- /dev/null +++ b/commands/docs/polars_selector_unsigned-integer.md @@ -0,0 +1,48 @@ +--- +title: polars selector unsigned-integer +categories: | + expression +version: 0.112.0 +expression: | + Select all unsigned integer columns. +usage: | + Select all unsigned integer columns. +editLink: false +contributors: false +--- + + +# `polars selector unsigned-integer` for [expression](/commands/categories/expression.md) + +
Select all unsigned integer columns.
+ +## Signature + +```> polars selector unsigned-integer {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | --------------- | +| any | polars_selector | +## Examples + +Select all unsigned integer columns +```nu +> { + "foo": ["x", "y"], + "bar": [123, 200], + "baz": [2.0, 5.5], + } | + polars into-df --as-columns -s {foo: str, bar: u8, baz: f32}| + polars select (polars selector unsigned-integer) | + polars collect +╭───┬─────╮ +│ # │ bar │ +├───┼─────┤ +│ 0 │ 123 │ +│ 1 │ 200 │ +╰───┴─────╯ + +``` diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index d1a9880fd0e..cc18cccebef 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.111.0 +version: 0.112.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 56a50ae445d..90858865630 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.111.0 +version: 0.112.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 0a8908bcad1..a366475a6a7 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.111.0 +version: 0.112.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 e549c597a56..ef11861148c 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.111.0 +version: 0.112.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 ad78e29e56e..69fe64f0970 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.111.0 +version: 0.112.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 38cd3f5b92f..2bed787f697 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.111.0 +version: 0.112.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 5ab2742e9e3..4b6e3ed8e49 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.111.0 +version: 0.112.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 6f7d4c006ca..e7ac2524328 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.111.0 +version: 0.112.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 0423a4b1a75..429d0f3a70e 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.111.0 +version: 0.112.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 96ff5058954..c2dc8a6df24 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.111.0 +version: 0.112.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 26f01854bed..5d196141f14 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.111.0 +version: 0.112.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 2e9c32a1a46..1a73c6c77f4 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.111.0 +version: 0.112.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 c37e1a02027..3d710252490 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.111.0 +version: 0.112.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 f390408a948..e2c1694b4fd 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.111.0 +version: 0.112.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 a5a47e0aede..67f40e03266 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.111.0 +version: 0.112.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 1d52a5e05f8..bd36bb9dcf3 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.111.0 +version: 0.112.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 0d9131ef8e8..96c6309e96b 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.111.0 +version: 0.112.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 7c028a7446a..e061956ccd4 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.111.0 +version: 0.112.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 7199e6bc8f7..83f44dcbc69 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.111.0 +version: 0.112.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 0c92f800a91..ad0516f4d01 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.111.0 +version: 0.112.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 9306581dcdb..204db9eca33 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.111.0 +version: 0.112.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 1fd98a548a9..1c2a0f2b6ef 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.111.0 +version: 0.112.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 72efc575a0d..90a4c3ce77f 100644 --- a/commands/docs/polars_truncate.md +++ b/commands/docs/polars_truncate.md @@ -2,7 +2,7 @@ title: polars truncate categories: | expression -version: 0.111.0 +version: 0.112.0 expression: | Divide the date/datetime range into buckets. usage: | @@ -41,8 +41,8 @@ Truncate a series of dates by period length ├───┼───────────────┼───────────────┤ │ 0 │ a year ago │ a year ago │ │ 1 │ a year ago │ a year ago │ -│ 2 │ 11 months ago │ 11 months ago │ -│ 3 │ 9 months ago │ 9 months ago │ +│ 2 │ a year ago │ a year ago │ +│ 3 │ 11 months ago │ 11 months ago │ ╰───┴───────────────┴───────────────╯ ``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index 928934930b6..0f3ab86627c 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.111.0 +version: 0.112.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 2f472f2bc4e..ac2b871c26e 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.111.0 +version: 0.112.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 6631f88e40b..a12f3bf9aa1 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.111.0 +version: 0.112.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 773c50dd226..1fdf00ae0a2 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.111.0 +version: 0.112.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 d8ed5ff3135..bc281098191 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.111.0 +version: 0.112.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 f2933b20ed6..434fdda8e1b 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.111.0 +version: 0.112.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 620b506bd97..f05c975a8c7 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.111.0 +version: 0.112.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 7fd1f9eb6e4..9d964a27f1a 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.111.0 +version: 0.112.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index 47cfa6ee073..7eb96ac3010 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.111.0 +version: 0.112.0 network: | Get a free TCP port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 72f7512e196..56e6192ef65 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 4bf87e14653..20f387d88d3 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Print the given values to stdout. usage: | @@ -61,4 +61,5 @@ Print 'ABC' from binary data Unlike `echo`, this command does not return any value (`print | describe` will return "nothing"). Since this command has no output, there is no point in piping it with other commands. -`print` may be used inside blocks of code (e.g.: hooks) to display text during execution without interfering with the pipeline. \ No newline at end of file +`print` may be used inside blocks of code (e.g.: hooks) to display text during execution without interfering with the pipeline. +In protocol modes (`--lsp`, `--mcp`), `print` always writes to stderr to keep stdout reserved for protocol messages. \ No newline at end of file diff --git a/commands/docs/ps.md b/commands/docs/ps.md index bc6f4521044..2db040a4f07 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index d338bfe65ec..a882538fd98 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.111.0 +version: 0.112.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 32cdf250f45..7ae2ab91973 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 7bfc00d49b7..e997129dfd3 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.111.0 +version: 0.112.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 0172a16204a..867b2dcfe42 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.111.0 +version: 0.112.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 c5a0360b011..b193c987be2 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.111.0 +version: 0.112.0 network: | execute selector query on html/web usage: | @@ -27,6 +27,7 @@ contributors: false - `--attribute, -a {any}`: Downselect based on the given attribute. - `--as-table, -t {list}`: Find table based on column header list. - `--inspect, -i`: Run in inspect mode to provide more information for determining column headers. + - `--document, -d`: Parse the input as a full HTML document instead of a fragment ## Examples @@ -49,6 +50,12 @@ Pass multiple css selectors to extract several elements within single query, gro ``` +Parse the response as a full document so that the `` element is preserved +```nu +> http get http://example.com | query web --document --query body + +``` + Retrieve a specific html attribute instead of the default text ```nu > http get https://example.org | query web --query a --attribute href diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index dcc6c9515b5..a2dd8de0ca2 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.111.0 +version: 0.112.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 2721034d429..98959a2949f 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Execute XPath 1.0 query on XML input usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index c3a7e0e6778..1b79d7aea7f 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.111.0 +version: 0.112.0 random: | Generate a random value. usage: | @@ -36,7 +36,6 @@ You must use one of the following subcommands. Using this command as-is will onl | [`random binary`](/commands/docs/random_binary.md) | Generate random bytes. | built-in | | [`random bool`](/commands/docs/random_bool.md) | Generate a random boolean value. | built-in | | [`random chars`](/commands/docs/random_chars.md) | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. | built-in | -| [`random dice`](/commands/docs/random_dice.md) | Generate a random dice roll. | built-in | | [`random float`](/commands/docs/random_float.md) | Generate a random float within a range [min..max]. | built-in | | [`random int`](/commands/docs/random_int.md) | Generate a random integer [min..max]. | built-in | | [`random uuid`](/commands/docs/random_uuid.md) | Generate a random uuid string of the specified version. | built-in | \ No newline at end of file diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index bb317a3894c..d3dafe95004 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.111.0 +version: 0.112.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index b114c904bb6..3e235033292 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.111.0 +version: 0.112.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index fb3fdc724e3..3ac2dae6b5e 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.111.0 +version: 0.112.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_dice.md b/commands/docs/random_dice.md deleted file mode 100644 index 8ab35d413b0..00000000000 --- a/commands/docs/random_dice.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: random dice -categories: | - random -version: 0.111.0 -random: | - Generate a random dice roll. -usage: | - Generate a random dice roll. -editLink: false -contributors: false ---- - - -# `random dice` for [random](/commands/categories/random.md) - -
Generate a random dice roll.
- -## Signature - -```> random dice {flags} ``` - -## Flags - - - `--dice, -d {int}`: The amount of dice being rolled. - - `--sides, -s {int}`: The amount of sides a die has. - - -## Input/output types: - -| input | output | -| ------- | --------- | -| nothing | list<int> | -## Examples - -Roll 1 dice with 6 sides each. -```nu -> random dice - -``` - -Roll 10 dice with 12 sides each. -```nu -> random dice --dice 10 --sides 12 - -``` diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index c47a2c3f1f7..666305ccd4a 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.111.0 +version: 0.112.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 511c7d88960..7ad34f5710d 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.111.0 +version: 0.112.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index e17e608b044..12b9c9931c5 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.111.0 +version: 0.112.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 7a56479fe5d..d1e3606c0d2 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.111.0 +version: 0.112.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 4e2e1f89319..d33f69f4936 100644 --- a/commands/docs/registry.md +++ b/commands/docs/registry.md @@ -2,7 +2,7 @@ title: registry categories: | system -version: 0.111.0 +version: 0.112.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 edb4efc98b9..8e691e44d3f 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.111.0 +version: 0.112.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 45b589f67a0..d2d13aa86b5 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.111.0 +version: 0.112.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 c1091164603..a26d89cf551 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 14a2e37a581..b05bb26f517 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.111.0 +version: 0.112.0 core: | Return early from a custom command. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 8a14c1cbc9f..50206efe8f1 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 8f52c49deb6..537602e4753 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 690813ca7e9..69f10f5a34a 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index be6497ec8b8..17705c0832e 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 75b57d722cc..f35f43ab5c3 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 9cec9c7da39..5a4a2852c37 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index ff1743bc11e..9ae74da32af 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 45e9e95711e..8c7fa9ae77c 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.111.0 +version: 0.112.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 6251ff2ff0d..e8e15ed26eb 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.111.0 +version: 0.112.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index b359a6c48f8..3f6ed5e816c 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index af1310374c4..fea45d77512 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.111.0 +version: 0.112.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 6ce3ab92c05..aa641f1530f 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.111.0 +version: 0.112.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 b1fc585b32b..1cc73731bed 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.111.0 +version: 0.112.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 0ee1ba16ab7..6fc7c3922c5 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.111.0 +version: 0.112.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 e0fc1a26e44..e844fc6d386 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.111.0 +version: 0.112.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 41b27f24efb..ce2f344b071 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.111.0 +version: 0.112.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 b25ae877343..999dd375f70 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.111.0 +version: 0.112.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 79ccb69067c..20a2990c40e 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.111.0 +version: 0.112.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 b9fe9e1ac00..767243900e2 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.111.0 +version: 0.112.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 022f6a94b55..0ca2ac9c307 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.111.0 +version: 0.112.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index e562a203608..ef20f1849d2 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.111.0 +version: 0.112.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 4830d71cbc2..a82c53c852d 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.111.0 +version: 0.112.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 4799db509c0..9f25dd05b69 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 78b99401c97..9d209440f81 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | @@ -59,7 +59,7 @@ Skip two rows of a table. Skip 2 bytes of a binary value. ```nu > 0x[01 23 45 67] | skip 2 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 45 67 Eg ``` diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 50ec952fb5d..a21b46fe42d 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.111.0 +version: 0.112.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 5f028360c49..70e59fb5aa1 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.111.0 +version: 0.112.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 b9d2b1b70b0..feee28dc7b6 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/slice.md b/commands/docs/slice.md index 8ce8ccb6669..b9fcd045be1 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index 5b1e1c17e84..cf3c9e12e4b 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 4c094270536..6d903128468 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Sort the input in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 02041f23796..c1bd574450c 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.111.0 +version: 0.112.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 abab1d2f9cd..8dac03d9bdd 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.111.0 +version: 0.112.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 6d58ff75087..7edb040a96b 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.111.0 +version: 0.112.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 0b87dcc4cb6..22be1e30734 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.111.0 +version: 0.112.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 659c7bca256..6450033d68f 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.111.0 +version: 0.112.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 a3aeea6fc11..87ab825fb32 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.111.0 +version: 0.112.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 dd9c57ff830..d287b80a9f7 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.111.0 +version: 0.112.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 b8937bec7fa..d21c6e1fd6a 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.111.0 +version: 0.112.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 b2f5d6e352c..0bdd5d407eb 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 4b29c31d5c5..19509612230 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.111.0 +version: 0.112.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 e40ae2dd961..c039b4d5aab 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.111.0 +version: 0.112.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 967fe2bd8a2..bc7cd32f4ac 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.111.0 +version: 0.112.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 ee5dd435ee1..31ca3b7b31c 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.111.0 +version: 0.112.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 97ed14ffbfe..363a171a1d5 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.111.0 +version: 0.112.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 98c48e7c98c..e4cd06ab476 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.111.0 +version: 0.112.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 9a7cca91d88..63441e497aa 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.111.0 +version: 0.112.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 fb3bad1a40b..8f91407db21 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.111.0 +version: 0.112.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index a03bc9f35fd..a78fc38a12d 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.111.0 +version: 0.112.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 c6fb9d50b00..e3de3ca4e26 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.111.0 +version: 0.112.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 fbab38395ab..1b5f588eeca 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Various commands for working with string data. usage: | @@ -39,6 +39,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`str distance`](/commands/docs/str_distance.md) | Compare two strings and return the edit distance/Levenshtein distance. | built-in | | [`str downcase`](/commands/docs/str_downcase.md) | Convert text to lowercase. | built-in | | [`str ends-with`](/commands/docs/str_ends-with.md) | Check if an input ends with a string. | built-in | +| [`str escape-regex`](/commands/docs/str_escape-regex.md) | Escapes special characters in the input string with '\\'. | built-in | | [`str expand`](/commands/docs/str_expand.md) | Generates all possible combinations defined in brace expansion syntax. | built-in | | [`str index-of`](/commands/docs/str_index-of.md) | Returns start index of first occurrence of string in input, or -1 if no match. | built-in | | [`str join`](/commands/docs/str_join.md) | Concatenate multiple strings into a single string, with an optional separator between each. | built-in | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 7e834e22fc0..c0b74b6406d 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.111.0 +version: 0.112.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index fb341b4f46c..cb3ba5e3d7e 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Capitalize the first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 18cf317b2b5..a46faa4d4d1 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.111.0 +version: 0.112.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 037981f4d42..9bc3b7e3a4a 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.111.0 +version: 0.112.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 d46ef1f92d7..18c7a07fe44 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Convert text to lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 8a8c356b27e..27df0fb4e46 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.111.0 +version: 0.112.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 new file mode 100644 index 00000000000..c505a9b7215 --- /dev/null +++ b/commands/docs/str_escape-regex.md @@ -0,0 +1,64 @@ +--- +title: str escape-regex +categories: | + strings +version: 0.112.0 +strings: | + Escapes special characters in the input string with '\'. +usage: | + Escapes special characters in the input string with '\'. +editLink: false +contributors: false +--- + + +# `str escape-regex` for [strings](/commands/categories/strings.md) + +
Escapes special characters in the input string with '\'.
+ +## Signature + +```> str escape-regex {flags} ...rest``` + +## Parameters + + - `...rest`: For a data structure input, escape strings at the given cell paths. + + +## Input/output types: + +| input | output | +| ------------ | ------------ | +| string | string | +| list<string> | list<string> | +| table | table | +| record | record | +## Examples + +Escape dots in an IP address. +```nu +> '192.168.1.1' | str escape-regex +192\.168\.1\.1 +``` + +Escape a list of strings containing special characters. +```nu +> ['(abc)', '1 + 1'] | str escape-regex +╭───┬─────────╮ +│ 0 │ \(abc\) │ +│ 1 │ 1 \+ 1 │ +╰───┴─────────╯ + +``` + +Escape characters in a specific column of a table. +```nu +> [[pattern]; ['find.me'] ['(group)']] | str escape-regex pattern +╭───┬───────────╮ +│ # │ pattern │ +├───┼───────────┤ +│ 0 │ find\.me │ +│ 1 │ \(group\) │ +╰───┴───────────╯ + +``` diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 488fcfe62a8..80c93a8d53b 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.111.0 +version: 0.112.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 ed92e113d02..f2aa9561030 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.111.0 +version: 0.112.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 cf3aa995de9..c6a80425209 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.111.0 +version: 0.112.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 d4cd905f2a3..2f00a0bdcb7 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.111.0 +version: 0.112.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 87e2e94cf57..feba21d227d 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.111.0 +version: 0.112.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 959a912c019..e8182b7d23f 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.111.0 +version: 0.112.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 970abb49e41..6e19d7cd455 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Find and replace text in the input string. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index ac808708409..24d092e2db2 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.111.0 +version: 0.112.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 3d48d5f1f5a..dadc44a8b90 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.111.0 +version: 0.112.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 5df77096a18..88e171a4223 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.111.0 +version: 0.112.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 d0a757fcd53..89c92a2ace8 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.111.0 +version: 0.112.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 0f1dee10a77..55fd39c3b9b 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.111.0 +version: 0.112.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 d99b8cafd11..97de5b6709d 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.111.0 +version: 0.112.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 d0c726b71b2..2e3567e57fc 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.111.0 +version: 0.112.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 70da032dd3d..3d4509527f8 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 08e587be3b6..5984e22d13b 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.111.0 +version: 0.112.0 strings: | Convert text to uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 94b5247ac93..6a179d8eb65 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 0e3d0e77c46..47d6d7f7ef3 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index 197cd470981..43f696e8a33 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 8aea4e643f7..019b29455ef 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index 3f501d44bf0..25718ef3baa 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index cd70589bdb6..42fd32769d7 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.111.0 +version: 0.112.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 565ad3dbe65..cd63c040c21 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.111.0 +version: 0.112.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index cc1df142730..25333738300 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.111.0 +version: 0.112.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 07157f7f426..532baf4c4dd 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.111.0 +version: 0.112.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index f57092e8b9b..cf2a4f1029d 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | @@ -69,7 +69,7 @@ Return the first two rows of a table. Return the first 2 bytes of a binary value. ```nu > 0x[01 23 45] | take 2 -Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +Length: 2 (0x2) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 01 23 •# ``` diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 19dfb7dfb31..23c9c3c46a6 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.111.0 +version: 0.112.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 d79246ef9c4..3163da6769a 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.111.0 +version: 0.112.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 20620419c83..7ad0c128b45 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term.md b/commands/docs/term.md index 79c0c303625..72b7acd4f42 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.111.0 +version: 0.112.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 632724e032e..dc423a0f0b9 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Query the terminal for information. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index d77791b9ced..b9bc8397bc9 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.111.0 +version: 0.112.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 32b3c3f76ad..fc1a1ca55d9 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.111.0 +version: 0.112.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 ce21282678f..6f573a88f65 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Translate structured data to various formats. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index abe34958509..56da8280426 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 1101de392ab..0a553dd921a 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 95315b3fc13..1a27896a577 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 7212d7cf670..8732f747548 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 36e574103a6..295c12e8fca 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert Nu values into MessagePack. usage: | @@ -35,7 +35,7 @@ contributors: false Convert a list of values to MessagePack. ```nu > [foo, 42, false] | to msgpack -Length: 7 (0x7) bytes | printable whitespace ascii_other non_ascii +Length: 7 (0x7) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 93 a3 66 6f 6f 2a c2 ××foo*× ``` @@ -43,7 +43,7 @@ Length: 7 (0x7) bytes | printable whitespace ascii_other non_ascii Convert a range to a MessagePack array. ```nu > 1..10 | to msgpack -Length: 11 (0xb) bytes | printable whitespace ascii_other non_ascii +Length: 11 (0xb) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 9a 01 02 03 04 05 06 07 08 09 0a ו•••••••__ ``` @@ -55,7 +55,7 @@ Convert a table to MessagePack. ['Apollo 11 Landing' 1969-07-24T16:50:35] ['Nushell first commit' 2019-05-10T09:59:12-07:00] ] | to msgpack -Length: 95 (0x5f) bytes | printable whitespace ascii_other non_ascii +Length: 95 (0x5f) bytes | null_char printable whitespace ascii_other non_ascii 00000000: 92 82 aa 65 76 65 6e 74 5f 6e 61 6d 65 b1 41 70 ×××event_name×Ap 00000010: 6f 6c 6c 6f 20 31 31 20 4c 61 6e 64 69 6e 67 a4 ollo 11 Landing× 00000020: 74 69 6d 65 c7 0c ff 00 00 00 00 ff ff ff ff ff time×_×0000××××× diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index db41a3cd16e..92746d4c922 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.111.0 +version: 0.112.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 dd053a2a0b5..74fd69c0b2d 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | @@ -26,7 +26,8 @@ contributors: false - `--indent, -i {number}`: Specify indentation width. - `--tabs, -t {number}`: Specify indentation tab quantity. - `--serialize, -s`: Serialize nushell types that cannot be deserialized. - - `--raw-strings`: Use raw string syntax (r#'...'#) for strings with quotes or backslashes. + - `--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. ## Input/output types: @@ -85,3 +86,18 @@ Use raw string syntax for strings with quotes or backslashes. > 'hello "world"' | to nuon --raw-strings r#'hello "world"'# ``` + +Serialize table values as a list of records instead of table syntax. +```nu +> [[a, b]; [1, 2], [3, 4]] | to nuon --list-of-records +[{a: 1, b: 2}, {a: 3, b: 4}] +``` + +Serialize table values as list of records with pretty indentation. +```nu +> [[a, b]; [1, 2], [3, 4]] | to nuon --list-of-records --indent 2 +[ + {a: 1, b: 2}, + {a: 3, b: 4} +] +``` diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index 59b8765bdcc..e73191dbd5e 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 0d0d908eeb6..6512f1e6713 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert data into plain text format. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 2975dcca152..ba9dc40b003 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 6e4e73ff056..fc9ecf3b8f5 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index e5b79449b66..636bcf4c4e3 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.111.0 +version: 0.112.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 b3af1c937b5..6a561fe94bf 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md index fbbe719fbbf..e8f7c305f73 100644 --- a/commands/docs/to_yml.md +++ b/commands/docs/to_yml.md @@ -2,7 +2,7 @@ title: to yml categories: | formats -version: 0.111.0 +version: 0.112.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 3041f141ac2..7a59c1ea4e0 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index 9b7e1ff3b3a..a6e33e7238e 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.111.0 +version: 0.112.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 969d3251cef..e55a161ec9d 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.111.0 +version: 0.112.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 95d7c01012c..b1e0fb10fa3 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.111.0 +version: 0.112.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index e538aa6e491..d5c07122bf9 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/umask.md b/commands/docs/umask.md index a557cd4c3d9..3cc513d00f7 100644 --- a/commands/docs/umask.md +++ b/commands/docs/umask.md @@ -2,7 +2,7 @@ title: umask categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Get or set default file creation permissions. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index f622d12b467..86920f474c1 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.111.0 +version: 0.112.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 15df68b3ccc..f02850defcc 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.111.0 +version: 0.112.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 b0b430eb906..140efda7626 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/unlet.md b/commands/docs/unlet.md index 901733a3adb..3cf0a1fb628 100644 --- a/commands/docs/unlet.md +++ b/commands/docs/unlet.md @@ -2,7 +2,7 @@ title: unlet categories: | experimental -version: 0.111.0 +version: 0.112.0 experimental: | Delete variables from nushell memory, making them unrecoverable. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index b7b459012cc..972ee59b449 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.111.0 +version: 0.112.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 5cd8b7f004a..5b4458c6c07 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 8a2d3824dc2..878bc40e069 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | @@ -118,20 +118,16 @@ Upsert into a list, inserting a new value at the end. Upsert into a nested path, creating new values as needed. ```nu > [{} {a: [{}]}] | upsert a.0.b "value" -╭───┬───────────────╮ -│ # │ a │ -├───┼───────────────┤ -│ 0 │ ╭───┬───────╮ │ -│ │ │ # │ b │ │ -│ │ ├───┼───────┤ │ -│ │ │ 0 │ value │ │ -│ │ ╰───┴───────╯ │ -│ 1 │ ╭───┬───────╮ │ -│ │ │ # │ b │ │ -│ │ ├───┼───────┤ │ -│ │ │ 0 │ value │ │ -│ │ ╰───┴───────╯ │ -╰───┴───────────────╯ +╭───┬───────────────────────────╮ +│ # │ a │ +├───┼───────────────────────────┤ +│ 0 │ ╭───┬───────╮ │ +│ │ │ b │ value │ │ +│ │ ╰───┴───────╯ │ +│ 1 │ ╭───┬───────────────────╮ │ +│ │ │ 0 │ {record 0 fields} │ │ +│ │ ╰───┴───────────────────╯ │ +╰───┴───────────────────────────╯ ``` diff --git a/commands/docs/url.md b/commands/docs/url.md index 779604f8c6d..f2e418180d5 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.111.0 +version: 0.112.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 b670af3f826..55d44223f9c 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.111.0 +version: 0.112.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 54515fdbb97..c16445e246c 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.111.0 +version: 0.112.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 49411504350..50f77c76477 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.111.0 +version: 0.112.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 6436ce56fe3..4864fee9787 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.111.0 +version: 0.112.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 426c8bd6303..a03ccca684d 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.111.0 +version: 0.112.0 network: | Parse a URL string into structured data. usage: | @@ -20,6 +20,10 @@ contributors: false ```> url parse {flags} ...rest``` +## Flags + + - `--base, -b {string}`: Base URL used to resolve relative URLs. + ## Parameters - `...rest`: Optionally operate by cell path. @@ -56,3 +60,19 @@ Parses a URL. │ │ ╰───┴─────────┴─────────╯ │ ╰──────────┴──────────────────────────────────────────╯ ``` + +Resolves a relative URL against a base URL. +```nu +> "../images/logo.png" | url parse --base "https://example.com/products/item1" +╭──────────┬──────────────────╮ +│ scheme │ https │ +│ username │ │ +│ password │ │ +│ host │ example.com │ +│ port │ │ +│ path │ /images/logo.png │ +│ query │ │ +│ fragment │ │ +│ params │ [list 0 items] │ +╰──────────┴──────────────────╯ +``` diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index 9436c989cb9..cd5a42b2cdb 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.111.0 +version: 0.112.0 network: | Converts query string into table applying percent-decoding. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index dfc9558fde6..67a0d5fba19 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.111.0 +version: 0.112.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 214a8714193..6b2e7af77dc 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.111.0 +version: 0.112.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 16bfcdee4c4..7f35b114e2a 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.111.0 +version: 0.112.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 9a1e02c4f16..65558afcaae 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.111.0 +version: 0.112.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 300f958bd70..13cd6374738 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index 5745206b33a..8c7ceba76a8 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.111.0 +version: 0.112.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 220fd7e7acd..0bfc3651655 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.111.0 +version: 0.112.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 eda8bced479..ae69eba20ea 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.111.0 +version: 0.112.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 9af0b3490f1..e5eeb8085a8 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.111.0 +version: 0.112.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 5067d5ad0bb..8968e172869 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.111.0 +version: 0.112.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index f6127ae18ba..18c32738522 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.111.0 +version: 0.112.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | @@ -22,8 +22,7 @@ contributors: false ## Flags - - `--debounce-ms, -d {int}`: Debounce changes for this many milliseconds (default: 100). Adjust if you find that single writes are reported as multiple events (deprecated). - - `--debounce {duration}`: Debounce changes for this duration (default: 100ms). Adjust if you find that single writes are reported as multiple events. + - `--debounce, -d {duration}`: Debounce changes for this duration (default: 100ms). Adjust if you find that single writes are reported as multiple events. - `--glob, -g {string}`: Only report changes for files that match this glob pattern (default: all files) - `--recursive, -r {bool}`: Watch all directories under `` recursively. Will be ignored if `` is a file (default: true). - `--quiet, -q`: Hide the initial status message (default: false). diff --git a/commands/docs/where.md b/commands/docs/where.md index 4b6af73a1c1..beb93d8c3ff 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.111.0 +version: 0.112.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 d144b9dc387..2da3c7459fd 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.111.0 +version: 0.112.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 e998ce5ae5b..88f3a85bcb4 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.111.0 +version: 0.112.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 1f25ca9fa79..e706c68f121 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.111.0 +version: 0.112.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 2214777b745..f5c5e47e6dd 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.111.0 +version: 0.112.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 b08630815ce..a1a3f76e6bf 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.111.0 +version: 0.112.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 3601b1d3729..e573b345444 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 31bc1bbec6b..b106060e7f2 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.111.0 +version: 0.112.0 filters: | Combine a stream with the input. usage: |