diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 553822d7a27..237a018b842 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.107.0 +version: 0.108.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 dbbd4ce7597..e9c69342ba4 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.107.0 +version: 0.108.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 8d2af2c307a..534d2047ca9 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.107.0 +version: 0.108.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 1a3f9f216de..76a27a944d1 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 481f549b241..7c895c5504b 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.107.0 +version: 0.108.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 367091cdd73..ed3adb029d8 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index ee011a7ab15..c827bb6e712 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.107.0 +version: 0.108.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 6f67beef3cf..81588ad04b1 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 602033060c6..836bbbe6685 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/attr.md b/commands/docs/attr.md index d462b40fd98..df24794fc64 100644 --- a/commands/docs/attr.md +++ b/commands/docs/attr.md @@ -2,7 +2,7 @@ title: attr categories: | core -version: 0.107.0 +version: 0.108.0 core: | Various attributes for custom commands. usage: | @@ -31,9 +31,11 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | description | type | -| ---------------------------------------------------------- | ------------------------------------------------------ | -------- | -| [`attr category`](/commands/docs/attr_category.md) | Attribute for adding a category to custom commands. | built-in | -| [`attr deprecated`](/commands/docs/attr_deprecated.md) | Attribute for marking a command or flag as deprecated. | built-in | -| [`attr example`](/commands/docs/attr_example.md) | Attribute for adding examples to custom commands. | built-in | -| [`attr search-terms`](/commands/docs/attr_search-terms.md) | Attribute for adding search terms to custom commands. | built-in | \ No newline at end of file +| name | description | type | +| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------- | +| [`attr category`](/commands/docs/attr_category.md) | Attribute for adding a category to custom commands. | built-in | +| [`attr complete`](/commands/docs/attr_complete.md) | Attribute for using another command as a completion source for all arguments. | built-in | +| [`attr complete external`](/commands/docs/attr_complete_external.md) | Attribute for enabling use of the external completer for internal commands. | built-in | +| [`attr deprecated`](/commands/docs/attr_deprecated.md) | Attribute for marking a command or flag as deprecated. | built-in | +| [`attr example`](/commands/docs/attr_example.md) | Attribute for adding examples to custom commands. | built-in | +| [`attr search-terms`](/commands/docs/attr_search-terms.md) | Attribute for adding search terms to custom commands. | built-in | \ No newline at end of file diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md index b3a7d2ddde0..89d8dbee1ab 100644 --- a/commands/docs/attr_category.md +++ b/commands/docs/attr_category.md @@ -2,7 +2,7 @@ title: attr category categories: | core -version: 0.107.0 +version: 0.108.0 core: | Attribute for adding a category to custom commands. usage: | @@ -27,9 +27,9 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------------ | -| nothing | list<string> | +| input | output | +| ------- | ------ | +| nothing | string | ## Examples Add a category to a custom command diff --git a/commands/docs/attr_complete.md b/commands/docs/attr_complete.md new file mode 100644 index 00000000000..a782545f490 --- /dev/null +++ b/commands/docs/attr_complete.md @@ -0,0 +1,44 @@ +--- +title: attr complete +categories: | + core +version: 0.108.0 +core: | + Attribute for using another command as a completion source for all arguments. +usage: | + Attribute for using another command as a completion source for all arguments. +editLink: false +contributors: false +--- + + +# `attr complete` for [core](/commands/categories/core.md) + +
Attribute for using another command as a completion source for all arguments.
+ +## Signature + +```> attr complete {flags} (completer)``` + +## Parameters + + - `completer`: Name of the completion command. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | +## Examples + +Use another command as completion source +```nu +> def complete-foo [spans: list] { + [bar baz qux spam eggs] | where $it not-in $spans +} + +@complete 'complete-foo' +def foo [...args] { $args } + +``` diff --git a/commands/docs/attr_complete_external.md b/commands/docs/attr_complete_external.md new file mode 100644 index 00000000000..d123f6e99a1 --- /dev/null +++ b/commands/docs/attr_complete_external.md @@ -0,0 +1,38 @@ +--- +title: attr complete external +categories: | + core +version: 0.108.0 +core: | + Attribute for enabling use of the external completer for internal commands. +usage: | + Attribute for enabling use of the external completer for internal commands. +editLink: false +contributors: false +--- + + +# `attr complete external` for [core](/commands/categories/core.md) + +
Attribute for enabling use of the external completer for internal commands.
+ +## Signature + +```> attr complete external {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | +## Examples + +Use the external completer for a wrapper command +```nu +> @complete external +def --wrapped jc [...args] { + ^jc ...$args | from json +} + +``` diff --git a/commands/docs/attr_deprecated.md b/commands/docs/attr_deprecated.md index 707a17f3815..b44da5b3cfa 100644 --- a/commands/docs/attr_deprecated.md +++ b/commands/docs/attr_deprecated.md @@ -2,7 +2,7 @@ title: attr deprecated categories: | core -version: 0.107.0 +version: 0.108.0 core: | Attribute for marking a command or flag as deprecated. usage: | @@ -34,10 +34,9 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------- | -| nothing | nothing | -| nothing | string | +| input | output | +| ------- | ------ | +| nothing | record | ## Examples Add a deprecation warning to a custom command diff --git a/commands/docs/attr_example.md b/commands/docs/attr_example.md index c24762455a2..4657ef0f546 100644 --- a/commands/docs/attr_example.md +++ b/commands/docs/attr_example.md @@ -2,7 +2,7 @@ title: attr example categories: | core -version: 0.107.0 +version: 0.108.0 core: | Attribute for adding examples to custom commands. usage: | diff --git a/commands/docs/attr_search-terms.md b/commands/docs/attr_search-terms.md index 504fbe40bf7..e021ce7ef63 100644 --- a/commands/docs/attr_search-terms.md +++ b/commands/docs/attr_search-terms.md @@ -2,7 +2,7 @@ title: attr search-terms categories: | core -version: 0.107.0 +version: 0.108.0 core: | Attribute for adding search terms to custom commands. usage: | diff --git a/commands/docs/banner.md b/commands/docs/banner.md index faff6e9b733..8530dc17ae2 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.107.0 +version: 0.108.0 default: | Print a banner for Nushell with information about the project usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 03d375c99b5..963a7892c00 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index d310fe4bee4..20e68624fdf 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Performs bitwise and for ints or binary values. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index 2167907c026..06fd5dd1d99 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 695dc4dd347..27b005539a7 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Performs bitwise or for ints or binary values. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 575e8de35c9..10a57f76c21 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Bitwise rotate left for ints or binary values. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 0f64a1c91b9..ec07f2f1b0e 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Bitwise rotate right for ints or binary values. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index a040bf4e74d..e0b7b0c7281 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Bitwise shift left for ints or binary values. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index bba93ddc91f..73cec34c86b 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Bitwise shift right for ints or binary values. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index acd9b88a5de..14973bce6b3 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.107.0 +version: 0.108.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 0802675f0e7..e74f4d0afe6 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.107.0 +version: 0.108.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 24ba8d2e5af..c7565c36894 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.107.0 +version: 0.108.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 b569ef9bbc7..f0f7473377f 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index ff3e4367f20..ae753b729b9 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 65656aef6b0..931ba9e65a7 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index a5a99b3ce63..60f21a908dd 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.107.0 +version: 0.108.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 fee90c4d6eb..c179d9c9163 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.107.0 +version: 0.108.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 53d51b2da87..ce206eb41ed 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.107.0 +version: 0.108.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 e20d6d6b07f..a74d78b39ed 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.107.0 +version: 0.108.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 a67c1071a74..0cee051b11e 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index d96ab25672d..848dd01f401 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 3f82de54ea6..58a572f698c 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.107.0 +version: 0.108.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index 8ce13f04fc5..ca96ab85dff 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.107.0 +version: 0.108.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 698e9a8b3ea..43eee915040 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.107.0 +version: 0.108.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index f80b5c09d8a..8749aca0361 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.107.0 +version: 0.108.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index b33ac7e281e..18fea0d7cfb 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 18c12c58140..c42dacb06cb 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index b65b1530bcb..9db4e228224 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.107.0 +version: 0.108.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 b9c676881b2..7b272534f49 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Divide a list, table or binary input into chunks of `chunk_size`. usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 241a2798aea..a01ce07cc19 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index f68fbce17f8..0a49b76a078 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index d29a599a80d..c428c43f67e 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.107.0 +version: 0.108.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 e45cc5b74dc..315b0173ac8 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.107.0 +version: 0.108.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 a4a3fdd3b49..8258fb01631 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.107.0 +version: 0.108.0 core: | Modify the current command line input buffer. usage: | diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 1bfb2c3a007..d9f68f6af7e 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.107.0 +version: 0.108.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 10d0b224634..3bee377a1cf 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.107.0 +version: 0.108.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 54ec79d86ec..a79d82b3877 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Creates a table with non-empty rows. usage: | @@ -33,6 +33,7 @@ contributors: false | input | output | | --------- | --------- | +| record | record | | list<any> | list<any> | ## Examples @@ -78,3 +79,15 @@ Filter out all instances of null and empty items from a list ╰───┴───╯ ``` + +Filter out all instances of null from a record +```nu +> {a: 1, b: null, c: 3} | compact +╭───┬───╮ +│ a │ 1 │ +│ c │ 3 │ +╰───┴───╯ +``` + +## Notes +Can be used to remove `null` or empty values from lists and records too. \ No newline at end of file diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 9ce836e578e..23efda7587d 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.107.0 +version: 0.108.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 a0a5b41eb5e..19bb3342b84 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.107.0 +version: 0.108.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 1214caba6d5..f4ae9f9b03e 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.107.0 +version: 0.108.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index db32a1981fb..5bb2fc60e65 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.107.0 +version: 0.108.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 719d236b8c1..c1305a9578e 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.107.0 +version: 0.108.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 3351b9ca578..0c77a3dfb5e 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.107.0 +version: 0.108.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 92671860185..b77887e85e0 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.107.0 +version: 0.108.0 env: | Get the configuration for color output. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 3b6680e5107..793290cd36a 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.107.0 +version: 0.108.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 4721340924e..a036e5eeb2c 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.107.0 +version: 0.108.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 2d705b4dbac..d561cd78c87 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index cb23f2c8ff7..db950fed190 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.107.0 +version: 0.108.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index cda71d1a664..b9503eda423 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.107.0 +version: 0.108.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_from-human.md b/commands/docs/date_from-human.md index 4e4714243e9..18756da4344 100644 --- a/commands/docs/date_from-human.md +++ b/commands/docs/date_from-human.md @@ -2,7 +2,7 @@ title: date from-human categories: | date -version: 0.107.0 +version: 0.108.0 date: | Convert a human readable datetime string to a datetime. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index de930d972c4..80c898b5e79 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.107.0 +version: 0.108.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 9e89754f807..351e77ebebd 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.107.0 +version: 0.108.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 35ed6569288..7531808ccf9 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.107.0 +version: 0.108.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 3e6899b809c..8ff1957736a 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.107.0 +version: 0.108.0 date: | Convert a date to a given time zone. usage: | @@ -54,13 +54,13 @@ Get the current date in Hawaii. Get a date in a different time zone, from a string. ```nu > "2020-10-10 10:00:00 +02:00" | date to-timezone "+0500" -Sat, 10 Oct 2020 13:00:00 +0500 (4 years ago) +Sat, 10 Oct 2020 13:00:00 +0500 (5 years ago) ``` Get a date in a different time zone, from a datetime. ```nu > "2020-10-10 10:00:00 +02:00" | into datetime | date to-timezone "+0500" -Sat, 10 Oct 2020 13:00:00 +0500 (4 years ago) +Sat, 10 Oct 2020 13:00:00 +0500 (5 years ago) ``` ## Notes diff --git a/commands/docs/debug.md b/commands/docs/debug.md index df3a789a5cb..9d304a7f03b 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_env.md b/commands/docs/debug_env.md index 45dd3ecc811..92b9be80814 100644 --- a/commands/docs/debug_env.md +++ b/commands/docs/debug_env.md @@ -2,7 +2,7 @@ title: debug env categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Show environment variables as external commands would get it. usage: | diff --git a/commands/docs/debug_experimental-options.md b/commands/docs/debug_experimental-options.md index 5cd9233fc70..0f46fc054fc 100644 --- a/commands/docs/debug_experimental-options.md +++ b/commands/docs/debug_experimental-options.md @@ -2,7 +2,7 @@ title: debug experimental-options categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Show all experimental options. usage: | @@ -23,6 +23,6 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ----------------------------------------------------------------------------- | -| nothing | table<identifier: string, enabled: bool, status: string, description: string> | \ No newline at end of file +| input | output | +| ------- | ----------------------------------------------------------------------------------------------------------- | +| nothing | table<identifier: string, enabled: bool, status: string, description: string, since: string, issue: string> | \ No newline at end of file diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index b7903c3f05e..4a5c96b0081 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index dc9edec4a07..86f7ef502c2 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index b02e3f7e0d9..f004233ac87 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 09b3ff5c8da..305ed76dc69 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Decode a Base32 value. usage: | diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 231a26ef835..f53d067655d 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Encode a base32hex value. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index a745890708a..f0796e6bbad 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Decode a Base64 value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 9a501449c0f..aefd2595622 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index fe94c76e672..091dd6728f3 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.107.0 +version: 0.108.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 835b9efab96..f44942a33e3 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Sets a default value if a row's column is missing or null. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 670bbe9bef0..18eeee565e2 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.107.0 +version: 0.108.0 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect.md b/commands/docs/detect.md index d769965792a..651cd82f4c0 100644 --- a/commands/docs/detect.md +++ b/commands/docs/detect.md @@ -2,7 +2,7 @@ title: detect categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Various commands for detecting things. usage: | @@ -33,4 +33,5 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | ---------------------------------------------------- | ---------------------------------------------------------- | -------- | -| [`detect columns`](/commands/docs/detect_columns.md) | Attempt to automatically split text into multiple columns. | built-in | \ No newline at end of file +| [`detect columns`](/commands/docs/detect_columns.md) | Attempt to automatically split text into multiple columns. | built-in | +| [`detect type`](/commands/docs/detect_type.md) | Infer Nushell datatype from a string. | built-in | \ No newline at end of file diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index e26d92946df..8016e628461 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/detect_type.md b/commands/docs/detect_type.md new file mode 100644 index 00000000000..6da51a87684 --- /dev/null +++ b/commands/docs/detect_type.md @@ -0,0 +1,106 @@ +--- +title: detect type +categories: | + strings +version: 0.108.0 +strings: | + Infer Nushell datatype from a string. +usage: | + Infer Nushell datatype from a string. +editLink: false +contributors: false +--- + + +# `detect type` for [strings](/commands/categories/strings.md) + +
Infer Nushell datatype from a string.
+ +## Signature + +```> detect type {flags} ``` + +## Flags + + - `--prefer-filesize, -f`: For ints display them as human-readable file sizes + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | any | +| any | any | +## Examples + +Bool from string +```nu +> 'true' | detect type +true +``` + +Bool is case insensitive +```nu +> 'FALSE' | detect type +false +``` + +Int from plain digits +```nu +> '42' | detect type +42 +``` + +Int with underscores +```nu +> '1_000_000' | detect type +1000000 +``` + +Int with commas +```nu +> '1,234,567' | detect type +1234567 +``` + +Float from decimal +```nu +> '3.14' | detect type +3.14 +``` + +Float in scientific notation +```nu +> '6.02e23' | detect type +601999999999999995805696.0 +``` + +Prefer filesize for ints +```nu +> '1024' | detect type -f +1.0 kB +``` + +Date Y-M-D +```nu +> '2022-01-01' | detect type +Sat, 1 Jan 2022 00:00:00 +0800 (3 years ago) +``` + +Date with time and offset +```nu +> '2022-01-01T00:00:00Z' | detect type +Sat, 1 Jan 2022 00:00:00 +0000 (3 years ago) +``` + +Date D-M-Y +```nu +> '31-12-2021' | detect type +Fri, 31 Dec 2021 00:00:00 +0800 (3 years ago) +``` + +Unknown stays a string +```nu +> 'not-a-number' | detect type +not-a-number +``` diff --git a/commands/docs/do.md b/commands/docs/do.md index a341f2f882b..8a0f35b8b17 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.107.0 +version: 0.108.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 39a64b16be6..f223419b88f 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.107.0 +version: 0.108.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 3ffa4ca9807..90879d7fc8a 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.107.0 +version: 0.108.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 d78d20fe2d6..8dfe9ab35fa 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 0bc1a504df5..45ef88c528d 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index 7991b5a44a2..8592d7ae755 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -23,6 +23,7 @@ contributors: false ## Flags - `--keep-empty, -k`: keep empty result cells + - `--flatten, -f`: combine outputs into a single stream instead ofcollecting them to separate values ## Parameters @@ -96,6 +97,12 @@ Update value if not null, otherwise do nothing ``` +Scan through multiple files without pause +```nu +> ls *.txt | each --flatten {|f| open $f.name | lines } | find -i 'note: ' | str join "\n" + +``` + ## Notes Since tables are lists of records, passing a table into 'each' will iterate over each record, not necessarily each cell within it. @@ -105,6 +112,19 @@ one-row structure, 'each' will only run once, behaving similar to 'do'. To iterate over a record's values, use 'items' or try converting it to a table with 'transpose' first. + +By default, for each input there is a single output value. +If the closure returns a stream rather than value, the stream is collected +completely, and the resulting value becomes one of the items in `each`'s output. + +To receive items from those streams without waiting for the whole stream to be +collected, `each --flatten` can be used. +Instead of waiting for the stream to be collected before returning the result as +a single item, `each --flatten` will return each item as soon as they are received. + +This "flattens" the output, turning an output that would otherwise be a +list of lists like `list>` into a flat list like `list`. + ## Subcommands: | name | description | type | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 87f2fcabc07..5a8a455009e 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 236b92547d3..7dea9c31f0d 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.107.0 +version: 0.108.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index f8829fee7f4..d6967981329 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index eb469f8072a..08dee4075ae 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.107.0 +version: 0.108.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 e0c0eb50dd2..78bc1908ef2 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.107.0 +version: 0.108.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 80446493d30..b134e40504d 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.107.0 +version: 0.108.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 38b8a5bdcb8..3254f2b1957 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 3de9784f76f..aff6cdbec2a 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error.md b/commands/docs/error.md index 4885b13d289..247d48fc7f2 100644 --- a/commands/docs/error.md +++ b/commands/docs/error.md @@ -2,7 +2,7 @@ title: error categories: | core -version: 0.107.0 +version: 0.108.0 core: | Various commands for working with errors. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 5fd1441dfae..5dbfa5f558e 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.107.0 +version: 0.108.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 62d68aee2af..8c5574c7003 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.107.0 +version: 0.108.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 0a22fd2a7d0..c15e602b62a 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.107.0 +version: 0.108.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 62685a414a8..41efe0a7e08 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.107.0 +version: 0.108.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 7e92cafeea9..5535053f565 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index f410d4a54e4..6839bbc2db0 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.107.0 +version: 0.108.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 0e0e9a4e8b2..55e4a1c9fe1 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.107.0 +version: 0.108.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 be5f227c516..eac84d5bb47 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.107.0 +version: 0.108.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 eff0d8bd02e..2e74da8be8e 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.107.0 +version: 0.108.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 14fbc4a930e..0ec0ac00878 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.107.0 +version: 0.108.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 bd20d15805f..ab349d44a57 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.107.0 +version: 0.108.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 2f71a4fc9d1..4a5b60d2db6 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.107.0 +version: 0.108.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 0944198858f..5b774a2f860 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.107.0 +version: 0.108.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 1c610ea80c6..1f567afff00 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.107.0 +version: 0.108.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 f1981b9918d..a84bb4f290f 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.107.0 +version: 0.108.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 1c68358ca17..6934d7c31d5 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index e948277c21f..9556b9715ed 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 8652c1df08d..2c2990644aa 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index dc90e7492f8..ebdeb65e864 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.107.0 +version: 0.108.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 e55bbb119e2..50a60efb364 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index be471036697..10eaeb437f1 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.107.0 +version: 0.108.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index e28e458ea98..9efc134a9c8 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index e47fc8fc37d..186e9d4e280 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to a string of binary data represented by 0 and 1. usage: | @@ -20,6 +20,10 @@ contributors: false ```> format bits {flags} ...rest``` +## Flags + + - `--endian, -e {string}`: Byte encode endian. Only applies to int, filesize, duration and bool, as well as tables and records of those. Available options: native, little, big(default) + ## Parameters - `...rest`: For a data structure input, convert data at the given cell paths. @@ -57,6 +61,12 @@ convert an int into a string, padded to 8 places with 0s (big endian) 00000001 00000010 ``` +convert an int into a string, padded to 8 places with 0s (little endian) +```nu +> 258 | format bits --endian little +00000010 00000001 +``` + convert a filesize value into a string, padded to 8 places with 0s ```nu > 1b | format bits diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 5e928260a05..cc9e636827f 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.107.0 +version: 0.108.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 3d5357c5258..56d2e106cdf 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.107.0 +version: 0.108.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 32c3d7cf8fc..c79fddc5588 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.107.0 +version: 0.108.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 10e5245b891..3756c907070 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Format a number. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 13e0899b6f4..dc13452daa5 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index be3a0d85da8..ecf61f644ee 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.107.0 +version: 0.108.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 0dc8c5406a0..f3c71fbe4fb 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.107.0 +version: 0.108.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 9a9935ee3c9..a62febbf510 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.107.0 +version: 0.108.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 12484b24b7e..420623b2ff9 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Parse text as .ics and create table. usage: | diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index e1cdd73cac5..0f32d616f58 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.107.0 +version: 0.108.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 3e1ebd39e4c..14189d9ab85 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 5d950091fcc..5f8cfa79028 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index 09f022fa8fc..27653006137 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.107.0 +version: 0.108.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 8d5ba98bdc3..ddc2924f0da 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index ef67dcc4ab0..8b8e50cddf9 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.107.0 +version: 0.108.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 895a6d7bd52..7e15770495c 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 8994ef9d79e..2965fd8d1f7 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.107.0 +version: 0.108.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 262043f12f3..e06fc3eaad6 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.107.0 +version: 0.108.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 e7124e39bff..f0f2dd9a357 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.107.0 +version: 0.108.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 b2988ce8790..ee537344b37 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.107.0 +version: 0.108.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 3c930ce4389..046005ce2e5 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.107.0 +version: 0.108.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 b3c916d84b2..f6966d8c378 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.107.0 +version: 0.108.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 2693f1d665a..299a9bb7058 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 455d073dd9d..b82a95ec0b7 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.107.0 +version: 0.108.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 ff2beb59d05..bc55bcf7e08 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 9ef499d3ad4..58e70896cd3 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.107.0 +version: 0.108.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 c1b54abebb0..5a0bafef7b8 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index c317efd41ff..7ee12bea1ba 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.107.0 +version: 0.108.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 2ad409b584f..f83dcca3f67 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.107.0 +version: 0.108.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 c819c4e57b3..2931c0e48dc 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.107.0 +version: 0.108.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 06a9f23c722..f1aa48fb542 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.107.0 +version: 0.108.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 7667ac3fc98..f588446ab74 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.107.0 +version: 0.108.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 4da8e2c2b58..f8dbd4e24b2 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.107.0 +version: 0.108.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 44883622530..d7dcbdab314 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.107.0 +version: 0.108.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 106e16d0bb4..1056cb3d9f4 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.107.0 +version: 0.108.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 009ec328912..107ca83ecf3 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.107.0 +version: 0.108.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 0d583693c55..538b02891cb 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.107.0 +version: 0.108.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 4ee784674b7..97842d2226f 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.107.0 +version: 0.108.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index b34b2bd5424..ba3ccc09db8 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.107.0 +version: 0.108.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 3e2553cb3b6..d1694d472c0 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.107.0 +version: 0.108.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index d863a2b13c9..bfe3dac7f16 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.107.0 +version: 0.108.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 2b38f7a5f04..39aacc915ba 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.107.0 +version: 0.108.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 2fd6f87e3fb..e95f3bfde19 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.107.0 +version: 0.108.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 ceec6f2aaa9..283cdb0f04c 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.107.0 +version: 0.108.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 14ccfd89542..67638e51483 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.107.0 +version: 0.108.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index 6ee3a9e81d5..f8f480227fb 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.107.0 +version: 0.108.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | diff --git a/commands/docs/history.md b/commands/docs/history.md index ae6e7f3575b..6d91b675160 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.107.0 +version: 0.108.0 history: | Get the command history. usage: | diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index 2027c0bb044..3c90fe08976 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,7 +2,7 @@ title: history import categories: | history -version: 0.107.0 +version: 0.108.0 history: | Import command line history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 41c48d78523..bb32967ef07 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.107.0 +version: 0.108.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 886c6da9c49..4117edf3b12 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.107.0 +version: 0.108.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 17cbd446d90..638321472a8 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.107.0 +version: 0.108.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index a1491602210..6261a77317c 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.107.0 +version: 0.108.0 network: | Fetch the contents from a URL. usage: | @@ -68,5 +68,17 @@ Get content from example.com, with custom headers using a list ``` +Get the response status code +```nu +> http get https://www.example.com | metadata | get http_response.status + +``` + +Check response status while streaming +```nu +> http get --allow-errors https://example.com/file | metadata access {|m| if $m.http_response.status != 200 { error make {msg: "failed"} } else { } } | lines + +``` + ## Notes Performs HTTP GET operation. \ No newline at end of file diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index be2857af6f3..21da91fc8b8 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.107.0 +version: 0.108.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 6a5bb0d9272..d667cb4220b 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.107.0 +version: 0.108.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 1f5e856a278..650eced606d 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.107.0 +version: 0.108.0 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index f375dc82ed9..a19d518420b 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.107.0 +version: 0.108.0 network: | Post a body to a URL. usage: | @@ -94,5 +94,17 @@ Convert a text file into binary and upload it to example.com ``` +Get the response status code +```nu +> http post https://www.example.com 'body' | metadata | get http_response.status + +``` + +Check response status while streaming +```nu +> http post --allow-errors https://example.com/upload 'data' | metadata access {|m| if $m.http_response.status != 200 { error make {msg: "failed"} } else { } } | lines + +``` + ## Notes Performs HTTP POST operation. \ No newline at end of file diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index d804301c43f..edacfb7e762 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.107.0 +version: 0.108.0 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index 86e339e81a1..4e765c733c5 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.107.0 +version: 0.108.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 62af2c8441f..115b49ee1ae 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.107.0 +version: 0.108.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 e324a93f43d..70833600dfa 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.107.0 +version: 0.108.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 3a4aedd693c..16e4b7ed52c 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index d8ed171538f..5b137787117 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 689efc82e34..36212015569 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index c9bc8f2a6c9..37271ac32af 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 3c707c3e8ce..23410d079f0 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 110fba3c3c5..7c5ef22a73a 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.107.0 +version: 0.108.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 7efead1489e..3c6ff26fc59 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Commands to convert data from one type to another. usage: | @@ -45,4 +45,4 @@ You must use one of the following subcommands. Using this command as-is will onl | [`into record`](/commands/docs/into_record.md) | Convert value to record. | built-in | | [`into sqlite`](/commands/docs/into_sqlite.md) | Convert table into a SQLite database. | built-in | | [`into string`](/commands/docs/into_string.md) | Convert value to string. | built-in | -| [`into value`](/commands/docs/into_value.md) | Infer Nushell datatype for each cell. | built-in | \ No newline at end of file +| [`into value`](/commands/docs/into_value.md) | Convert custom values into base values. | built-in | \ No newline at end of file diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 495e97dbc35..64891eee841 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 4e1b9de7a10..2d900814540 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 1df2fba811c..e6d1b6e1527 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.107.0 +version: 0.108.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index d7200283004..b476d8a41e8 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -92,7 +92,7 @@ Sat, 27 Feb 2021 13:55:40 +0000 (4 years ago) Using a record as input ```nu > {year: 2025, month: 3, day: 30, hour: 12, minute: 15, second: 59, timezone: '+02:00'} | into datetime -Sun, 30 Mar 2025 10:15:59 +0000 (5 months ago) +Sun, 30 Mar 2025 10:15:59 +0000 (6 months ago) ``` Convert list of timestamps to datetimes diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index 1432fce2ba3..f62cda5532a 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 3a6b0405068..ed988244a09 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 44ac5dc59a4..1c2f6507f7e 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index e5c42148d84..c56c055aeca 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 39cc37f06ae..53ad006b064 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index 4766ea3fdca..168aad9497c 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 0c7db52cb43..e411b459cf5 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 91de5938faa..7f9b2a0de35 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.107.0 +version: 0.108.0 conversions: | Convert value to string. usage: | @@ -43,6 +43,7 @@ contributors: false | filesize | string | | datetime | string | | duration | string | +| cell-path | string | | range | string | | list<any> | list<string> | | table | table | @@ -114,3 +115,9 @@ convert duration to string > 9day | into string 1wk 2day ``` + +convert cell-path to string +```nu +> $.name | into string +$.name +``` diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index a958d9af722..7c8b498fcba 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -1,20 +1,20 @@ --- title: into value categories: | - filters -version: 0.107.0 -filters: | - Infer Nushell datatype for each cell. + conversions +version: 0.108.0 +conversions: | + Convert custom values into base values. usage: | - Infer Nushell datatype for each cell. + Convert custom values into base values. editLink: false contributors: false --- -# `into value` for [filters](/commands/categories/filters.md) +# `into value` for [conversions](/commands/categories/conversions.md) -
Infer Nushell datatype for each cell.
+
Convert custom values into base values.
## Signature @@ -30,17 +30,6 @@ contributors: false | input | output | | ----- | ------ | -| table | table | -## Examples - -Infer Nushell values for each cell. -```nu -> $table | into value - -``` - -Infer Nushell values for each cell in the given columns. -```nu -> $table | into value -c [column1, column5] - -``` +| any | any | +## Notes +Custom values from plugins have a base value representation. This extracts that base value representation. For streams use `collect`. \ No newline at end of file diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index cf6e120bb84..7242402def4 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.107.0 +version: 0.108.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 27e306e8ddb..447d540a06d 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 3aab7944b3e..c22864da33a 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.107.0 +version: 0.108.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index cb37f4e4a6d..9a0476a2801 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.107.0 +version: 0.108.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 6e2d0068a82..579fb43aeed 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/job.md b/commands/docs/job.md index 8ae446ea1cb..88458ee9712 100644 --- a/commands/docs/job.md +++ b/commands/docs/job.md @@ -2,7 +2,7 @@ title: job categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Various commands for working with background jobs. usage: | diff --git a/commands/docs/job_flush.md b/commands/docs/job_flush.md index bd106128cc9..01c3df13809 100644 --- a/commands/docs/job_flush.md +++ b/commands/docs/job_flush.md @@ -2,7 +2,7 @@ title: job flush categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Clear this job's mailbox. usage: | diff --git a/commands/docs/job_id.md b/commands/docs/job_id.md index 569f0606b26..25f5e361caf 100644 --- a/commands/docs/job_id.md +++ b/commands/docs/job_id.md @@ -2,7 +2,7 @@ title: job id categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Get id of current job. usage: | diff --git a/commands/docs/job_kill.md b/commands/docs/job_kill.md index 9fd9072d60d..50bf0441e44 100644 --- a/commands/docs/job_kill.md +++ b/commands/docs/job_kill.md @@ -2,7 +2,7 @@ title: job kill categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Kill a background job. usage: | diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md index 52f18f93d98..5c555a3482f 100644 --- a/commands/docs/job_list.md +++ b/commands/docs/job_list.md @@ -2,7 +2,7 @@ title: job list categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | List background jobs. usage: | diff --git a/commands/docs/job_recv.md b/commands/docs/job_recv.md index dc22f3bffc7..736d15fabeb 100644 --- a/commands/docs/job_recv.md +++ b/commands/docs/job_recv.md @@ -2,7 +2,7 @@ title: job recv categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Read a message from the mailbox. usage: | diff --git a/commands/docs/job_send.md b/commands/docs/job_send.md index 01a800e18d7..02e10d20c8e 100644 --- a/commands/docs/job_send.md +++ b/commands/docs/job_send.md @@ -2,7 +2,7 @@ title: job send categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Send a message to the mailbox of a job. usage: | diff --git a/commands/docs/job_spawn.md b/commands/docs/job_spawn.md index 4657b11e2f6..e7be075cff5 100644 --- a/commands/docs/job_spawn.md +++ b/commands/docs/job_spawn.md @@ -2,7 +2,7 @@ title: job spawn categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Spawn a background job and retrieve its ID. usage: | diff --git a/commands/docs/job_tag.md b/commands/docs/job_tag.md index 5e66b9118d8..49bc3507d0d 100644 --- a/commands/docs/job_tag.md +++ b/commands/docs/job_tag.md @@ -2,7 +2,7 @@ title: job tag categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Add a description tag to a background job. usage: | diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md index 42f43f166f5..3eb126ab7d5 100644 --- a/commands/docs/job_unfreeze.md +++ b/commands/docs/job_unfreeze.md @@ -2,7 +2,7 @@ title: job unfreeze categories: | experimental -version: 0.107.0 +version: 0.108.0 experimental: | Unfreeze a frozen process job in foreground. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 82d6333161b..c567a2b291c 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index e88b818082f..9426b397f2c 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 8740192357c..e0e225961c1 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 544f4e7d188..c417d5ff855 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.107.0 +version: 0.108.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 ce0af853e8e..3290dc65bd6 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 45dfc21cce0..807f95a9d06 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index b9531563525..46f4365969d 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.107.0 +version: 0.108.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 e60856b20d2..3f68ddf09e3 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.107.0 +version: 0.108.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 3734c4c33bc..c5e3d4e18b1 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.107.0 +version: 0.108.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 0b73b17bc36..0b3fdb2b9c0 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.107.0 +version: 0.108.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 20bc5c613fe..23007df4c5c 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 45d2c69f192..6b3eaa09eec 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 5e3bc916a11..0ecef2f2327 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.107.0 +version: 0.108.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index d0bd63eebcc..648db7b03c4 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.107.0 +version: 0.108.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 036965dfbc8..1b0c878b566 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.107.0 +version: 0.108.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 72c6740000f..37da83c1ca0 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.107.0 +version: 0.108.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 321fbde836c..cbcea296777 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.107.0 +version: 0.108.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 179fbcd5787..5d551579ada 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 07fe815b9b7..11cc55d878d 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.107.0 +version: 0.108.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 329fa7125e3..ec90d759a68 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index cc681d5fd13..7acc4599db0 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.107.0 +version: 0.108.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 a24b0db1198..5ede8177127 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index cebf1ea50e0..9ef8da31d41 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.107.0 +version: 0.108.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 8531f4b9042..4ae9f0fe883 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.107.0 +version: 0.108.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 e7f550fb43f..72fff7fd430 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.107.0 +version: 0.108.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 561b3ad53eb..3f0ac92b2fb 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 8c27213fe09..aa8f783958c 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.107.0 +version: 0.108.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 3a1cc427ac7..a1b5db0f7fa 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.107.0 +version: 0.108.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 180bad4be23..5082f687f4a 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.107.0 +version: 0.108.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 a79e0b8ccd3..aeb09fdfe2d 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.107.0 +version: 0.108.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 9c1d27051a1..d0b1db231fc 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.107.0 +version: 0.108.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 cda8270b440..533f2b23daa 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.107.0 +version: 0.108.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 7793e1bad81..92d26fcca94 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.107.0 +version: 0.108.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 11abde97400..e9478ad37b6 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.107.0 +version: 0.108.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 ad5774af723..5bc3ca98151 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.107.0 +version: 0.108.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 9dafe26d6c7..5346355ff06 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.107.0 +version: 0.108.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 3ed1744ce92..d1a4fc99060 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.107.0 +version: 0.108.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 2bd15ef4c26..ac3d9981795 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index dfbd65b62cb..7c6ad5d6dff 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.107.0 +version: 0.108.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 77556cb2bf6..47e2b3028cb 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.107.0 +version: 0.108.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 e05583c8252..d16bc254260 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.107.0 +version: 0.108.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 c3d7704156f..a04a02ecd92 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.107.0 +version: 0.108.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 84bfb4f13f5..6e9c2596be0 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.107.0 +version: 0.108.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 50f5ee4aa2d..419639d6740 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.107.0 +version: 0.108.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 ce7f51aafa5..156ae4e331f 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.107.0 +version: 0.108.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 7ff508e6315..3375cd26d58 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.107.0 +version: 0.108.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 71ec87365a8..11dca9d5cac 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.107.0 +version: 0.108.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 0948fc0c039..57ed1b2d76a 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.107.0 +version: 0.108.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 fbd62cd3292..aecebe3b32b 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.107.0 +version: 0.108.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 454629ef6af..e84c614558c 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Set the metadata for items in the stream. usage: | @@ -25,6 +25,7 @@ contributors: false - `--datasource-ls, -l`: Assign the DataSource::Ls metadata to the input - `--datasource-filepath, -f {path}`: Assign the DataSource::FilePath metadata to the input - `--content-type, -c {string}`: Assign content type metadata to the input + - `--merge, -m {record}`: Merge arbitrary metadata fields ## Input/output types: @@ -46,8 +47,14 @@ Set the metadata of a file path ``` -Set the metadata of a file path +Set the content type metadata ```nu > 'crates' | metadata set --content-type text/plain | metadata | get content_type text/plain ``` + +Set custom metadata +```nu +> "data" | metadata set --merge {custom_key: "value"} | metadata | get custom_key +value +``` diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index f957a5d3ee2..e1c2144699f 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.107.0 +version: 0.108.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 e74a5c86d63..7a6e41e786f 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.107.0 +version: 0.108.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 a48c664e18f..9472ba9f029 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.107.0 +version: 0.108.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 3e9e51bcbe0..3d7df540e7a 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.107.0 +version: 0.108.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 bbf18e4e5f6..03a83a52011 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.107.0 +version: 0.108.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 b6ffa3e2847..82df05e9e99 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.107.0 +version: 0.108.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 d660482a404..ce0d5507c1d 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 89088d64dca..6c837a583bd 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 9dadb38ce4f..c841ea9ae34 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.107.0 +version: 0.108.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 2eedfd75473..3f85d0808e2 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.107.0 +version: 0.108.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 0dd7aa7b1b6..5e44a3109b4 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.107.0 +version: 0.108.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index b744dcd03f7..d840b6f4441 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.107.0 +version: 0.108.0 core: | List all overlays with their active status. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 8f992a603f5..a581665a18f 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.107.0 +version: 0.108.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 616d1148a59..503167df930 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.107.0 +version: 0.108.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index bde5a2ed65e..07e31b9ab11 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 67869be3658..f225fbd2df4 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.107.0 +version: 0.108.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 e52773af2b7..2308f8509f6 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.107.0 +version: 0.108.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 2b9842ce688..9dae608158b 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.107.0 +version: 0.108.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 9c4775bad4d..54087724dd7 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.107.0 +version: 0.108.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 21e4b4f813e..e771c8bbeac 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.107.0 +version: 0.108.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 7879440bc49..07ff6bef03a 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.107.0 +version: 0.108.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index bc925ff60fc..dae585c7f84 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.107.0 +version: 0.108.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 8ebaf6da602..150847cf856 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.107.0 +version: 0.108.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 dcdfe5a8a92..0602bf8fc9c 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.107.0 +version: 0.108.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 fa54b85e05e..0d025beaf05 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.107.0 +version: 0.108.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 820cb88cfbc..ebc4dd22d3c 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.107.0 +version: 0.108.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 da094beb1f4..ede8b5d8b0c 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.107.0 +version: 0.108.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 0e564f8883f..98955e83a40 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.107.0 +version: 0.108.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 79d739b71ae..96cb01ab467 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index db0cee0efe5..c167f10c73b 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | Add a plugin to the plugin registry file. usage: | diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 25f706905e2..f3d47c41558 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | List loaded and installed plugins. usage: | @@ -37,13 +37,13 @@ contributors: false List installed plugins. ```nu > plugin list -╭───┬──────┬─────────┬─────────┬────────┬───────────────────────────────┬───────┬─────────────╮ -│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ -├───┼──────┼─────────┼─────────┼────────┼───────────────────────────────┼───────┼─────────────┤ -│ 0 │ inc │ 0.107.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ -│ │ │ │ │ │ │ │ │ 0 │ inc │ │ -│ │ │ │ │ │ │ │ ╰───┴─────╯ │ -╰───┴──────┴─────────┴─────────┴────────┴───────────────────────────────┴───────┴─────────────╯ +╭───┬──────┬────────────────────┬─────────┬────────┬───────────────────────────────┬───────┬─────────────╮ +│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ +├───┼──────┼────────────────────┼─────────┼────────┼───────────────────────────────┼───────┼─────────────┤ +│ 0 │ inc │ 0.108.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ │ │ │ │ │ │ │ │ 0 │ inc │ │ +│ │ │ │ │ │ │ │ ╰───┴─────╯ │ +╰───┴──────┴────────────────────┴─────────┴────────┴───────────────────────────────┴───────┴─────────────╯ ``` diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 7df532299b6..c83309e27a8 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | Remove a plugin from the plugin registry file. usage: | diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index d17945b1aaa..6afedcfcbb7 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | Stop an installed plugin if it was running. usage: | diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index 9fd41d1071e..8140060cb71 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.107.0 +version: 0.108.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | diff --git a/commands/docs/polars.md b/commands/docs/polars.md index 967803aa90e..a7b4dbb6796 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -89,7 +89,6 @@ to the `polars agg` command with some column expressions for aggregation which t | [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | | [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | | [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | -| [`polars fetch`](/commands/docs/polars_fetch.md) | Collects the lazyframe to the selected rows. | plugin | | [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | | [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | | [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | @@ -168,7 +167,7 @@ to the `polars agg` command with some column expressions for aggregation which t | [`polars str-replace`](/commands/docs/polars_str-replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | | [`polars str-replace-all`](/commands/docs/polars_str-replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | | [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | -| [`polars str-split`](/commands/docs/polars_str-split.md) | Split the string by a substring. The resulting dtype is list\. | plugin | +| [`polars str-split`](/commands/docs/polars_str-split.md) | Split the string by a substring. The resulting dtype is list\\. | plugin | | [`polars str-strip-chars`](/commands/docs/polars_str-strip-chars.md) | Strips specified characters from strings in a column | plugin | | [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | | [`polars struct-json-encode`](/commands/docs/polars_struct-json-encode.md) | Convert this struct to a string column with json values. | plugin | diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index a73df422140..12d1c188cdd 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.107.0 +version: 0.108.0 dataframe: | Creates an agg_groups expression. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Get the group index of the group by operations. diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 9e085efc8a5..110c52a4651 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Group by and perform an aggregation diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index b17015db686..213cb537640 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.107.0 +version: 0.108.0 dataframe: | Returns true if all values are false. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns true if all values are false diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index 9be85cb28ff..60a5741e157 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.107.0 +version: 0.108.0 dataframe: | Returns true if all values are true. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns true if all values are true diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index 9f7fdcb32e3..be2a47f5f5d 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Appends a new dataframe. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Appends a dataframe as new columns diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 49bb88c08ce..42a70f864f3 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.107.0 +version: 0.108.0 dataframe: | Return index for max value in series. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns index for max value diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index 7c3ff7036a0..552d198eb28 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.107.0 +version: 0.108.0 dataframe: | Return index for min value in series. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns index for min value diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index 8d2a87b6050..129cb90b58c 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.107.0 +version: 0.108.0 dataframe: | Returns indexes for a sorted series. usage: | @@ -37,9 +37,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns indexes for a sorted series diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index 0475448d1d6..32825d1c384 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.107.0 +version: 0.108.0 dataframe: | Returns indexes where values are true. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns indexes where values are true diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 950167c9dfc..980a0554527 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.107.0 +version: 0.108.0 dataframe: | Returns indexes for unique values. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns indexes for unique values diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index 013c42a1ebd..1d8fab24bfd 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.107.0 +version: 0.108.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Return a dataframe where the value match the expression diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index 5c40975c007..d031f2c67b9 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.107.0 +version: 0.108.0 dataframe: | Converts string to date. usage: | @@ -38,10 +38,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Converts string to date diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 2a1cdd8da1b..85ddae72aac 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.107.0 +version: 0.108.0 dataframe: | Converts string to datetime. usage: | @@ -37,6 +37,8 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. `latest`: use the latest datetime `null`: set to null Used only when input is a lazyframe or expression and ignored otherwise + - `--time-unit {string}`: time unit for the output datetime. One of: ns, us, ms. Default is ns + - `--time-zone {string}`: time zone for the output datetime. E.g. 'UTC', 'America/New_York' ## Parameters @@ -45,10 +47,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Converts string to datetime @@ -89,14 +92,14 @@ Converts string to datetime using the `--not-exact` flag even with excessive sym Converts string to datetime using the `--not-exact` flag even with excessive symbols in an expression ```nu > ["2025-11-02 00:00:00", "2025-11-02 01:00:00", "2025-11-02 02:00:00", "2025-11-02 03:00:00"] | polars into-df | polars select (polars col 0 | polars as-datetime "%Y-%m-%d %H:%M:%S") -╭───┬─────────────╮ -│ # │ datetime │ -├───┼─────────────┤ -│ 0 │ in 2 months │ -│ 1 │ in 2 months │ -│ 2 │ in 2 months │ -│ 3 │ in 2 months │ -╰───┴─────────────╯ +╭───┬────────────╮ +│ # │ datetime │ +├───┼────────────┤ +│ 0 │ in 2 weeks │ +│ 1 │ in 2 weeks │ +│ 2 │ in 2 weeks │ +│ 3 │ in 2 weeks │ +╰───┴────────────╯ ``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 274d9127fbc..68e6898f3f8 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Creates an alias expression. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Creates and alias expression diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index bf1c1ede666..3c68b60821b 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Caches operations in a new LazyFrame. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Caches the result into a new LazyFrame diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index cf1782de125..320b377dd1b 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Cast a column to a different dtype. usage: | @@ -35,10 +35,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Cast a column in a dataframe to a different dtype diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index a4cc72775f0..d2f7c72f996 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Creates a named column expression. usage: | @@ -39,9 +39,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Creates a named column expression and converts it to a nu object diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 640d967fb5c..d74ffd4893b 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_dataframe | ## Examples drop duplicates diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index f53e9f247ea..788400e33ad 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Show dataframe columns. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | ------ | -| dataframe | any | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Dataframe columns diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 0ce428ca8e6..1b5e9c86abb 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.107.0 +version: 0.108.0 expression: | Creates a concat string expression. usage: | @@ -35,9 +35,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Creates a concat string expression diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index 333ee1b6e7f..8311d86d9aa 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Concatenate two or more dataframes. usage: | @@ -43,9 +43,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | --------- | -| any | dataframe | +| input | output | +| ----- | ---------------- | +| any | polars_dataframe | +| any | polars_lazyframe | ## Examples Concatenates two dataframes with the dataframe in the pipeline. diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 67672907b42..6e5fac7eb65 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns boolean indicating if pattern was found in a column diff --git a/commands/docs/polars_convert-time-zone.md b/commands/docs/polars_convert-time-zone.md index 185cb592a62..5bc7f3db85f 100644 --- a/commands/docs/polars_convert-time-zone.md +++ b/commands/docs/polars_convert-time-zone.md @@ -2,7 +2,7 @@ title: polars convert-time-zone categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Convert datetime to target timezone. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Convert timezone for timezone-aware datetime @@ -47,8 +47,8 @@ Convert timezone for timezone-aware datetime ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 4 months ago │ -│ 1 │ 4 months ago │ +│ 0 │ 6 months ago │ +│ 1 │ 6 months ago │ ╰───┴──────────────╯ ``` @@ -61,8 +61,8 @@ Timezone conversions for timezone-naive datetime will assume the original timezo ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 4 months ago │ -│ 1 │ 4 months ago │ +│ 0 │ 6 months ago │ +│ 1 │ 6 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 46704c68d7f..e71fb41ce5c 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.107.0 +version: 0.108.0 dataframe: | Counts null values. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Counts null values diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index ba9749304a8..4a215210340 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Returns the number of non-null values in the column. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Count the number of non-null values in a column diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index b8d7885d0a3..e937eb4cd34 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Cumulative calculation for a column or series. usage: | @@ -38,10 +38,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Cumulative sum for a column diff --git a/commands/docs/polars_cut.md b/commands/docs/polars_cut.md index 20a78368967..bb9b6486140 100644 --- a/commands/docs/polars_cut.md +++ b/commands/docs/polars_cut.md @@ -2,7 +2,7 @@ title: polars cut categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Bin continuous values into discrete categories for a series. usage: | @@ -40,9 +40,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Divide the column into three categories. diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index d6ab29def5d..51704f8fa60 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Creates an expression to capture the year date part diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index cba75896841..40f8278efa4 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Converts a string column into a decimal column usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Modifies strings to decimal diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index b1541ba58ba..ccae8fc7efc 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.107.0 +version: 0.108.0 dataframe: | Drops duplicate values in dataframe. usage: | @@ -39,9 +39,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples drop duplicates diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index c1f4cd59f3b..4a4e5bf2e1a 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.107.0 +version: 0.108.0 dataframe: | Drops null values in dataframe. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples drop null values in dataframe diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index ca96b4f53a9..7b603312a5c 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples drop column a diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index 3e08e73927a..6e56faf4e37 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a new dataframe with dummy variables. usage: | @@ -30,13 +30,16 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Flags - `--drop-first, -d`: Drop first row + - `--drop-nulls, -n`: Drop nulls + - `--separator, -s`: Optional separator ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create new dataframe with dummy variables from a dataframe diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 7f9c3becfd3..32b8b60e28c 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Explode the specified dataframe diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 12a5bbd45eb..8fbcc99474e 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.107.0 +version: 0.108.0 dataframe: | Creates a not expression. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Creates a not expression diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md deleted file mode 100644 index ef9ab2bc44b..00000000000 --- a/commands/docs/polars_fetch.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: polars fetch -categories: | - lazyframe -version: 0.107.0 -lazyframe: | - Collects the lazyframe to the selected rows. -usage: | - Collects the lazyframe to the selected rows. -editLink: false -contributors: false ---- - - -# `polars fetch` for [lazyframe](/commands/categories/lazyframe.md) - -
Collects the lazyframe to the selected rows.
- -::: warning This command requires a plugin -The `polars fetch` 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 fetch {flags} (rows)``` - -## Parameters - - - `rows`: number of rows to be fetched from lazyframe - - -## Input/output types: - -| input | output | -| --------- | --------- | -| dataframe | dataframe | -## Examples - -Fetch a rows from the dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars fetch 2 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 6 │ 2 │ -│ 1 │ 4 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index a314cf600b1..10b9dd72ae1 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.107.0 +version: 0.108.0 lazyframe: | Replaces NaN values with the given expression. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Fills the NaN values with 0 diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index 885a638d14e..bb8e5d727b4 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.107.0 +version: 0.108.0 lazyframe: | Replaces NULL values with the given expression. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Fills the null values by 0 diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index 84545bc3857..e7e65b44272 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.107.0 +version: 0.108.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Filter dataframe using a bool mask diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 26a49f90062..54e9bcd1c9b 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Filter dataframe based in expression. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Filter dataframe using an expression @@ -58,8 +59,8 @@ Filter dataframe for rows where dt is within the last 2 days of the maximum dt v ╭───┬──────────────┬─────╮ │ # │ dt │ val │ ├───┼──────────────┼─────┤ -│ 0 │ 5 months ago │ 3 │ -│ 1 │ 5 months ago │ 4 │ +│ 0 │ 6 months ago │ 3 │ +│ 1 │ 6 months ago │ 4 │ ╰───┴──────────────┴─────╯ ``` diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index c0c4a926c5c..2b00c6deaa5 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Show only the first number of rows or create a first expression usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Return the first row of a dataframe diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index fce6ad1c29e..95332d22df8 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | An alias for polars explode. usage: | @@ -34,10 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | ## Examples Flatten the specified dataframe diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index 1b8a31c012a..fbfafc14949 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.107.0 +version: 0.108.0 dataframe: | Gets day from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns day from a date diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 773079b7bf8..cbf8fccaae2 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.107.0 +version: 0.108.0 dataframe: | Gets hour from datetime. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns hour from a date diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 859c4e088b8..18cc4936953 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.107.0 +version: 0.108.0 dataframe: | Gets minute from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns minute from a date diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index 089025ebe4b..242b1f98656 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.107.0 +version: 0.108.0 dataframe: | Gets month from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns month from a date diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 7d41d66ef65..3339c5182b0 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.107.0 +version: 0.108.0 dataframe: | Gets nanosecond from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns nanosecond from a date diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 87ffb80b3d4..ce765edc183 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.107.0 +version: 0.108.0 dataframe: | Gets ordinal from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns ordinal from a date diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 22179a66bfa..5b6d6f644a8 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.107.0 +version: 0.108.0 dataframe: | Gets second from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns second from a date diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 352f66f1ffd..1acf500d979 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.107.0 +version: 0.108.0 dataframe: | Gets week from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns week from a date diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 12e143cc054..98a34415574 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.107.0 +version: 0.108.0 dataframe: | Gets weekday from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns weekday from a date diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 921953ad956..0f43185c725 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.107.0 +version: 0.108.0 dataframe: | Gets year from date. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns year from a date diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 155f0ccf87d..44c94fb075c 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates dataframe with the selected columns. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns the selected column diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index b0adf8778f0..eb848d22a32 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.107.0 +version: 0.108.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Group by and perform an aggregation diff --git a/commands/docs/polars_horizontal.md b/commands/docs/polars_horizontal.md index 30fac5f7d50..97a31970b54 100644 --- a/commands/docs/polars_horizontal.md +++ b/commands/docs/polars_horizontal.md @@ -2,7 +2,7 @@ title: polars horizontal categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Horizontal calculation across multiple columns. usage: | @@ -39,9 +39,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Horizontal sum across two columns (ignore nulls by default) diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 07ab55d5bab..ce6e9ff8b64 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Aggregates values into a list. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Create two lists for columns a and b with all the rows as values. diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index 584f44d7ff8..5c9cdfdc171 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Converts a string column into a integer column usage: | @@ -25,14 +25,23 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Signature -```> polars integer {flags} ``` +```> polars integer {flags} (base) (dtype)``` + +## Flags + + - `--strict, -s`: Raises an error as opposed to converting to null + +## Parameters + + - `base`: An integer or expression representing the base (radix) of the number system (default is 10) + - `dtype`: Data type to cast to (defaults is i64) ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Modifies strings to integer diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index edaf06294a5..84b2d234bfc 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.107.0 +version: 0.108.0 dataframe: | Converts a list, table or record into a dataframe. usage: | @@ -35,9 +35,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | --------- | -| any | dataframe | +| input | output | +| ----- | ---------------- | +| any | polars_dataframe | ## Examples Takes a dictionary and creates a dataframe diff --git a/commands/docs/polars_into-dtype.md b/commands/docs/polars_into-dtype.md index cfaa464aadf..7912425a7e8 100644 --- a/commands/docs/polars_into-dtype.md +++ b/commands/docs/polars_into-dtype.md @@ -2,7 +2,7 @@ title: polars into-dtype categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Convert a string to a specific datatype. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ------ | -------- | -| string | datatype | +| input | output | +| ------ | ---------------- | +| string | polars_dataframe | ## Examples Convert a string to a specific datatype and back to a nu object diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 9628c1077f0..2f76fa99c7f 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.107.0 +version: 0.108.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | --------- | -| any | dataframe | +| input | output | +| ----- | ---------------- | +| any | polars_lazyframe | ## Examples Takes a table and creates a lazyframe diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index 30cf606f72a..d01e4aa4375 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.107.0 +version: 0.108.0 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | @@ -36,12 +36,15 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ------ | -| expression | any | -| dataframe | table | -| datatype | any | -| schema | any | +| input | output | +| ----------------- | ------ | +| polars_dataframe | table | +| polars_lazyframe | table | +| polars_expression | any | +| polars_group_by | any | +| polars_when | any | +| polars_datatype | any | +| polars_schema | any | ## Examples Shows head rows from dataframe diff --git a/commands/docs/polars_into-repr.md b/commands/docs/polars_into-repr.md index d26c8fc3a04..a84bcb51849 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.107.0 +version: 0.108.0 dataframe: | Display a dataframe in its repr format. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | ------ | -| dataframe | string | +| input | output | +| ---------------- | ------ | +| polars_dataframe | string | +| polars_lazyframe | string | ## Examples Shows dataframe in repr format diff --git a/commands/docs/polars_into-schema.md b/commands/docs/polars_into-schema.md index 5e6720a7ebb..2985b2d754d 100644 --- a/commands/docs/polars_into-schema.md +++ b/commands/docs/polars_into-schema.md @@ -2,7 +2,7 @@ title: polars into-schema categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Convert a value to a polars schema object usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ------ | -| any | schema | +| input | output | +| ----- | ------------- | +| any | polars_schema | ## Examples Convert a record into a schema and back to a nu object diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 9dd5660044e..7e36251029c 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.107.0 +version: 0.108.0 dataframe: | Creates mask indicating duplicated values. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create mask indicating duplicated values diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index 92bff3d499e..11b6bae29fd 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.107.0 +version: 0.108.0 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Creates a is-in expression diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index 96d41e09b85..44fbfd0d95f 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.107.0 +version: 0.108.0 dataframe: | Creates mask where value is not null. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create mask where values are not null diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index 369b0a89ad7..0728fd4e364 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.107.0 +version: 0.108.0 dataframe: | Creates mask where value is null. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create mask where values are null diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index dc2606c2573..ad136e85f81 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.107.0 +version: 0.108.0 dataframe: | Creates mask indicating unique values. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create mask indicating unique values diff --git a/commands/docs/polars_join-where.md b/commands/docs/polars_join-where.md index 7e3a9d446a2..3b71813447e 100644 --- a/commands/docs/polars_join-where.md +++ b/commands/docs/polars_join-where.md @@ -2,7 +2,7 @@ title: polars join-where categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Joins a lazy frame with other lazy frame based on conditions. usage: | @@ -35,9 +35,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Join two lazy dataframes with a condition diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index f97ecebf3c5..99c96a4683e 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | @@ -45,9 +45,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Join two lazy dataframes diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 93e0476a9ae..23c79fd2eae 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create new dataframe with last rows diff --git a/commands/docs/polars_len.md b/commands/docs/polars_len.md index 36c605874a4..49d30e2345a 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Return the number of rows in the context. This is similar to COUNT(*) in SQL. usage: | @@ -30,9 +30,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Count the number of rows in the the dataframe. diff --git a/commands/docs/polars_list-contains.md b/commands/docs/polars_list-contains.md index 4a22dd6f21b..2407c7dcf62 100644 --- a/commands/docs/polars_list-contains.md +++ b/commands/docs/polars_list-contains.md @@ -2,7 +2,7 @@ title: polars list-contains categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Checks if an element is contained in a list. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Returns boolean indicating if a literal element was found in a list column diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index f12cbbdf438..746e609f2d4 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Creates a literal expression. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Created a literal expression and converts it to a nu object @@ -56,7 +56,7 @@ Create a literal expression from date │ expr │ │ expr │ literal │ │ │ │ │ value │ dyn int: 1744502400000000000 │ │ │ │ ╰───────┴──────────────────────────────╯ │ -│ dtype │ Datetime(Nanoseconds, None) │ +│ dtype │ Datetime('ns') │ │ cast_options │ STRICT │ ╰──────────────┴──────────────────────────────────────────╯ ``` @@ -69,7 +69,7 @@ Create a literal expression from duration │ expr │ │ expr │ literal │ │ │ │ │ value │ dyn int: 10800000000000 │ │ │ │ ╰───────┴─────────────────────────╯ │ -│ dtype │ Duration(Nanoseconds) │ +│ dtype │ Duration('ns') │ │ cast_options │ STRICT │ ╰──────────────┴─────────────────────────────────────╯ ``` diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index 759caaba192..08ca57e72ce 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Lowercase the strings in the column. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Modifies strings in a column to lowercase diff --git a/commands/docs/polars_math.md b/commands/docs/polars_math.md index b1b19740148..40878fb6b1b 100644 --- a/commands/docs/polars_math.md +++ b/commands/docs/polars_math.md @@ -2,7 +2,7 @@ title: polars math categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Collection of math functions to be applied on one or more column expressions usage: | @@ -35,9 +35,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Apply function to column expression diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 3dfd56afe47..bef948856c1 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a max expression or aggregates columns to their max value. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Max value from columns in a dataframe diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index cd4b05f2c7a..d1a69ef110f 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Mean value from columns in a dataframe diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index 3e8913aa3e2..fc074440b29 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Median aggregation for a group-by diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 95e252e974f..905a5737038 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a min expression or aggregates columns to their min value. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Min value from columns in a dataframe diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index 48b25799497..080124221f2 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.107.0 +version: 0.108.0 dataframe: | Counts unique values. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Counts unique values diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 19652bd8d5f..4d398ad4037 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Inverts boolean mask. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Inverts boolean mask diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index e7f58f54e82..9cd977bfbd5 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.107.0 +version: 0.108.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: | @@ -50,9 +50,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | --------- | -| any | dataframe | +| input | output | +| ----- | ---------------- | +| any | polars_dataframe | +| any | polars_lazyframe | ## Examples Takes a file name and creates a dataframe diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index 03baffc2f50..048b3f9936c 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Completes a when expression. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_expression | ## Examples Create a when conditions diff --git a/commands/docs/polars_over.md b/commands/docs/polars_over.md index 8d7919e2566..ab48f8c5d5a 100644 --- a/commands/docs/polars_over.md +++ b/commands/docs/polars_over.md @@ -2,7 +2,7 @@ title: polars over categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Compute expressions over a window group defined by partition expressions. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Compute expression over an aggregation window diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 4aeebfc5881..d3aba5145b1 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Pivot a DataFrame from long to wide format. usage: | @@ -32,17 +32,19 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. - `--on, -o {list}`: column names for pivoting - `--index, -i {list}`: column names for indexes - `--values, -v {list}`: column names used as value columns - - `--aggregate, -a {string}`: Aggregation to apply when pivoting. The following are supported: first, sum, min, max, mean, median, count, last + - `--aggregate, -a {any}`: Aggregation to apply when pivoting. The following are supported: first, sum, min, max, mean, median, count, last, or a custom expression - `--separator, -p {string}`: Delimiter in generated column names in case of multiple `values` columns (default '_') - `--sort, -s`: Sort columns - `--streamable, -t`: Whether or not to use the polars streaming engine. Only valid for lazy dataframes + - `--stable`: Perform a stable pivot. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Perform a pivot in order to show individuals test score by subject @@ -51,8 +53,8 @@ Perform a pivot in order to show individuals test score by subject ╭───┬───────┬──────────────┬───────┬─────────╮ │ # │ name │ date │ maths │ physics │ ├───┼───────┼──────────────┼───────┼─────────┤ -│ 0 │ Cady │ 5 months ago │ 98 │ 99 │ -│ 1 │ Karen │ 5 months ago │ 61 │ 58 │ +│ 0 │ Cady │ 6 months ago │ 98 │ 99 │ +│ 1 │ Karen │ 6 months ago │ 61 │ 58 │ ╰───┴───────┴──────────────┴───────┴─────────╯ ``` diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index 2ce5eda007c..263f41e7454 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Profile a lazy dataframe. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Profile a lazy dataframe diff --git a/commands/docs/polars_qcut.md b/commands/docs/polars_qcut.md index b561b5ce735..54460438b17 100644 --- a/commands/docs/polars_qcut.md +++ b/commands/docs/polars_qcut.md @@ -2,7 +2,7 @@ title: polars qcut categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Bin continuous values into discrete categories based on their quantiles for a series. usage: | @@ -41,9 +41,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Divide a column into three categories according to pre-defined quantile probabilities. diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index aeaea14f153..fba43547d0a 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples quantile value from columns in a dataframe diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index ecf180b0f7f..02a2486eb0d 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Query dataframe using SQL diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index 04dc3861712..410bfeb0cfd 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.107.0 +version: 0.108.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | @@ -35,9 +35,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Renames a series diff --git a/commands/docs/polars_replace-time-zone.md b/commands/docs/polars_replace-time-zone.md index 7becbdded10..74ccb49af70 100644 --- a/commands/docs/polars_replace-time-zone.md +++ b/commands/docs/polars_replace-time-zone.md @@ -2,7 +2,7 @@ title: polars replace-time-zone categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Replace the timezone information in a datetime column. usage: | @@ -43,9 +43,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Apply timezone to a naive datetime @@ -68,14 +68,14 @@ Apply timezone with ambiguous datetime | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S" --naive | polars select (polars col datetime | polars replace-time-zone "America/New_York" --ambiguous null) -╭───┬─────────────╮ -│ # │ datetime │ -├───┼─────────────┤ -│ 0 │ in 2 months │ -│ 1 │ │ -│ 2 │ in 2 months │ -│ 3 │ in 2 months │ -╰───┴─────────────╯ +╭───┬────────────╮ +│ # │ datetime │ +├───┼────────────┤ +│ 0 │ in 2 weeks │ +│ 1 │ │ +│ 2 │ in 2 weeks │ +│ 3 │ in 2 weeks │ +╰───┴────────────╯ ``` @@ -88,10 +88,10 @@ Apply timezone with nonexistent datetime ╭───┬──────────────╮ │ # │ datetime │ ├───┼──────────────┤ -│ 0 │ 5 months ago │ +│ 0 │ 7 months ago │ │ 1 │ │ -│ 2 │ 5 months ago │ -│ 3 │ 5 months ago │ +│ 2 │ 7 months ago │ +│ 3 │ 7 months ago │ ╰───┴──────────────╯ ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 07bb9f0b688..da1e7a29dc6 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Create an expression that replaces old values with new values usage: | @@ -41,9 +41,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Replace column with different values of same type diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 6d61eec953b..5671147211c 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Reverses the LazyFrame usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Reverses the dataframe. diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index cee42766755..b0df5ec9047 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Rolling calculation for a series. usage: | @@ -35,9 +35,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Rolling sum for a series diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index 2cdf4aee7d3..12b5bbb9d1a 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Create sample dataframe. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Sample rows from dataframe diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index 8573fdd9122..ac2ebba6818 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson). usage: | diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 6dcb16cf747..a184eb6cd4f 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index d45f3ef4d50..74fa5b9ee35 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.107.0 +version: 0.108.0 lazyframe: | Selects columns from lazyframe. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Select a column from the dataframe diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index 185f8bccb06..4bfbdf2f450 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.107.0 +version: 0.108.0 dataframe: | Sets value in the given index. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Set value in selected rows from series diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 438924ba025..bdc8a5ebd8f 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Sets value where given mask is true. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Shifts the values by a given period diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index 9361d151382..5f50f9e6a11 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Shows column and row size for a dataframe. usage: | @@ -30,9 +30,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Shows row and column shape diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index 3c394ef4628..cb88b3c82f2 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.107.0 +version: 0.108.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | @@ -38,10 +38,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Shifts the values by a given period diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index 0ea8de75af2..bd8b21c3a43 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates new dataframe from a slice of rows. usage: | @@ -35,9 +35,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Create new dataframe from a slice of the rows diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index 49edf26efd4..b4b3aad7cd9 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.107.0 +version: 0.108.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | @@ -40,9 +40,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Sort dataframe by one column diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index 78a3c6da20a..4ca5290ea21 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Std value from columns in a dataframe diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index affa1eb3053..6b72846b4f4 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.107.0 +version: 0.108.0 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | @@ -34,10 +34,15 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ----- | ---------- | -| any | dataframe | -| any | expression | +| input | output | +| ----- | ----------------- | +| any | polars_dataframe | +| any | polars_lazyframe | +| any | polars_expression | +| any | polars_group_by | +| any | polars_when | +| any | polars_datatype | +| any | polars_schema | ## Examples Get a stored object diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 26a37339d6c..59d09fbb501 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.107.0 +version: 0.108.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index abc18423c88..7c2104360e7 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.107.0 +version: 0.108.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 8f99964d3e0..9bfabe957dc 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.107.0 +version: 0.108.0 dataframe: | Concatenates strings within a column or dataframes usage: | @@ -39,10 +39,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Join strings in a column diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 9f08e1f1c31..ae1b26e8636 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.107.0 +version: 0.108.0 dataframe: | Get lengths of all strings. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Returns string lengths for a column diff --git a/commands/docs/polars_str-replace-all.md b/commands/docs/polars_str-replace-all.md index 600ddbbc577..67944b6dab9 100644 --- a/commands/docs/polars_str-replace-all.md +++ b/commands/docs/polars_str-replace-all.md @@ -2,7 +2,7 @@ title: polars str-replace-all categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -35,10 +35,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Replaces string in a column diff --git a/commands/docs/polars_str-replace.md b/commands/docs/polars_str-replace.md index bff0b3df2e7..b7c2091e405 100644 --- a/commands/docs/polars_str-replace.md +++ b/commands/docs/polars_str-replace.md @@ -2,7 +2,7 @@ title: polars str-replace categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -35,10 +35,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Replaces string in column diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index ffd319c2507..de40287f150 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.107.0 +version: 0.108.0 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -38,10 +38,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Creates slices from the strings in a specified column diff --git a/commands/docs/polars_str-split.md b/commands/docs/polars_str-split.md index fbbd22f14c1..d5b6e017b04 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.107.0 +version: 0.108.0 dataframe: | Split the string by a substring. The resulting dtype is list. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Split the string by comma, then create a new row for each string diff --git a/commands/docs/polars_str-strip-chars.md b/commands/docs/polars_str-strip-chars.md index 436fa5569a7..2501184cdda 100644 --- a/commands/docs/polars_str-strip-chars.md +++ b/commands/docs/polars_str-strip-chars.md @@ -2,7 +2,7 @@ title: polars str-strip-chars categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Strips specified characters from strings in a column usage: | @@ -39,9 +39,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Strip characters from both ends of strings in a column diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index da0477a62f2..6c846389603 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Formats date based on string rule. usage: | @@ -34,10 +34,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Formats date column as a string diff --git a/commands/docs/polars_struct-json-encode.md b/commands/docs/polars_struct-json-encode.md index 7ba82d7e5e1..e4009d05f5b 100644 --- a/commands/docs/polars_struct-json-encode.md +++ b/commands/docs/polars_struct-json-encode.md @@ -2,7 +2,7 @@ title: polars struct-json-encode categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Convert this struct to a string column with json values. usage: | diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index 606f015260c..1ca460852aa 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Sums all columns in a dataframe diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 8709d2158d1..bd2f4b1f04f 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples list dataframe descriptives diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index e03239e8406..cc46693f5d6 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Creates new dataframe using the given indices. usage: | @@ -34,9 +34,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Takes selected rows from dataframe diff --git a/commands/docs/polars_truncate.md b/commands/docs/polars_truncate.md index 5b25d0a957e..2c69ba15d52 100644 --- a/commands/docs/polars_truncate.md +++ b/commands/docs/polars_truncate.md @@ -2,7 +2,7 @@ title: polars truncate categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Divide the date/datetime range into buckets. usage: | @@ -34,9 +34,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | ## Examples Truncate a series of dates by period length @@ -45,10 +45,10 @@ Truncate a series of dates by period length ╭───┬──────────────┬──────────────╮ │ # │ datetime │ truncated │ ├───┼──────────────┼──────────────┤ -│ 0 │ 8 months ago │ 8 months ago │ -│ 1 │ 6 months ago │ 6 months ago │ -│ 2 │ 5 months ago │ 5 months ago │ -│ 3 │ 3 months ago │ 4 months ago │ +│ 0 │ 9 months ago │ 9 months ago │ +│ 1 │ 8 months ago │ 8 months ago │ +│ 2 │ 6 months ago │ 6 months ago │ +│ 3 │ 5 months ago │ 5 months ago │ ╰───┴──────────────┴──────────────╯ ``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index e144d7f5861..7d0f5edc535 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.107.0 +version: 0.108.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | @@ -36,10 +36,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Returns unique values from a series diff --git a/commands/docs/polars_unnest.md b/commands/docs/polars_unnest.md index f8a7691657d..677e2033b12 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.107.0 +version: 0.108.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: | @@ -31,6 +31,13 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. - `...rest`: columns to unnest + +## Input/output types: + +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Unnest a dataframe diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index dd11cc16ff5..18eda100c3a 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | @@ -37,9 +37,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples unpivot on an eager dataframe diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index 8a3d2dbdbe6..bcf967706e4 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Uppercase the strings in the column. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| dataframe | dataframe | -| expression | expression | +| input | output | +| ----------------- | ----------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | +| polars_expression | polars_expression | ## Examples Modifies strings in a column to uppercase diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 662f0402d82..04aa8252ce7 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.107.0 +version: 0.108.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -37,9 +37,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Calculates value counts diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 2f4709b7f85..3988d422aa5 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.107.0 +version: 0.108.0 dataframe: | Create a var expression for an aggregation. usage: | @@ -30,10 +30,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| expression | expression | -| dataframe | dataframe | +| input | output | +| ----------------- | ----------------- | +| polars_expression | polars_expression | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Var value from columns in a dataframe or aggregates columns to their var value diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index f81f50a166c..cff56eba3a4 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.107.0 +version: 0.108.0 expression: | Creates and modifies a when expression. usage: | @@ -35,11 +35,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| ---------- | ---------- | -| nothing | expression | -| expression | expression | -| any | expression | +| input | output | +| ----------------- | ----------------- | +| nothing | polars_expression | +| polars_expression | polars_expression | +| any | polars_expression | ## Examples Create a when conditions diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index 85d6249cd45..bb68514bbc8 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.107.0 +version: 0.108.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | @@ -38,9 +38,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Input/output types: -| input | output | -| --------- | --------- | -| dataframe | dataframe | +| input | output | +| ---------------- | ---------------- | +| polars_dataframe | polars_dataframe | +| polars_lazyframe | polars_lazyframe | ## Examples Adds a series to the dataframe diff --git a/commands/docs/port.md b/commands/docs/port.md index 23c926b8b47..db2348c2a7e 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,11 +2,11 @@ title: port categories: | network -version: 0.107.0 +version: 0.108.0 network: | - Get a free port from system. + Get a free TCP port from system. usage: | - Get a free port from system. + Get a free TCP port from system. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `port` for [network](/commands/categories/network.md) -
Get a free port from system.
+
Get a free TCP port from system.
## Signature diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 64307b1237e..2f079127a92 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 2273c3969e2..5dbbafa7373 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 4e63c98e80e..34d4593e6f0 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index c35a3831c0b..e41bab1aa6a 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.107.0 +version: 0.108.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 19cc58c1c33..22900d96bae 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Show all the query commands usage: | @@ -32,8 +32,8 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. | name | description | type | | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | -------- | -| [`query db`](/commands/docs/query_db.md) | Query a database using SQL. | built-in | -| [`query json`](/commands/docs/query_json.md) | execute json query on json file (open --raw \ | query json 'query string') | plugin | +| [`query db`](/commands/docs/query_db.md) | Query a SQLite database with SQL statements. | built-in | +| [`query json`](/commands/docs/query_json.md) | execute json query on json file (open --raw \\ \| query json 'query string') | plugin | | [`query web`](/commands/docs/query_web.md) | execute selector query on html/web | plugin | | [`query webpage-info`](/commands/docs/query_webpage-info.md) | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more | plugin | | [`query xml`](/commands/docs/query_xml.md) | Execute XPath 1.0 query on XML input | plugin | \ No newline at end of file diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 68b357cefc9..6b87486c2e2 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,11 +2,11 @@ title: query db categories: | database -version: 0.107.0 +version: 0.108.0 database: | - Query a database using SQL. + Query a SQLite database with SQL statements. usage: | - Query a database using SQL. + Query a SQLite database with SQL statements. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `query db` for [database](/commands/categories/database.md) -
Query a database using SQL.
+
Query a SQLite database with SQL statements.
## Signature @@ -96,3 +96,6 @@ stor open | query db "SELECT data->'baz' AS baz FROM my_table" | update baz {fro ╰───┴───────────╯ ``` + +## Notes +This command is only supported for local or in-memory SQLite databases. \ No newline at end of file diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 1d85be3d366..58b553bf676 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -80,4 +80,4 @@ 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 +query json uses the gjson crate https://github.com/tidwall/gjson.rs to query json data. \ No newline at end of file diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index fa5cb8f79a5..89c728671b1 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.107.0 +version: 0.108.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 35fd912032e..04588a910d0 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.107.0 +version: 0.108.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 d4dda4e9e5f..f5bc15b6e32 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Execute XPath 1.0 query on XML input usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 4ab0c94a6af..428922630af 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate a random value. usage: | diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index 170c08bafc7..14c62fea134 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index a94983b45c7..6ce58f7d8fc 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 1deb813743f..5d5319b0562 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.107.0 +version: 0.108.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 b24a630956d..d9896033f66 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 124310e5f42..08835c74bec 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.107.0 +version: 0.108.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 ef2adae43f0..afef743fb1a 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index a1853005bad..60f3b5775f3 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.107.0 +version: 0.108.0 random: | Generate a random uuid string of the specified version. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 3396feae854..ad79bdfe9ac 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry.md b/commands/docs/registry.md index d54c569d17d..38875ed6712 100644 --- a/commands/docs/registry.md +++ b/commands/docs/registry.md @@ -2,7 +2,7 @@ title: registry categories: | system -version: 0.107.0 +version: 0.108.0 system: | Various commands for interacting with the system registry (Windows only). usage: | @@ -33,4 +33,4 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | ---------------------------------------------------- | --------------------------- | -------- | -| [`registry query`](/commands/docs/registry_query.md) | Query the Windows registry. | built-in | \ No newline at end of file +| [`registry query`](/commands/docs/registry_query.md) | Query the Windows registry. | built-in | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index 1bd7a212658..a1f6c95e3d9 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.107.0 +version: 0.108.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 4168e8a54a7..bc82d64c516 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.107.0 +version: 0.108.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 6a094de6113..b2dd4df2243 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 749732a4499..fb0a63fc839 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.107.0 +version: 0.108.0 core: | Return early from a custom command. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 27a70cb1d2b..785a2541c3e 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index cffa6a330c9..c597fe4eecb 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 13dd6c1473a..09082324fa1 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 4152dfc7b1d..a535d2a4e2d 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 7289b8806a7..6a1175d8889 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 49c0b560ac9..22aef8547d6 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index a06a0f2cb9e..8de0234eec3 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 08f912d4cd4..19b75ac1011 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index 281abb287ac..4cb8535f393 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.107.0 +version: 0.108.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 3dbea452b29..8b762cb28bf 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index a419f1dd9cb..addb5547385 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.107.0 +version: 0.108.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 4f00aaff902..dcf902d2a38 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.107.0 +version: 0.108.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 2fa28b4f02d..469dbdcade4 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.107.0 +version: 0.108.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 a282215945a..016ecd38ec5 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.107.0 +version: 0.108.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 985b438d9df..b6349518d7d 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.107.0 +version: 0.108.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 6814d257492..a3bcc1f5406 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.107.0 +version: 0.108.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 bd30e999d73..8cb0750fefe 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.107.0 +version: 0.108.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 282555d2089..7f8dd87a932 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.107.0 +version: 0.108.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 a23df4dae5d..23521c28bdd 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.107.0 +version: 0.108.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 e37eff5fc56..5d7a65253ec 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.107.0 +version: 0.108.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 6567a27ae9e..0ceb6c51617 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.107.0 +version: 0.108.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 491dfe2ce3c..99f53bfb93b 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.107.0 +version: 0.108.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index cfee8b84e3d..c7f4f4e2582 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index fa5a0bcdc29..045d4730947 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.107.0 +version: 0.108.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 a4b771bb8e3..5bae41c9f2a 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.107.0 +version: 0.108.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 719676632f7..acc9a340d7c 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.107.0 +version: 0.108.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 455209c0f80..f9902a27308 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/slice.md b/commands/docs/slice.md index d4b4ab1ff22..3e4762bc1f1 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index df75a9ad06d..f5594e8aa3e 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index a8865060ff1..4fe7b8cd133 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 9a82bc27ac9..b1442bf0a0c 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.107.0 +version: 0.108.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 8091077393e..10c862b4d73 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.107.0 +version: 0.108.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 5aa017745cf..31f0ce3188a 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.107.0 +version: 0.108.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 8b5f2388f9d..fce8552d467 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.107.0 +version: 0.108.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 36f131e9b21..a779ea81f3a 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.107.0 +version: 0.108.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 58e58beeecd..48106f3827d 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.107.0 +version: 0.108.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 67f3a504e8c..412eb8808af 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 31a6835d9c5..60270c8bb77 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.107.0 +version: 0.108.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 7f8eee98b73..09a43202982 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index b6fb591a855..27a6e57d0db 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.107.0 +version: 0.108.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 70ddffd25b5..2858c2173a7 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.107.0 +version: 0.108.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 873daa9cf53..f2ab5dea50b 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.107.0 +version: 0.108.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 f2bc5966e23..f93f346d59a 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.107.0 +version: 0.108.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 86785f4fde0..e7565f41f9b 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.107.0 +version: 0.108.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 5abed85e706..fc25fa89e29 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.107.0 +version: 0.108.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 8a7703006e3..e4e5295841d 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.107.0 +version: 0.108.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 1b348fb7667..1abeb6f6b4f 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.107.0 +version: 0.108.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index 6f14885b1a8..3174fcbbca8 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.107.0 +version: 0.108.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 425ee281567..76a0bffa90c 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.107.0 +version: 0.108.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 e849bd01085..0046285b66f 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.107.0 +version: 0.108.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 a8ef1f1ed98..af65c36d9f3 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.107.0 +version: 0.108.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 6b0a43e5a99..23678735c56 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 6d3497ec2b0..e6fba4d4c0b 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.107.0 +version: 0.108.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 1088e7aa017..1b427d7e32f 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.107.0 +version: 0.108.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 f83d84c1116..b31a2c58da8 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 82924b89462..220f5cbd7e6 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.107.0 +version: 0.108.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 55104913094..d3fc7155596 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index f3dd8474b41..d8a20e36c22 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.107.0 +version: 0.108.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 0a8ed85a4ed..40f38a84c8c 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.107.0 +version: 0.108.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 4f6edb41f35..d19a111a86d 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.107.0 +version: 0.108.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 446f37eeddd..a0ce892e9df 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Output the length of any strings in the pipeline. usage: | @@ -22,8 +22,9 @@ contributors: false ## Flags - - `--grapheme-clusters, -g`: count length using grapheme clusters (all visible chars have length 1) - - `--utf-8-bytes, -b`: count length using UTF-8 bytes (default; all non-ASCII chars have length 2+) + - `--grapheme-clusters, -g`: count length in grapheme clusters (all visible chars have length 1) + - `--utf-8-bytes, -b`: count length in UTF-8 bytes (default; all non-ASCII chars have length 2+) + - `--chars, -c`: count length in chars ## Parameters @@ -40,19 +41,19 @@ contributors: false | record | record | ## Examples -Return the lengths of a string +Return the lengths of a string in bytes ```nu > 'hello' | str length 5 ``` -Count length using grapheme clusters +Count length of a string in grapheme clusters ```nu > '🇯🇵ほげ ふが ぴよ' | str length --grapheme-clusters 9 ``` -Return the lengths of multiple strings +Return the lengths of multiple strings in bytes ```nu > ['hi' 'there'] | str length ╭───┬───╮ @@ -61,3 +62,9 @@ Return the lengths of multiple strings ╰───┴───╯ ``` + +Return the lengths of a string in chars +```nu +> 'hällo' | str length --chars +5 +``` diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 94751833248..f6bcd2235a2 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.107.0 +version: 0.108.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 33e43638922..a463d45040f 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index ffe90670930..ab6f090fb47 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.107.0 +version: 0.108.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 70413a08e3b..344eb1d61e1 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.107.0 +version: 0.108.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index 7d11bd80ab9..da5be3b23da 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.107.0 +version: 0.108.0 strings: | Convert a string to snake_case. usage: | diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index 3621376b5e4..a1f5a69f98f 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.107.0 +version: 0.108.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 b94967cbb12..b7ba9c655f5 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.107.0 +version: 0.108.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 2406349b4fb..9108b8aa102 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.107.0 +version: 0.108.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 efd286b5c83..9cd8905217b 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.107.0 +version: 0.108.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index ba5e064e8c2..35cb329ee44 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 11260a0d360..e55ffc92f8d 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.107.0 +version: 0.108.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 66d5d5f0a97..4879a210770 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 13b779dff3b..6b4dcdff047 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index 190c5c7b565..7ab749fe219 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index c54b76e9fa3..6aa294373cc 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index 548bd158613..1e5245e997c 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index 5a05cec339a..4e5203c4c76 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.107.0 +version: 0.108.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 7265402dba3..8d2aa1023be 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.107.0 +version: 0.108.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 3b498ab60fc..3b2bff59124 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.107.0 +version: 0.108.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 1450ed9bb5f..831524b6479 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.107.0 +version: 0.108.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 9aec8859820..61324d164ff 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.107.0 +version: 0.108.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 a0dda9e7bcd..3dbece54bc8 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.107.0 +version: 0.108.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 ba182f7d341..0f172dd0a8a 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.107.0 +version: 0.108.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 e5be7cad854..2c89e7efdbf 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term.md b/commands/docs/term.md index 89f5543041d..e93195790ff 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.107.0 +version: 0.108.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 e320df46c0c..efb6efef630 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Query the terminal for information. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index 23a2db52ed0..ae2ba0e70ed 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.107.0 +version: 0.108.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 efe750508b7..2c8879be400 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.107.0 +version: 0.108.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 a5b5b6250c4..586577bbe9f 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Translate structured data to a format. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 19efaa60e37..8b97a4a886e 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index ad47f33d8ea..f71925fc71d 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 8cf9458a289..fa22dfcfb56 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 43934cbb21b..15845d9602b 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into simple Markdown. usage: | @@ -23,8 +23,11 @@ contributors: false ## Flags - `--pretty, -p`: Formats the Markdown table to vertically align items - - `--per-element, -e`: treat each row as markdown syntax element + - `--per-element, -e`: Treat each row as markdown syntax element - `--center, -c {list}`: Formats the Markdown table to center given columns + - `--escape-md, -m`: Escapes Markdown special characters + - `--escape-html, -t`: Escapes HTML special characters + - `--escape-all, -a`: Escapes both Markdown and HTML special characters ## Input/output types: @@ -37,9 +40,9 @@ contributors: false Outputs an MD string representing the contents of this table ```nu > [[foo bar]; [1 2]] | to md -|foo|bar| -|-|-| -|1|2| +| foo | bar | +| --- | --- | +| 1 | 2 | ``` Optionally, output a formatted markdown string @@ -70,13 +73,14 @@ Render a list Separate list into markdown tables ```nu > [ {foo: 1, bar: 2} {foo: 3, bar: 4} {foo: 5}] | to md --per-element -|foo|bar| -|-|-| -|1|2| -|3|4| -|foo| -|-| -|5| +| foo | bar | +| --- | --- | +| 1 | 2 | +| 3 | 4 | + +| foo | +| --- | +| 5 | ``` Center a column of a markdown table @@ -87,3 +91,20 @@ Center a column of a markdown table | 1 | 2 | | 3 | 4 | ``` + +Escape markdown special characters +```nu +> [ {foo: "_1_", bar: "\# 2"} {foo: "[3]", bar: "4|5"}] | to md --escape-md +| foo | bar | +| --- | --- | +| \_1\_ | \# 2 | +| \[3\] | 4\|5 | +``` + +Escape html special characters +```nu +> [ {a: p, b: "

Welcome to nushell

"}] | to md --escape-html +| a | b | +| --- | --- | +| p | <p>Welcome to nushell</p> | +``` diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 8bf00e24ec9..2e24410a9b7 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 3e197952b5b..300731f3b36 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 8654f03927c..19149ccc2a2 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.107.0 +version: 0.108.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 2ee50314e9a..4247ba028ac 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 9cf12595e84..6576f1e77d8 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index d4571d414a3..8946af97144 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 19fb118c3f4..28c3604db4b 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 96d8c333ce7..2a72980770c 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.107.0 +version: 0.108.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 fc324cee79e..f1448afad56 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md index 018d028e8d7..530e6f9df44 100644 --- a/commands/docs/to_yml.md +++ b/commands/docs/to_yml.md @@ -2,7 +2,7 @@ title: to yml categories: | formats -version: 0.107.0 +version: 0.108.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 875a4c1de08..2e9bf1d75f9 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.107.0 +version: 0.108.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index 452e780b845..131bf699fee 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.107.0 +version: 0.108.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 a237e2101f7..ddd6499e05e 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.107.0 +version: 0.108.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 12c0c7ea28c..afa2a64e177 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.107.0 +version: 0.108.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index a2c0a17fda0..29da54b8f60 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index c81e9f1ace8..0067e1fbde8 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.107.0 +version: 0.108.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 0873743f335..cdc33d9cb03 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.107.0 +version: 0.108.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 6bebd798474..d5c54f01cd2 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 53d61605730..d84f6cfbd62 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.107.0 +version: 0.108.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 c0a606aa006..d52cdf598bd 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index b94d1c48b03..339598b9749 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | diff --git a/commands/docs/url.md b/commands/docs/url.md index 19ac87bb46f..44f39ab4308 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.107.0 +version: 0.108.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 bdec77117eb..e4bc1793a4b 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.107.0 +version: 0.108.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 48eb6cffea1..23a3b13510d 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.107.0 +version: 0.108.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 a1fecfc506c..47015f51a5d 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.107.0 +version: 0.108.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 d1a712be430..8e4cd92b7d8 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.107.0 +version: 0.108.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index fc6ce957d60..06d770bb9f4 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.107.0 +version: 0.108.0 network: | Parses a url. usage: | diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index 85088f9ca2e..40d5dd86410 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.107.0 +version: 0.108.0 network: | Converts query string into table applying percent-decoding. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 6b50f9ffb20..136356ac7fa 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.107.0 +version: 0.108.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 c3d5a8c76e1..818177297c0 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.107.0 +version: 0.108.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 173645f211f..49baa960134 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.107.0 +version: 0.108.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 1e2ef757c3d..ca22159b6e2 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.107.0 +version: 0.108.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 98debe42e85..b5ff7782f72 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index f87ffbad7cb..514e1b2f81d 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.107.0 +version: 0.108.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 84e37e1b3a9..f63df83ab26 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.107.0 +version: 0.108.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 865212bc759..902bf53e4e9 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.107.0 +version: 0.108.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 c961c8ba297..e8610bff133 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.107.0 +version: 0.108.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 fc43436af14..fb867f0f95d 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.107.0 +version: 0.108.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index 8475a7448aa..4f74fb7213c 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.107.0 +version: 0.108.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 10ddbc3b7b9..40c45c986eb 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Filter values of an input list based on a condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 4bf52d68ca5..97ba9dfa680 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,11 +2,11 @@ title: which categories: | system -version: 0.107.0 +version: 0.108.0 system: | - Finds a program file, alias or custom command. + Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned. usage: | - Finds a program file, alias or custom command. + Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `which` for [system](/commands/categories/system.md) -
Finds a program file, alias or custom command.
+
Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned.
## Signature @@ -41,3 +41,9 @@ Find if the 'myapp' application is available > which myapp ``` + +Find all executables across all paths without deduplication +```nu +> which -a + +``` diff --git a/commands/docs/while.md b/commands/docs/while.md index 9e86e1c17ca..1a5144adefb 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.107.0 +version: 0.108.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 47b04a8bce8..29a5344a07e 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.107.0 +version: 0.108.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 6bce3cf760f..372ce68bcf8 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.107.0 +version: 0.108.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 1f07a68caef..238120bdac2 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.107.0 +version: 0.108.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index eff1ae16073..cdbc9adfc3e 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 22bd5db55b5..f49c4b0a5d1 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.107.0 +version: 0.108.0 filters: | Combine a stream with the input. usage: |