diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 53b047a60d4..8ec58438f5d 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -10,8 +10,8 @@ export const commandCategories = [ '/commands/categories/date.md', '/commands/categories/debug.md', '/commands/categories/default.md', - '/commands/categories/deprecated.md', '/commands/categories/env.md', + '/commands/categories/experimental.md', '/commands/categories/expression.md', '/commands/categories/filesystem.md', '/commands/categories/filters.md', diff --git a/commands/categories/experimental.md b/commands/categories/experimental.md index 9008981e821..a0c0dae28fd 100644 --- a/commands/categories/experimental.md +++ b/commands/categories/experimental.md @@ -1,3 +1,8 @@ +--- +editLink: false +contributors: false +--- + # Experimental - - - - - - - - + + + + + + + + + + + +
CommandDescription
{{ command.title }}{{ command.frontmatter.usage }}
CommandDescription
{{ command.title }}{{ command.frontmatter.usage }}
diff --git a/commands/docs/alias.md b/commands/docs/alias.md index f95d8986b68..a392ee8d9ed 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.102.0 +version: 0.103.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 b42fb53d460..5e60a8721d8 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.102.0 +version: 0.103.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 bb9d6b2dc41..7eb2418b941 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.102.0 +version: 0.103.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 17f6beb54e7..29a26972a7e 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | @@ -29,7 +29,7 @@ contributors: false ## Parameters - - `...rest`: for a data structure input, add a gradient to strings at the given cell paths + - `...rest`: For a data structure input, add a gradient to strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 086c34b3209..2d6026bbd4d 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.102.0 +version: 0.103.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 d9b0adba01a..add33f96101 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 8e457d72d70..c0588f9a1ea 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.102.0 +version: 0.103.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 c872c41e3a8..f680be28412 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index bef61c26048..40255ceab7c 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md new file mode 100644 index 00000000000..b489191cc28 --- /dev/null +++ b/commands/docs/attr_category.md @@ -0,0 +1,42 @@ +--- +title: attr category +categories: | + core +version: 0.103.0 +core: | + Attribute for adding a category to custom commands. +usage: | + Attribute for adding a category to custom commands. +editLink: false +contributors: false +--- + + +# `attr category` for [core](/commands/categories/core.md) + +
Attribute for adding a category to custom commands.
+ +## Signature + +```> attr category {flags} (category)``` + +## Parameters + + - `category`: Category of the custom command. + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list\ | + +## Examples + +Add a category to a custom command +```nu +> # Double numbers + @category math + def double []: [number -> number] { $in * 2 } + +``` diff --git a/commands/docs/attr_example.md b/commands/docs/attr_example.md new file mode 100644 index 00000000000..5d7f86fb143 --- /dev/null +++ b/commands/docs/attr_example.md @@ -0,0 +1,48 @@ +--- +title: attr example +categories: | + core +version: 0.103.0 +core: | + Attribute for adding examples to custom commands. +usage: | + Attribute for adding examples to custom commands. +editLink: false +contributors: false +--- + + +# `attr example` for [core](/commands/categories/core.md) + +
Attribute for adding examples to custom commands.
+ +## Signature + +```> attr example {flags} (description) (example)``` + +## Flags + + - `--result {any}`: Expected output of example. + +## Parameters + + - `description`: Description of the example. + - `example`: Example code snippet. + + +## Input/output types: + +| input | output | +| ------- | -------------------------------------------- | +| nothing | record\ | + +## Examples + +Add examples to custom command +```nu +> # Double numbers + @example "double an int" { 2 | double } --result 4 + @example "double a float" { 0.25 | double } --result 0.5 + def double []: [number -> number] { $in * 2 } + +``` diff --git a/commands/docs/attr_search-terms.md b/commands/docs/attr_search-terms.md new file mode 100644 index 00000000000..db869483cb2 --- /dev/null +++ b/commands/docs/attr_search-terms.md @@ -0,0 +1,42 @@ +--- +title: attr search-terms +categories: | + core +version: 0.103.0 +core: | + Attribute for adding search terms to custom commands. +usage: | + Attribute for adding search terms to custom commands. +editLink: false +contributors: false +--- + + +# `attr search-terms` for [core](/commands/categories/core.md) + +
Attribute for adding search terms to custom commands.
+ +## Signature + +```> attr search-terms {flags} ...rest``` + +## Parameters + + - `...rest`: Search terms. + + +## Input/output types: + +| input | output | +| ------- | ------------ | +| nothing | list\ | + +## Examples + +Add search terms to a custom command +```nu +> # Double numbers + @search-terms multiply times + def double []: [number -> number] { $in * 2 } + +``` diff --git a/commands/docs/banner.md b/commands/docs/banner.md index 82bb12ecd4d..8696cbd9057 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,11 +2,11 @@ title: banner categories: | default -version: 0.102.0 +version: 0.103.0 default: | - Print a banner for nushell with information about the project + Print a banner for Nushell with information about the project usage: | - Print a banner for nushell with information about the project + Print a banner for Nushell with information about the project editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `banner` for [default](/commands/categories/default.md) -
Print a banner for nushell with information about the project
+
Print a banner for Nushell with information about the project
## Signature diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 3e6d6d2de09..270ec84a1b6 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 5d04cc3225a..54457c69ddc 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Performs bitwise and for ints or binary values. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `target`: right-hand side of the operation + - `target`: Right-hand side of the operation. ## Input/output types: diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index cc02574b9a0..019da37ea56 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 44a19fb7dd5..f0c91cecab2 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Performs bitwise or for ints or binary values. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `target`: right-hand side of the operation + - `target`: Right-hand side of the operation. ## Input/output types: diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index cc4f43e8baa..30cc3cd1d82 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Bitwise rotate left for ints or binary values. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `bits`: number of bits to rotate left + - `bits`: Number of bits to rotate left. ## Input/output types: diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 5cd763e2a3e..6ad4ba9c2f4 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Bitwise rotate right for ints or binary values. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `bits`: number of bits to rotate right + - `bits`: Number of bits to rotate right. ## Input/output types: diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 82a698cb2ec..7b362334b2e 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Bitwise shift left for ints or binary values. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `bits`: number of bits to shift left + - `bits`: Number of bits to shift left. ## Input/output types: diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 7b38623b63c..2c11179ca61 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Bitwise shift right for ints or binary values. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `bits`: number of bits to shift right + - `bits`: Number of bits to shift right. ## Input/output types: diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index a7f5539a6bf..3da32bd370e 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.102.0 +version: 0.103.0 bits: | Performs bitwise xor for ints or binary values. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `target`: right-hand side of the operation + - `target`: Right-hand side of the operation. ## Input/output types: diff --git a/commands/docs/break.md b/commands/docs/break.md index 36db260f433..cd70b53c397 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.102.0 +version: 0.103.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 1e459d687f9..6a14c7aa758 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.102.0 +version: 0.103.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 24d6163eb3a..99c2c6d77ac 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 73d0c8c557c..e04f9ee87fe 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 0164e8c4f74..1c2991a6336 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index c4db4580e38..0abe7316a39 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 7e2114dc639..ca9001223b9 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.102.0 +version: 0.103.0 bytes: | Check if bytes ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 44359e939c8..775300182e3 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.102.0 +version: 0.103.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 250aaa51c0b..fd823eff8ff 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.102.0 +version: 0.103.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 9396a51120b..ff4790818e9 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index d65e92a1e09..6acb7945525 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 3e6c85e2008..a610028c7c3 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.102.0 +version: 0.103.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index e628459a532..43e6e586193 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.102.0 +version: 0.103.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 0a9ddbf3d64..1bc966f46ed 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.102.0 +version: 0.103.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 7f95eb919ba..27c826b9656 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.102.0 +version: 0.103.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 48d7dcfce3f..dddae6f9d38 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 93fea099a22..ddc19dea8a3 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index d4904ed5b91..26715681124 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.102.0 +version: 0.103.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 e5b7ae20e7f..f6c67c36327 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,11 +2,11 @@ title: chunks categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | - Divide a list or table into chunks of `chunk_size`. + Divide a list, table or binary input into chunks of `chunk_size`. usage: | - Divide a list or table into chunks of `chunk_size`. + Divide a list, table or binary input into chunks of `chunk_size`. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `chunks` for [filters](/commands/categories/filters.md) -
Divide a list or table into chunks of `chunk_size`.
+
Divide a list, table or binary input into chunks of `chunk_size`.
## Signature diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 2dcebc954fc..4a946bb1b6e 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index c434b1d0fc8..2e6f93f0850 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index ee2f3617e84..02728fe2842 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.102.0 +version: 0.103.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 671afc1633f..a7747af6114 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.102.0 +version: 0.103.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 9f412f0745d..5dde8a3088c 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.102.0 +version: 0.103.0 core: | Modify the current command line input buffer. usage: | @@ -28,7 +28,7 @@ contributors: false ## Parameters - - `str`: the string to perform the operation with + - `str`: The string to perform the operation with. ## Input/output types: diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 9f3869f59e4..f61afd1c741 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.102.0 +version: 0.103.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 ed36329d3a9..896f88019a6 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.102.0 +version: 0.103.0 core: | Set the current cursor position. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `pos`: Cursor position to be set + - `pos`: Cursor position to be set. ## Input/output types: diff --git a/commands/docs/compact.md b/commands/docs/compact.md index d3c18aab120..3ada80a19a7 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 636b013c0d4..d4afee20897 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.102.0 +version: 0.103.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 43ad7217cef..cc2ffa83f42 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.102.0 +version: 0.103.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index ee561634b81..49929e1556a 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.102.0 +version: 0.103.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index f1d804f2ac4..ccfbab5e6be 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.102.0 +version: 0.103.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 7340352afc7..3dcfad5d8c4 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.102.0 +version: 0.103.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 5867dbb4889..619c8215b00 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.102.0 +version: 0.103.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 59e74aa1deb..a8dafa41bb5 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.102.0 +version: 0.103.0 env: | Get the configuration for color output. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 1015f287df3..5b919161c25 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.102.0 +version: 0.103.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 3487a9422c7..23360a73f22 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.102.0 +version: 0.103.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 19c0c3b0a4f..d64318ecbf9 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index 153d8bca0c5..a13126d6ef0 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.102.0 +version: 0.103.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index e1803c0f385..d093628367c 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.102.0 +version: 0.103.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 72fe5ac54ee..31047d35825 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.102.0 +version: 0.103.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 dcc7730baa0..d6e3bfed4dc 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.102.0 +version: 0.103.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 8b35a2135d3..16248eaf8d4 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.102.0 +version: 0.103.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 5f56efdc872..a3db159b68f 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.102.0 +version: 0.103.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index d061bf8e096..fc5a05555f9 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index e8c1f892653..a5da4c39a79 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 8b80cc5b037..60935203a51 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 5de964341bb..1c20e512faf 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 059d1758076..e6acc354950 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Decode a Base32 value. usage: | diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 637e4d2ec95..a4ffe3e2453 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Encode a base32hex value. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 6b7d0c812d7..f4428e46995 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Decode a Base64 value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index e11375813b1..456000bf8fb 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index f2c98120b23..fac23538252 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.102.0 +version: 0.103.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 2ed6f6a0f77..9fa7f83b9d8 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Sets a default value if a row's column is missing or null. usage: | @@ -20,6 +20,10 @@ contributors: false ```> default {flags} (default value) (column name)``` +## Flags + + - `--empty, -e`: also replace empty items like "", {}, and [] + ## Parameters - `default value`: The value to use as a default. @@ -69,3 +73,15 @@ Replace the missing value in the "a" column of a list ╰───┴─────┴───╯ ``` + +Replace the empty string in the "a" column of a list +```nu +> [{a:1 b:2} {a:'' b:1}] | default -e 'N/A' a +╭───┬─────┬───╮ +│ # │ a │ b │ +├───┼─────┼───┤ +│ 0 │ 1 │ 2 │ +│ 1 │ N/A │ 1 │ +╰───┴─────┴───╯ + +``` diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 8e7500679fb..ed74aecd472 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.102.0 +version: 0.103.0 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index d3d03202aa0..36a648a6614 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index c0adeb09943..12f52c0219d 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.102.0 +version: 0.103.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index fa20ae543cd..dcb2ef11105 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index 3dadb80ce3f..04919dfa663 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index fbf1a8bb19b..94378d0ce06 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 811aefb8c36..670f5f6f7bc 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index c5e8fc20278..a49d475ef34 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -60,7 +60,7 @@ Produce a list of values in the record, converted to string ``` -Produce a list that has "two" for each 2 in the input +'null' items will be dropped from the result list. It has the same effect as 'filter_map' in other languages. ```nu > [1 2 3 2] | each {|e| if $e == 2 { "two" } } ╭───┬─────╮ @@ -96,7 +96,7 @@ iterate over each record, not necessarily each cell within it. Avoid passing single records to this command. Since a record is a one-row structure, 'each' will only run once, behaving similar to 'do'. -To iterate over a record's values, try converting it to a table +To iterate over a record's values, use 'items' or try converting it to a table with 'transpose' first. ## Subcommands: diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 41744358935..06d094e513c 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `closure`: the closure to run + - `closure`: The closure to run. ## Input/output types: diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 70de57967b7..4111b5637f5 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.102.0 +version: 0.103.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 5c61505efcb..6deed969c52 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index 8b3d43bdb56..1aaf908de5f 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.102.0 +version: 0.103.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 7d67473e69e..3c785149037 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.102.0 +version: 0.103.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 b0133ee4627..a8333594403 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.102.0 +version: 0.103.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 797c8c8207c..38d41083d2b 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 73d65b3fa1c..adbc7ad37d0 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 50803b3b8aa..49be5619c0e 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.102.0 +version: 0.103.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 3d93c5e027f..be3257bcde8 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.102.0 +version: 0.103.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 022b07cd30a..aa206d7977b 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.102.0 +version: 0.103.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 cb66c25f37e..8f4ffb02006 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.102.0 +version: 0.103.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 062e12a0e1f..1fd5842ed7e 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 43a8ae99c24..116e3b0bfa7 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.102.0 +version: 0.103.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 8cfdbf7ce5e..828bba27db9 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.102.0 +version: 0.103.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 fe4988b4cb9..2b042cd6440 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.102.0 +version: 0.103.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 e7c72c0115c..eb68b9a207a 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.102.0 +version: 0.103.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 a493e057417..af458c13df1 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.102.0 +version: 0.103.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 6309f9341a0..8150623148c 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.102.0 +version: 0.103.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 f2c00b5d0dc..964f3042f90 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.102.0 +version: 0.103.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 81146d7915c..0d8efd45925 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.102.0 +version: 0.103.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 25bced420f1..2f3dac4bcd0 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.102.0 +version: 0.103.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 0ce7deb6a82..5c9dba58c73 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.102.0 +version: 0.103.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 5c9cfd23bf0..5b08833b9ab 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 2cb947f58bf..b91d947ef90 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index c20c1f1708a..54e9e387425 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index edbbd0e89de..7691e47852b 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index ea8a89b4bac..672307f800c 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md deleted file mode 100644 index 9befd8ea718..00000000000 --- a/commands/docs/fmt.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: fmt -categories: | - deprecated -version: 0.102.0 -deprecated: | - Format a number. -usage: | - Format a number. -editLink: false -contributors: false ---- - - -# `fmt` for [deprecated](/commands/categories/deprecated.md) - -
Format a number.
- -## Signature - -```> fmt {flags} ``` - - -## Input/output types: - -| input | output | -| ------ | ------ | -| number | record | - -## Examples - -Get a record containing multiple formats for the number 42 -```nu -> 42 | fmt -╭──────────┬──────────╮ -│ binary │ 0b101010 │ -│ debug │ 42 │ -│ display │ 42 │ -│ lowerexp │ 4.2e1 │ -│ lowerhex │ 0x2a │ -│ octal │ 0o52 │ -│ upperexp │ 4.2E1 │ -│ upperhex │ 0x2A │ -╰──────────┴──────────╯ -``` diff --git a/commands/docs/for.md b/commands/docs/for.md index 298b7da6a38..e19e7746e0b 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.102.0 +version: 0.103.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index 7819aeff9a9..863d4094a5b 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index a839246b387..f84926f1748 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to a string of binary data represented by 0 and 1. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: for a data structure input, convert data at the given cell paths + - `...rest`: For a data structure input, convert data at the given cell paths. ## Input/output types: diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 03bf2314467..6ac89c74544 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.102.0 +version: 0.103.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 554202c4d91..9a894739d80 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.102.0 +version: 0.103.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 1d38e8ab93c..2327fd93016 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.102.0 +version: 0.103.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 79e37ee985f..ebdb48d6a55 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Format a number. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 955888c382f..b217e5ef9f4 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Format columns into a string using a simple pattern. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `pattern`: the pattern to output. e.g.) "{foo}: {bar}" + - `pattern`: The pattern to output. e.g.) "{foo}: {bar}". ## Input/output types: diff --git a/commands/docs/from.md b/commands/docs/from.md index 52fad97ab24..94e0c5b3c80 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Parse a string or binary data into structured data. usage: | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 414ec9ec8db..dbdd9f112e8 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.102.0 +version: 0.103.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 7c26e6a5b9f..f039e17e856 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.102.0 +version: 0.103.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 c30849b5f84..aa29be49180 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Parse text as .ics and create table. usage: | @@ -40,11 +40,10 @@ Converts ics formatted string to table ```nu > 'BEGIN:VCALENDAR END:VCALENDAR' | from ics -╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────╮ -│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │ -├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────┤ -│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 │ -│ │ │ │ │ │ │ │ items] │ -╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴───────────╯ +╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────╮ +│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │ +├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┤ +│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ +╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────╯ ``` diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 53f0f8fd1f6..225b10ce0cf 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.102.0 +version: 0.103.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 dc129afdebb..90ca1de021f 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 67a2198c2ee..4d2edfae626 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index c1c7f9f9771..95326bdebeb 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.102.0 +version: 0.103.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 c13706482e5..2d1b41b3431 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 45875b9d6f2..a7776dc12d9 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.102.0 +version: 0.103.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 290a9b6cb42..e348d6ebe49 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 73bedde7dcc..773f31c657b 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.102.0 +version: 0.103.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 4d2b0d4df9a..14249967c1a 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.102.0 +version: 0.103.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 22a9b314a0f..941ae216829 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.102.0 +version: 0.103.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 653748ed221..07d2804a1f4 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.102.0 +version: 0.103.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 76e24710d44..a2d1dd6f245 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.102.0 +version: 0.103.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 91380d425ee..712585ca419 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.102.0 +version: 0.103.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 3116e000ff7..17d1a502949 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Parse text as .xml and create record. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--keep-comments`: add comment nodes to result + - `--allow-dtd`: allow parsing documents with DTDs (may result in exponential entity expansion) - `--keep-pi`: add processing instruction nodes to result diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index d6841ac8d40..1e5349f8e66 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.102.0 +version: 0.103.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 055cc3cc234..a16633df210 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 87615100b3e..98b1f0896d6 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.102.0 +version: 0.103.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 7273f827bec..1e4d61f58e3 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 4dbaf174ab6..0863ec98d4e 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.102.0 +version: 0.103.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 e69565750e4..51888279596 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.102.0 +version: 0.103.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 0ee2caf1e38..c744f27f572 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 88f7048011a..a83530914b7 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.102.0 +version: 0.103.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 245ec335829..657582183a3 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.102.0 +version: 0.103.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 1191df547f5..24350f15726 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.102.0 +version: 0.103.0 hash: | Hash a value using the md5 hash algorithm. usage: | diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index 648ce1a421f..46ca1d56c2d 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.102.0 +version: 0.103.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 0741e207c18..4fb8ef136e9 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.102.0 +version: 0.103.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 c931115a991..d548da9c07a 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.102.0 +version: 0.103.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 d755e8b753f..814101e8330 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.102.0 +version: 0.103.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 6e2a011adaa..07ede84fece 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.102.0 +version: 0.103.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 679387d2da4..2112bafb16a 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.102.0 +version: 0.103.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index a2e48da1fa7..e42c28e6b64 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.102.0 +version: 0.103.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 238fa60be52..478bf26724c 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.102.0 +version: 0.103.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index fea9aacaffb..f26b7816dd1 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.102.0 +version: 0.103.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 221a01bbe2e..2f3d6914804 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.102.0 +version: 0.103.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 9e555cfffbb..7c252021ae8 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.102.0 +version: 0.103.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index b24d97ba5cd..6ba638943b9 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.102.0 +version: 0.103.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index d0b3f418189..5e76e2a4a79 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.102.0 +version: 0.103.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | @@ -53,12 +53,12 @@ Compute a histogram for the types of files, with frequency column named freq Compute a histogram for a list of numbers ```nu > [1 2 1] | histogram -╭────┬────────┬────────┬───────────┬─────────────┬────────────────────────────────────────────────────────────────────╮ -│ # │ value │ count │ quantile │ percentage │ frequency │ -├────┼────────┼────────┼───────────┼─────────────┼────────────────────────────────────────────────────────────────────┤ -│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ -│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ -╰────┴────────┴────────┴───────────┴─────────────┴────────────────────────────────────────────────────────────────────╯ +╭───┬───────┬───────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮ +│ # │ value │ count │ quantile │ percentage │ frequency │ +├───┼───────┼───────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤ +│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ +│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ +╰───┴───────┴───────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯ ``` diff --git a/commands/docs/history.md b/commands/docs/history.md index af29cd6eabd..066ec4ec513 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.102.0 +version: 0.103.0 history: | Get the command history. usage: | @@ -57,5 +57,5 @@ Search all the commands from history that contains 'cargo' | name | description | type | | ------------------------------------------------------ | -------------------------------- | -------- | -| [`history import`](/commands/docs/history_import.md) | Import command line history | built-in | +| [`history import`](/commands/docs/history_import.md) | Import command line history. | built-in | | [`history session`](/commands/docs/history_session.md) | Get the command history session. | built-in | \ No newline at end of file diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index 9c745c5ee83..fefa739224a 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,11 +2,11 @@ title: history import categories: | history -version: 0.102.0 +version: 0.103.0 history: | - Import command line history + Import command line history. usage: | - Import command line history + Import command line history. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `history import` for [history](/commands/categories/history.md) -
Import command line history
+
Import command line history.
## Signature diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index e47d4523063..62ddfd2c555 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.102.0 +version: 0.103.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index ae3b928ef21..3a951ffc2e9 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.102.0 +version: 0.103.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 6d10bcef555..d6fec9db25b 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.102.0 +version: 0.103.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 6ff7d7c283e..b452c2064d7 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.102.0 +version: 0.103.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 2b9e824bb32..6738e7168f7 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.102.0 +version: 0.103.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index bb5258b3e37..e613d10870b 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.102.0 +version: 0.103.0 network: | Requests permitted communication options for a given URL. usage: | diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 74edde9a727..0d435d7f298 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.102.0 +version: 0.103.0 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 0a350685f45..9ace43d8516 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.102.0 +version: 0.103.0 network: | Post a body to a URL. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index f2d4ed3d997..e1ef9119265 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.102.0 +version: 0.103.0 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index 59790fe97a4..0a6fa778fe4 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.102.0 +version: 0.103.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 6a4c795b969..0cbbfc1b7f7 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.102.0 +version: 0.103.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 600bf2d8071..7b05ecf3cb2 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.102.0 +version: 0.103.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 4a0aba2548f..cdf9490fb8c 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index 4c8691a6974..221542ae5e1 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index b7b7c116c66..b823f7fa298 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index e2fa32105a9..42860d62334 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | @@ -93,6 +93,26 @@ 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 │ │ +│ │ ╰───┴───────╯ │ +╰───┴───────────────╯ + +``` + ## Notes When inserting a column, the closure will be run for each row, and the current row will be passed as the first argument. When inserting into a specific index, the closure will instead get the current value at the index or null if inserting at the end of a list/table. \ No newline at end of file diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index dfaf3be1389..3420df9f418 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 673a2b4b4fb..2a229695a51 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.102.0 +version: 0.103.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 08a8f1ced81..a310c977098 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Commands to convert data from one type to another. usage: | @@ -35,7 +35,6 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | ---------------------------------------------------- | ------------------------------------------ | -------- | | [`into binary`](/commands/docs/into_binary.md) | Convert value to a binary primitive. | built-in | -| [`into bits`](/commands/docs/into_bits.md) | Convert value to a binary string. | built-in | | [`into bool`](/commands/docs/into_bool.md) | Convert value to boolean. | built-in | | [`into cell-path`](/commands/docs/into_cell-path.md) | Convert value to a cell-path. | built-in | | [`into datetime`](/commands/docs/into_datetime.md) | Convert text or timestamp into a datetime. | built-in | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index c8b5d13fbc1..81b0ea80708 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md deleted file mode 100644 index c412f38afbb..00000000000 --- a/commands/docs/into_bits.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: into bits -categories: | - deprecated -version: 0.102.0 -deprecated: | - Convert value to a binary string. -usage: | - Convert value to a binary string. -editLink: false -contributors: false ---- - - -# `into bits` for [deprecated](/commands/categories/deprecated.md) - -
Convert value to a binary string.
- -## Signature - -```> into bits {flags} ...rest``` - -## Parameters - - - `...rest`: for a data structure input, convert data at the given cell paths - - -## Input/output types: - -| input | output | -| -------- | ------ | -| binary | string | -| bool | string | -| duration | string | -| filesize | string | -| int | string | -| record | record | -| string | string | -| table | table | -## Examples - -convert a binary value into a string, padded to 8 places with 0s -```nu -> 0x[1] | into bits -00000001 -``` - -convert an int into a string, padded to 8 places with 0s -```nu -> 1 | into bits -00000001 -``` - -convert a filesize value into a string, padded to 8 places with 0s -```nu -> 1b | into bits -00000001 -``` - -convert a duration value into a string, padded to 8 places with 0s -```nu -> 1ns | into bits -00000001 -``` - -convert a boolean value into a string, padded to 8 places with 0s -```nu -> true | into bits -00000001 -``` - -convert a string into a raw binary string, padded with 0s to 8 places -```nu -> 'nushell.sh' | into bits -01101110 01110101 01110011 01101000 01100101 01101100 01101100 00101110 01110011 01101000 -``` diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 128df9976cb..4a3309aae75 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index e8b54046aa9..e11e2b5a724 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.102.0 +version: 0.103.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 81aebb2a3cb..477f3230423 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -50,19 +50,19 @@ contributors: false Convert timestamp string to datetime with timezone offset ```nu > '27.02.2021 1:55 pm +0000' | into datetime -Sat, 27 Feb 2021 13:55:00 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:00 +0000 (4 years ago) ``` Convert standard timestamp string to datetime with timezone offset ```nu > '2021-02-27T13:55:40.2246+00:00' | into datetime -Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) ``` Convert non-standard timestamp string, with timezone offset, to datetime using a custom format ```nu > '20210227_135540+0000' | into datetime --format '%Y%m%d_%H%M%S%z' -Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) ``` Convert non-standard timestamp string, without timezone offset, to datetime with custom formatting @@ -74,19 +74,19 @@ Fri, 16 Nov 1984 08:00:00 +0800 (40 years ago) Convert nanosecond-precision unix timestamp to a datetime with offset from UTC ```nu > 1614434140123456789 | into datetime --offset -5 -Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) ``` Convert standard (seconds) unix timestamp to a UTC datetime ```nu > 1614434140 | into datetime -f '%s' -Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) ``` Using a datetime as input simply returns the value ```nu > 2021-02-27T13:55:40 | into datetime -Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) +Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) ``` Convert list of timestamps to datetimes diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index 264ef6bc199..9f59480e89c 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 78eda558dfc..4962dd78a9a 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 1de077a931d..b3e89d3b519 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 3dcde6247bf..4564ef854b3 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 961b6b0e68a..4c4e8c4bec8 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index de2e8cfc95f..56d09ce4695 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index ec1213e730c..a8b9baf3429 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 736137d3edf..e52f1796a4b 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.102.0 +version: 0.103.0 conversions: | Convert value to string. usage: | @@ -22,6 +22,7 @@ contributors: false ## Flags + - `--group-digits, -g`: group digits together by the locale specific thousands separator - `--decimals, -d {int}`: decimal digits to which to round ## Parameters diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 282f290febf..9f21c91aa96 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Infer Nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 25281c64669..7cdc8879a29 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.102.0 +version: 0.103.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 e895882aabb..22c142b6085 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index b634d6dc869..3240df01021 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.102.0 +version: 0.103.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 8386d0c43b6..7e21305fce3 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.102.0 +version: 0.103.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 b8cf2558191..fb33c67a20d 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.102.0 +version: 0.103.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 new file mode 100644 index 00000000000..a78c9c1bed7 --- /dev/null +++ b/commands/docs/job.md @@ -0,0 +1,40 @@ +--- +title: job +categories: | + strings +version: 0.103.0 +strings: | + Various commands for working with background jobs. +usage: | + Various commands for working with background jobs. +editLink: false +contributors: false +--- + + +# `job` for [strings](/commands/categories/strings.md) + +
Various commands for working with background jobs.
+ +## Signature + +```> job {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | + +## Notes +You must use one of the following subcommands. Using this command as-is will only produce this help message. + +## Subcommands: + +| name | description | type | +| ------------------------------------------------ | -------------------------------------------- | -------- | +| [`job kill`](/commands/docs/job_kill.md) | Kill a background job. | built-in | +| [`job list`](/commands/docs/job_list.md) | List background jobs. | built-in | +| [`job spawn`](/commands/docs/job_spawn.md) | Spawn a background job and retrieve its ID. | 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_kill.md b/commands/docs/job_kill.md new file mode 100644 index 00000000000..c56589a16a3 --- /dev/null +++ b/commands/docs/job_kill.md @@ -0,0 +1,40 @@ +--- +title: job kill +categories: | + experimental +version: 0.103.0 +experimental: | + Kill a background job. +usage: | + Kill a background job. +editLink: false +contributors: false +--- + + +# `job kill` for [experimental](/commands/categories/experimental.md) + +
Kill a background job.
+ +## Signature + +```> job kill {flags} (id)``` + +## Parameters + + - `id`: The id of the job to kill. + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Kill a newly spawned job +```nu +> let id = job spawn { sleep 10sec }; job kill $id + +``` diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md new file mode 100644 index 00000000000..35b4465bab4 --- /dev/null +++ b/commands/docs/job_list.md @@ -0,0 +1,36 @@ +--- +title: job list +categories: | + experimental +version: 0.103.0 +experimental: | + List background jobs. +usage: | + List background jobs. +editLink: false +contributors: false +--- + + +# `job list` for [experimental](/commands/categories/experimental.md) + +
List background jobs.
+ +## Signature + +```> job list {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +List all background jobs +```nu +> job list + +``` diff --git a/commands/docs/job_spawn.md b/commands/docs/job_spawn.md new file mode 100644 index 00000000000..3bc5f022f7a --- /dev/null +++ b/commands/docs/job_spawn.md @@ -0,0 +1,46 @@ +--- +title: job spawn +categories: | + experimental +version: 0.103.0 +experimental: | + Spawn a background job and retrieve its ID. +usage: | + Spawn a background job and retrieve its ID. +editLink: false +contributors: false +--- + + +# `job spawn` for [experimental](/commands/categories/experimental.md) + +
Spawn a background job and retrieve its ID.
+ +## Signature + +```> job spawn {flags} (closure)``` + +## Parameters + + - `closure`: The closure to run in another thread. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | int | + +## Examples + +Spawn a background job to do some time consuming work +```nu +> job spawn { sleep 5sec; rm evidence.pdf } + +``` + +## Notes +Executes the provided closure in a background thread +and registers this task in the background job table, which can be retrieved with `job list`. + +This command returns the job id of the newly created job. diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md new file mode 100644 index 00000000000..95d82ca05c9 --- /dev/null +++ b/commands/docs/job_unfreeze.md @@ -0,0 +1,50 @@ +--- +title: job unfreeze +categories: | + experimental +version: 0.103.0 +experimental: | + Unfreeze a frozen process job in foreground. +usage: | + Unfreeze a frozen process job in foreground. +editLink: false +contributors: false +--- + + +# `job unfreeze` for [experimental](/commands/categories/experimental.md) + +
Unfreeze a frozen process job in foreground.
+ +## Signature + +```> job unfreeze {flags} (id)``` + +## Parameters + + - `id`: The process id to unfreeze. + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Unfreeze the latest frozen job +```nu +> job unfreeze + +``` + +Unfreeze a specific frozen job by its PID +```nu +> job unfreeze 4 + +``` + +## Notes +When a running process is frozen (with the SIGTSTP signal or with the Ctrl-Z key on unix), +a background job gets registered for this process, which can then be resumed using this command. \ No newline at end of file diff --git a/commands/docs/join.md b/commands/docs/join.md index 93cca3a262f..49b8471a669 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 52f6b75f0f4..32eafff67a4 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index ebfd52820c6..de50fbdf7b4 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 98d0a5445fa..b9f9450dcfc 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.102.0 +version: 0.103.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 f1298d4418d..d5321fcccb9 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index cf359bcc25c..0c189a5516e 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 814ca1c4f9a..e1ca3595035 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index f97e145e522..3195d121b23 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.102.0 +version: 0.103.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 fbf098468c7..be1ce1700a4 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.102.0 +version: 0.103.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 4c7194fa17e..7417ebef501 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.102.0 +version: 0.103.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 2ed4605f6d6..627e0bb0527 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 125086f2289..02b6cf9176c 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 62f44f2d295..493a4991d8f 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.102.0 +version: 0.103.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 44283418a2d..66e99106a7f 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.102.0 +version: 0.103.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 c92e728c678..0098958d774 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.102.0 +version: 0.103.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 720bd62906c..d7c54a7b424 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.102.0 +version: 0.103.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 f3497d3c8e2..6155742eb12 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.102.0 +version: 0.103.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 c9785b8f090..d7e4ff1ebf4 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 3e0fc8d794b..e8249d1c578 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.102.0 +version: 0.103.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 253c7aecd4e..51ca322d220 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 93128e3f7f3..99c133dd115 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.102.0 +version: 0.103.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 fd5c55f2617..302c418b475 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index b8cf05360ab..113ee61903b 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.102.0 +version: 0.103.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 78fcf4fdc89..9b5623f41b9 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.102.0 +version: 0.103.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 9c41bee8556..fec62875a39 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.102.0 +version: 0.103.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 a46bb78907c..da56c6376dc 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 0d207499440..34037ce7867 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.102.0 +version: 0.103.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 10a50e25402..bfdd4690aa0 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.102.0 +version: 0.103.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 46dcb3c1d92..e62419cb45f 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.102.0 +version: 0.103.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 e23f8ef2da5..f619a64b25e 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.102.0 +version: 0.103.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 db0ecf8398e..acb193da0a0 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.102.0 +version: 0.103.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 4d3cf0f4d6d..e74504541e7 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.102.0 +version: 0.103.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 8b6daa10c51..fb92fdca8db 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.102.0 +version: 0.103.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 accca675e7e..bf92e7bf983 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.102.0 +version: 0.103.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 9aef7362386..cdf26d5f48f 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.102.0 +version: 0.103.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 270f7184b4c..2bb5657750a 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.102.0 +version: 0.103.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 5094b0d5ea5..022935770b2 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.102.0 +version: 0.103.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 9e93ff9d11d..96ccc44b89f 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 20f63a4871b..a1c6f0f086d 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.102.0 +version: 0.103.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 c4c2e8e5154..723fa9cc88c 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.102.0 +version: 0.103.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 183533902fd..8191bc61f05 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.102.0 +version: 0.103.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 a594855b249..4a1482dbe3e 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.102.0 +version: 0.103.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 3f15e2a480a..b2fb7945f30 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.102.0 +version: 0.103.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 26bf4f0d672..828d2f395b7 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.102.0 +version: 0.103.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 fede6f194b6..45fc675f3fa 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.102.0 +version: 0.103.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 34fa17d7828..16809e11e7f 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.102.0 +version: 0.103.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 05c00017f25..6fe88c6c7d5 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.102.0 +version: 0.103.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 c8900ce5798..086aba20ae6 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.102.0 +version: 0.103.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 b97367a5141..5b0aa74744c 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.102.0 +version: 0.103.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 6c8e1dce997..e8e8900d7ec 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index ffaf44039d9..d236ba4ab2a 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.102.0 +version: 0.103.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 2ec4be84a6c..b50b79c758b 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.102.0 +version: 0.103.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 fdf646ecca3..dcf48b07102 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.102.0 +version: 0.103.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index f8f498c302f..d709cc77184 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.102.0 +version: 0.103.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 67eba1a2506..7f9a12d6f58 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.102.0 +version: 0.103.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 9e4f342ac0f..6b31a695f09 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.102.0 +version: 0.103.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 3debe211194..cd6d15bf4cb 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Validate and parse input content. usage: | @@ -75,15 +75,3 @@ Parse a string as script > $'two(char nl)lines' | nu-check ``` - -Heuristically parse which begins with script first, if it sees a failure, try module afterwards -```nu -> nu-check -a script.nu - -``` - -Heuristically parse by showing error message -```nu -> open foo.nu | lines | nu-check --all --debug - -``` diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 7e07e302cbb..1370007e78c 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 1f784918148..5fba937a16f 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.102.0 +version: 0.103.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 e4ba0e2aba4..b6cf8efee0a 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.102.0 +version: 0.103.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 26efb836eda..86f60bffa97 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.102.0 +version: 0.103.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 162990540b8..f17c2062c85 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.102.0 +version: 0.103.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index e0263e916ce..f6a4078e892 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.102.0 +version: 0.103.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 3343bf3030f..d09475ea2c5 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.102.0 +version: 0.103.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 475cd41c504..147ae123e82 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 630132f7d18..8ead9c2a5e5 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.102.0 +version: 0.103.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 f32d6c570ca..0dec75c80ad 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.102.0 +version: 0.103.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 c6fb87ef38f..8466a84cbdf 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.102.0 +version: 0.103.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 4a45cccd5f8..8239d380f03 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.102.0 +version: 0.103.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 e9cff8356e5..c9bf13fe987 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.102.0 +version: 0.103.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 e66373fa262..834eda03abc 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.102.0 +version: 0.103.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 2bd8a7602cc..5116d291f06 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.102.0 +version: 0.103.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 b4578ebca06..69b7de3f7e9 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.102.0 +version: 0.103.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 81105113085..b6cc1438d9f 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.102.0 +version: 0.103.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 30084829b68..2530b237220 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.102.0 +version: 0.103.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 77c7f56d147..7dab545fc4f 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.102.0 +version: 0.103.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 3629608c7ab..fe9589548bf 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.102.0 +version: 0.103.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 83f24dd27a0..e4f7c8e1fb2 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.102.0 +version: 0.103.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 18850796f65..f1ab4a4b6a0 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 8a1b15e442f..0ffa9757f3c 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | Add a plugin to the plugin registry file. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `filename`: Path to the executable for the plugin + - `filename`: Path to the executable for the plugin. ## Input/output types: diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 68db6f92b76..d83f3047812 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | List loaded and installed plugins. usage: | @@ -38,13 +38,13 @@ contributors: false List installed plugins. ```nu > plugin list -╭─────┬────────┬──────────────┬───────────┬──────────┬────────────────────────────────┬────────┬──────────────╮ -│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ -├─────┼────────┼──────────────┼───────────┼──────────┼────────────────────────────────┼────────┼──────────────┤ -│ 0 │ inc │ 0.102.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ -│ │ │ │ │ │ │ │ │ 0 │ inc │ │ -│ │ │ │ │ │ │ │ ╰───┴─────╯ │ -╰─────┴────────┴──────────────┴───────────┴──────────┴────────────────────────────────┴────────┴──────────────╯ +╭───┬──────┬─────────┬─────────┬────────┬───────────────────────────────┬───────┬─────────────╮ +│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ +├───┼──────┼─────────┼─────────┼────────┼───────────────────────────────┼───────┼─────────────┤ +│ 0 │ inc │ 0.103.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ │ │ │ │ │ │ │ │ 0 │ inc │ │ +│ │ │ │ │ │ │ │ ╰───┴─────╯ │ +╰───┴──────┴─────────┴─────────┴────────┴───────────────────────────────┴───────┴─────────────╯ ``` @@ -75,4 +75,4 @@ or the plugin has not been loaded yet, the values of `version`, `filename`, `shell`, and `commands` reflect the values in the engine and not the ones in the plugin registry file. -See also: `plugin use` +See also: `plugin use` \ No newline at end of file diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 21c211934d0..aba84ebaa44 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | Remove a plugin from the plugin registry file. usage: | @@ -27,7 +27,7 @@ contributors: false ## Parameters - - `name`: The name, or filename, of the plugin to remove + - `name`: The name, or filename, of the plugin to remove. ## Input/output types: diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index 0bac642027e..9d2913add80 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | Stop an installed plugin if it was running. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `name`: The name, or filename, of the plugin to stop + - `name`: The name, or filename, of the plugin to stop. ## Input/output types: diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index 16f4997971d..11cff4d84de 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.102.0 +version: 0.103.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `name`: The name, or filename, of the plugin to load + - `name`: The name, or filename, of the plugin to load. ## Input/output types: diff --git a/commands/docs/polars.md b/commands/docs/polars.md index b30af27d1a3..74f6e88096f 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -35,7 +35,21 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. | nothing | string | ## Notes -You must use one of the following subcommands. Using this command as-is will only produce this help message. + +You must use one of the subcommands below. Using this command as-is will only produce this help message. + +The following are the main datatypes (wrapped from Polars) that are used by these subcommands: + +Lazy and Strict dataframes (called `NuLazyFrame` and `NuDataFrame` in error messages) are the main +data structure. + +Expressions, representing various column operations (called `NuExpression`), are passed to many commands such as +`polars filter` or `polars with-column`. Most nushell operators are supported in these expressions, importantly +arithmetic, comparison and boolean logical. + +Groupbys (`NuLazyGroupBy`), the output of a `polars group-by`, represent a grouped dataframe and are typically piped +to the `polars agg` command with some column expressions for aggregation which then returns a dataframe. + ## Subcommands: @@ -107,6 +121,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | 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 max`](/commands/docs/polars_max.md) | Creates a max expression or aggregates columns to their max value. | plugin | @@ -144,6 +159,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | 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 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 | diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index a747f1008c0..9f37955fbd3 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.102.0 +version: 0.103.0 dataframe: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 03081c82174..75777cb7a79 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.102.0 +version: 0.103.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 cdd0b4e2c6e..ece646ce463 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.102.0 +version: 0.103.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 08c37ea787b..a68b32c99fe 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.102.0 +version: 0.103.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 61a23fcf710..481b549bd44 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index dfb512f39b4..a48ff22a885 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.102.0 +version: 0.103.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 cc065324cb4..af2c0ca8b13 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.102.0 +version: 0.103.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 c5d7a216e31..14d86bd0994 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.102.0 +version: 0.103.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 61b0ab67d18..f218e8cc833 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.102.0 +version: 0.103.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 654747cc7f3..8c9269a4a22 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.102.0 +version: 0.103.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 aa63060faa2..111c7b7a991 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.102.0 +version: 0.103.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 0d231cc43b7..c60b3ca167a 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.102.0 +version: 0.103.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 56ef5c07b43..5943dce0e20 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.102.0 +version: 0.103.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 4c093f87b9b..d46ec0a4a5f 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.102.0 +version: 0.103.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index bda96757d59..8e7f6f239fe 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 3f6ad377be9..ecf5e20b9de 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.102.0 +version: 0.103.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 4569177cf4e..cf78ce457fc 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.102.0 +version: 0.103.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 5afd5cc5222..a4cd64f4ac5 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.102.0 +version: 0.103.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index e6236d09d70..7f9d7c89f26 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index cf891d12a7d..853f8b7095d 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.102.0 +version: 0.103.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index cc13a7e228e..cc74ebd50d8 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Concatenate two or more dataframes. usage: | @@ -33,6 +33,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. - `--rechunk`: Rechunk the resulting dataframe - `--to-supertypes`: Cast to supertypes - `--diagonal`: Concatenate dataframes diagonally + - `--no-maintain-order`: Do not maintain order. The default behavior is to maintain order. - `--from-partitioned-ds`: Concatenate dataframes from a partitioned dataset ## Parameters diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 6ada7c0f7ed..781718a1a04 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 33a89377049..acf83892298 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.102.0 +version: 0.103.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index a5d7ab7f232..c5c396abc5c 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.102.0 +version: 0.103.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 32b0084610b..0dce51c512b 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Cumulative calculation for a column or series. usage: | diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index c3c8cfe9910..39665ae2d9c 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.102.0 +version: 0.103.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -61,10 +61,10 @@ Creates an expression to capture multiple date parts (polars col datetime | polars datepart minute | polars as datetime_minute ), (polars col datetime | polars datepart second | polars as datetime_second ), (polars col datetime | polars datepart nanosecond | polars as datetime_ns ) ] -╭─────┬───────────────┬─────────────────┬──────────────────┬───────────────┬────────────────┬──────────────────┬──────╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ ... │ -├─────┼───────────────┼─────────────────┼──────────────────┼───────────────┼────────────────┼──────────────────┼──────┤ -│ 0 │ 3 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ ... │ -╰─────┴───────────────┴─────────────────┴──────────────────┴───────────────┴────────────────┴──────────────────┴──────╯ +╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮ +│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ +├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤ +│ 0 │ 3 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ +╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯ ``` diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index e9f48dba48c..15272e4b9f6 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.102.0 +version: 0.103.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 ba7d5d81d6e..e6254ee9ed6 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.102.0 +version: 0.103.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 fab86dd312f..a9d4fc8e733 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.102.0 +version: 0.103.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index fdd89448795..1de83043ac7 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.102.0 +version: 0.103.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 402f06d41c2..4bd08cbea8d 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 1b1d1980325..08b4334094e 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.102.0 +version: 0.103.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 74c469f15c8..d00bec4fae5 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.102.0 +version: 0.103.0 dataframe: | Creates a not expression. usage: | diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md index f257964d457..08730cc178d 100644 --- a/commands/docs/polars_fetch.md +++ b/commands/docs/polars_fetch.md @@ -2,7 +2,7 @@ title: polars fetch categories: | lazyframe -version: 0.102.0 +version: 0.103.0 lazyframe: | Collects the lazyframe to the selected rows. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index eb8edd47930..b6c92d0b1da 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.102.0 +version: 0.103.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 13182af2cd9..4667249bf21 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.102.0 +version: 0.103.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 660249486fa..0205ce12c39 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.102.0 +version: 0.103.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 e20082a9c2e..cd9520d81d0 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.102.0 +version: 0.103.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index b1bb6d84588..17674e43d1c 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.102.0 +version: 0.103.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 40a68ed126a..6027dd2ebe1 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.102.0 +version: 0.103.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 499e98ef68c..0c382612dbc 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.102.0 +version: 0.103.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 97586f54952..29bb00ab2e9 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.102.0 +version: 0.103.0 dataframe: | Gets hour from date. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index aa7aeba3437..ca4050b1807 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.102.0 +version: 0.103.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index 33d87f32cd4..be14977d3e5 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.102.0 +version: 0.103.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 616d4c5ccbe..bfacfe96113 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.102.0 +version: 0.103.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 92c9c7c64d0..97cc0a1ed47 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.102.0 +version: 0.103.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 77935b67be6..b5b94911f81 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.102.0 +version: 0.103.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 26fdc682918..d36374212fa 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.102.0 +version: 0.103.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index c71b48cbc44..a2b0b6720d9 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.102.0 +version: 0.103.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index ac0f2126349..f0cf053d092 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.102.0 +version: 0.103.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index c6c2f7e9a89..9431e25f355 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.102.0 +version: 0.103.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 018e51e59e0..475d07c12ac 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.102.0 +version: 0.103.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 015936f4f3d..e0c2070ba18 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Aggregates values into a list. usage: | diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index 39a0ede93a8..6a7808220ef 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.102.0 +version: 0.103.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 49540b99d8c..d2937952347 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.102.0 +version: 0.103.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 0b7c8caf35a..5fc14ebfd6a 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.102.0 +version: 0.103.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 7e9d5e7f7f6..f22b6f896da 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.102.0 +version: 0.103.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 c1f0206d12b..b93f4502e07 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.102.0 +version: 0.103.0 dataframe: | Display a dataframe in its repr format. usage: | diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 4272200aa46..5d77c92c4e0 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.102.0 +version: 0.103.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 2f64bc9eff1..956f3e7ad63 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.102.0 +version: 0.103.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 f96ee707f6f..79c62d4a7e5 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.102.0 +version: 0.103.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 14b7e5b53cc..644a355f86d 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.102.0 +version: 0.103.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 b9fae36323d..dbe9f18162b 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.102.0 +version: 0.103.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index bb677d34cc0..6891d54d36c 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.102.0 +version: 0.103.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 cc5f549776b..bd03a7467ff 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.102.0 +version: 0.103.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 abafc704004..232d61a3802 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.102.0 +version: 0.103.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 new file mode 100644 index 00000000000..44e18403d76 --- /dev/null +++ b/commands/docs/polars_list-contains.md @@ -0,0 +1,86 @@ +--- +title: polars list-contains +categories: | + dataframe +version: 0.103.0 +dataframe: | + Checks if an element is contained in a list. +usage: | + Checks if an element is contained in a list. +editLink: false +contributors: false +--- + + +# `polars list-contains` for [dataframe](/commands/categories/dataframe.md) + +
Checks if an element is contained in a list.
+ +::: warning This command requires a plugin +The `polars list-contains` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Signature + +```> polars list-contains {flags} (element)``` + +## Parameters + + - `element`: Element to search for in the list + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Returns boolean indicating if a literal element was found in a list column +```nu +> let df = [[a]; [[a,b,c]] [[b,c,d]] [[c,d,f]]] | polars into-df -s {a: list}; + let df2 = $df | polars with-column [(polars col a | polars list-contains (polars lit a) | polars as b)] | polars collect; + $df2.b +╭───┬───────╮ +│ # │ b │ +├───┼───────┤ +│ 0 │ true │ +│ 1 │ false │ +│ 2 │ false │ +╰───┴───────╯ + +``` + +Returns boolean indicating if an element from another column was found in a list column +```nu +> let df = [[a, b]; [[a,b,c], a] [[b,c,d], f] [[c,d,f], f]] | polars into-df -s {a: list, b: str}; + let df2 = $df | polars with-column [(polars col a | polars list-contains b | polars as c)] | polars collect; + $df2.c +╭───┬───────╮ +│ # │ b │ +├───┼───────┤ +│ 0 │ true │ +│ 1 │ false │ +│ 2 │ true │ +╰───┴───────╯ + +``` + +Returns boolean indicating if an element from another expression was found in a list column +```nu +> let df = [[a, b]; [[1,2,3], 4] [[2,4,1], 2] [[2,1,6], 3]] | polars into-df -s {a: list, b: i64}; + let df2 = $df | polars with-column [(polars col a | polars list-contains ((polars col b) * 2) | polars as c)] | polars collect; + $df2.c +╭───┬───────╮ +│ # │ b │ +├───┼───────┤ +│ 0 │ false │ +│ 1 │ true │ +│ 2 │ true │ +╰───┴───────╯ + +``` diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 6875f25266f..c90ac15405f 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.102.0 +version: 0.103.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index a6bcc9e57ac..fea77e19d46 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 624efb30736..c3aa8870a68 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.102.0 +version: 0.103.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 79df989b42e..37ceaab476d 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.102.0 +version: 0.103.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 9257d83c01e..3ebd4c47b34 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.102.0 +version: 0.103.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 b81e8bb244e..ff230101b30 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.102.0 +version: 0.103.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 27213a215f7..95b83962e43 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.102.0 +version: 0.103.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 251e7a3a722..b14e84321e1 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 447ccf7f885..e5bac8ef874 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.102.0 +version: 0.103.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: | @@ -37,6 +37,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. - `--skip-rows {number}`: Number of rows to skip from file. CSV file - `--columns {list}`: Columns to be selected from csv file. CSV and Parquet file - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files + - `--hive-enabled`: Enable hive support. Parquet and Arrow files + - `--hive-start-idx {number}`: Start index of hive partitioning. Parquet and Arrow files + - `--hive-schema {record}`: Hive schema in format [{name: str}]. Parquet and Arrow files + - `--hive-try-parse-dates`: Try to parse dates in hive partitioning. Parquet and Arrow files - `--truncate-ragged-lines`: Truncate lines that are longer than the schema. CSV file ## Parameters diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index 054c860c232..0d301966742 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.102.0 +version: 0.103.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index b84d89945a0..6a5a2e65bec 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Pivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index 2d6be47026d..fcba3c2299b 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Profile a lazy dataframe. usage: | diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index cdb2a090930..7110a10b0b0 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.102.0 +version: 0.103.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 516a4c4803d..1a778cc2bd9 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.102.0 +version: 0.103.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 55bc2830773..f0c6bac315a 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.102.0 +version: 0.103.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/polars_replace-all.md b/commands/docs/polars_replace-all.md index 98c19580752..12589bfac08 100644 --- a/commands/docs/polars_replace-all.md +++ b/commands/docs/polars_replace-all.md @@ -2,7 +2,7 @@ title: polars replace-all categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 8dc33b6cc8b..51032c3f269 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 2bade57bdbf..ced94e15b03 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 9a340f9f329..74275af3af2 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index c439c36ff6c..8937deb12b6 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index efd80510c6b..31921504655 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.102.0 +version: 0.103.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: | @@ -36,7 +36,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Parameters - - `path`: Path to write to. + - `path`: Path or cloud url to write to ## Input/output types: @@ -79,12 +79,12 @@ Saves dataframe to avro file Saves dataframe to CSV file ```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr save test.csv +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.csv ``` Saves dataframe to CSV file using other delimiter ```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr save test.csv --delimiter '|' +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.csv --csv-delimiter '|' ``` diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 9d418123b9d..150ebd8c343 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index d7f7bc4a24a..049c46fef52 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.102.0 +version: 0.103.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index 3d2a3adca70..3d5645cfe63 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.102.0 +version: 0.103.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 4f4c1a6ffc9..f7442b3d1db 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.102.0 +version: 0.103.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 921f6f1a0d8..647e836c680 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.102.0 +version: 0.103.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 d7846ac77eb..9bbd6c465e6 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.102.0 +version: 0.103.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 feeb1a9605b..8d94f8695ef 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.102.0 +version: 0.103.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 79225bc45ac..d9a52301a07 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.102.0 +version: 0.103.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 9512e2cc809..6b44924afde 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.102.0 +version: 0.103.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 b97b38e0351..268a22dac36 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.102.0 +version: 0.103.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 e0498b609ed..bffb24d2928 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.102.0 +version: 0.103.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 77fa1561ef9..98e8367b453 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.102.0 +version: 0.103.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 ed345c46772..964651089db 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.102.0 +version: 0.103.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 f18cc05e424..bc04889f2b1 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.102.0 +version: 0.103.0 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index a86e88f19c0..3e6f31c05f0 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.102.0 +version: 0.103.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 54f5ffad168..5ae5f01e0fc 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.102.0 +version: 0.103.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 new file mode 100644 index 00000000000..1072bb6bfa4 --- /dev/null +++ b/commands/docs/polars_str-strip-chars.md @@ -0,0 +1,98 @@ +--- +title: polars str-strip-chars +categories: | + dataframe +version: 0.103.0 +dataframe: | + Strips specified characters from strings in a column +usage: | + Strips specified characters from strings in a column +editLink: false +contributors: false +--- + + +# `polars str-strip-chars` for [dataframe](/commands/categories/dataframe.md) + +
Strips specified characters from strings in a column
+ +::: warning This command requires a plugin +The `polars str-strip-chars` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Signature + +```> polars str-strip-chars {flags} (pattern)``` + +## Flags + + - `--start, -s`: Strip from start of strings only + - `--end, -e`: Strip from end of strings only + +## Parameters + + - `pattern`: Characters to strip as either a string or polars expression + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Strip characters from both ends of strings in a column +```nu +> [[text]; ["!!!hello!!!"] ["!!!world!!!"] ["!!!test!!!"]] | polars into-df | polars select (polars col text | polars str-strip-chars "!") | polars collect +╭───┬───────╮ +│ # │ text │ +├───┼───────┤ +│ 0 │ hello │ +│ 1 │ world │ +│ 2 │ test │ +╰───┴───────╯ + +``` + +Strip characters from both ends of strings in a column using an expression +```nu +> [[text]; ["!!!hello!!!"] ["!!!world!!!"] ["!!!test!!!"]] | polars into-df | polars select (polars col text | polars str-strip-chars (polars lit "!")) | polars collect +╭───┬───────╮ +│ # │ text │ +├───┼───────┤ +│ 0 │ hello │ +│ 1 │ world │ +│ 2 │ test │ +╰───┴───────╯ + +``` + +Strip characters from end of strings in a column +```nu +> [[text]; ["hello!!!"] ["world!!!"] ["test!!!"]] | polars into-df | polars select (polars col text | polars str-strip-chars --end "!") | polars collect +╭───┬───────╮ +│ # │ text │ +├───┼───────┤ +│ 0 │ hello │ +│ 1 │ world │ +│ 2 │ test │ +╰───┴───────╯ + +``` + +Strip characters from start of strings in a column +```nu +> [[text]; ["!!!hello"] ["!!!world"] ["!!!test"]] | polars into-df | polars select (polars col text | polars str-strip-chars --start "!") | polars collect +╭───┬───────╮ +│ # │ text │ +├───┼───────┤ +│ 0 │ hello │ +│ 1 │ world │ +│ 2 │ test │ +╰───┴───────╯ + +``` diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index 478c371f81f..a71b59d04bd 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index 4116164bc4f..699307c3e1e 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.102.0 +version: 0.103.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 389d86ee624..4c7beb58209 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.102.0 +version: 0.103.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 f009cc97981..058c7e172aa 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.102.0 +version: 0.103.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index fd9768d8806..a9bcfee0142 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.102.0 +version: 0.103.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 7576a6c8fad..d812fdbd412 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.102.0 +version: 0.103.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 4ec53f6599d..4e7009991b7 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.102.0 +version: 0.103.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 e096839db14..ffbf855c503 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.102.0 +version: 0.103.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 64f03a5e468..d0c08404962 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.102.0 +version: 0.103.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 a4a016e719d..43ac106199e 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.102.0 +version: 0.103.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 c90992eb002..ca4c6a23dd6 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.102.0 +version: 0.103.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 7a1a9a220dd..1836d0f0273 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.102.0 +version: 0.103.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index fd1e57e694e..fa8260f8861 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.102.0 +version: 0.103.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index fe88a7cb745..29eb06d9e89 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index ba3a089cadf..3afbd1b3303 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 622d2b26286..44475902e3b 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 221e8eb4633..97c73e9ab1e 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.102.0 +version: 0.103.0 default: | Return the current working directory usage: | @@ -22,7 +22,7 @@ contributors: false ## Flags - - `--physical, -P`: resolve symbolic links + - `--physical, -P`: Resolve symbolic links ## Input/output types: diff --git a/commands/docs/query.md b/commands/docs/query.md index eeaba3587ad..364f94b3bf4 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index eb9bf1266d7..0964c6018ae 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.102.0 +version: 0.103.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 1d624c792ad..72a86cc4587 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -37,3 +37,54 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. | input | output | | ----- | ------ | | any | any | + +## Examples + +Get a list of children from a json object +```nu +> '{"children": ["Sara","Alex","Jack"]}' | query json children +╭───┬──────╮ +│ 0 │ Sara │ +│ 1 │ Alex │ +│ 2 │ Jack │ +╰───┴──────╯ + +``` + +Get a list of first names of the friends from a json object +```nu +> '{ + "friends": [ + {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]}, + {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]}, + {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]} + ] +}' | query json friends.#.first +╭───┬───────╮ +│ 0 │ Dale │ +│ 1 │ Roger │ +│ 2 │ Jane │ +╰───┴───────╯ + +``` + +Get the key named last of the name from a json object +```nu +> '{"name": {"first": "Tom", "last": "Anderson"}}' | query json name.last +Anderson +``` + +Get the count of children from a json object +```nu +> '{"children": ["Sara","Alex","Jack"]}' | query json children.# +3 +``` + +Get the first child from the children array in reverse the order using the @reverse modifier from a json object +```nu +> '{"children": ["Sara","Alex","Jack"]}' | query json "children|@reverse|0" +Jack +``` + +## Notes +query json uses the gjson crate https://github.com/tidwall/gjson.rs to query json data. The query syntax is available at https://github.com/tidwall/gjson/blob/master/SYNTAX.md. \ No newline at end of file diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index d7206ca0cb5..496b2e63f1b 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.102.0 +version: 0.103.0 network: | execute selector query on html/web usage: | diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index dd1ae4329f1..3f1495d0061 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.102.0 +version: 0.103.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 01acfe36a15..320dec06d2f 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | execute xpath query on xml usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 41e11ed5414..693c26cff71 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.102.0 +version: 0.103.0 random: | Generate a random value. usage: | @@ -40,4 +40,4 @@ You must use one of the following subcommands. Using this command as-is will onl | [`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 uuid4 string. | built-in | \ No newline at end of file +| [`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 71571489d4f..79924b38d66 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.102.0 +version: 0.103.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index dd63621f402..99e26a1648c 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.102.0 +version: 0.103.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index fe93a0dea7d..e3363d36233 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.102.0 +version: 0.103.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 index f137d68215d..9165cfd103e 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.102.0 +version: 0.103.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 7e1925684fa..98f25b24208 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.102.0 +version: 0.103.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 c22dbc8ba02..b45553b489b 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.102.0 +version: 0.103.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 1e875833c0c..da800ed58db 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,11 +2,11 @@ title: random uuid categories: | random -version: 0.102.0 +version: 0.103.0 random: | - Generate a random uuid4 string. + Generate a random uuid string of the specified version. usage: | - Generate a random uuid4 string. + Generate a random uuid string of the specified version. editLink: false contributors: false --- @@ -14,12 +14,19 @@ contributors: false # `random uuid` for [random](/commands/categories/random.md) -
Generate a random uuid4 string.
+
Generate a random uuid string of the specified version.
## Signature ```> random uuid {flags} ``` +## Flags + + - `--version, -v {int}`: The UUID version to generate (1, 3, 4, 5, 7). Defaults to 4 if not specified. + - `--namespace, -n {string}`: The namespace for v3 and v5 UUIDs (dns, url, oid, x500). Required for v3 and v5. + - `--name, -s {string}`: The name string for v3 and v5 UUIDs. Required for v3 and v5. + - `--mac, -m {string}`: The MAC address (node ID) used to generate v1 UUIDs. Required for v1. + ## Input/output types: @@ -29,8 +36,38 @@ contributors: false ## Examples -Generate a random uuid4 string +Generate a random uuid v4 string (default) ```nu > random uuid ``` + +Generate a uuid v1 string (timestamp-based) +```nu +> random uuid -v 1 -m 00:11:22:33:44:55 + +``` + +Generate a uuid v3 string (namespace with MD5) +```nu +> random uuid -v 3 -n dns -s example.com + +``` + +Generate a uuid v4 string (random). +```nu +> random uuid -v 4 + +``` + +Generate a uuid v5 string (namespace with SHA1) +```nu +> random uuid -v 5 -n dns -s example.com + +``` + +Generate a uuid v7 string (timestamp + random) +```nu +> random uuid -v 7 + +``` diff --git a/commands/docs/range.md b/commands/docs/range.md deleted file mode 100644 index abfedc7dfe0..00000000000 --- a/commands/docs/range.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: range -categories: | - deprecated -version: 0.102.0 -deprecated: | - Return only the selected rows. -usage: | - Return only the selected rows. -editLink: false -contributors: false ---- - - -# `range` for [deprecated](/commands/categories/deprecated.md) - -
Return only the selected rows.
- -## Signature - -```> range {flags} (rows)``` - -## Parameters - - - `rows`: Range of rows to return. - - -## Input/output types: - -| input | output | -| --------- | --------- | -| list\ | list\ | - -## Examples - -Get the last 2 items -```nu -> [0,1,2,3,4,5] | range 4..5 -╭───┬───╮ -│ 0 │ 4 │ -│ 1 │ 5 │ -╰───┴───╯ - -``` - -Get the last 2 items -```nu -> [0,1,2,3,4,5] | range (-2).. -╭───┬───╮ -│ 0 │ 4 │ -│ 1 │ 5 │ -╰───┴───╯ - -``` - -Get the next to last 2 items -```nu -> [0,1,2,3,4,5] | range (-3)..-2 -╭───┬───╮ -│ 0 │ 3 │ -│ 1 │ 4 │ -╰───┴───╯ - -``` diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 2f67c95e2ff..0d8ff63d4f8 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index fad58434141..33431378c04 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.102.0 +version: 0.103.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 158ed78e768..0b998c8162a 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.102.0 +version: 0.103.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 f86f80c4b9f..fe7fb848d2a 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 2876eff95e6..c604e705f2a 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,11 +2,11 @@ title: return categories: | core -version: 0.102.0 +version: 0.103.0 core: | - Return early from a function. + Return early from a custom command. usage: | - Return early from a function. + Return early from a custom command. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `return` for [core](/commands/categories/core.md) -
Return early from a function.
+
Return early from a custom command.
## Signature diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index eff051c839f..f7921a6737e 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index a2a069b60f1..efd4ae38288 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 4634b5926ac..0a5ed44f4e5 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index c9f88a05e57..9ec116b0b61 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 881477cb4ac..f8f6969c3dc 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 919498632ae..b8a7ae6b502 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index ef976decb4c..910f0840821 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 36f9dc519a0..3d87ea88570 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `...rest`: the names to give columns once rotated + - `...rest`: The names to give columns once rotated. ## Input/output types: diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index a4500ab2aa9..eff0d64fa71 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.102.0 +version: 0.103.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index ef2aa4ee5d2..e6b6e203c90 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index 66ab06c943c..c494608851b 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.102.0 +version: 0.103.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index c0b8a784015..564d5478147 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.102.0 +version: 0.103.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 6bae8d040eb..3549f0f151a 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.102.0 +version: 0.103.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 e33c363798e..22faf1d70bf 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.102.0 +version: 0.103.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 96a2d34652d..4069e6881db 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.102.0 +version: 0.103.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 31136a3fbca..db1525e3747 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.102.0 +version: 0.103.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 64cd42d3d6b..328113f022f 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.102.0 +version: 0.103.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 728ec274564..d772bf9472f 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.102.0 +version: 0.103.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 04aedd2ae59..231ba77a6ef 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.102.0 +version: 0.103.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 883ec495ad4..c492e8a3546 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.102.0 +version: 0.103.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 188b9f3d7c9..c5830fc2790 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.102.0 +version: 0.103.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index e09857c4954..e0916e6ebd9 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.102.0 +version: 0.103.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 5672835a84b..429136ef665 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index aaf9835437a..d3e4fa29e6b 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 882bfdaf4d7..67a014dd122 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.102.0 +version: 0.103.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 ed6db84c12d..56a51c9a239 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.102.0 +version: 0.103.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 2b47f5a9adf..8cf9a9a24ef 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/slice.md b/commands/docs/slice.md index 18e7a12aacf..4b9a9fe4015 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index c7549b52a1b..730c69ce723 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 2b17ece87c6..598a2535d0e 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 5c555674126..e538bb60207 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.102.0 +version: 0.103.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 9c19d19a604..40d19380916 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.102.0 +version: 0.103.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 2c48adf5af4..b898c8fcaef 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.102.0 +version: 0.103.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 bdd725cf797..7978f47b76f 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.102.0 +version: 0.103.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 87ed7735edb..c92f3bb5b74 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.102.0 +version: 0.103.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 8aef03d592c..fe4145acc0b 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.102.0 +version: 0.103.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 90234429798..23448ac495f 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Split a list into multiple lists using a separator. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--regex, -r`: separator is a regular expression, matching values that can be coerced into a string + - `--split {string}`: Whether to split lists before, after, or on (default) the separator ## Parameters @@ -78,18 +79,19 @@ Split a list of lists into two lists of lists Split a list of chars into two lists ```nu > [a, b, c, d, a, e, f, g] | split list a -╭───┬───────────╮ -│ 0 │ ╭───┬───╮ │ -│ │ │ 0 │ b │ │ -│ │ │ 1 │ c │ │ -│ │ │ 2 │ d │ │ -│ │ ╰───┴───╯ │ -│ 1 │ ╭───┬───╮ │ -│ │ │ 0 │ e │ │ -│ │ │ 1 │ f │ │ -│ │ │ 2 │ g │ │ -│ │ ╰───┴───╯ │ -╰───┴───────────╯ +╭───┬────────────────╮ +│ 0 │ [list 0 items] │ +│ 1 │ ╭───┬───╮ │ +│ │ │ 0 │ b │ │ +│ │ │ 1 │ c │ │ +│ │ │ 2 │ d │ │ +│ │ ╰───┴───╯ │ +│ 2 │ ╭───┬───╮ │ +│ │ │ 0 │ e │ │ +│ │ │ 1 │ f │ │ +│ │ │ 2 │ g │ │ +│ │ ╰───┴───╯ │ +╰───┴────────────────╯ ``` @@ -112,3 +114,55 @@ Split a list of chars into lists based on multiple characters ╰───┴───────────╯ ``` + +Split a list of numbers on multiples of 3 +```nu +> [1 2 3 4 5 6 7 8 9 10] | split list {|e| $e mod 3 == 0 } +╭───┬────────────╮ +│ 0 │ ╭───┬───╮ │ +│ │ │ 0 │ 1 │ │ +│ │ │ 1 │ 2 │ │ +│ │ ╰───┴───╯ │ +│ 1 │ ╭───┬───╮ │ +│ │ │ 0 │ 4 │ │ +│ │ │ 1 │ 5 │ │ +│ │ ╰───┴───╯ │ +│ 2 │ ╭───┬───╮ │ +│ │ │ 0 │ 7 │ │ +│ │ │ 1 │ 8 │ │ +│ │ ╰───┴───╯ │ +│ 3 │ ╭───┬────╮ │ +│ │ │ 0 │ 10 │ │ +│ │ ╰───┴────╯ │ +╰───┴────────────╯ + +``` + +Split a list of numbers into lists ending with 0 +```nu +> [1 2 0 3 4 5 0 6 0 0 7] | split list --split after 0 +╭───┬───────────╮ +│ 0 │ ╭───┬───╮ │ +│ │ │ 0 │ 1 │ │ +│ │ │ 1 │ 2 │ │ +│ │ │ 2 │ 0 │ │ +│ │ ╰───┴───╯ │ +│ 1 │ ╭───┬───╮ │ +│ │ │ 0 │ 3 │ │ +│ │ │ 1 │ 4 │ │ +│ │ │ 2 │ 5 │ │ +│ │ │ 3 │ 0 │ │ +│ │ ╰───┴───╯ │ +│ 2 │ ╭───┬───╮ │ +│ │ │ 0 │ 6 │ │ +│ │ │ 1 │ 0 │ │ +│ │ ╰───┴───╯ │ +│ 3 │ ╭───┬───╮ │ +│ │ │ 0 │ 0 │ │ +│ │ ╰───┴───╯ │ +│ 4 │ ╭───┬───╮ │ +│ │ │ 0 │ 7 │ │ +│ │ ╰───┴───╯ │ +╰───┴───────────╯ + +``` diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 63ec3926632..b19544aae90 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.102.0 +version: 0.103.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 3ba2871f56d..acd66b80729 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 7a0a8b2a144..c4703451ee2 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.102.0 +version: 0.103.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 f559abee500..1cc45325592 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.102.0 +version: 0.103.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 e5349b13a18..d7e87bd25b0 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.102.0 +version: 0.103.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 dae554d0920..15a7d5d461c 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.102.0 +version: 0.103.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 d1cc9c250ad..727a4392815 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.102.0 +version: 0.103.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 eb3b491d8bc..9c2a47fcfdd 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.102.0 +version: 0.103.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 57716db6c24..561f256c183 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.102.0 +version: 0.103.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 5a0290ca0bd..45ee2338edc 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.102.0 +version: 0.103.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index b1844dfb86f..21784ecb012 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.102.0 +version: 0.103.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 30cfd245158..907b6157aa7 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.102.0 +version: 0.103.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 6f5ff272377..20586516351 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Various commands for working with string data. usage: | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 56e1110f076..90dd1941125 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.102.0 +version: 0.103.0 strings: | Convert a string to camelCase. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index bcbe55573fa..0c045a43fff 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 80a8a2330ce..6da7cd8ba51 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.102.0 +version: 0.103.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 18cfc8825f0..c3496f970d7 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.102.0 +version: 0.103.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 7c1c89763e9..fcab7af45ba 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 07eb49d2873..fab9f10b7c5 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.102.0 +version: 0.103.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 06441dc587e..f6ec1a7a438 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | @@ -152,5 +152,22 @@ Also, it is possible to use one inside another. Here is a real-world example, th ``` +Supports zero padding in numeric ranges. +```nu +> "A{08..10}B{11..013}C" | str expand +╭───┬──────────╮ +│ 0 │ A08B011C │ +│ 1 │ A08B012C │ +│ 2 │ A08B013C │ +│ 3 │ A09B011C │ +│ 4 │ A09B012C │ +│ 5 │ A09B013C │ +│ 6 │ A10B011C │ +│ 7 │ A10B012C │ +│ 8 │ A10B013C │ +╰───┴──────────╯ + +``` + ## Notes This syntax may seem familiar with `glob {A,B}.C`. The difference is glob relies on filesystem, but str expand is not. Inside braces, we put variants. Then basically we're creating all possible outcomes. \ No newline at end of file diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index d8aa08f6c3e..dcc0a7756eb 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.102.0 +version: 0.103.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 88105c2c814..203fe2c1d4d 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.102.0 +version: 0.103.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 1ffdc62ba30..7b09995066e 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.102.0 +version: 0.103.0 strings: | Convert a string to kebab-case. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 67b5f9cf8ce..c88b326dd0e 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.102.0 +version: 0.103.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 dc603c6d0db..afba6359d5d 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.102.0 +version: 0.103.0 strings: | Convert a string to PascalCase. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index f68a1ecd519..f3338937a42 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index fb503983d80..a4e36beee01 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.102.0 +version: 0.103.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 147243df643..ffae837d758 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.102.0 +version: 0.103.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index b23a9a5516e..d20c7b700a8 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.102.0 +version: 0.103.0 strings: | Convert a string to snake_case. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index 8b4045c391a..da9fd241923 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.102.0 +version: 0.103.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 6b87bf7a6d1..b6e182fa012 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.102.0 +version: 0.103.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 d22545d2f81..db51a10527f 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.102.0 +version: 0.103.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 9c6a33a03c1..b391afad991 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.102.0 +version: 0.103.0 strings: | Convert a string to Title Case. usage: | @@ -22,7 +22,7 @@ contributors: false ## Parameters - - `...rest`: For a data structure input, convert strings at the given cell paths + - `...rest`: For a data structure input, convert strings at the given cell paths. ## Input/output types: diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index d75417a4c1d..d3cd69ce6eb 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index b63a1e5ef02..faa8e8e1a60 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.102.0 +version: 0.103.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 430fcae6b65..5c2cb90c3ad 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index a6ad18c6fb2..23743c32c2f 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index d7dff0e834a..46060ada981 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 5c0a71df106..a3fee2271b9 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index a2c0cb3c565..a3972f8e76f 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index 0917bcd5787..a18c71aa28e 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.102.0 +version: 0.103.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 5c1607bb6e0..851a6080733 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.102.0 +version: 0.103.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 66a2179252e..d6972fa9f8a 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.102.0 +version: 0.103.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 64abbad553f..21a44bb3d6f 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.102.0 +version: 0.103.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index bfa5f5049e3..96edf51180a 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 5739ab852dc..050a367d0a7 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.102.0 +version: 0.103.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 b883a6a903d..b274c86eca6 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.102.0 +version: 0.103.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 7d94886de85..a31a4d44c69 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term.md b/commands/docs/term.md index e4d0743e700..c2078963b46 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.102.0 +version: 0.103.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 8bf2c93a268..1e42eb810c6 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Query the terminal for information. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index 8c7621557af..7978befc401 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.102.0 +version: 0.103.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 badf49dbe45..27b7da02fa2 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.102.0 +version: 0.103.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 9c70d99f660..03dbfa749d4 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Translate structured data to a format. usage: | @@ -46,4 +46,5 @@ You must use one of the following subcommands. Using this command as-is will onl | [`to toml`](/commands/docs/to_toml.md) | Convert record into .toml text. | built-in | | [`to tsv`](/commands/docs/to_tsv.md) | Convert table into .tsv text. | built-in | | [`to xml`](/commands/docs/to_xml.md) | Convert special record structure into .xml text. | built-in | -| [`to yaml`](/commands/docs/to_yaml.md) | Convert table into .yaml/.yml text. | built-in | \ No newline at end of file +| [`to yaml`](/commands/docs/to_yaml.md) | Convert table into .yaml/.yml text. | built-in | +| [`to yml`](/commands/docs/to_yml.md) | Convert table into .yaml/.yml text. | built-in | \ No newline at end of file diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index ce59e8a5376..9c89166dfd5 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 7bbad8c227e..b09f2de0dc0 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 087ab0fbbdd..76d0323db31 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Converts table data into JSON text. usage: | @@ -22,7 +22,7 @@ contributors: false ## Flags - - `--raw, -r`: remove all of the whitespace + - `--raw, -r`: remove all of the whitespace and trailing line ending - `--indent, -i {number}`: specify indentation width - `--tabs, -t {number}`: specify indentation tab quantity - `--serialize, -s`: serialize nushell types that cannot be deserialized diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 02d79dc41d2..1f9883abf44 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 85fbca3e494..e84a93c2ac7 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert Nu values into MessagePack. usage: | @@ -20,6 +20,10 @@ contributors: false ```> to msgpack {flags} ``` +## Flags + + - `--serialize, -s`: serialize nushell types that cannot be deserialized + ## Input/output types: diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 294bd229d24..cf051e72967 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | @@ -24,6 +24,7 @@ contributors: false - `--quality, -q {int}`: Quality of brotli compression (default 3) - `--window-size, -w {int}`: Window size for brotli compression (default 20) + - `--serialize, -s`: serialize nushell types that cannot be deserialized ## Input/output types: diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index e00a11d619e..05e927ca200 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index b8a98bcc4a4..5fd594940a1 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index cc82fc22c60..55a01c1a4ba 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 41215b3a00e..94c038c85ed 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 6137f0e31b7..a16ddc488c6 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index a09ed40a607..112cca84bac 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.102.0 +version: 0.103.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 ad6e3447b2e..b2bb496506e 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.102.0 +version: 0.103.0 formats: | Convert table into .yaml/.yml text. usage: | @@ -33,7 +33,7 @@ contributors: false ## Examples -Outputs an YAML string representing the contents of this table +Outputs a YAML string representing the contents of this table ```nu > [[foo bar]; ["1" "2"]] | to yaml - foo: '1' diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md new file mode 100644 index 00000000000..edbb281b4f0 --- /dev/null +++ b/commands/docs/to_yml.md @@ -0,0 +1,42 @@ +--- +title: to yml +categories: | + formats +version: 0.103.0 +formats: | + Convert table into .yaml/.yml text. +usage: | + Convert table into .yaml/.yml text. +editLink: false +contributors: false +--- + + +# `to yml` for [formats](/commands/categories/formats.md) + +
Convert table into .yaml/.yml text.
+ +## Signature + +```> to yml {flags} ``` + +## Flags + + - `--serialize, -s`: serialize nushell types that cannot be deserialized + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | string | + +## Examples + +Outputs a YAML string representing the contents of this table +```nu +> [[foo bar]; ["1" "2"]] | to yml +- foo: '1' + bar: '2' + +``` diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 8b12c325b54..f72d46f38fa 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index fd4891263a7..39f5ee35251 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.102.0 +version: 0.103.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 d7018738a1d..f7cf1aca948 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.102.0 +version: 0.103.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 560560e07c5..26a368e8acb 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.102.0 +version: 0.103.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 11ad8c050c2..3eba1c11b51 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 582b05885ff..e3ee79ce8c3 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.102.0 +version: 0.103.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 e431f5adb38..067c8b7b6fd 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.102.0 +version: 0.103.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 6a4e36c5515..c3c8a50be33 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 1888097d49d..b8025409708 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.102.0 +version: 0.103.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 e764f11c021..e28d08c4d97 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Update the table cells. usage: | @@ -26,7 +26,7 @@ contributors: false ## Parameters - - `closure`: the closure to run an update for each cell + - `closure`: The closure to run an update for each cell. ## Input/output types: @@ -49,11 +49,11 @@ Update the zero value cells to empty strings. $value } } -╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤ -│ 0 │ 37 │ │ │ │ 37 │ │ │ -╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯ +╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ 0 │ 37 │ │ │ │ 37 │ │ │ +╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ ``` @@ -69,10 +69,10 @@ Update the zero value cells to empty strings in 2 last columns. $value } } -╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤ -│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ -╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯ +╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ +╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ ``` diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 5be82a629f2..4338a157f30 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | @@ -115,6 +115,26 @@ 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 │ │ +│ │ ╰───┴───────╯ │ +╰───┴───────────────╯ + +``` + ## Notes When updating or inserting a column, the closure will be run for each row, and the current row will be passed as the first argument. Referencing `$in` inside the closure will provide the value at the column for the current row or null if the column does not exist. diff --git a/commands/docs/url.md b/commands/docs/url.md index 15703e53ad8..83c6c447b81 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.102.0 +version: 0.103.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 f358d239980..b3b441de6ce 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.102.0 +version: 0.103.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 8741417531e..502c2eca90a 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.102.0 +version: 0.103.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 0cb53e2f528..dae804e6302 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.102.0 +version: 0.103.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 8a0db28cc0c..c660293f0af 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.102.0 +version: 0.103.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index 2046382c1d9..b067add1980 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.102.0 +version: 0.103.0 network: | Parses a url. usage: | diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index b7fba043eb6..cf44a3012bc 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.102.0 +version: 0.103.0 network: | Converts query string into table applying percent-decoding. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 68ac3f8dc9b..2e63815ee59 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.102.0 +version: 0.103.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 5e653fd39da..223819374b1 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.102.0 +version: 0.103.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 ac443dc56d6..d3a793dcb90 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.102.0 +version: 0.103.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 1ad4e2203fb..527a85852b8 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.102.0 +version: 0.103.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 23d9c5af5e4..f0d09d6bf50 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index 606fcb8ac63..da27fb97320 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.102.0 +version: 0.103.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 a9f509d3725..f7f43d7a1cc 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.102.0 +version: 0.103.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 eff15b6a55a..acf0a1d4916 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.102.0 +version: 0.103.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 0867d2075ee..d52795f2963 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.102.0 +version: 0.103.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 cf5ef01fd51..b3ffddd1234 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.102.0 +version: 0.103.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index e9e73137a75..4b3a3acbf61 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.102.0 +version: 0.103.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | diff --git a/commands/docs/where.md b/commands/docs/where.md index d82c2e064f9..7ed48bbe3b2 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 54acb96b113..87123d8d457 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.102.0 +version: 0.103.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 5ceedd8b076..b020cc6402b 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.102.0 +version: 0.103.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index be5a58a69b6..50f5cb948b1 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.102.0 +version: 0.103.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index f59e262fb39..4a4707471e6 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.102.0 +version: 0.103.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 6ea55e6ecfc..00998bd1056 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.102.0 +version: 0.103.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 06d10cfdf4d..f5c2a49cef1 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 86e6eb21038..c260cf17284 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.102.0 +version: 0.103.0 filters: | Combine a stream with the input. usage: |