diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 889bad61329..8ec58438f5d 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -25,6 +25,7 @@ export const commandCategories = [ '/commands/categories/network.md', '/commands/categories/path.md', '/commands/categories/platform.md', + '/commands/categories/plugin.md', '/commands/categories/prompt.md', '/commands/categories/random.md', '/commands/categories/removed.md', diff --git a/commands/categories/plugin.md b/commands/categories/plugin.md new file mode 100644 index 00000000000..65bace283d1 --- /dev/null +++ b/commands/categories/plugin.md @@ -0,0 +1,26 @@ +# Plugin + + + + + + + + + + + + +
CommandDescription
{{ command.title }}{{ command.frontmatter.usage }}
diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 610b141af4e..873be30f945 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.92.0 +version: 0.92.3 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 c5a11cd6e1f..a48f940fed4 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.92.0 +version: 0.92.3 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 92b8a882575..48b0eb8457d 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.92.0 +version: 0.92.3 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 bc594c1f49c..00fb806a697 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.92.0 +version: 0.92.3 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 65c1868c249..b26a0fa75b5 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.92.0 +version: 0.92.3 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 79fab015a21..abb70c79f71 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 24c1fd767f1..331c7ffcd55 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.92.0 +version: 0.92.3 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 bae3ab8b984..1ba331d110d 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index d203722be8d..f01d5f42228 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 669bc680ffa..40f2553bbcb 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.92.0 +version: 0.92.3 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index cb68463db19..c00d7e0364d 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.92.0 +version: 0.92.3 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 9e0b123eb5f..6ac8d015f75 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.92.0 +version: 0.92.3 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 2daf015664b..f814dc21a98 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.92.0 +version: 0.92.3 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 81ff41372b1..f8a89a4323d 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.92.0 +version: 0.92.3 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 200de1badfd..d26c0e2453f 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.92.0 +version: 0.92.3 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 c3d584f002a..56e8270cd7c 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.92.0 +version: 0.92.3 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 e0c744701fe..8834ebfb4a0 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.92.0 +version: 0.92.3 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 7d62031a5f8..baac6dfc6ee 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.92.0 +version: 0.92.3 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index da695b2d365..5fb041c5780 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.92.0 +version: 0.92.3 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 176b865ffc1..d5d72dd2be9 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index 559419465ff..2408ef19468 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index e320bfb51b4..b90eb58973d 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 75c05fcb815..f660608203e 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index d4328bde9fc..6378917b73c 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.92.0 +version: 0.92.3 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 c94a437cafd..e0d1b4a36d9 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.92.0 +version: 0.92.3 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 81f74a12af1..e1142181423 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.92.0 +version: 0.92.3 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 eafdc76eb05..e3f60b208bd 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.92.0 +version: 0.92.3 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 e1109ba5886..68801c99d80 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 628e823b7dd..1c463f2cf9e 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 80e93cceb52..caa7daec151 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.92.0 +version: 0.92.3 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index 16614398eea..9edb211f683 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.92.0 +version: 0.92.3 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 13c0c6db21c..022ea8fe34d 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.92.0 +version: 0.92.3 generators: | Display a calendar. usage: | @@ -51,6 +51,6 @@ The calendar for all of 2012 This month's calendar with the week starting on monday ```nu -> cal --week-start monday +> cal --week-start mo ``` diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 973504dadab..378d574709e 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 1061b688c9b..3a99a5fed8c 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index ff947c93700..d543eb74cce 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 40ceaaab6a7..2415c772c4a 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,18 +2,18 @@ title: collect categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | - Collect the stream and pass it to a block. + Collect a stream into a value and then run a closure with the collected value as input. usage: | - Collect the stream and pass it to a block. + Collect a stream into a value and then run a closure with the collected value as input. feature: default --- # `collect` for [filters](/commands/categories/filters.md) -
Collect the stream and pass it to a block.
+
Collect a stream into a value and then run a closure with the collected value as input.
## Signature @@ -21,7 +21,7 @@ feature: default ## Flags - - `--keep-env, -`: let the block affect environment variables + - `--keep-env, -`: let the closure affect environment variables ## Parameters @@ -41,3 +41,9 @@ Use the second value in the stream > [1 2 3] | collect { |x| $x.1 } 2 ``` + +Read and write to the same file +```nu +> open file.txt | collect { save -f file.txt } + +``` diff --git a/commands/docs/columns.md b/commands/docs/columns.md index d1e5c20c579..911d9378117 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.92.0 +version: 0.92.3 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 23834a5a1c9..ace96e2d611 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,42 +2,30 @@ title: commandline categories: | core -version: 0.92.0 +version: 0.92.3 core: | - View or modify the current command line input buffer. + View the current command line input buffer. usage: | - View or modify the current command line input buffer. + View the current command line input buffer. feature: default --- # `commandline` for [core](/commands/categories/core.md) -
View or modify the current command line input buffer.
+
View the current command line input buffer.
## Signature -```> commandline {flags} (cmd)``` - -## Flags - - - `--cursor, -c`: Set or get the current cursor position - - `--cursor-end, -e`: Set the current cursor position to the end of the buffer - - `--append, -a`: appends the string to the end of the buffer - - `--insert, -i`: inserts the string into the buffer at the cursor position - - `--replace, -r`: replaces the current contents of the buffer (default) - -## Parameters - - - `cmd`: the string to perform the operation with +```> commandline {flags} ``` ## Input/output types: -| input | output | -| ------- | ------- | -| nothing | nothing | -| string | string | +| input | output | +| ------- | ------ | +| nothing | string | + ## Subcommands: diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index bc605a1f662..acc26638de1 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.92.0 +version: 0.92.3 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 d39cc474116..f55e8982b6c 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.92.0 +version: 0.92.3 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 38da9f6c57c..1c540cf47a4 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.92.0 +version: 0.92.3 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index d95f279b663..1b74fa707d8 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 0fe9010b015..6e450bd5149 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.92.0 +version: 0.92.3 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 c2747b81e9f..30a53b7a6cb 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.92.0 +version: 0.92.3 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 634c5751639..64e95e35663 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.92.0 +version: 0.92.3 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index af7fcb170f6..e58f401b636 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.92.0 +version: 0.92.3 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 2624852d340..2a24a572872 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.92.0 +version: 0.92.3 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/const.md b/commands/docs/const.md index dd23242aea0..21983dae5f1 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 1963e45d25d..a09affe363d 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.92.0 +version: 0.92.3 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 5f25f3947f6..4c26f5ae2f3 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index f94dc8d069b..a26d5ddc200 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.92.0 +version: 0.92.3 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 3ad08a44ff5..1b43e658376 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.92.0 +version: 0.92.3 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 4f16d8c3224..695b6a52e7e 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.92.0 +version: 0.92.3 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 f5c6b170c43..2a3ee136dad 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.92.0 +version: 0.92.3 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 0ff5537f626..4b43967706b 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.92.0 +version: 0.92.3 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index 286c753672c..5ef06558cd2 100644 --- a/commands/docs/date_to-record.md +++ b/commands/docs/date_to-record.md @@ -2,7 +2,7 @@ title: date to-record categories: | date -version: 0.92.0 +version: 0.92.3 date: | Convert the date into a record. usage: | diff --git a/commands/docs/date_to-table.md b/commands/docs/date_to-table.md index b73b1c33c0b..91f192bae6c 100644 --- a/commands/docs/date_to-table.md +++ b/commands/docs/date_to-table.md @@ -2,7 +2,7 @@ title: date to-table categories: | date -version: 0.92.0 +version: 0.92.3 date: | Convert the date into a structured table. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 874eca5b3db..6d576ff2a55 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.92.0 +version: 0.92.3 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 42b09a290ca..ddbcb4e697c 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index d470dfd7261..b8a44d49ef4 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 4b98c60c6b9..80c7e9b7a98 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 6db7c3ea257..948860c3954 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index ab2bb9ec5f0..f84f7aeb6dd 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.92.0 +version: 0.92.3 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index d6b9a8cfde9..789fa952ff4 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index 0c1f2a68e0e..92226090d84 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.92.0 +version: 0.92.3 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index a626c4cf20b..073facbe26a 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Sets a default row's column if missing. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index cf3b9b0c8ca..94988752c0f 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.92.0 +version: 0.92.3 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 948b2cbe192..27d1653012a 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/dfr.md b/commands/docs/dfr.md index dec08a2935b..44579e203cd 100644 --- a/commands/docs/dfr.md +++ b/commands/docs/dfr.md @@ -2,7 +2,7 @@ title: dfr categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Operate with data in a dataframe format. usage: | diff --git a/commands/docs/dfr_agg-groups.md b/commands/docs/dfr_agg-groups.md index 4a55d1d85a4..d0b8c5ceee1 100644 --- a/commands/docs/dfr_agg-groups.md +++ b/commands/docs/dfr_agg-groups.md @@ -2,7 +2,7 @@ title: dfr agg-groups categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/dfr_agg.md b/commands/docs/dfr_agg.md index 713bf2f5396..0becaf298a0 100644 --- a/commands/docs/dfr_agg.md +++ b/commands/docs/dfr_agg.md @@ -2,7 +2,7 @@ title: dfr agg categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Performs a series of aggregations from a group-by. usage: | diff --git a/commands/docs/dfr_all-false.md b/commands/docs/dfr_all-false.md index b6ef2ef0271..8493535cfee 100644 --- a/commands/docs/dfr_all-false.md +++ b/commands/docs/dfr_all-false.md @@ -2,7 +2,7 @@ title: dfr all-false categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns true if all values are false. usage: | diff --git a/commands/docs/dfr_all-true.md b/commands/docs/dfr_all-true.md index 41762c0bd25..120c4b62173 100644 --- a/commands/docs/dfr_all-true.md +++ b/commands/docs/dfr_all-true.md @@ -2,7 +2,7 @@ title: dfr all-true categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns true if all values are true. usage: | diff --git a/commands/docs/dfr_append.md b/commands/docs/dfr_append.md index d675227b0a4..16e57a5013a 100644 --- a/commands/docs/dfr_append.md +++ b/commands/docs/dfr_append.md @@ -2,7 +2,7 @@ title: dfr append categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/dfr_arg-max.md b/commands/docs/dfr_arg-max.md index a1478efab5b..62c5cb59dc6 100644 --- a/commands/docs/dfr_arg-max.md +++ b/commands/docs/dfr_arg-max.md @@ -2,7 +2,7 @@ title: dfr arg-max categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Return index for max value in series. usage: | diff --git a/commands/docs/dfr_arg-min.md b/commands/docs/dfr_arg-min.md index 124b7c760cc..d00a5715d13 100644 --- a/commands/docs/dfr_arg-min.md +++ b/commands/docs/dfr_arg-min.md @@ -2,7 +2,7 @@ title: dfr arg-min categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Return index for min value in series. usage: | diff --git a/commands/docs/dfr_arg-sort.md b/commands/docs/dfr_arg-sort.md index a4913eecc9b..f50890059cd 100644 --- a/commands/docs/dfr_arg-sort.md +++ b/commands/docs/dfr_arg-sort.md @@ -2,7 +2,7 @@ title: dfr arg-sort categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns indexes for a sorted series. usage: | diff --git a/commands/docs/dfr_arg-true.md b/commands/docs/dfr_arg-true.md index 6fd783a8d9e..6d890475a6a 100644 --- a/commands/docs/dfr_arg-true.md +++ b/commands/docs/dfr_arg-true.md @@ -2,7 +2,7 @@ title: dfr arg-true categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns indexes where values are true. usage: | diff --git a/commands/docs/dfr_arg-unique.md b/commands/docs/dfr_arg-unique.md index 146eb7edca5..940a4d7e24d 100644 --- a/commands/docs/dfr_arg-unique.md +++ b/commands/docs/dfr_arg-unique.md @@ -2,7 +2,7 @@ title: dfr arg-unique categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns indexes for unique values. usage: | diff --git a/commands/docs/dfr_arg-where.md b/commands/docs/dfr_arg-where.md index 3656484d152..0c4308cf675 100644 --- a/commands/docs/dfr_arg-where.md +++ b/commands/docs/dfr_arg-where.md @@ -2,7 +2,7 @@ title: dfr arg-where categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates an expression that returns the arguments where expression is true. usage: | diff --git a/commands/docs/dfr_as-date.md b/commands/docs/dfr_as-date.md index 2a4b48c12e0..c81beab9d5a 100644 --- a/commands/docs/dfr_as-date.md +++ b/commands/docs/dfr_as-date.md @@ -2,7 +2,7 @@ title: dfr as-date categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/dfr_as-datetime.md b/commands/docs/dfr_as-datetime.md index 2d6593db043..c6aa89121ef 100644 --- a/commands/docs/dfr_as-datetime.md +++ b/commands/docs/dfr_as-datetime.md @@ -2,7 +2,7 @@ title: dfr as-datetime categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/dfr_as.md b/commands/docs/dfr_as.md index f23fccc14e3..7acc40ade26 100644 --- a/commands/docs/dfr_as.md +++ b/commands/docs/dfr_as.md @@ -2,7 +2,7 @@ title: dfr as categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/dfr_cache.md b/commands/docs/dfr_cache.md index 60cfd2b752e..5fc74e4ecf1 100644 --- a/commands/docs/dfr_cache.md +++ b/commands/docs/dfr_cache.md @@ -2,7 +2,7 @@ title: dfr cache categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/dfr_cast.md b/commands/docs/dfr_cast.md index 58ccaba0282..645522c2362 100644 --- a/commands/docs/dfr_cast.md +++ b/commands/docs/dfr_cast.md @@ -2,7 +2,7 @@ title: dfr cast categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Cast a column to a different dtype. usage: | diff --git a/commands/docs/dfr_col.md b/commands/docs/dfr_col.md index a49747d7e1f..4ee4a681ee7 100644 --- a/commands/docs/dfr_col.md +++ b/commands/docs/dfr_col.md @@ -2,7 +2,7 @@ title: dfr col categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/dfr_collect.md b/commands/docs/dfr_collect.md index d14fea4514d..583c7e3c8ad 100644 --- a/commands/docs/dfr_collect.md +++ b/commands/docs/dfr_collect.md @@ -2,7 +2,7 @@ title: dfr collect categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/dfr_columns.md b/commands/docs/dfr_columns.md index 2e6e3683bbe..0834796e935 100644 --- a/commands/docs/dfr_columns.md +++ b/commands/docs/dfr_columns.md @@ -2,7 +2,7 @@ title: dfr columns categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/dfr_concat-str.md b/commands/docs/dfr_concat-str.md index 5d80a6fbb9d..7df9af3c06e 100644 --- a/commands/docs/dfr_concat-str.md +++ b/commands/docs/dfr_concat-str.md @@ -2,7 +2,7 @@ title: dfr concat-str categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/dfr_concatenate.md b/commands/docs/dfr_concatenate.md index 51956487c3c..551f53677a6 100644 --- a/commands/docs/dfr_concatenate.md +++ b/commands/docs/dfr_concatenate.md @@ -2,7 +2,7 @@ title: dfr concatenate categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Concatenates strings with other array. usage: | diff --git a/commands/docs/dfr_contains.md b/commands/docs/dfr_contains.md index 80ee37580ac..baf8af35db6 100644 --- a/commands/docs/dfr_contains.md +++ b/commands/docs/dfr_contains.md @@ -2,7 +2,7 @@ title: dfr contains categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/dfr_count-null.md b/commands/docs/dfr_count-null.md index 5a0192dc8a2..89e1d505aba 100644 --- a/commands/docs/dfr_count-null.md +++ b/commands/docs/dfr_count-null.md @@ -2,7 +2,7 @@ title: dfr count-null categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Counts null values. usage: | diff --git a/commands/docs/dfr_count.md b/commands/docs/dfr_count.md index 00a30ec9623..092156c1e17 100644 --- a/commands/docs/dfr_count.md +++ b/commands/docs/dfr_count.md @@ -2,7 +2,7 @@ title: dfr count categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a count expression. usage: | diff --git a/commands/docs/dfr_cumulative.md b/commands/docs/dfr_cumulative.md index ee0dd441d56..b0ae5865686 100644 --- a/commands/docs/dfr_cumulative.md +++ b/commands/docs/dfr_cumulative.md @@ -2,7 +2,7 @@ title: dfr cumulative categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Cumulative calculation for a series. usage: | diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md index e95aed547c4..da3a08034e1 100644 --- a/commands/docs/dfr_datepart.md +++ b/commands/docs/dfr_datepart.md @@ -2,7 +2,7 @@ title: dfr datepart categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates an expression for capturing the specified datepart in a column. usage: | diff --git a/commands/docs/dfr_drop-duplicates.md b/commands/docs/dfr_drop-duplicates.md index 1aca9a2f454..b570bf3a88d 100644 --- a/commands/docs/dfr_drop-duplicates.md +++ b/commands/docs/dfr_drop-duplicates.md @@ -2,7 +2,7 @@ title: dfr drop-duplicates categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Drops duplicate values in dataframe. usage: | diff --git a/commands/docs/dfr_drop-nulls.md b/commands/docs/dfr_drop-nulls.md index afbda181a48..1c43c2710ab 100644 --- a/commands/docs/dfr_drop-nulls.md +++ b/commands/docs/dfr_drop-nulls.md @@ -2,7 +2,7 @@ title: dfr drop-nulls categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/dfr_drop.md b/commands/docs/dfr_drop.md index 7789ecae762..6906ed1c2d5 100644 --- a/commands/docs/dfr_drop.md +++ b/commands/docs/dfr_drop.md @@ -2,7 +2,7 @@ title: dfr drop categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | diff --git a/commands/docs/dfr_dtypes.md b/commands/docs/dfr_dtypes.md index 9bf6da6c444..89512f6f08a 100644 --- a/commands/docs/dfr_dtypes.md +++ b/commands/docs/dfr_dtypes.md @@ -2,7 +2,7 @@ title: dfr dtypes categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Show dataframe data types. usage: | diff --git a/commands/docs/dfr_dummies.md b/commands/docs/dfr_dummies.md index 75c63ea9fa2..d97920725fd 100644 --- a/commands/docs/dfr_dummies.md +++ b/commands/docs/dfr_dummies.md @@ -2,7 +2,7 @@ title: dfr dummies categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/dfr_explode.md b/commands/docs/dfr_explode.md index 7a2c5fadfc7..9c3af6c0b57 100644 --- a/commands/docs/dfr_explode.md +++ b/commands/docs/dfr_explode.md @@ -2,7 +2,7 @@ title: dfr explode categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/dfr_expr-not.md b/commands/docs/dfr_expr-not.md index e869eb609e6..694c76646b7 100644 --- a/commands/docs/dfr_expr-not.md +++ b/commands/docs/dfr_expr-not.md @@ -2,7 +2,7 @@ title: dfr expr-not categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a not expression. usage: | diff --git a/commands/docs/dfr_fetch.md b/commands/docs/dfr_fetch.md index 4ea30cf045b..10845152e27 100644 --- a/commands/docs/dfr_fetch.md +++ b/commands/docs/dfr_fetch.md @@ -2,7 +2,7 @@ title: dfr fetch categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Collects the lazyframe to the selected rows. usage: | diff --git a/commands/docs/dfr_fill-nan.md b/commands/docs/dfr_fill-nan.md index 726cc1d1f9a..785be82ddf3 100644 --- a/commands/docs/dfr_fill-nan.md +++ b/commands/docs/dfr_fill-nan.md @@ -2,7 +2,7 @@ title: dfr fill-nan categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Replaces NaN values with the given expression. usage: | diff --git a/commands/docs/dfr_fill-null.md b/commands/docs/dfr_fill-null.md index 0bbd5bac873..df37b406c14 100644 --- a/commands/docs/dfr_fill-null.md +++ b/commands/docs/dfr_fill-null.md @@ -2,7 +2,7 @@ title: dfr fill-null categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Replaces NULL values with the given expression. usage: | diff --git a/commands/docs/dfr_filter-with.md b/commands/docs/dfr_filter-with.md index 376e346895c..19d2b6d5c1e 100644 --- a/commands/docs/dfr_filter-with.md +++ b/commands/docs/dfr_filter-with.md @@ -2,7 +2,7 @@ title: dfr filter-with categories: | dataframe or lazyframe -version: 0.92.0 +version: 0.92.3 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | diff --git a/commands/docs/dfr_filter.md b/commands/docs/dfr_filter.md index 1771f21e04f..40c204edf73 100644 --- a/commands/docs/dfr_filter.md +++ b/commands/docs/dfr_filter.md @@ -2,7 +2,7 @@ title: dfr filter categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/dfr_first.md b/commands/docs/dfr_first.md index 8a32cee5ff8..47904055665 100644 --- a/commands/docs/dfr_first.md +++ b/commands/docs/dfr_first.md @@ -2,7 +2,7 @@ title: dfr first categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Show only the first number of rows or create a first expression usage: | diff --git a/commands/docs/dfr_flatten.md b/commands/docs/dfr_flatten.md index 749bcb23ded..086b5e2be1d 100644 --- a/commands/docs/dfr_flatten.md +++ b/commands/docs/dfr_flatten.md @@ -2,7 +2,7 @@ title: dfr flatten categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | An alias for dfr explode. usage: | diff --git a/commands/docs/dfr_get-day.md b/commands/docs/dfr_get-day.md index d42a70ca0b2..a36306f03e4 100644 --- a/commands/docs/dfr_get-day.md +++ b/commands/docs/dfr_get-day.md @@ -2,7 +2,7 @@ title: dfr get-day categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/dfr_get-hour.md b/commands/docs/dfr_get-hour.md index 5aff596a6f9..f7ebbc230f0 100644 --- a/commands/docs/dfr_get-hour.md +++ b/commands/docs/dfr_get-hour.md @@ -2,7 +2,7 @@ title: dfr get-hour categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets hour from date. usage: | diff --git a/commands/docs/dfr_get-minute.md b/commands/docs/dfr_get-minute.md index 51fec609242..95e6a7ea9b9 100644 --- a/commands/docs/dfr_get-minute.md +++ b/commands/docs/dfr_get-minute.md @@ -2,7 +2,7 @@ title: dfr get-minute categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/dfr_get-month.md b/commands/docs/dfr_get-month.md index 04a28218bd7..f12694da88b 100644 --- a/commands/docs/dfr_get-month.md +++ b/commands/docs/dfr_get-month.md @@ -2,7 +2,7 @@ title: dfr get-month categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/dfr_get-nanosecond.md b/commands/docs/dfr_get-nanosecond.md index edd4ca9c265..4237f42c785 100644 --- a/commands/docs/dfr_get-nanosecond.md +++ b/commands/docs/dfr_get-nanosecond.md @@ -2,7 +2,7 @@ title: dfr get-nanosecond categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/dfr_get-ordinal.md b/commands/docs/dfr_get-ordinal.md index 72ce9d5620c..bb254773456 100644 --- a/commands/docs/dfr_get-ordinal.md +++ b/commands/docs/dfr_get-ordinal.md @@ -2,7 +2,7 @@ title: dfr get-ordinal categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/dfr_get-second.md b/commands/docs/dfr_get-second.md index 5acf1d8710a..55c633e7245 100644 --- a/commands/docs/dfr_get-second.md +++ b/commands/docs/dfr_get-second.md @@ -2,7 +2,7 @@ title: dfr get-second categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/dfr_get-week.md b/commands/docs/dfr_get-week.md index c132c4efac5..a40144817a8 100644 --- a/commands/docs/dfr_get-week.md +++ b/commands/docs/dfr_get-week.md @@ -2,7 +2,7 @@ title: dfr get-week categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/dfr_get-weekday.md b/commands/docs/dfr_get-weekday.md index 3d6586cf7e3..87f1e88d081 100644 --- a/commands/docs/dfr_get-weekday.md +++ b/commands/docs/dfr_get-weekday.md @@ -2,7 +2,7 @@ title: dfr get-weekday categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/dfr_get-year.md b/commands/docs/dfr_get-year.md index 3d7f0edfe5d..9bf83cfd028 100644 --- a/commands/docs/dfr_get-year.md +++ b/commands/docs/dfr_get-year.md @@ -2,7 +2,7 @@ title: dfr get-year categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/dfr_get.md b/commands/docs/dfr_get.md index 542238d43c8..421ea41adc4 100644 --- a/commands/docs/dfr_get.md +++ b/commands/docs/dfr_get.md @@ -2,7 +2,7 @@ title: dfr get categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates dataframe with the selected columns. usage: | diff --git a/commands/docs/dfr_group-by.md b/commands/docs/dfr_group-by.md index fc5b6de9e4d..e5192a86aac 100644 --- a/commands/docs/dfr_group-by.md +++ b/commands/docs/dfr_group-by.md @@ -2,7 +2,7 @@ title: dfr group-by categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/dfr_implode.md b/commands/docs/dfr_implode.md index 4e56b78fe39..a9b32e48c33 100644 --- a/commands/docs/dfr_implode.md +++ b/commands/docs/dfr_implode.md @@ -2,7 +2,7 @@ title: dfr implode categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Aggregates a group to a Series. usage: | diff --git a/commands/docs/dfr_into-df.md b/commands/docs/dfr_into-df.md index daf33616b83..cd935a99aba 100644 --- a/commands/docs/dfr_into-df.md +++ b/commands/docs/dfr_into-df.md @@ -2,7 +2,7 @@ title: dfr into-df categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/dfr_into-lazy.md b/commands/docs/dfr_into-lazy.md index 80c698b90d2..081d17cb30c 100644 --- a/commands/docs/dfr_into-lazy.md +++ b/commands/docs/dfr_into-lazy.md @@ -2,7 +2,7 @@ title: dfr into-lazy categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | diff --git a/commands/docs/dfr_into-nu.md b/commands/docs/dfr_into-nu.md index b2e1e5e9b2f..c93c9a5640c 100644 --- a/commands/docs/dfr_into-nu.md +++ b/commands/docs/dfr_into-nu.md @@ -2,7 +2,7 @@ title: dfr into-nu categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Converts a dataframe or an expression into into nushell value for access and exploration. usage: | diff --git a/commands/docs/dfr_is-duplicated.md b/commands/docs/dfr_is-duplicated.md index 1e4490f542b..6132fbc2ce9 100644 --- a/commands/docs/dfr_is-duplicated.md +++ b/commands/docs/dfr_is-duplicated.md @@ -2,7 +2,7 @@ title: dfr is-duplicated categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates mask indicating duplicated values. usage: | diff --git a/commands/docs/dfr_is-in.md b/commands/docs/dfr_is-in.md index 897f0d0ea9d..9088f916f76 100644 --- a/commands/docs/dfr_is-in.md +++ b/commands/docs/dfr_is-in.md @@ -2,7 +2,7 @@ title: dfr is-in categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates an is-in expression. usage: | diff --git a/commands/docs/dfr_is-not-null.md b/commands/docs/dfr_is-not-null.md index cafdeaaaba1..169e744ba76 100644 --- a/commands/docs/dfr_is-not-null.md +++ b/commands/docs/dfr_is-not-null.md @@ -2,7 +2,7 @@ title: dfr is-not-null categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates mask where value is not null. usage: | diff --git a/commands/docs/dfr_is-null.md b/commands/docs/dfr_is-null.md index cf29d8d3317..5b32089f654 100644 --- a/commands/docs/dfr_is-null.md +++ b/commands/docs/dfr_is-null.md @@ -2,7 +2,7 @@ title: dfr is-null categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates mask where value is null. usage: | diff --git a/commands/docs/dfr_is-unique.md b/commands/docs/dfr_is-unique.md index 4ea062036e7..6d78de5804d 100644 --- a/commands/docs/dfr_is-unique.md +++ b/commands/docs/dfr_is-unique.md @@ -2,7 +2,7 @@ title: dfr is-unique categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/dfr_join.md b/commands/docs/dfr_join.md index c9d223db4e1..12945cb8bce 100644 --- a/commands/docs/dfr_join.md +++ b/commands/docs/dfr_join.md @@ -2,7 +2,7 @@ title: dfr join categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Joins a lazy frame with other lazy frame. usage: | diff --git a/commands/docs/dfr_last.md b/commands/docs/dfr_last.md index c9fd3983ba8..13217975ed2 100644 --- a/commands/docs/dfr_last.md +++ b/commands/docs/dfr_last.md @@ -2,7 +2,7 @@ title: dfr last categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/dfr_lit.md b/commands/docs/dfr_lit.md index 76e32f3ee5d..816bd86999e 100644 --- a/commands/docs/dfr_lit.md +++ b/commands/docs/dfr_lit.md @@ -2,7 +2,7 @@ title: dfr lit categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/dfr_lowercase.md b/commands/docs/dfr_lowercase.md index 9a3ac289263..69e244cf20a 100644 --- a/commands/docs/dfr_lowercase.md +++ b/commands/docs/dfr_lowercase.md @@ -2,7 +2,7 @@ title: dfr lowercase categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/dfr_ls.md b/commands/docs/dfr_ls.md index 4bcb37bcdea..0a02a62c04c 100644 --- a/commands/docs/dfr_ls.md +++ b/commands/docs/dfr_ls.md @@ -2,7 +2,7 @@ title: dfr ls categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Lists stored dataframes. usage: | diff --git a/commands/docs/dfr_max.md b/commands/docs/dfr_max.md index 3308ab125ac..4644d5108e8 100644 --- a/commands/docs/dfr_max.md +++ b/commands/docs/dfr_max.md @@ -2,7 +2,7 @@ title: dfr max categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a max expression or aggregates columns to their max value. usage: | diff --git a/commands/docs/dfr_mean.md b/commands/docs/dfr_mean.md index ab4f3fdae13..1a648361a50 100644 --- a/commands/docs/dfr_mean.md +++ b/commands/docs/dfr_mean.md @@ -2,7 +2,7 @@ title: dfr mean categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | diff --git a/commands/docs/dfr_median.md b/commands/docs/dfr_median.md index c40a4260b1b..320b933b9ae 100644 --- a/commands/docs/dfr_median.md +++ b/commands/docs/dfr_median.md @@ -2,7 +2,7 @@ title: dfr median categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Aggregates columns to their median value usage: | diff --git a/commands/docs/dfr_melt.md b/commands/docs/dfr_melt.md index ec8aa5f2211..c4906ce4d31 100644 --- a/commands/docs/dfr_melt.md +++ b/commands/docs/dfr_melt.md @@ -2,7 +2,7 @@ title: dfr melt categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Unpivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/dfr_min.md b/commands/docs/dfr_min.md index a8fddfbe5d2..e9c27041e80 100644 --- a/commands/docs/dfr_min.md +++ b/commands/docs/dfr_min.md @@ -2,7 +2,7 @@ title: dfr min categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a min expression or aggregates columns to their min value. usage: | diff --git a/commands/docs/dfr_n-unique.md b/commands/docs/dfr_n-unique.md index 852cf33c61d..ce0de638f4f 100644 --- a/commands/docs/dfr_n-unique.md +++ b/commands/docs/dfr_n-unique.md @@ -2,7 +2,7 @@ title: dfr n-unique categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/dfr_not.md b/commands/docs/dfr_not.md index 4e858509cb5..cb338e62820 100644 --- a/commands/docs/dfr_not.md +++ b/commands/docs/dfr_not.md @@ -2,7 +2,7 @@ title: dfr not categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/dfr_open.md b/commands/docs/dfr_open.md index 1045b071746..54766acbe63 100644 --- a/commands/docs/dfr_open.md +++ b/commands/docs/dfr_open.md @@ -2,7 +2,7 @@ title: dfr open categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. usage: | diff --git a/commands/docs/dfr_otherwise.md b/commands/docs/dfr_otherwise.md index 40a4d80ddc3..58878deb29a 100644 --- a/commands/docs/dfr_otherwise.md +++ b/commands/docs/dfr_otherwise.md @@ -2,7 +2,7 @@ title: dfr otherwise categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Completes a when expression. usage: | diff --git a/commands/docs/dfr_quantile.md b/commands/docs/dfr_quantile.md index 61ac07f1a74..7dc51b228c0 100644 --- a/commands/docs/dfr_quantile.md +++ b/commands/docs/dfr_quantile.md @@ -2,7 +2,7 @@ title: dfr quantile categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Aggregates the columns to the selected quantile. usage: | diff --git a/commands/docs/dfr_query.md b/commands/docs/dfr_query.md index 0495af52e63..017a25489fd 100644 --- a/commands/docs/dfr_query.md +++ b/commands/docs/dfr_query.md @@ -2,7 +2,7 @@ title: dfr query categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | diff --git a/commands/docs/dfr_rename.md b/commands/docs/dfr_rename.md index a64674f49c5..58177d065cd 100644 --- a/commands/docs/dfr_rename.md +++ b/commands/docs/dfr_rename.md @@ -2,7 +2,7 @@ title: dfr rename categories: | dataframe or lazyframe -version: 0.92.0 +version: 0.92.3 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/dfr_replace-all.md b/commands/docs/dfr_replace-all.md index cb3244fb3be..4203ac2535a 100644 --- a/commands/docs/dfr_replace-all.md +++ b/commands/docs/dfr_replace-all.md @@ -2,7 +2,7 @@ title: dfr replace-all categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/dfr_replace.md b/commands/docs/dfr_replace.md index dba261d59de..b8a1db2eb7e 100644 --- a/commands/docs/dfr_replace.md +++ b/commands/docs/dfr_replace.md @@ -2,7 +2,7 @@ title: dfr replace categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/dfr_reverse.md b/commands/docs/dfr_reverse.md index 629ec8fdecd..f7d6d837cb9 100644 --- a/commands/docs/dfr_reverse.md +++ b/commands/docs/dfr_reverse.md @@ -2,7 +2,7 @@ title: dfr reverse categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/dfr_rolling.md b/commands/docs/dfr_rolling.md index 87afccfcc18..e2a46fa91d5 100644 --- a/commands/docs/dfr_rolling.md +++ b/commands/docs/dfr_rolling.md @@ -2,7 +2,7 @@ title: dfr rolling categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/dfr_sample.md b/commands/docs/dfr_sample.md index 0ae2c967009..09f6a46484b 100644 --- a/commands/docs/dfr_sample.md +++ b/commands/docs/dfr_sample.md @@ -2,7 +2,7 @@ title: dfr sample categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/dfr_schema.md b/commands/docs/dfr_schema.md index 307f99f05c7..da1650553c6 100644 --- a/commands/docs/dfr_schema.md +++ b/commands/docs/dfr_schema.md @@ -2,7 +2,7 @@ title: dfr schema categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/dfr_select.md b/commands/docs/dfr_select.md index a50fdfbffbe..46e1eb48287 100644 --- a/commands/docs/dfr_select.md +++ b/commands/docs/dfr_select.md @@ -2,7 +2,7 @@ title: dfr select categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/dfr_set-with-idx.md b/commands/docs/dfr_set-with-idx.md index 62574d8c95e..903407a4374 100644 --- a/commands/docs/dfr_set-with-idx.md +++ b/commands/docs/dfr_set-with-idx.md @@ -2,7 +2,7 @@ title: dfr set-with-idx categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/dfr_set.md b/commands/docs/dfr_set.md index 6a3dc9c03b6..7595231108e 100644 --- a/commands/docs/dfr_set.md +++ b/commands/docs/dfr_set.md @@ -2,7 +2,7 @@ title: dfr set categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Sets value where given mask is true. usage: | diff --git a/commands/docs/dfr_shape.md b/commands/docs/dfr_shape.md index dd84670c177..81c15f0f96f 100644 --- a/commands/docs/dfr_shape.md +++ b/commands/docs/dfr_shape.md @@ -2,7 +2,7 @@ title: dfr shape categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Shows column and row size for a dataframe. usage: | diff --git a/commands/docs/dfr_shift.md b/commands/docs/dfr_shift.md index d57ba2f59b2..b504f8d9d93 100644 --- a/commands/docs/dfr_shift.md +++ b/commands/docs/dfr_shift.md @@ -2,7 +2,7 @@ title: dfr shift categories: | dataframe or lazyframe -version: 0.92.0 +version: 0.92.3 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | diff --git a/commands/docs/dfr_slice.md b/commands/docs/dfr_slice.md index 5b81dcc8276..51a6bf83ecd 100644 --- a/commands/docs/dfr_slice.md +++ b/commands/docs/dfr_slice.md @@ -2,7 +2,7 @@ title: dfr slice categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates new dataframe from a slice of rows. usage: | diff --git a/commands/docs/dfr_sort-by.md b/commands/docs/dfr_sort-by.md index c3f6fe5b4a1..58df7d32fd4 100644 --- a/commands/docs/dfr_sort-by.md +++ b/commands/docs/dfr_sort-by.md @@ -2,7 +2,7 @@ title: dfr sort-by categories: | lazyframe -version: 0.92.0 +version: 0.92.3 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | diff --git a/commands/docs/dfr_std.md b/commands/docs/dfr_std.md index bc4c5a3ecb0..77f60df5d0a 100644 --- a/commands/docs/dfr_std.md +++ b/commands/docs/dfr_std.md @@ -2,7 +2,7 @@ title: dfr std categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | diff --git a/commands/docs/dfr_str-lengths.md b/commands/docs/dfr_str-lengths.md index cfcbac76220..452cc235d18 100644 --- a/commands/docs/dfr_str-lengths.md +++ b/commands/docs/dfr_str-lengths.md @@ -2,7 +2,7 @@ title: dfr str-lengths categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/dfr_str-slice.md b/commands/docs/dfr_str-slice.md index 534a222b4f5..b20c8cc5395 100644 --- a/commands/docs/dfr_str-slice.md +++ b/commands/docs/dfr_str-slice.md @@ -2,7 +2,7 @@ title: dfr str-slice categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Slices the string from the start position until the selected length. usage: | diff --git a/commands/docs/dfr_strftime.md b/commands/docs/dfr_strftime.md index 44ebd444860..a1fb2fb7b72 100644 --- a/commands/docs/dfr_strftime.md +++ b/commands/docs/dfr_strftime.md @@ -2,7 +2,7 @@ title: dfr strftime categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/dfr_sum.md b/commands/docs/dfr_sum.md index 21ce0a0b7ff..562b9e47758 100644 --- a/commands/docs/dfr_sum.md +++ b/commands/docs/dfr_sum.md @@ -2,7 +2,7 @@ title: dfr sum categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | diff --git a/commands/docs/dfr_summary.md b/commands/docs/dfr_summary.md index f9be747f372..f5b6bdd7050 100644 --- a/commands/docs/dfr_summary.md +++ b/commands/docs/dfr_summary.md @@ -2,7 +2,7 @@ title: dfr summary categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | diff --git a/commands/docs/dfr_take.md b/commands/docs/dfr_take.md index 884901e1bc2..310fc2b568b 100644 --- a/commands/docs/dfr_take.md +++ b/commands/docs/dfr_take.md @@ -2,7 +2,7 @@ title: dfr take categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/dfr_to-arrow.md b/commands/docs/dfr_to-arrow.md index 4839ba6caf3..038b21a92e2 100644 --- a/commands/docs/dfr_to-arrow.md +++ b/commands/docs/dfr_to-arrow.md @@ -2,7 +2,7 @@ title: dfr to-arrow categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Saves dataframe to arrow file. usage: | diff --git a/commands/docs/dfr_to-avro.md b/commands/docs/dfr_to-avro.md index 5578c5ad91b..be71520515e 100644 --- a/commands/docs/dfr_to-avro.md +++ b/commands/docs/dfr_to-avro.md @@ -2,7 +2,7 @@ title: dfr to-avro categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Saves dataframe to avro file. usage: | diff --git a/commands/docs/dfr_to-csv.md b/commands/docs/dfr_to-csv.md index 0a948a6ea81..3ea5c06f9f6 100644 --- a/commands/docs/dfr_to-csv.md +++ b/commands/docs/dfr_to-csv.md @@ -2,7 +2,7 @@ title: dfr to-csv categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Saves dataframe to CSV file. usage: | diff --git a/commands/docs/dfr_to-jsonl.md b/commands/docs/dfr_to-jsonl.md index a61d9b480dc..521cce14de3 100644 --- a/commands/docs/dfr_to-jsonl.md +++ b/commands/docs/dfr_to-jsonl.md @@ -2,7 +2,7 @@ title: dfr to-jsonl categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Saves dataframe to a JSON lines file. usage: | diff --git a/commands/docs/dfr_to-parquet.md b/commands/docs/dfr_to-parquet.md index e84748e6695..08d3781c39e 100644 --- a/commands/docs/dfr_to-parquet.md +++ b/commands/docs/dfr_to-parquet.md @@ -2,7 +2,7 @@ title: dfr to-parquet categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Saves dataframe to parquet file. usage: | diff --git a/commands/docs/dfr_unique.md b/commands/docs/dfr_unique.md index c180b1b4c7e..0f1315c6f0c 100644 --- a/commands/docs/dfr_unique.md +++ b/commands/docs/dfr_unique.md @@ -2,7 +2,7 @@ title: dfr unique categories: | dataframe or lazyframe -version: 0.92.0 +version: 0.92.3 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/dfr_uppercase.md b/commands/docs/dfr_uppercase.md index a78422b5d6c..6a98c9e86d0 100644 --- a/commands/docs/dfr_uppercase.md +++ b/commands/docs/dfr_uppercase.md @@ -2,7 +2,7 @@ title: dfr uppercase categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Uppercase the strings in the column. usage: | diff --git a/commands/docs/dfr_value-counts.md b/commands/docs/dfr_value-counts.md index ee135f4d993..d80b3eacf36 100644 --- a/commands/docs/dfr_value-counts.md +++ b/commands/docs/dfr_value-counts.md @@ -2,7 +2,7 @@ title: dfr value-counts categories: | dataframe -version: 0.92.0 +version: 0.92.3 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | diff --git a/commands/docs/dfr_var.md b/commands/docs/dfr_var.md index c07f82a2f92..d5a5a308df9 100644 --- a/commands/docs/dfr_var.md +++ b/commands/docs/dfr_var.md @@ -2,7 +2,7 @@ title: dfr var categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Create a var expression for an aggregation. usage: | diff --git a/commands/docs/dfr_when.md b/commands/docs/dfr_when.md index 36f9f21bf73..1ef46e6bcb7 100644 --- a/commands/docs/dfr_when.md +++ b/commands/docs/dfr_when.md @@ -2,7 +2,7 @@ title: dfr when categories: | expression -version: 0.92.0 +version: 0.92.3 expression: | Creates and modifies a when expression. usage: | diff --git a/commands/docs/dfr_with-column.md b/commands/docs/dfr_with-column.md index 1e48bc1e716..890dbe28d7f 100644 --- a/commands/docs/dfr_with-column.md +++ b/commands/docs/dfr_with-column.md @@ -2,7 +2,7 @@ title: dfr with-column categories: | dataframe or lazyframe -version: 0.92.0 +version: 0.92.3 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index 8f043073fd4..aed04491b99 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.92.0 +version: 0.92.3 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 0e6e35b6214..642ec74c095 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.92.0 +version: 0.92.3 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 83d998fcf11..9613b0326e9 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.92.0 +version: 0.92.3 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 20249965e5b..1123b96f0ca 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 56677f4903f..0b55b81cd93 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Find disk usage sizes of specified items. usage: | @@ -17,7 +17,7 @@ feature: default ## Signature -```> du {flags} (path)``` +```> du {flags} ...rest``` ## Flags @@ -29,7 +29,7 @@ feature: default ## Parameters - - `path`: Starting directory. + - `...rest`: Starting directory. ## Input/output types: diff --git a/commands/docs/each.md b/commands/docs/each.md index 51e9676daf8..1b55d73c6f8 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index f2369b06e37..51c25ceb41d 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Run a block 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 2be145cd15a..d1a2b8efb54 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.92.0 +version: 0.92.3 core: | Returns its arguments, ignoring the piped-in value. usage: | @@ -50,6 +50,8 @@ Returns the piped-in value, by using the special $in variable to obtain it. ``` ## Notes -When given no arguments, it returns an empty string. When given one argument, -it returns it. Otherwise, it returns a list of the arguments. There is usually +Unlike `print`, which prints unstructured text to stdout, `echo` is like an +identity function and simply returns its arguments. When given no arguments, +it returns an empty string. When given one argument, it returns it as a +nushell value. Otherwise, it returns a list of the arguments. There is usually little reason to use this over just writing the values as-is. \ No newline at end of file diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 738044d6939..5a80d36cb1e 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Encode a string into bytes. usage: | @@ -59,6 +59,7 @@ Multiple encodings are supported; here are a few: big5, euc-jp, euc-kr, gbk, iso-8859-1, cp1252, latin5 Note that since the Encoding Standard doesn't specify encoders for utf-16le and utf-16be, these are not yet supported. +More information can be found here: https://docs.rs/encoding_rs/latest/encoding_rs/#utf-16le-utf-16be-and-unicode-encoding-schemes For a more complete list of encodings, please refer to the encoding_rs documentation link at https://docs.rs/encoding_rs/latest/encoding_rs/#statics diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 90aeea5cbff..d0889d0260a 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.92.0 +version: 0.92.3 hash: | Encode a string or binary value using Base64. usage: | diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 8c8604ff9ba..6282b3983c1 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Encode a binary value using hex. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 70379c3adee..6eeb8c583cd 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 86985fa10fc..0c08bedb3f0 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index b9b02012cf1..ef0bc3834c7 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.92.0 +version: 0.92.3 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 5353c5a26ee..28895660be6 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.92.0 +version: 0.92.3 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 e36b4034a49..c1664a4f422 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.92.0 +version: 0.92.3 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index c2f7b5cba0f..9d9952745b7 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 5f6ca1e03d4..4a2df54642e 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.92.0 +version: 0.92.3 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 6c87c3a74cc..7ac3fde23b4 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.92.0 +version: 0.92.3 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 008a3f4b86b..497b6bb4010 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.92.0 +version: 0.92.3 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 c30e7f9fe8b..d991f534b6d 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.92.0 +version: 0.92.3 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 25944520907..6a6affa46ab 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.92.0 +version: 0.92.3 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 29358f1b728..d48dcc32a83 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.92.0 +version: 0.92.3 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 b045718a0b6..e55739dde9e 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.92.0 +version: 0.92.3 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 933b7886df1..8fffcd0e812 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.92.0 +version: 0.92.3 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 6ac2589a048..197ff20e6fc 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.92.0 +version: 0.92.3 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 9a46deec039..edcb890e3aa 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.92.0 +version: 0.92.3 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 4b736630f06..f9eaeace0ca 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index c428722a5ba..88238a46439 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 884e824d1f7..15d6f5a9f46 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index 4918a52dceb..a888a20e7f9 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.92.0 +version: 0.92.3 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 ebbda5cb933..2bb87c5c286 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index 9f47d09286c..a59bd48c334 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index c690ab96f3a..81a48279ffe 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.92.0 +version: 0.92.3 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index 66d25964362..7fed2ee905a 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 3a6831f9563..85b9d859fa1 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | date -version: 0.92.0 +version: 0.92.3 date: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 30eefad7932..457e5a84920 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.92.0 +version: 0.92.3 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 439bc2056eb..8500efdb4bd 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index a2c6c2d5217..9c823a1ea2f 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 6cc04152498..24dbdf3bba7 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse a string or binary data into structured data. usage: | @@ -31,21 +31,23 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | -| [`from eml`](/commands/docs/from_eml.md) | Builtin,Plugin | Parse text as .eml and create record. | -| [`from ics`](/commands/docs/from_ics.md) | Builtin,Plugin | Parse text as .ics and create table. | -| [`from ini`](/commands/docs/from_ini.md) | Builtin,Plugin | Parse text as .ini and create table. | -| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | -| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | -| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | -| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | -| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | -| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | -| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | -| [`from vcf`](/commands/docs/from_vcf.md) | Builtin,Plugin | Parse text as .vcf and create table. | -| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | -| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | -| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | -| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file +| name | type | usage | +| -------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------- | +| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | +| [`from eml`](/commands/docs/from_eml.md) | Builtin,Plugin | Parse text as .eml and create record. | +| [`from ics`](/commands/docs/from_ics.md) | Builtin,Plugin | Parse text as .ics and create table. | +| [`from ini`](/commands/docs/from_ini.md) | Builtin,Plugin | Parse text as .ini and create table. | +| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | +| [`from msgpack`](/commands/docs/from_msgpack.md) | Builtin | Convert MessagePack data into Nu values. | +| [`from msgpackz`](/commands/docs/from_msgpackz.md) | Builtin | Convert brotli-compressed MessagePack data into Nu values. | +| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | +| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | +| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | +| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | +| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | +| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | +| [`from vcf`](/commands/docs/from_vcf.md) | Builtin,Plugin | Parse text as .vcf and create table. | +| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | +| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | +| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | +| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index a0eaa27cde6..7b070c12d10 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index 2e9b4a36b51..2291f812187 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .eml and create record. usage: | diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index 2e702119c23..bc9c413ae03 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .ics and create table. usage: | diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 02ab16b2879..51dde31bca5 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .ini and create table. usage: | diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 2edc46ad731..433e9fa2057 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md new file mode 100644 index 00000000000..090703f9c2a --- /dev/null +++ b/commands/docs/from_msgpack.md @@ -0,0 +1,79 @@ +--- +title: from msgpack +categories: | + formats +version: 0.92.3 +formats: | + Convert MessagePack data into Nu values. +usage: | + Convert MessagePack data into Nu values. +feature: default +--- + + +# `from msgpack` for [formats](/commands/categories/formats.md) + +
Convert MessagePack data into Nu values.
+ +## Signature + +```> from msgpack {flags} ``` + +## Flags + + - `--objects, -`: Read multiple objects from input + + +## Input/output types: + +| input | output | +| ------ | ------ | +| binary | any | + +## Examples + +Read a list of values from MessagePack +```nu +> 0x[93A3666F6F2AC2] | from msgpack +╭───┬───────╮ +│ 0 │ foo │ +│ 1 │ 42 │ +│ 2 │ false │ +╰───┴───────╯ + +``` + +Read a stream of multiple values from MessagePack +```nu +> 0x[81A76E757368656C6CA5726F636B73A9736572696F75736C79] | from msgpack --objects +╭───┬─────────────────────╮ +│ 0 │ ╭─────────┬───────╮ │ +│ │ │ nushell │ rocks │ │ +│ │ ╰─────────┴───────╯ │ +│ 1 │ seriously │ +╰───┴─────────────────────╯ + +``` + +Read a table from MessagePack +```nu +> 0x[9282AA6576656E745F6E616D65B141706F6C6C6F203131204C616E64696E67A474696D65C70CFF00000000FFFFFFFFFF2CAB5B82AA6576656E745F6E616D65B44E757368656C6C20666972737420636F6D6D6974A474696D65D6FF5CD5ADE0] | from msgpack +╭───┬──────────────────────┬──────────────╮ +│ # │ event_name │ time │ +├───┼──────────────────────┼──────────────┤ +│ 0 │ Apollo 11 Landing │ 54 years ago │ +│ 1 │ Nushell first commit │ 4 years ago │ +╰───┴──────────────────────┴──────────────╯ + +``` + +## Notes + +Not all values are representable as MessagePack. + +The datetime extension type is read as dates. MessagePack binary values are +read to their Nu equivalent. Most other types are read in an analogous way to +`from json`, and may not convert to the exact same type if `to msgpack` was +used originally to create the data. + +MessagePack: https://msgpack.org/ diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md new file mode 100644 index 00000000000..1078092c7a2 --- /dev/null +++ b/commands/docs/from_msgpackz.md @@ -0,0 +1,34 @@ +--- +title: from msgpackz +categories: | + formats +version: 0.92.3 +formats: | + Convert brotli-compressed MessagePack data into Nu values. +usage: | + Convert brotli-compressed MessagePack data into Nu values. +feature: default +--- + + +# `from msgpackz` for [formats](/commands/categories/formats.md) + +
Convert brotli-compressed MessagePack data into Nu values.
+ +## Signature + +```> from msgpackz {flags} ``` + +## Flags + + - `--objects, -`: Read multiple objects from input + + +## Input/output types: + +| input | output | +| ------ | ------ | +| binary | any | + +## Notes +This is the format used by the plugin registry file ($nu.plugin-path). \ No newline at end of file diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 2eb441a8d12..2082bbec79f 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 876571c6b8e..e92acc4a694 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index c85297f866a..d2d6df4ee11 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.92.0 +version: 0.92.3 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 c7fb2f2d4f8..cb51807b647 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 00d23ec70c7..3d754558e43 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 969e3653308..7cf221ad49d 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index bf300f6ad04..c23a113934b 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .vcf and create table. usage: | diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 6b9679d754a..57b403c781e 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.92.0 +version: 0.92.3 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 9339984258f..c0632a001f7 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 3d6cfa80746..d2d74413da2 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.92.0 +version: 0.92.3 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 a10ab8ae669..33adbb08786 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index c24270ba2fc..10dad6a82a3 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.92.0 +version: 0.92.3 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 3ed5a86eba3..5a013b5b33d 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index cbbe35d46f4..2dc16fc43fa 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 48d8cd1caaf..f4e1e85d829 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.92.0 +version: 0.92.3 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 2d1dfe202a0..79dba3e1b44 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/group.md b/commands/docs/group.md index 33155fc8bcd..f1214f4d542 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index c3a35849f38..63b4b96b1ef 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.92.0 +version: 0.92.3 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index c590dd603bc..f77a861d932 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.92.0 +version: 0.92.3 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index e29e0c22f4f..ece7ad5ce2e 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.92.0 +version: 0.92.3 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 ca9b109e77b..0ffd72c510b 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.92.0 +version: 0.92.3 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index dd064814b1f..adb05f1edd9 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.92.0 +version: 0.92.3 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 9eb2c3eef35..a1a25086739 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.92.0 +version: 0.92.3 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 940b1f86fb2..4ce5055dcee 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 8a74baa03b3..237e48bb821 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 7507aa594a8..13b1f6ce3c7 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index e1c916349d8..56761411963 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 6a3707db41d..596e9db0ae7 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index e8d197e0fe2..a627a4a5477 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.92.0 +version: 0.92.3 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 30e64e29644..b12c3e17de9 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.92.0 +version: 0.92.3 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index cc0accb605b..30e0ef67124 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.92.0 +version: 0.92.3 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index 90f22f8dbaa..65a9852fa4f 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.92.0 +version: 0.92.3 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 5ab0a1b8025..a7e2c4aab54 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.92.0 +version: 0.92.3 history: | Get the command history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 52f9f377056..af04dd526f6 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.92.0 +version: 0.92.3 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index e082a6b4ab9..e1227bb0d97 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.92.0 +version: 0.92.3 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index c99a0abf535..2bef93cac55 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.92.0 +version: 0.92.3 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 05bbec7792f..ab26339383b 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.92.0 +version: 0.92.3 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 25f70dff366..ec36ee25adf 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.92.0 +version: 0.92.3 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index f6e5060ede6..e2bd61263a7 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.92.0 +version: 0.92.3 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 6f768e76495..30600bf85a5 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.92.0 +version: 0.92.3 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 160ffdf41e4..a53920ff948 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.92.0 +version: 0.92.3 network: | Post a body to a URL. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index b7d33dbcae9..0e913c6420b 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.92.0 +version: 0.92.3 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index d7a36e86547..a9d8f8c94e7 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.92.0 +version: 0.92.3 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 4a5c5f7a2f1..ef051becf2b 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.92.0 +version: 0.92.3 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 85a89c37dd9..4c7dd0d2d8e 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.92.0 +version: 0.92.3 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 ec59dc34f82..2858e78e4fb 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index 7a424ccbea5..13f33f57eb0 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 8458d07e725..43836f3642c 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 91ffd53f42d..9c8fa9dbe73 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.92.0 +version: 0.92.3 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 e37bc2e3f4d..91662cc742e 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 9653128b068..f60aedef00e 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.92.0 +version: 0.92.3 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 0b992c6b86c..8b97ed27c90 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Commands to convert data from one type to another. usage: | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index a2b02563510..2f17e223bd6 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index 96a8ca61b19..7b076dccad4 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to a binary primitive. usage: | @@ -40,7 +40,7 @@ feature: default convert a binary value into a string, padded to 8 places with 0s ```nu -> 01b | into bits +> 0x[1] | into bits 00000001 ``` diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 1115db0658e..eb43ed62150 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index de9a8cc8692..cb1aec5f794 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.92.0 +version: 0.92.3 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index aba3d2c3633..fb298c0c382 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert text or timestamp into a datetime. usage: | @@ -78,8 +78,8 @@ Convert list of timestamps to datetimes > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime ╭───┬───────────────╮ │ 0 │ a year ago │ -│ 1 │ 11 months ago │ -│ 2 │ 10 months ago │ +│ 1 │ a year ago │ +│ 2 │ 11 months ago │ ╰───┴───────────────╯ ``` diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index f252b585fdd..cc53103053a 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index e0126678cb8..74acdfc0a1d 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to filesize. usage: | @@ -76,3 +76,9 @@ Convert file size to filesize > 4KB | into filesize 3.9 KiB ``` + +Convert string with unit to filesize +```nu +> '-1KB' | into filesize +-1,000 B +``` diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 7bc48cb9e05..d08e8f67ae4 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 08748418bc0..c524287048a 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 15c0f628536..63066abfbf5 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index b5dc611b278..88cbe150e2e 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 687135d0674..78440334bb4 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 04529b08db5..6a26d0c1e3a 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.92.0 +version: 0.92.3 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index f77890663ec..ed4bfdaf127 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Infer nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index eeb9f46488d..fa09de83548 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.92.0 +version: 0.92.3 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 713cf69485d..f2b7c1a665c 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 9045925a1ee..5bd4cd06dd0 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.92.0 +version: 0.92.3 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index a98613076a6..8d75755ed72 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index 1295aafe388..0ee73ad47ac 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 1e949cec085..4cacbded8a1 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 9cddb041586..f16a3d91d6c 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index a43b365ea54..85af51af654 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index c6409ac65f2..0a944ac216e 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.92.0 +version: 0.92.3 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 998b8dff936..02ad33b5d84 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 7f7cb02e4cb..2b2b904c40e 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index fcb4e0a736f..16b0f8f72db 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/lazy_make.md b/commands/docs/lazy_make.md index 0e0a0789e34..5118f006268 100644 --- a/commands/docs/lazy_make.md +++ b/commands/docs/lazy_make.md @@ -2,7 +2,7 @@ title: lazy make categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create a lazy record. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index 35d9025c7ab..7e56555998c 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Count the number of items in an input list or rows in a table. usage: | diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 81361e66771..1054091bd8d 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.92.0 +version: 0.92.3 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 de5226f303c..2f71e0214a2 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index ccb860758fc..eb25fdd5bd0 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index a0c0f221d5c..b45010eceaa 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 79546b420e9..1e754838a6e 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.92.0 +version: 0.92.3 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 00e08583df5..daa052155c1 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | @@ -17,7 +17,7 @@ feature: default ## Signature -```> ls {flags} (pattern)``` +```> ls {flags} ...rest``` ## Flags @@ -31,7 +31,7 @@ feature: default ## Parameters - - `pattern`: The glob pattern to use. + - `...rest`: The glob pattern to use. ## Input/output types: diff --git a/commands/docs/match.md b/commands/docs/match.md index 639933e9906..eaabeab85cb 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.92.0 +version: 0.92.3 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index b37d5176e08..f1e898d8fc7 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.92.0 +version: 0.92.3 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 1e1cd3b4861..d89d3a7b775 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 6f68ad77ece..928065f9d20 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 707f667d987..4bfe15a0043 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.92.0 +version: 0.92.3 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 cc0679e2d19..39901f5ff38 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index f753cde1b56..5de5f079e2f 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.92.0 +version: 0.92.3 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 7a5f5eaa8f1..7a72cefea86 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 36fce759ec7..b468734f1d0 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.92.0 +version: 0.92.3 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 61ba289ace4..671fbc8ca23 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.92.0 +version: 0.92.3 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 fb95478628d..9e12602bee3 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.92.0 +version: 0.92.3 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 56a4970db62..5d9651df118 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 5e9683108ee..6e5c9bc2a9c 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 5e3fc3b0b83..319fbdbf895 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.92.0 +version: 0.92.3 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 12f41264d6d..6d1cac90a9f 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.92.0 +version: 0.92.3 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 3fae863fe7b..edea206fcb8 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 6c207b87c93..cc852bc3558 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 982e57473e1..f238a0164b3 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.92.0 +version: 0.92.3 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 20d0c518bc8..824e4149833 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.92.0 +version: 0.92.3 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 7cea201b563..4f1a7d35b51 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.92.0 +version: 0.92.3 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 208f8e16ee1..ce26d7df42e 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.92.0 +version: 0.92.3 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 1ef7bc51b73..92ad73ec917 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.92.0 +version: 0.92.3 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 a0178de11f4..f8eb69bd424 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.92.0 +version: 0.92.3 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 61fd6fbd9e7..98da4d0ef0d 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 62d020a6277..2eaa2a25982 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index f6d5afb4bc5..00e0645d68b 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.92.0 +version: 0.92.3 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 e745353cec5..cd5c01911a9 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.92.0 +version: 0.92.3 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 317f6486d19..de92bc37952 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.92.0 +version: 0.92.3 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 caff8601c54..6d2c9dcc546 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index bf3a9665337..71c984a6e23 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.92.0 +version: 0.92.3 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 4ede3ce86b7..377d0088852 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.92.0 +version: 0.92.3 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 a568da3f8d4..bd6b6bf73a0 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index d711e371528..03cd6a03887 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Get the metadata for items in the stream. usage: | @@ -43,3 +43,10 @@ Get the metadata of the input > ls | metadata ``` + + +## Subcommands: + +| name | type | usage | +| ------------------------------------------------ | ------- | ----------------------------------------- | +| [`metadata set`](/commands/docs/metadata_set.md) | Builtin | Set the metadata for items in the stream. | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md new file mode 100644 index 00000000000..6076e4381bf --- /dev/null +++ b/commands/docs/metadata_set.md @@ -0,0 +1,46 @@ +--- +title: metadata set +categories: | + debug +version: 0.92.3 +debug: | + Set the metadata for items in the stream. +usage: | + Set the metadata for items in the stream. +feature: default +--- + + +# `metadata set` for [debug](/commands/categories/debug.md) + +
Set the metadata for items in the stream.
+ +## Signature + +```> metadata set {flags} ``` + +## Flags + + - `--datasource-ls, -l`: Assign the DataSource::Ls metadata to the input + - `--datasource-filepath, -f {path}`: Assign the DataSource::FilePath metadata to the input + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Set the metadata of a table literal +```nu +> [[name color]; [Cargo.lock '#ff0000'] [Cargo.toml '#00ff00'] [README.md '#0000ff']] | metadata set --datasource-ls + +``` + +Set the metadata of a file path +```nu +> 'crates' | metadata set --datasource-filepath $'(pwd)/crates' | metadata + +``` diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index c92f5078060..53f6834dc5f 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 bffc44aadd6..950d895f178 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 075f330cdbd..ba329237a95 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.92.0 +version: 0.92.3 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 140796a262b..c0c3fc42738 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index e5d29f4f7d3..ba8f8f3bcf7 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index 6952a5e68ff..ed0ba8531e7 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 dcea12841fc..01cf0ec5282 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index a457d1d09eb..f90942a4686 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 138ebd81cc0..dc06cda10b1 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 d650c426268..cd0bbf96b30 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.92.0 +version: 0.92.3 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 586582a1bd6..672f6016937 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.92.0 +version: 0.92.3 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 10d4053e66c..a50d8937c12 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.92.0 +version: 0.92.3 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index d033faf4f78..9a000a2627e 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.92.0 +version: 0.92.3 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 82842186be4..0d19aa733ee 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.92.0 +version: 0.92.3 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index ad3c7216ee6..623182a76d3 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | experimental -version: 0.92.0 +version: 0.92.3 experimental: | Executes a rust panic, useful only for testing. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index b0ff72793df..914039d7498 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.92.0 +version: 0.92.3 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 d1cf02a6ae4..2fd148a2c2f 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Parse columns from string data using a simple pattern. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index 9aace873b95..18856979390 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.92.0 +version: 0.92.3 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 0f178d19781..553ddce4190 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.92.0 +version: 0.92.3 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index d7ffe7f9fc8..20a6504a1bd 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.92.0 +version: 0.92.3 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 9dfa0894de9..f43e9ebb709 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.92.0 +version: 0.92.3 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 6529ac3aad6..3e08699223d 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.92.0 +version: 0.92.3 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 f7ce65bec5f..74e2cfa480d 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.92.0 +version: 0.92.3 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 268f47508f9..fd664345d05 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.92.0 +version: 0.92.3 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 09e2f96c3e8..173988539c2 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.92.0 +version: 0.92.3 path: | Express a path as relative to another path. usage: | diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index 9df2f926df5..36a76075d5b 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.92.0 +version: 0.92.3 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 32de8046ba8..39f13e573cf 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.92.0 +version: 0.92.3 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 aec6d16fa62..f54d4cfe64a 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -1,9 +1,9 @@ --- title: plugin categories: | - core -version: 0.92.0 -core: | + plugin +version: 0.92.3 +plugin: | Commands for managing plugins. usage: | Commands for managing plugins. @@ -11,7 +11,7 @@ feature: default --- -# `plugin` for [core](/commands/categories/core.md) +# `plugin` for [plugin](/commands/categories/plugin.md)
Commands for managing plugins.
@@ -28,6 +28,20 @@ feature: default ## Examples +Run the `nu_plugin_inc` plugin from the current directory and install its signatures. +```nu +> plugin add nu_plugin_inc + +``` + +Load (or reload) the `inc` plugin from the plugin registry file and put its +commands in scope. The plugin must already be in the registry file at parse +time. +```nu +> plugin use inc + +``` + List installed plugins ```nu > plugin list @@ -40,12 +54,19 @@ Stop the plugin named `inc`. ``` -## Notes -To load a plugin, see `register`. +Remove the installed signatures for the `inc` plugin. +```nu +> plugin rm inc + +``` + ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | ------------------------------------------- | -| [`plugin list`](/commands/docs/plugin_list.md) | Builtin | List installed plugins. | -| [`plugin stop`](/commands/docs/plugin_stop.md) | Builtin | Stop an installed plugin if it was running. | \ No newline at end of file +| name | type | usage | +| ---------------------------------------------- | ------- | ------------------------------------------------------- | +| [`plugin add`](/commands/docs/plugin_add.md) | Builtin | Add a plugin to the plugin registry file. | +| [`plugin list`](/commands/docs/plugin_list.md) | Builtin | List installed plugins. | +| [`plugin rm`](/commands/docs/plugin_rm.md) | Builtin | Remove a plugin from the plugin registry file. | +| [`plugin stop`](/commands/docs/plugin_stop.md) | Builtin | Stop an installed plugin if it was running. | +| [`plugin use`](/commands/docs/plugin_use.md) | Builtin | Load a plugin from the plugin registry file into scope. | \ No newline at end of file diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md new file mode 100644 index 00000000000..a7f04bae6ca --- /dev/null +++ b/commands/docs/plugin_add.md @@ -0,0 +1,57 @@ +--- +title: plugin add +categories: | + plugin +version: 0.92.3 +plugin: | + Add a plugin to the plugin registry file. +usage: | + Add a plugin to the plugin registry file. +feature: default +--- + + +# `plugin add` for [plugin](/commands/categories/plugin.md) + +
Add a plugin to the plugin registry file.
+ +## Signature + +```> plugin add {flags} (filename)``` + +## Flags + + - `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path` + - `--shell, -s {path}`: Use an additional shell program (cmd, sh, python, etc.) to run the plugin + +## Parameters + + - `filename`: Path to the executable for the plugin + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Run the `nu_plugin_inc` plugin from the current directory or $env.NU_PLUGIN_DIRS and install its signatures. +```nu +> plugin add nu_plugin_inc + +``` + +Run the `nu_plugin_polars` plugin from the current directory or $env.NU_PLUGIN_DIRS, and install its signatures to the "polars.msgpackz" plugin registry file. +```nu +> plugin add --plugin-config polars.msgpackz nu_plugin_polars + +``` + +## Notes +This does not load the plugin commands into the scope - see `register` for that. + +Instead, it runs the plugin to get its command signatures, and then edits the +plugin registry file (by default, `$nu.plugin-path`). The changes will be +apparent the next time `nu` is next launched with that plugin registry file. \ No newline at end of file diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 3ea7315cfe8..8e7208f9e3e 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -1,9 +1,9 @@ --- title: plugin list categories: | - core -version: 0.92.0 -core: | + plugin +version: 0.92.3 +plugin: | List installed plugins. usage: | List installed plugins. @@ -11,7 +11,7 @@ feature: default --- -# `plugin list` for [core](/commands/categories/core.md) +# `plugin list` for [plugin](/commands/categories/plugin.md)
List installed plugins.
diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md new file mode 100644 index 00000000000..2e9ad34ec67 --- /dev/null +++ b/commands/docs/plugin_rm.md @@ -0,0 +1,65 @@ +--- +title: plugin rm +categories: | + plugin +version: 0.92.3 +plugin: | + Remove a plugin from the plugin registry file. +usage: | + Remove a plugin from the plugin registry file. +feature: default +--- + + +# `plugin rm` for [plugin](/commands/categories/plugin.md) + +
Remove a plugin from the plugin registry file.
+ +## Signature + +```> plugin rm {flags} (name)``` + +## Flags + + - `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path` + - `--force, -f`: Don't cause an error if the plugin name wasn't found in the file + +## Parameters + + - `name`: The name, or filename, of the plugin to remove + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Remove the installed signatures for the `inc` plugin. +```nu +> plugin rm inc + +``` + +Remove the installed signatures for the plugin with the filename `~/.cargo/bin/nu_plugin_inc`. +```nu +> plugin rm ~/.cargo/bin/nu_plugin_inc + +``` + +Remove the installed signatures for the `polars` plugin from the "polars.msgpackz" plugin registry file. +```nu +> plugin rm --plugin-config polars.msgpackz polars + +``` + +## Notes +This does not remove the plugin commands from the current scope or from `plugin +list` in the current shell. It instead removes the plugin from the plugin +registry file (by default, `$nu.plugin-path`). The changes will be apparent the +next time `nu` is launched with that plugin registry file. + +This can be useful for removing an invalid plugin signature, if it can't be +fixed with `plugin add`. \ No newline at end of file diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index e61e53707cc..ffa9a1d0546 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -1,9 +1,9 @@ --- title: plugin stop categories: | - core -version: 0.92.0 -core: | + plugin +version: 0.92.3 +plugin: | Stop an installed plugin if it was running. usage: | Stop an installed plugin if it was running. @@ -11,7 +11,7 @@ feature: default --- -# `plugin stop` for [core](/commands/categories/core.md) +# `plugin stop` for [plugin](/commands/categories/plugin.md)
Stop an installed plugin if it was running.
@@ -21,7 +21,7 @@ feature: default ## Parameters - - `name`: The name of the plugin to stop. + - `name`: The name, or filename, of the plugin to stop ## Input/output types: @@ -38,6 +38,12 @@ Stop the plugin named `inc`. ``` +Stop the plugin with the filename `~/.cargo/bin/nu_plugin_inc`. +```nu +> plugin stop ~/.cargo/bin/nu_plugin_inc + +``` + Stop all plugins. ```nu > plugin list | each { |p| plugin stop $p.name } diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md new file mode 100644 index 00000000000..f06b78fffa1 --- /dev/null +++ b/commands/docs/plugin_use.md @@ -0,0 +1,70 @@ +--- +title: plugin use +categories: | + plugin +version: 0.92.3 +plugin: | + Load a plugin from the plugin registry file into scope. +usage: | + Load a plugin from the plugin registry file into scope. +feature: default +--- + + +# `plugin use` for [plugin](/commands/categories/plugin.md) + +
Load a plugin from the plugin registry file into scope.
+ +## Signature + +```> plugin use {flags} (name)``` + +## Flags + + - `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path` + +## Parameters + + - `name`: The name, or filename, of the plugin to load + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Load the commands for the `query` plugin from $nu.plugin-path +```nu +> plugin use query + +``` + +Load the commands for the plugin with the filename `~/.cargo/bin/nu_plugin_query` from $nu.plugin-path +```nu +> plugin use ~/.cargo/bin/nu_plugin_query + +``` + +Load the commands for the `query` plugin from a custom plugin registry file +```nu +> plugin use --plugin-config local-plugins.msgpackz query + +``` + +## Notes +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nu.html + +The plugin definition must be available in the plugin registry file at parse +time. Run `plugin add` first in the REPL to do this, or from a script consider +preparing a plugin registry file and passing `--plugin-config`, or using the +`--plugin` option to `nu` instead. + +If the plugin was already loaded, this will reload the latest definition from +the registry file into scope. + +Note that even if the plugin filename is specified, it will only be loaded if +it was already previously registered with `plugin add`. \ No newline at end of file diff --git a/commands/docs/port.md b/commands/docs/port.md index 3adc3ef53a7..24b0086d6f0 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.92.0 +version: 0.92.3 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index cf82feeac60..95b6f7a1fa6 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index eb2aca423e3..63b6408b799 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index e9bb9f8b86b..748e4797947 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.92.0 +version: 0.92.3 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 0da3bfefd96..4402a48d541 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.92.0 +version: 0.92.3 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 7b2365ca003..3f92660bb7c 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index c6e8e8e4273..72cb0b5bf60 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.92.0 +version: 0.92.3 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 9e5f2449cdd..1d8b763fee4 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | execute json query on json file (open --raw | query json 'query string') usage: | diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 94b953d8e67..a35aec7f693 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.92.0 +version: 0.92.3 network: | execute selector query on html/web usage: | diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index dc15e8638cd..cda59b3e7b2 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | execute xpath query on xml usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index cc22e7f893a..8a392136bce 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate a random value. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 2532692a740..b737ea48971 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 7b4898d73b0..df54459ec33 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate random chars. usage: | diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index 81ab1255003..1d03dd3d01a 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index cc1f8c73feb..4c115a1f13e 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.92.0 +version: 0.92.3 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 3a9feb5e1aa..d1e21d79ec8 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index fbe9fd4ee1a..ca469f8f124 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.92.0 +version: 0.92.3 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index 4e0cd4feeb8..e712ace61cc 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 10b29fed46b..b7e9aabd507 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Aggregate a list to a single value using an accumulator closure. usage: | diff --git a/commands/docs/register.md b/commands/docs/register.md index afdab432f1f..3e7e662088d 100644 --- a/commands/docs/register.md +++ b/commands/docs/register.md @@ -1,9 +1,9 @@ --- title: register categories: | - core -version: 0.92.0 -core: | + plugin +version: 0.92.3 +plugin: | Register a plugin. usage: | Register a plugin. @@ -11,7 +11,7 @@ feature: default --- -# `register` for [core](/commands/categories/core.md) +# `register` for [plugin](/commands/categories/plugin.md)
Register a plugin.
@@ -50,5 +50,7 @@ Register `nu_plugin_query` plugin from `nu -c` (writes/updates $nu.plugin-path) ``` ## Notes +Deprecated in favor of `plugin add` and `plugin use`. + This command is a parser keyword. For details, check: https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index 47b61827e35..a97acd9d1a2 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.92.0 +version: 0.93.0 system: | Query the Windows registry. usage: | @@ -60,4 +60,4 @@ Query the HKEY_LOCAL_MACHINE hive ``` ## Notes -Currently supported only on Windows systems. \ No newline at end of file +Currently supported only on Windows systems. diff --git a/commands/docs/reject.md b/commands/docs/reject.md index feca5cf9383..fb533b5fa3e 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.92.0 +version: 0.92.3 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 24e2c163a8b..48bcc7b9b27 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 064f8f4321f..e1263c19083 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.92.0 +version: 0.92.3 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 553f47eb0bc..ada0da7bdaa 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 44528700e85..ed1f0de65c8 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index c27b1e8a41e..26c582757f9 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 95477e2aeab..9f981edcc93 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index d9b7c92def5..dc321ee3569 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index e1a363858c7..b685a392f2c 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index cc6c9608659..c6b138c80c8 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 9a8602943ba..37f87eb4cae 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.92.0 +version: 0.92.3 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 63b201a78a7..a7c75787ca1 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.92.0 +version: 0.92.3 system: | Runs external command. usage: | @@ -19,13 +19,6 @@ feature: default ```> run-external {flags} (command) ...rest``` -## Flags - - - `--redirect-stdout, -`: redirect stdout to the pipeline - - `--redirect-stderr, -`: redirect stderr to the pipeline - - `--redirect-combine, -`: redirect both stdout and stderr combined to the pipeline (collected in stdout) - - `--trim-end-newline, -`: trimming end newlines - ## Parameters - `command`: External command to run. diff --git a/commands/docs/save.md b/commands/docs/save.md index 1fee947c59c..05f74648ad0 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index 7fe90f80f33..83aa8405fcc 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.92.0 +version: 0.92.3 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index bb0c3973111..a33ecc01bf3 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.92.0 +version: 0.92.3 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 963136494a8..6561ded281f 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.92.0 +version: 0.92.3 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 49e9003676f..8c19284c40f 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.92.0 +version: 0.92.3 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 f5b6aa739dc..1f7fa28112b 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.92.0 +version: 0.92.3 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 9b757aa7329..f4db00bc27b 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.92.0 +version: 0.92.3 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 0556d655182..5757a137c0d 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.92.0 +version: 0.92.3 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 d912dacdfd5..6ccf64ba274 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.92.0 +version: 0.92.3 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index df806dbb346..f32458ba7e1 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.92.0 +version: 0.92.3 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 2f6f9b889ba..5ba8161b8ee 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.92.0 +version: 0.92.3 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 1b76c095c1f..b75f90fd147 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.92.0 +version: 0.92.3 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 8ecb46bb39e..107e4880efb 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.92.0 +version: 0.92.3 generators: | Print sequences of dates. usage: | @@ -38,25 +38,25 @@ feature: default ## Examples -print the next 10 days in YYYY-MM-DD format with newline separator +Return a list of the next 10 days in the YYYY-MM-DD format ```nu > seq date --days 10 ``` -print the previous 10 days in YYYY-MM-DD format with newline separator +Return the previous 10 days in the YYYY-MM-DD format ```nu > seq date --days 10 --reverse ``` -print the previous 10 days starting today in MM/DD/YYYY format with newline separator +Return the previous 10 days, starting today, in the MM/DD/YYYY format ```nu > seq date --days 10 -o '%m/%d/%Y' --reverse ``` -print the first 10 days in January, 2020 +Return the first 10 days in January, 2020 ```nu > seq date --begin-date '2020-01-01' --end-date '2020-01-10' ╭───┬────────────╮ diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 570236802e0..b153a229933 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 0fc41701115..e69d46c08a9 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.92.0 +version: 0.92.3 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 2c0bd2d0d38..c9abed56044 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.92.0 +version: 0.92.3 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 425f7436954..c24762d0fb3 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.92.0 +version: 0.92.3 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 575c9e473a2..4b478bb5d46 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index 2b80ab73ed7..1b31fe10fda 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Sort by the given columns, in increasing order. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 96612c1f6e5..cf6948803c2 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 9bce0c15c1d..857138647b6 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.92.0 +version: 0.92.3 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 56459dd6880..decbc0d7b3a 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.92.0 +version: 0.92.3 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split-by.md b/commands/docs/split-by.md index e4b7f8dc1bf..a3dc893d8b8 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Split a record into groups. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index c67e24385ac..0248e23048d 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 5f11b7312b4..f50647d0cf1 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.92.0 +version: 0.92.3 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 e0a801b934c..7d3b4e59bce 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.92.0 +version: 0.92.3 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 7bdb44be375..75f86f83760 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.92.0 +version: 0.92.3 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 22451ef8741..b8eaae658f0 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.92.0 +version: 0.92.3 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 73dbcaaf113..f73d5cf5b67 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 0a30c0d43ee..e924941b15f 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 cca1a6f5b0e..565bf0ba77b 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.92.0 +version: 0.92.3 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 c81405d923e..ec916d1f714 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.92.0 +version: 0.92.3 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 412047c2008..11ac7a5e14a 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.92.0 +version: 0.92.3 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 bc3f9e0db1d..05179ce94ce 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.92.0 +version: 0.92.3 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 8587b2a7361..b78555be6fc 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.92.0 +version: 0.92.3 database: | Import a sqlite database file into the in-memory sqlite database. usage: | @@ -21,7 +21,7 @@ feature: default ## Flags - - `--file-name, -f {string}`: file name to export the sqlite in-memory database to + - `--file-name, -f {string}`: file name to import the sqlite in-memory database from ## Input/output types: diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index ab803bf863d..f008ac752a7 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.92.0 +version: 0.92.3 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 5b37336deff..404a2a49d5c 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.92.0 +version: 0.92.3 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index 3fca3fec1b0..32659afd8e7 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.92.0 +version: 0.92.3 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 f129eed9522..d1d60dc9990 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.92.0 +version: 0.92.3 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 3d7589b3f15..cb67b8d78e0 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.92.0 +version: 0.92.3 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 faa581f46f7..27aa4242940 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.92.0 +version: 0.92.3 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index df442944bc9..1ed263533d0 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 6d9a40c2b7a..2d11ab9fac3 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 3e717e2968a..41c0218fb56 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.92.0 +version: 0.92.3 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 82961ae66f3..78cdac8cb7c 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index fd2d953b554..baa473983e8 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.92.0 +version: 0.92.3 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 20cabbd99a5..e893ff31007 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.92.0 +version: 0.92.3 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 30126a9ab10..7f57fc3775d 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.92.0 +version: 0.92.3 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 ae2e004b3fb..6ccd93823e2 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.92.0 +version: 0.92.3 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 b275ceb6c79..a271dc55def 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.92.0 +version: 0.92.3 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 1ab6e280c5b..720c1b9b1c6 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index f37db4df041..fb15bf568ab 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.92.0 +version: 0.92.3 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index da74484bd56..091230c2b1c 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index de648493bdf..a8d33ad0e37 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.92.0 +version: 0.92.3 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 0adc0ad80d1..2f6b36bc66b 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.92.0 +version: 0.92.3 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 c033665b61a..4ecbe94a115 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.92.0 +version: 0.92.3 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 97aca1ccbe1..26967a0c1be 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.92.0 +version: 0.92.3 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 821864652ed..8d8f067ef5a 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 42c89d0b01f..d93a8fc293d 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Get part of a string. Note that the start is included but the end is excluded, and 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 5ffa45ba891..c065e8485ff 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.92.0 +version: 0.92.3 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index c13779f1d75..be969be91e5 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 03db15b3f8a..fe92e7e6ce7 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.92.0 +version: 0.92.3 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 98567df7bc6..dde2dc97fec 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.92.0 +version: 0.92.3 system: | View information about the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 74f502dc747..dfa8ab93cf9 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.92.0 +version: 0.92.3 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index b9765024a98..f278aa66559 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.92.0 +version: 0.92.3 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 fc76376aedd..2f32dc50cbf 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.92.0 +version: 0.92.3 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 37abf215c7b..2610f975e31 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.92.0 +version: 0.92.3 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 19bd9e5ebe2..2c00f52872a 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index 929582ab0c1..756e4218fa4 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.92.0 +version: 0.92.3 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 6673665eb74..19ae106d6cb 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index f94773277de..39c5be7f178 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Translate structured data to a format. usage: | @@ -31,15 +31,17 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------- | ------- | ------------------------------------------------------------- | -| [`to csv`](/commands/docs/to_csv.md) | Builtin | Convert table into .csv text . | -| [`to html`](/commands/docs/to_html.md) | Builtin | Convert table into simple HTML. | -| [`to json`](/commands/docs/to_json.md) | Builtin | Converts table data into JSON text. | -| [`to md`](/commands/docs/to_md.md) | Builtin | Convert table into simple Markdown. | -| [`to nuon`](/commands/docs/to_nuon.md) | Builtin | Converts table data into Nuon (Nushell Object Notation) text. | -| [`to text`](/commands/docs/to_text.md) | Builtin | Converts data into simple text. | -| [`to toml`](/commands/docs/to_toml.md) | Builtin | Convert record into .toml text. | -| [`to tsv`](/commands/docs/to_tsv.md) | Builtin | Convert table into .tsv text. | -| [`to xml`](/commands/docs/to_xml.md) | Builtin | Convert special record structure into .xml text. | -| [`to yaml`](/commands/docs/to_yaml.md) | Builtin | Convert table into .yaml/.yml text. | \ No newline at end of file +| name | type | usage | +| ---------------------------------------------- | ------- | ------------------------------------------------------------- | +| [`to csv`](/commands/docs/to_csv.md) | Builtin | Convert table into .csv text . | +| [`to html`](/commands/docs/to_html.md) | Builtin | Convert table into simple HTML. | +| [`to json`](/commands/docs/to_json.md) | Builtin | Converts table data into JSON text. | +| [`to md`](/commands/docs/to_md.md) | Builtin | Convert table into simple Markdown. | +| [`to msgpack`](/commands/docs/to_msgpack.md) | Builtin | Convert Nu values into MessagePack. | +| [`to msgpackz`](/commands/docs/to_msgpackz.md) | Builtin | Convert Nu values into brotli-compressed MessagePack. | +| [`to nuon`](/commands/docs/to_nuon.md) | Builtin | Converts table data into Nuon (Nushell Object Notation) text. | +| [`to text`](/commands/docs/to_text.md) | Builtin | Converts data into simple text. | +| [`to toml`](/commands/docs/to_toml.md) | Builtin | Convert record into .toml text. | +| [`to tsv`](/commands/docs/to_tsv.md) | Builtin | Convert table into .tsv text. | +| [`to xml`](/commands/docs/to_xml.md) | Builtin | Convert special record structure into .xml text. | +| [`to yaml`](/commands/docs/to_yaml.md) | Builtin | Convert table into .yaml/.yml text. | \ No newline at end of file diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index e4bb3a4e012..925903b3b39 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 6672a30ff40..69e6021a271 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 85916570b2b..dc1d2fa4129 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index d76edf88649..ae315099725 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md new file mode 100644 index 00000000000..49d650c4277 --- /dev/null +++ b/commands/docs/to_msgpack.md @@ -0,0 +1,72 @@ +--- +title: to msgpack +categories: | + formats +version: 0.92.3 +formats: | + Convert Nu values into MessagePack. +usage: | + Convert Nu values into MessagePack. +feature: default +--- + + +# `to msgpack` for [formats](/commands/categories/formats.md) + +
Convert Nu values into MessagePack.
+ +## Signature + +```> to msgpack {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | binary | + +## Examples + +Convert a list of values to MessagePack +```nu +> [foo, 42, false] | to msgpack +Length: 7 (0x7) bytes | printable whitespace ascii_other non_ascii +00000000: 93 a3 66 6f 6f 2a c2 ××foo*× + +``` + +Convert a range to a MessagePack array +```nu +> 1..10 | to msgpack +Length: 11 (0xb) bytes | printable whitespace ascii_other non_ascii +00000000: 9a 01 02 03 04 05 06 07 08 09 0a ו•••••••__ + +``` + +Convert a table to MessagePack +```nu +> [ + [event_name time]; + ['Apollo 11 Landing' 1969-07-24T16:50:35] + ['Nushell first commit' 2019-05-10T09:59:12-07:00] + ] | to msgpack +Length: 95 (0x5f) bytes | printable whitespace ascii_other non_ascii +00000000: 92 82 aa 65 76 65 6e 74 5f 6e 61 6d 65 b1 41 70 ×××event_name×Ap +00000010: 6f 6c 6c 6f 20 31 31 20 4c 61 6e 64 69 6e 67 a4 ollo 11 Landing× +00000020: 74 69 6d 65 c7 0c ff 00 00 00 00 ff ff ff ff ff time×_×0000××××× +00000030: 2c ab 5b 82 aa 65 76 65 6e 74 5f 6e 61 6d 65 b4 ,×[××event_name× +00000040: 4e 75 73 68 65 6c 6c 20 66 69 72 73 74 20 63 6f Nushell first co +00000050: 6d 6d 69 74 a4 74 69 6d 65 d6 ff 5c d5 ad e0 mmit×time××\××× + +``` + +## Notes +Not all values are representable as MessagePack. + +The datetime extension type is used for dates. Binaries are represented with +the native MessagePack binary type. Most other types are represented in an +analogous way to `to json`, and may not convert to the exact same type when +deserialized with `from msgpack`. + +MessagePack: https://msgpack.org/ \ No newline at end of file diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md new file mode 100644 index 00000000000..f11e21931fe --- /dev/null +++ b/commands/docs/to_msgpackz.md @@ -0,0 +1,35 @@ +--- +title: to msgpackz +categories: | + formats +version: 0.92.3 +formats: | + Convert Nu values into brotli-compressed MessagePack. +usage: | + Convert Nu values into brotli-compressed MessagePack. +feature: default +--- + + +# `to msgpackz` for [formats](/commands/categories/formats.md) + +
Convert Nu values into brotli-compressed MessagePack.
+ +## Signature + +```> to msgpackz {flags} ``` + +## Flags + + - `--quality, -q {int}`: Quality of brotli compression (default 1) + - `--window-size, -w {int}`: Window size for brotli compression (default 20) + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | binary | + +## Notes +This is the format used by the plugin registry file ($nu.plugin-path). \ No newline at end of file diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 53704570260..06f12630386 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 41b82766dc9..f0a2907ea38 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 0de33642287..0a8a7e97d7f 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 340a0fec246..18725da4353 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index af73f22d638..2e8b703a1b6 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 43db1567096..09db462276e 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.92.0 +version: 0.92.3 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 53b2e9de703..5e9e02bba91 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.92.0 +version: 0.92.3 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index bdc87bc1dee..54cfb6a26fc 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.92.0 +version: 0.92.3 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 e883dc0f678..cb9884ceb35 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.92.0 +version: 0.92.3 core: | Try to run a block, if it fails optionally run a catch block. usage: | diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 57a42e7f50e..8a33b6bc2ac 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.92.0 +version: 0.92.3 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index ef336892a29..8920048a7d4 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 107d2efda88..f41100f7314 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.92.0 +version: 0.92.3 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 77eb07e852a..86b786ae2a2 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.92.0 +version: 0.92.3 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 649de3b07ba..6a5bf171704 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index d1d86c4a374..3e83d57b5e8 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.92.0 +version: 0.92.3 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 e2658b34f13..70b10307863 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index a8beb7583e4..f6ec44454e8 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.92.0 +version: 0.92.3 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 e05e4a2690c..6a095a763a6 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.92.0 +version: 0.92.3 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 1c96f7b8685..70228cd8f31 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.92.0 +version: 0.92.3 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 e462d7dc039..fd7b57204f9 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.92.0 +version: 0.92.3 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 b09855cac6e..4265b4b1bc1 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.92.0 +version: 0.92.3 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 9773e8e153d..af4f4f9aacb 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.92.0 +version: 0.92.3 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index bbdcee7483f..b227c201d60 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.92.0 +version: 0.92.3 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index e67a48a8605..e2d4f486b67 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.92.0 +version: 0.92.3 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 b8b0e36bc1c..249c032f694 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.92.0 +version: 0.92.3 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 a2d6e49652b..c3ec7e5c3a6 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.92.0 +version: 0.92.3 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 741cf20a0d1..d7d97407748 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 62d40b14618..de435466d99 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index b7566303275..69d2cde6380 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index a14b2fd1188..a282e1aa6e1 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.92.0 +version: 0.92.3 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index bb2405d5866..2023a2d3d63 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.92.0 +version: 0.92.3 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 3f4e6e02a9a..072939f0d2b 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 1a6656c8d17..547c58da140 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.92.0 +version: 0.92.3 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 9ef79f29ef5..7d06e2dc5e4 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.92.0 +version: 0.92.3 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 933a995e92d..3975a99f54d 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.92.0 +version: 0.92.3 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 77453c666e9..7e44dd4ba04 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.92.0 +version: 0.92.3 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 d76b1705adb..53d967b6e03 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.92.0 +version: 0.92.3 env: | Runs a block with an environment variable set. usage: | @@ -33,24 +33,6 @@ feature: default ## Examples -Set the MYENV environment variable -```nu -> with-env [MYENV "my env value"] { $env.MYENV } -my env value -``` - -Set by primitive value list -```nu -> with-env [X Y W Z] { $env.X } -Y -``` - -Set by single row table -```nu -> with-env [[X W]; [Y Z]] { $env.W } -Z -``` - Set by key-value record ```nu > with-env {X: "Y", W: "Z"} { [$env.X $env.W] } diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 5437f4dcb52..0dff2a1a0a1 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 07cd9b4d636..2a41ad9871c 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.92.0 +version: 0.92.3 filters: | Combine a stream with the input. usage: |