diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 4c61bd9a18..a58b552b7f 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.99.0 +version: 0.100.0 core: | Alias a command (with optional flags) to a new name. usage: | diff --git a/commands/docs/all.md b/commands/docs/all.md index b2bd90feea..993074a848 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Test if every element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index 489bd1abae..43c0fdc864 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Output ANSI codes to change color and style of text. usage: | diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index d57e0cbf8d..2256cb053d 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 94f2a69c38..a95d214f98 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 614427eaba..3b4b9e2690 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index ecc707132e..bf1c678d62 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Tests if any element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/append.md b/commands/docs/append.md index 80f46186f1..b32c52c606 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 7105f516e8..40af81cc5a 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/banner.md b/commands/docs/banner.md index dc46b2a871..6dcd3b9141 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.99.0 +version: 0.100.0 default: | Print a banner for nushell with information about the project usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 3f4d5402b3..f346958638 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 75ea64ea77..1439677d72 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Performs bitwise and for ints or binary values. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index a8439640c1..a831d9c678 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 410eefb249..eb1cc9e342 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Performs bitwise or for ints or binary values. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 0ec9ce5de1..415f923260 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Bitwise rotate left for ints or binary values. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index a778f5ede0..e0eeb0af15 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Bitwise rotate right for ints or binary values. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 22c706ab4c..da16546e0f 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Bitwise shift left for ints or binary values. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 617c565855..4321e5ba3e 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Bitwise shift right for ints or binary values. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index d9e6d71fd4..42016a3494 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.99.0 +version: 0.100.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 834a9842c3..d630e2054c 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.99.0 +version: 0.100.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index bb5ead923e..ebd408ea84 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index d1296c8ca1..f89d7f3f82 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 1d42ad415d..868980a376 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 755ab68071..8b8c926cf0 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index b3053a101d..ddfb4d9745 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index a68973ce6a..98c945d716 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.99.0 +version: 0.100.0 bytes: | Check if bytes ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 3cec667337..34ba4e4177 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.99.0 +version: 0.100.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 1b15fa8572..13bf8eae55 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Output the length of any bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index 8197dea9d9..f25f5ad88f 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 62a392a776..080fef8ffe 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.99.0 +version: 0.100.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 14e7d075bd..40efe4b0e6 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.99.0 +version: 0.100.0 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 5684d6bb8c..f0f7492523 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.99.0 +version: 0.100.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 374c062cae..54c7140d62 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.99.0 +version: 0.100.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 1d451e5d6a..34e3c44d3e 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 2b5816bbb8..865510e4db 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index bcf7827cc8..6ab137c24e 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Divide a list or table into chunks of `chunk_size`. usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 83565174f8..eb5e9a7aa9 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 75a733cc70..dba1497663 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 5514643419..421b97bc86 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Given a record or table, produce a list of its columns' names. usage: | diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index 89ff62684e..78b905be71 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.99.0 +version: 0.100.0 core: | View the current command line input buffer. usage: | diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index 2322f01025..4b6af4e6c0 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.99.0 +version: 0.100.0 core: | Modify the current command line input buffer. usage: | diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 041aa098ca..ec034b46ae 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.99.0 +version: 0.100.0 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 6b203b4b0b..79ca112d03 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.99.0 +version: 0.100.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 27434998b1..fc724340cb 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 66786bf788..e9803fe1a2 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.99.0 +version: 0.100.0 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | diff --git a/commands/docs/config.md b/commands/docs/config.md index 4a78ef6655..9723bd9948 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.99.0 +version: 0.100.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 6726a3f72c..702733469c 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.99.0 +version: 0.100.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 070bbe84ab..7a09414925 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.99.0 +version: 0.100.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 7aefebea15..2ff1661329 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.99.0 +version: 0.100.0 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 2eaf6d7b11..1fbfb874ec 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.99.0 +version: 0.100.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index ad9ad2f8d9..632f22db41 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.99.0 +version: 0.100.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 8b8dbd831a..9262156512 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index b72ec23db7..021a8faaab 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.99.0 +version: 0.100.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 7ebb8243bb..af01cf2bf4 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.99.0 +version: 0.100.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 052fd4aaf5..c4d57acbf5 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.99.0 +version: 0.100.0 date: | Print a 'humanized' format for the date, relative to now. usage: | diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index 6a93905d3e..91c4c2cccc 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.99.0 +version: 0.100.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 42fe51b323..4fa1063e7d 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.99.0 +version: 0.100.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index 03cd175cc8..3778209082 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.99.0 +version: 0.100.0 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 7655f01071..342d72af2a 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.99.0 +version: 0.100.0 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 ac1a04e7fb..16e7a086cc 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.99.0 +version: 0.100.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index dc6c8fc910..2aaf312c6d 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 5488b1ceb5..cad605f8b8 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 95869ddcaf..bd8b1448f2 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index bff8ed57d4..63ddf56eed 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 96bb922110..ea3ab91483 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Decode a Base32 value. usage: | diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 67735c345c..528790cd6d 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Encode a base32hex value. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 708edad4bf..d1f20df143 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Decode a Base64 value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 2e5731617c..437c911da7 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index 30c99d1bb7..3ab4449410 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.99.0 +version: 0.100.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index c2a4cb1e99..01ee90aef6 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Sets a default value if a row's column is missing or null. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 0d7b582a0d..a2f297bcb9 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.99.0 +version: 0.100.0 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 22a2b5d96e..8d30fc3a12 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index e4b4cb119b..d6facd4e29 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.99.0 +version: 0.100.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 3874f13554..f6eb534f7c 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index b7cb9b2452..17b9f3ad7e 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index 9d50bfe069..8bbde9d788 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index eeed2ab3c6..6a7cdea7ed 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index 41238a9052..c9ee7a7aac 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 7bbf8c5c1a..cbab4cbf3e 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | diff --git a/commands/docs/echo.md b/commands/docs/echo.md index e7c61e89d8..a910a94e4d 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.99.0 +version: 0.100.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 08aa38343f..643067a30f 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index 2d50d6836b..eadf695ae9 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Encode a string or binary value using Base32. usage: | diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md index 5f61903b38..f5b975b5de 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Encode a binary value or a string using base32hex. usage: | diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index ee22cd278c..5080a213a4 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Encode a string or binary value using Base64. usage: | diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 584113a20c..c68c1c4b86 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index c719162524..7ee7791b56 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index f1cbe2e712..7f54558377 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.99.0 +version: 0.100.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index b7d169811f..c12ffb335b 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Show (or skip) every n-th row, starting from the first one. usage: | diff --git a/commands/docs/exec.md b/commands/docs/exec.md index c35a61f743..b67c4fbc0c 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.99.0 +version: 0.100.0 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 59502cef67..28175f5106 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.99.0 +version: 0.100.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 9f15c363fe..8e44289597 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index f623030b9f..d1b4a422e5 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.99.0 +version: 0.100.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 1bfdc40150..92dc166797 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.99.0 +version: 0.100.0 env: | Run a block and preserve its environment in a current scope. usage: | diff --git a/commands/docs/export.md b/commands/docs/export.md index 6ce3a86a6d..339ce917c5 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.99.0 +version: 0.100.0 core: | Export definitions or environment variables from a module. usage: | diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index e06a6024ff..4ca6179352 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.99.0 +version: 0.100.0 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index 93a461294f..5709aadc08 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.99.0 +version: 0.100.0 core: | Use parse-time constant from a module and export them from this module. usage: | diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index f7d1725538..ccf8c5fdae 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.99.0 +version: 0.100.0 core: | Define a custom command and export it from a module. usage: | diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index 7622e31cc8..6a2bb3bc60 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.99.0 +version: 0.100.0 core: | Define an extern and export it from a module. usage: | diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index f05fa96f45..d05274e680 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.99.0 +version: 0.100.0 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 20e165d510..b96a62eb80 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.99.0 +version: 0.100.0 core: | Use definitions from a module and export them from this module. usage: | diff --git a/commands/docs/extern.md b/commands/docs/extern.md index f017aac866..8b811253dd 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.99.0 +version: 0.100.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 77ff7dbad5..2c2205a69e 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index b627823f74..3863600828 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 0367cac082..56ab27dae3 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index f402386b93..1642f3081e 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 46cb2d9750..14d6f99806 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index b846d4ad17..089270075b 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index ef19f57638..db3e9bbcb8 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.99.0 +version: 0.100.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index a8970c551f..478173d1cc 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 35eb8da091..2d91a457cb 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 4c5e405a4b..5d812fad93 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Outputs duration with a specified unit of time. usage: | diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index 2494ba7907..333495e753 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.99.0 +version: 0.100.0 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 451863978c..144cacd360 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 410de055df..060341caac 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse a string or binary data into structured data. usage: | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index d27db05d56..06dc1f08c7 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index 368917abf4..86fd5ffca3 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .eml and create record. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> from eml {flags} ``` diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index 6ce22b3ad7..579ae12564 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .ics and create table. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> from ics {flags} ``` diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 0c81e506cf..e601c85dc5 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .ini and create table. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> from ini {flags} ``` diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 14589691e1..ca4bc24591 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 963073d714..37d7376c70 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index 3b244f5165..bd4d01091f 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert brotli-compressed MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 5f419ed6b6..9fbfd98a9f 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index ee04192da7..8f890ad773 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_plist.md b/commands/docs/from_plist.md index 996e323f64..5d68671780 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert plist to Nushell values usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> from plist {flags} ``` diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index d811462a08..0551715962 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 7f8b1e7ec4..141dc9ade1 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 93e7ff098d..0ca89a7e50 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 3ad96c2866..4e6c19e972 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index c6bdfa1cf3..a9ca8377f5 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .vcf and create table. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> from vcf {flags} ``` diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 23bd42ed86..24247f4965 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 7fe327f7e4..248bd7d805 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 1e558d9a36..cf985c2a10 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index b7a24163dd..2545d95c03 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 7d42389437..84bdef8fb7 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.99.0 +version: 0.100.0 generators: | Generate a list of values by successively invoking a closure. usage: | diff --git a/commands/docs/get.md b/commands/docs/get.md index 173701e30c..b86a38afbc 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 02f4c3b760..7c1f6686ec 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | diff --git a/commands/docs/grid.md b/commands/docs/grid.md index b26dcb26b3..2ddb16cd23 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.99.0 +version: 0.100.0 viewers: | Renders the output to a textual terminal grid. usage: | diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index f01a618bb5..b9cfd0f13d 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | @@ -103,3 +103,25 @@ You can also output a table instead of a record ╰───┴───────┴───────────╯ ``` + +Group bools, whether they are strings or actual bools +```nu +> [true "true" false "false"] | group-by +╭───────┬───────────────╮ +│ │ ╭───┬──────╮ │ +│ true │ │ 0 │ true │ │ +│ │ │ 1 │ true │ │ +│ │ ╰───┴──────╯ │ +│ │ ╭───┬───────╮ │ +│ false │ │ 0 │ false │ │ +│ │ │ 1 │ false │ │ +│ │ ╰───┴───────╯ │ +╰───────┴───────────────╯ +``` + +## Notes +the group-by command makes some assumptions: + - if the input data is not a string, the grouper will convert the key to string but the values will remain in their original format. e.g. with bools, "true" and true would be in the same group (see example). + - datetime is formatted based on your configuration setting. use `format date` to change the format. + - filesize is formatted based on your configuration setting. use `format filesize` to change the format. + - some nushell values are not supported, such as closures. \ No newline at end of file diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 5ec6287933..ac1a47ea74 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.99.0 +version: 0.100.0 prompt: | Get the git status of a repo usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_gstat`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> gstat {flags} (path)``` diff --git a/commands/docs/hash.md b/commands/docs/hash.md index a755a587c1..5f77dd5581 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.99.0 +version: 0.100.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 485beb635f..4165a47d79 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.99.0 +version: 0.100.0 hash: | Hash a value using the md5 hash algorithm. usage: | diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index 806f147469..a59d8bc276 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.99.0 +version: 0.100.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index b3c3411c02..c8fc61fdb0 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Use the first row of the table as column names. usage: | diff --git a/commands/docs/help.md b/commands/docs/help.md index 4fdbd65ef0..0d394cd6c1 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.99.0 +version: 0.100.0 core: | Display help information about different parts of Nushell. usage: | diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index bddc94bf02..3930f1fc97 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index f8e984f8b2..8f2711cf7c 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 34ea32239d..e0c3144098 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index ee88f7cca2..63b62d999d 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 8d5e6868e6..4524a7fa4a 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index f1d2386152..fe25ec4b23 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.99.0 +version: 0.100.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index fcc0b25729..206fde8ae6 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.99.0 +version: 0.100.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 1f9fdc2eba..7ed8f5d7fd 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.99.0 +version: 0.100.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index ed8e4beb69..933c896f41 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.99.0 +version: 0.100.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | diff --git a/commands/docs/history.md b/commands/docs/history.md index f32db583eb..b323645fd5 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.99.0 +version: 0.100.0 history: | Get the command history. usage: | @@ -55,4 +55,5 @@ Search all the commands from history that contains 'cargo' | name | description | type | | ------------------------------------------------------ | -------------------------------- | -------- | -| [`history session`](/commands/docs/history_session.md) | Get the command history session. | built-in | +| [`history import`](/commands/docs/history_import.md) | Import command line history | built-in | +| [`history session`](/commands/docs/history_session.md) | Get the command history session. | built-in | \ No newline at end of file diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md new file mode 100644 index 0000000000..59bb823579 --- /dev/null +++ b/commands/docs/history_import.md @@ -0,0 +1,55 @@ +--- +title: history import +categories: | + history +version: 0.100.0 +history: | + Import command line history +usage: | + Import command line history +--- + + +# `history import` for [history](/commands/categories/history.md) + +
Import command line history
+ +## Signature + +```> history import {flags} ``` + + +## Input/output types: + +| input | output | +| ------------ | ------- | +| list\ | nothing | +| nothing | nothing | +| table | nothing | +## Examples + +Append all items from history in the other format to the current history +```nu +> history import + +``` + +Append `foo` to the current history +```nu +> echo foo | history import + +``` + +Append `foo` ran from `/home` to the current history +```nu +> [[ command_line cwd ]; [ foo /home ]] | history import + +``` + +## Notes +Can import history from input, either successive command lines or more detailed records. If providing records, available fields are: + command_line, id, start_timestamp, hostname, cwd, duration, exit_status. + +If no input is provided, will import all history items from existing history in the other format: if current history is stored in sqlite, it will store it in plain text and vice versa. + +Note that history item IDs are ignored when importing from file. \ No newline at end of file diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 79a72076b4..959a0615fd 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.99.0 +version: 0.100.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 796e78268a..27ab349c23 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.99.0 +version: 0.100.0 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index f86aed39fb..e8b827ee9c 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.99.0 +version: 0.100.0 network: | Delete the specified resource. usage: | @@ -24,7 +24,7 @@ usage: | - `--password, -p {any}`: the password when authenticating - `--data, -d {any}`: the content to post - `--content-type, -t {any}`: the MIME type of content to post - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--raw, -r`: fetch contents as text rather than a table - `--insecure, -k`: allow insecure server connections when using SSL diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index b78d05caeb..c5afcbe462 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.99.0 +version: 0.100.0 network: | Fetch the contents from a URL. usage: | @@ -22,7 +22,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--raw, -r`: fetch contents as text rather than a table - `--insecure, -k`: allow insecure server connections when using SSL diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 71640086dd..222a65ce08 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.99.0 +version: 0.100.0 network: | Get the headers from a URL. usage: | @@ -22,7 +22,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--insecure, -k`: allow insecure server connections when using SSL - `--redirect-mode, -R {string}`: What to do when encountering redirects. Default: 'follow'. Valid options: 'follow' ('f'), 'manual' ('m'), 'error' ('e'). diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index ff40697680..239a373989 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.99.0 +version: 0.100.0 network: | Requests permitted communication options for a given URL. usage: | @@ -22,7 +22,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--insecure, -k`: allow insecure server connections when using SSL - `--allow-errors, -e`: do not fail if the server returns an error code diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index fa3ff2eb24..e4b1760a73 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.99.0 +version: 0.100.0 network: | Patch a body to a URL. usage: | @@ -23,7 +23,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - `--content-type, -t {any}`: the MIME type of content to post - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--raw, -r`: return values as a string instead of a table - `--insecure, -k`: allow insecure server connections when using SSL diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 8c96b0562b..956a00b839 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.99.0 +version: 0.100.0 network: | Post a body to a URL. usage: | @@ -23,7 +23,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - `--content-type, -t {any}`: the MIME type of content to post - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--raw, -r`: return values as a string instead of a table - `--insecure, -k`: allow insecure server connections when using SSL @@ -75,9 +75,15 @@ Post JSON content from a pipeline to example.com ``` -Upload a file to example.com +Upload a binary file to example.com ```nu -> http post --content-type multipart/form-data https://www.example.com { audio: (open -r file.mp3) } +> http post --content-type multipart/form-data https://www.example.com { file: (open -r file.mp3) } + +``` + +Convert a text file into binary and upload it to example.com +```nu +> http post --content-type multipart/form-data https://www.example.com { file: (open -r file.txt | into binary) } ``` diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index e7f03366fb..a21fba7717 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.99.0 +version: 0.100.0 network: | Put a body to a URL. usage: | @@ -23,7 +23,7 @@ usage: | - `--user, -u {any}`: the username when authenticating - `--password, -p {any}`: the password when authenticating - `--content-type, -t {any}`: the MIME type of content to post - - `--max-time, -m {int}`: timeout period in seconds + - `--max-time, -m {duration}`: max duration before timeout occurs - `--headers, -H {any}`: custom headers you want to add - `--raw, -r`: return values as a string instead of a table - `--insecure, -k`: allow insecure server connections when using SSL diff --git a/commands/docs/if.md b/commands/docs/if.md index 0078361058..fa22e74f75 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.99.0 +version: 0.100.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index cf052cfd9f..edf574a81e 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.99.0 +version: 0.100.0 core: | Ignore the output of the previous command in the pipeline. usage: | diff --git a/commands/docs/inc.md b/commands/docs/inc.md index 37a8a54fad..9ef4866f24 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.99.0 +version: 0.100.0 default: | Increment a value or version. Optionally use the column of a table. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_inc`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> inc {flags} (cell_path)``` diff --git a/commands/docs/input.md b/commands/docs/input.md index a36ffa064d..972f8ec082 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index a30e89ac5f..5c040345c9 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index ba38014d59..64b6552b14 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index a7b76ea10a..9bf972661b 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 0cb3659f8c..36fae94688 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 132aa11a1a..c58c391fc5 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index 0f2ba8b6eb..8a354458a2 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Commands to convert data from one type to another. usage: | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index b3c060913a..fcb0957823 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index 876a8d2e36..a115812ff5 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 8aa5709973..5a5b84b94e 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index bf8da86189..9a69800694 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.99.0 +version: 0.100.0 conversions: | Convert value to a cell-path. usage: | @@ -31,25 +31,25 @@ usage: | Convert integer into cell path ```nu > 5 | into cell-path -5 +$.5 ``` Convert string into cell path ```nu > 'some.path' | split row '.' | into cell-path -some.path +$.some.path ``` Convert list into cell path ```nu > [5 c 7 h] | into cell-path -5.c.7.h +$.5.c.7.h ``` Convert table into cell path ```nu > [[value, optional]; [5 true] [c false]] | into cell-path -5.c +$.5?.c ``` ## Notes diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index c244157452..945758ca27 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -63,7 +63,7 @@ Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) Convert non-standard timestamp string, without timezone offset, to datetime with custom formatting ```nu > '16.11.1984 8:00 am' | into datetime --format '%d.%m.%Y %H:%M %P' -Fri, 16 Nov 1984 16:00:00 +0800 (39 years ago) +Fri, 16 Nov 1984 08:00:00 +0800 (40 years ago) ``` Convert nanosecond-precision unix timestamp to a datetime with offset from UTC @@ -83,7 +83,7 @@ Convert list of timestamps to datetimes > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime ╭───┬─────────────╮ │ 0 │ 2 years ago │ -│ 1 │ a year ago │ +│ 1 │ 2 years ago │ │ 2 │ a year ago │ ╰───┴─────────────╯ diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index e570fee349..b1311931f1 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 260ef100e8..5ab10a439f 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 14208ab950..ae28d6cdb3 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index bcdc603be7..db2bd705fc 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 1e07aee2bf..7c7b639143 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index 5490b0af36..c72fa7127e 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 8d13c2c9a4..25a79705b3 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index b63346b71a..f2bac1f4a9 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index e801b22e00..8061d830fa 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Infer Nushell datatype for each cell. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--columns, -c {table}`: list of columns to update + - `--columns, -c {list}`: list of columns to update - `--prefer-filesizes, -f`: For ints display them as human-readable file sizes diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index f3d4e77f34..3e0f050d24 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.99.0 +version: 0.100.0 core: | Check if nushell is running with administrator or root privileges. usage: | diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index 0b32e88aba..a0df2a6818 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 0bbd3dded8..980825d732 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.99.0 +version: 0.100.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index b2f2311c54..ed21f91c52 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index 33652ecfb0..16c0c07f77 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.99.0 +version: 0.100.0 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 23c8b0649e..a95b2aca20 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 2c8543651e..ad4000b9ed 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 4d4445a408..d28062eb52 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 67bed10dbc..1007213f0f 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | List available options that can be used to create keybindings. usage: | diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index be9241c453..0f3c601a57 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 2207db780d..4267aef717 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index d9a11c4f28..e8ebb93504 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index f10c3ae4be..2776c1740a 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,17 +2,17 @@ title: length categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | - Count the number of items in an input list or rows in a table. + Count the number of items in an input list, rows in a table, or bytes in binary data. usage: | - Count the number of items in an input list or rows in a table. + Count the number of items in an input list, rows in a table, or bytes in binary data. --- # `length` for [filters](/commands/categories/filters.md) -
Count the number of items in an input list or rows in a table.
+
Count the number of items in an input list, rows in a table, or bytes in binary data.
## Signature @@ -23,8 +23,8 @@ usage: | | input | output | | --------- | ------ | +| binary | int | | list\ | int | - ## Examples Count the number of items in a list @@ -38,3 +38,9 @@ Count the number of rows in a table > [{a:1 b:2}, {a:2 b:3}] | length 2 ``` + +Count the number of bytes in binary data +```nu +> 0x[01 02] | length +2 +``` diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index f2afa5d309..2127b1b3d1 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.99.0 +version: 0.100.0 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | diff --git a/commands/docs/let.md b/commands/docs/let.md index 148047d653..372016ef54 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.99.0 +version: 0.100.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 15536e537f..bb3e3ff497 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 4320ecc467..fde2ab55e4 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index ba80ec7fbc..b86227a394 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.99.0 +version: 0.100.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index c7ba1f1d98..0d76cf1fdc 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | diff --git a/commands/docs/match.md b/commands/docs/match.md index c5d38178a2..cbf54d7d42 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.99.0 +version: 0.100.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index e0cd664618..d4b1f8e202 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.99.0 +version: 0.100.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 454099bc5a..9817f6c254 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 701b95c2d5..900fde5585 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 0e77a2d0f3..ee48a73fff 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index bf42aa4757..f82a70f27d 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 289e51affd..c3ed1ad0a5 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the inverse of the hyperbolic sine function. usage: | diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index b6fcfbe1fa..a0b6659ffc 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index bdd733c5d7..bc344682ac 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 2569ce08b1..6ef2f6e20a 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the average of a list of numbers. usage: | diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index 4730fddc57..c5357239dc 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index d7a49cbecc..5203f78e58 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 0b8dc23bf3..be0a5cd508 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 3e54138efe..2f0064a596 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns e raised to the power of x. usage: | diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 5d78da44ca..5655e0182b 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 5a5b03bce0..f1e36bb74a 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 9745f13cc9..719e4d88c7 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index aca846a296..73b2ac00e1 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the maximum of a list of values, or of columns in a table. usage: | diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index 67fd2a8045..a38bed5079 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.99.0 +version: 0.100.0 math: | Computes the median of a list of numbers. usage: | diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index 9c61c7665f..8980693a54 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.99.0 +version: 0.100.0 math: | Finds the minimum within a list of values or tables. usage: | diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index 7f59f8e9a1..5d8d61bd0e 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index b98551fc69..da1fb43a02 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index 59e0fe5573..c7bfcdeb01 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the input number rounded to the specified precision. usage: | diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index ccb9289c12..9358683285 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 1705ed8311..cc855e7316 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index a03151e1e1..1eda85fcfa 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the square root of the input number. usage: | diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index f96312039d..f069744fdc 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index fee0d082f6..14391e1591 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the sum of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index 3ab8f9256f..a58f92048d 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 735bb8385f..93019fc14d 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index c71ee65b08..fad23a3526 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.99.0 +version: 0.100.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 0202edba93..105dccdc1c 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.99.0 +version: 0.100.0 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 217f0aa521..06a03f74ee 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/metadata_access.md b/commands/docs/metadata_access.md index 3ea7f2686e..eab15c9b53 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Access the metadata for the input stream within a closure. usage: | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index 36030b06cc..0e7d614b2b 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index b831f687f8..18e09bb9d7 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 84f546a92d..13c292cbba 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index b90726f43b..b89b9cde09 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.99.0 +version: 0.100.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 17e46d6311..f5ae5c0500 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index bf851d46ed..401a5c1585 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.99.0 +version: 0.100.0 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index c11d21a85f..653c0370fe 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 7709610d38..82e866fead 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index fd7347b05c..ce06671aae 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 8b78172f8e..75f893e354 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index 9d9ee665c3..d6c1325721 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.99.0 +version: 0.100.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 47d3053e6d..31e34c132d 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.99.0 +version: 0.100.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 8cf62a62ea..ee81ea373a 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.99.0 +version: 0.100.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index c64269d78c..a42d40372e 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.99.0 +version: 0.100.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index b3d53a4282..f26fd2147d 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.99.0 +version: 0.100.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index fef25c1b41..67cdcce2bb 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 5302cb0efa..fbc9dbe903 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 4b9aad0cf6..32059b230b 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Parse columns from string data using a simple pattern or a supplied regular expression. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index 893fc8c873..bffb2de15a 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.99.0 +version: 0.100.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 5be95f0d12..b34d8a8ef6 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.99.0 +version: 0.100.0 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index c31f4472dc..194524fba6 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.99.0 +version: 0.100.0 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index ed5ef08f8f..bdc32303b0 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.99.0 +version: 0.100.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index bf30dd8fd0..2d80ee1f2e 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.99.0 +version: 0.100.0 path: | Try to expand a path to its absolute form. usage: | diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index 3c86d2e68b..962f6ce3c4 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.99.0 +version: 0.100.0 path: | Join a structured path or a list of path parts. usage: | diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index 8c5b270812..7af164c869 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.99.0 +version: 0.100.0 path: | Convert a path into structured data. usage: | diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index d25062d3dc..99a0c0b70c 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.99.0 +version: 0.100.0 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 a6f4c54261..2480acd84e 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.99.0 +version: 0.100.0 path: | Split a path into a list based on the system's path separator. usage: | diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index e680de293b..b3ac0d35a0 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.99.0 +version: 0.100.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index 2b4538c237..864269bd5d 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | Commands for managing plugins. usage: | @@ -65,7 +65,7 @@ Remove the installed signatures for the `inc` plugin. | name | description | type | | ---------------------------------------------- | ------------------------------------------------------- | -------- | | [`plugin add`](/commands/docs/plugin_add.md) | Add a plugin to the plugin registry file. | built-in | -| [`plugin list`](/commands/docs/plugin_list.md) | List installed plugins. | built-in | +| [`plugin list`](/commands/docs/plugin_list.md) | List loaded and installed plugins. | built-in | | [`plugin rm`](/commands/docs/plugin_rm.md) | Remove a plugin from the plugin registry file. | built-in | | [`plugin stop`](/commands/docs/plugin_stop.md) | Stop an installed plugin if it was running. | built-in | | [`plugin use`](/commands/docs/plugin_use.md) | Load a plugin from the plugin registry file into scope. | keyword | \ No newline at end of file diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 3bbdafb0f7..e40ce50090 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | Add a plugin to the plugin registry file. usage: | diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 78040c5048..d32b1c68b2 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,41 +2,47 @@ title: plugin list categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | - List installed plugins. + List loaded and installed plugins. usage: | - List installed plugins. + List loaded and installed plugins. --- # `plugin list` for [plugin](/commands/categories/plugin.md) -
List installed plugins.
+
List loaded and installed plugins.
## Signature ```> plugin list {flags} ``` +## Flags + + - `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path` + - `--engine, -e`: Show info for plugins that are loaded into the engine only. + - `--registry, -r`: Show info for plugins from the registry file only. + ## Input/output types: -| input | output | -| ------- | ------------------------------------------------------------------------------------------------------------------------- | -| nothing | table\\> | +| input | output | +| ------- | ----------------------------------------------------------------------------------------------------------------------- | +| nothing | table\\> | ## Examples List installed plugins. ```nu > plugin list -╭───┬──────┬─────────┬────────────┬────────┬───────────────────────────────┬───────┬─────────────╮ -│ # │ name │ version │ is_running │ pid │ filename │ shell │ commands │ -├───┼──────┼─────────┼────────────┼────────┼───────────────────────────────┼───────┼─────────────┤ -│ 0 │ inc │ 0.99.0 │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ -│ │ │ │ │ │ │ │ │ 0 │ inc │ │ -│ │ │ │ │ │ │ │ ╰───┴─────╯ │ -╰───┴──────┴─────────┴────────────┴────────┴───────────────────────────────┴───────┴─────────────╯ +╭───┬──────┬─────────┬─────────┬────────┬───────────────────────────────┬───────┬─────────────╮ +│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ +├───┼──────┼─────────┼─────────┼────────┼───────────────────────────────┼───────┼─────────────┤ +│ 0 │ inc │ 0.100.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ │ │ │ │ │ │ │ │ 0 │ inc │ │ +│ │ │ │ │ │ │ │ ╰───┴─────╯ │ +╰───┴──────┴─────────┴─────────┴────────┴───────────────────────────────┴───────┴─────────────╯ ``` @@ -45,3 +51,26 @@ Get process information for running plugins. > ps | where pid in (plugin list).pid ``` + +## Notes +The `status` column will contain one of the following values: + +- `added`: The plugin is present in the plugin registry file, but not in + the engine. +- `loaded`: The plugin is present both in the plugin registry file and in + the engine, but is not running. +- `running`: The plugin is currently running, and the `pid` column should + contain its process ID. +- `modified`: The plugin state present in the plugin registry file is different + from the state in the engine. +- `removed`: The plugin is still loaded in the engine, but is not present in + the plugin registry file. +- `invalid`: The data in the plugin registry file couldn't be deserialized, + and the plugin most likely needs to be added again. + +`running` takes priority over any other status. Unless `--registry` is used +or the plugin has not been loaded yet, the values of `version`, `filename`, +`shell`, and `commands` reflect the values in the engine and not the ones in +the plugin registry file. + +See also: `plugin use` \ No newline at end of file diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 3a627d8527..56479928e9 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | Remove a plugin from the plugin registry file. usage: | diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index b4f7dfca77..98564b47a1 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | Stop an installed plugin if it was running. usage: | diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index ded3ce5008..b56f14c411 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.99.0 +version: 0.100.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | diff --git a/commands/docs/polars.md b/commands/docs/polars.md index 6c5479ceaa..8593b0925b 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars {flags} ``` @@ -102,6 +103,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | | [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | | [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | plugin | +| [`polars len`](/commands/docs/polars_len.md) | Return the number of rows in the context. This is similar to COUNT(*) in SQL. | plugin | | [`polars lit`](/commands/docs/polars_lit.md) | Creates a literal expression. | plugin | | [`polars lowercase`](/commands/docs/polars_lowercase.md) | Lowercase the strings in the column. | plugin | | [`polars max`](/commands/docs/polars_max.md) | Creates a max expression or aggregates columns to their max value. | plugin | @@ -145,6 +147,7 @@ The units of the timings are microseconds. | plugin | | [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | | [`polars take`](/commands/docs/polars_take.md) | Creates new dataframe using the given indices. | plugin | | [`polars unique`](/commands/docs/polars_unique.md) | Returns unique values from a dataframe. | plugin | +| [`polars unnest`](/commands/docs/polars_unnest.md) | Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column. | plugin | | [`polars unpivot`](/commands/docs/polars_unpivot.md) | Unpivot a DataFrame from wide to long format. | plugin | | [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | | [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index 6122971fb6..f6033e3eb5 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -2,7 +2,7 @@ title: polars agg-groups categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates an agg_groups expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars agg-groups {flags} ``` diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index e2454b67df..f782533999 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars agg {flags} ...rest``` diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index 86c71f0efb..22c95f942a 100644 --- a/commands/docs/polars_all-false.md +++ b/commands/docs/polars_all-false.md @@ -2,7 +2,7 @@ title: polars all-false categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns true if all values are false. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars all-false {flags} ``` diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index 45337dbf7d..8a6823d4b5 100644 --- a/commands/docs/polars_all-true.md +++ b/commands/docs/polars_all-true.md @@ -2,7 +2,7 @@ title: polars all-true categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns true if all values are true. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars all-true {flags} ``` diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index e3425746f1..21c6e52d92 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Appends a new dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars append {flags} (other)``` diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 165b061f34..b4a3165b43 100644 --- a/commands/docs/polars_arg-max.md +++ b/commands/docs/polars_arg-max.md @@ -2,7 +2,7 @@ title: polars arg-max categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Return index for max value in series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-max {flags} ``` diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index b31cef278b..fb0d482d84 100644 --- a/commands/docs/polars_arg-min.md +++ b/commands/docs/polars_arg-min.md @@ -2,7 +2,7 @@ title: polars arg-min categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Return index for min value in series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-min {flags} ``` diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index b0cd7938ec..e588265f48 100644 --- a/commands/docs/polars_arg-sort.md +++ b/commands/docs/polars_arg-sort.md @@ -2,7 +2,7 @@ title: polars arg-sort categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns indexes for a sorted series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-sort {flags} ``` diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index dd98bada81..13f570610b 100644 --- a/commands/docs/polars_arg-true.md +++ b/commands/docs/polars_arg-true.md @@ -2,7 +2,7 @@ title: polars arg-true categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns indexes where values are true. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-true {flags} ``` diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 2964d6b0f0..ec72c9ba28 100644 --- a/commands/docs/polars_arg-unique.md +++ b/commands/docs/polars_arg-unique.md @@ -2,7 +2,7 @@ title: polars arg-unique categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns indexes for unique values. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-unique {flags} ``` diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index dc3e3a37df..256447c720 100644 --- a/commands/docs/polars_arg-where.md +++ b/commands/docs/polars_arg-where.md @@ -2,7 +2,7 @@ title: polars arg-where categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars arg-where {flags} (column name)``` diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index 3adb8bcd65..01f019fb61 100644 --- a/commands/docs/polars_as-date.md +++ b/commands/docs/polars_as-date.md @@ -2,7 +2,7 @@ title: polars as-date categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts string to date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars as-date {flags} (format)``` diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 4a4aeb3aba..a064e44f39 100644 --- a/commands/docs/polars_as-datetime.md +++ b/commands/docs/polars_as-datetime.md @@ -2,7 +2,7 @@ title: polars as-datetime categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts string to datetime. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars as-datetime {flags} (format)``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index b2465e5c11..c1c678374d 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates an alias expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars as {flags} (Alias name)``` diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index c48efc4a17..f426ac8ed0 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Caches operations in a new LazyFrame. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars cache {flags} ``` diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 34c15212ef..7f1f3e530b 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Cast a column to a different dtype. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars cast {flags} (dtype) (column)``` diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index 4cb5cb2081..a23541059b 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates a named column expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars col {flags} (column name)``` diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index c32d874612..45265cfa92 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars collect {flags} ``` diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index fcfb5b2ae6..f0cc70573c 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Show dataframe columns. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars columns {flags} ``` diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 1d99a7e550..4fdc6f55ed 100644 --- a/commands/docs/polars_concat-str.md +++ b/commands/docs/polars_concat-str.md @@ -2,7 +2,7 @@ title: polars concat-str categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates a concat string expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars concat-str {flags} (separator) (concat expressions)``` diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index 4a83fefd0c..b4df567353 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Concatenate two or more dataframes. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars concat {flags} ...rest``` diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 96f4e9f1b5..608efc1502 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars contains {flags} (pattern)``` diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 93d520a17d..a5b4dd5155 100644 --- a/commands/docs/polars_count-null.md +++ b/commands/docs/polars_count-null.md @@ -2,7 +2,7 @@ title: polars count-null categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Counts null values. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars count-null {flags} ``` diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 6d109dbf74..4fae4c18f9 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns the number of non-null values in the column. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars count {flags} ``` diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 1c0d2a7cbf..dc2947832d 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Cumulative calculation for a column or series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars cumulative {flags} (type)``` diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index fa6b4bd42e..e0bf65d976 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars datepart {flags} (Datepart name)``` diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index 624f0ebcf2..cb872e0b4e 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts a string column into a decimal column usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars decimal {flags} (infer_length)``` diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index 78825cf32c..b803fb6a09 100644 --- a/commands/docs/polars_drop-duplicates.md +++ b/commands/docs/polars_drop-duplicates.md @@ -2,7 +2,7 @@ title: polars drop-duplicates categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Drops duplicate values in dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars drop-duplicates {flags} (subset)``` diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index 4e7c03e54e..387b85367e 100644 --- a/commands/docs/polars_drop-nulls.md +++ b/commands/docs/polars_drop-nulls.md @@ -2,7 +2,7 @@ title: polars drop-nulls categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Drops null values in dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars drop-nulls {flags} (subset)``` diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index e5de084160..4f8b2f502b 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars drop {flags} ...rest``` diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index 0013d09a45..24e5156ee9 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a new dataframe with dummy variables. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars dummies {flags} ``` diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 572a6082c3..071e7eab4d 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars explode {flags} ...rest``` diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 46c32e9c70..7b84bad569 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -2,7 +2,7 @@ title: polars expr-not categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a not expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars expr-not {flags} ``` diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md index 4618b631a6..6f386b00d6 100644 --- a/commands/docs/polars_fetch.md +++ b/commands/docs/polars_fetch.md @@ -2,7 +2,7 @@ title: polars fetch categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Collects the lazyframe to the selected rows. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars fetch {flags} (rows)``` diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index df56403501..2d8ff5b6ff 100644 --- a/commands/docs/polars_fill-nan.md +++ b/commands/docs/polars_fill-nan.md @@ -2,7 +2,7 @@ title: polars fill-nan categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Replaces NaN values with the given expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars fill-nan {flags} (fill)``` diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index 3a25346540..5990ee0929 100644 --- a/commands/docs/polars_fill-null.md +++ b/commands/docs/polars_fill-null.md @@ -2,7 +2,7 @@ title: polars fill-null categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Replaces NULL values with the given expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars fill-null {flags} (fill)``` diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index 203172d554..f190f3f677 100644 --- a/commands/docs/polars_filter-with.md +++ b/commands/docs/polars_filter-with.md @@ -2,7 +2,7 @@ title: polars filter-with categories: | dataframe or lazyframe -version: 0.99.0 +version: 0.100.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars filter-with {flags} (mask or expression)``` diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 3447455453..ab82c7d3c1 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Filter dataframe based in expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars filter {flags} (filter expression)``` diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index cda23bb972..6f95f7cb4e 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Show only the first number of rows or create a first expression usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars first {flags} (rows)``` diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index 5ba119f3c8..367f0915d5 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | An alias for polars explode. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars flatten {flags} ...rest``` diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index 968da80b07..7342b8f85a 100644 --- a/commands/docs/polars_get-day.md +++ b/commands/docs/polars_get-day.md @@ -2,7 +2,7 @@ title: polars get-day categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets day from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-day {flags} ``` diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 0cb1fca266..6a288f8e18 100644 --- a/commands/docs/polars_get-hour.md +++ b/commands/docs/polars_get-hour.md @@ -2,7 +2,7 @@ title: polars get-hour categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets hour from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-hour {flags} ``` diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 74f6a45b07..862f54a2ef 100644 --- a/commands/docs/polars_get-minute.md +++ b/commands/docs/polars_get-minute.md @@ -2,7 +2,7 @@ title: polars get-minute categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets minute from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-minute {flags} ``` diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index 5cd8edb711..964c6cec05 100644 --- a/commands/docs/polars_get-month.md +++ b/commands/docs/polars_get-month.md @@ -2,7 +2,7 @@ title: polars get-month categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets month from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-month {flags} ``` diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index ebab545688..7428f28222 100644 --- a/commands/docs/polars_get-nanosecond.md +++ b/commands/docs/polars_get-nanosecond.md @@ -2,7 +2,7 @@ title: polars get-nanosecond categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets nanosecond from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-nanosecond {flags} ``` diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index c9e21ac6ac..e0e32ddf49 100644 --- a/commands/docs/polars_get-ordinal.md +++ b/commands/docs/polars_get-ordinal.md @@ -2,7 +2,7 @@ title: polars get-ordinal categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets ordinal from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-ordinal {flags} ``` diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index b97dcb109a..8df36be16d 100644 --- a/commands/docs/polars_get-second.md +++ b/commands/docs/polars_get-second.md @@ -2,7 +2,7 @@ title: polars get-second categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets second from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-second {flags} ``` diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 8d12ae072c..41ae6ca44c 100644 --- a/commands/docs/polars_get-week.md +++ b/commands/docs/polars_get-week.md @@ -2,7 +2,7 @@ title: polars get-week categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets week from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-week {flags} ``` diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 20413f7693..08bfc2366b 100644 --- a/commands/docs/polars_get-weekday.md +++ b/commands/docs/polars_get-weekday.md @@ -2,7 +2,7 @@ title: polars get-weekday categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets weekday from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-weekday {flags} ``` diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 1b183ab402..c7db47089f 100644 --- a/commands/docs/polars_get-year.md +++ b/commands/docs/polars_get-year.md @@ -2,7 +2,7 @@ title: polars get-year categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets year from date. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get-year {flags} ``` diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 421956019c..41e92aa5a8 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates dataframe with the selected columns. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars get {flags} ...rest``` diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index 3561264b1a..161a7655d4 100644 --- a/commands/docs/polars_group-by.md +++ b/commands/docs/polars_group-by.md @@ -2,7 +2,7 @@ title: polars group-by categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars group-by {flags} ...rest``` diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 3073766be9..c5ab8a38fd 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Aggregates values into a list. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars implode {flags} ``` diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index d08c6fda6b..6f5624fe6e 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts a string column into a integer column usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars integer {flags} ``` diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index 94796188fa..7fc18e5bc6 100644 --- a/commands/docs/polars_into-df.md +++ b/commands/docs/polars_into-df.md @@ -2,7 +2,7 @@ title: polars into-df categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts a list, table or record into a dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars into-df {flags} ``` @@ -103,18 +104,18 @@ Takes a list of booleans and creates a dataframe Convert to a dataframe and provide a schema ```nu -> {a: 1, b: {a: [1 2 3]}, c: [a b c]}| polars into-df -s {a: u8, b: {a: list}, c: list} -╭───┬───┬───────────────────┬───────────╮ -│ # │ a │ b │ c │ -├───┼───┼───────────────────┼───────────┤ -│ 0 │ 1 │ ╭───┬───────────╮ │ ╭───┬───╮ │ -│ │ │ │ │ ╭───┬───╮ │ │ │ 0 │ a │ │ -│ │ │ │ a │ │ 0 │ 1 │ │ │ │ 1 │ b │ │ -│ │ │ │ │ │ 1 │ 2 │ │ │ │ 2 │ c │ │ -│ │ │ │ │ │ 2 │ 3 │ │ │ ╰───┴───╯ │ -│ │ │ │ │ ╰───┴───╯ │ │ │ -│ │ │ ╰───┴───────────╯ │ │ -╰───┴───┴───────────────────┴───────────╯ +> [[a b c]; [1 {d: [1 2 3]} [10 11 12] ]]| polars into-df -s {a: u8, b: {d: list}, c: list} +╭───┬───┬───────────────────┬────────────╮ +│ # │ a │ b │ c │ +├───┼───┼───────────────────┼────────────┤ +│ 0 │ 1 │ ╭───┬───────────╮ │ ╭───┬────╮ │ +│ │ │ │ │ ╭───┬───╮ │ │ │ 0 │ 10 │ │ +│ │ │ │ a │ │ 0 │ 1 │ │ │ │ 1 │ 11 │ │ +│ │ │ │ │ │ 1 │ 2 │ │ │ │ 2 │ 12 │ │ +│ │ │ │ │ │ 2 │ 3 │ │ │ ╰───┴────╯ │ +│ │ │ │ │ ╰───┴───╯ │ │ │ +│ │ │ ╰───┴───────────╯ │ │ +╰───┴───┴───────────────────┴────────────╯ ``` diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 4a4e86eba5..2df2dbaf26 100644 --- a/commands/docs/polars_into-lazy.md +++ b/commands/docs/polars_into-lazy.md @@ -2,7 +2,7 @@ title: polars into-lazy categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars into-lazy {flags} ``` diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index e847214d46..0248a9eb84 100644 --- a/commands/docs/polars_into-nu.md +++ b/commands/docs/polars_into-nu.md @@ -2,7 +2,7 @@ title: polars into-nu categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars into-nu {flags} ``` diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 7905e6be32..24537dbba2 100644 --- a/commands/docs/polars_is-duplicated.md +++ b/commands/docs/polars_is-duplicated.md @@ -2,7 +2,7 @@ title: polars is-duplicated categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates mask indicating duplicated values. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars is-duplicated {flags} ``` diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index 57aadc0101..09383f3346 100644 --- a/commands/docs/polars_is-in.md +++ b/commands/docs/polars_is-in.md @@ -2,7 +2,7 @@ title: polars is-in categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars is-in {flags} (list)``` diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index 930739061d..d2b751c817 100644 --- a/commands/docs/polars_is-not-null.md +++ b/commands/docs/polars_is-not-null.md @@ -2,7 +2,7 @@ title: polars is-not-null categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates mask where value is not null. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars is-not-null {flags} ``` diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index f5ae9d233f..cbde451b40 100644 --- a/commands/docs/polars_is-null.md +++ b/commands/docs/polars_is-null.md @@ -2,7 +2,7 @@ title: polars is-null categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates mask where value is null. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars is-null {flags} ``` diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index 994eccb095..4018f36ec8 100644 --- a/commands/docs/polars_is-unique.md +++ b/commands/docs/polars_is-unique.md @@ -2,7 +2,7 @@ title: polars is-unique categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates mask indicating unique values. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars is-unique {flags} ``` diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index b8999b309f..c0f677b9ac 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars join {flags} (other) (left_on) (right_on)``` diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 074c01614c..465b4d3676 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars last {flags} (rows)``` diff --git a/commands/docs/polars_len.md b/commands/docs/polars_len.md new file mode 100644 index 0000000000..3c1dbe5221 --- /dev/null +++ b/commands/docs/polars_len.md @@ -0,0 +1,52 @@ +--- +title: polars len +categories: | + dataframe +version: 0.100.0 +dataframe: | + Return the number of rows in the context. This is similar to COUNT(*) in SQL. +usage: | + Return the number of rows in the context. This is similar to COUNT(*) in SQL. +--- + + +# `polars len` for [dataframe](/commands/categories/dataframe.md) + +
Return the number of rows in the context. This is similar to COUNT(*) in SQL.
+ +::: warning This command requires a plugin +The `polars len` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Signature + +```> polars len {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Count the number of rows in the the dataframe. +```nu +> [[a b]; [1 2] [3 4]] | polars into-df | polars select (polars len) | polars collect +╭───┬─────╮ +│ # │ len │ +├───┼─────┤ +│ 0 │ 2 │ +╰───┴─────╯ + +``` + +Creates a last expression from a column +```nu +> polars col a | polars last + +``` diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 1bbecbd778..53d2341004 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates a literal expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars lit {flags} (literal)``` diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index fbef3425c9..50a0978065 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Lowercase the strings in the column. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars lowercase {flags} ``` diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index a249a210df..93fe80f56b 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a max expression or aggregates columns to their max value. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars max {flags} ``` diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 58624a603d..9ab16bc825 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars mean {flags} ``` diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index b745fcf44f..40c888d279 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars median {flags} ``` diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 22df2bcbe8..aeb249899f 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a min expression or aggregates columns to their min value. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars min {flags} ``` diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index 77cc2b42af..54587910a5 100644 --- a/commands/docs/polars_n-unique.md +++ b/commands/docs/polars_n-unique.md @@ -2,7 +2,7 @@ title: polars n-unique categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Counts unique values. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars n-unique {flags} ``` diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 2a558db0b1..11f1dd4691 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Inverts boolean mask. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars not {flags} ``` diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 2f68efb37d..07356ad81a 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars open {flags} (file)``` @@ -34,6 +35,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. - `--skip-rows, - {number}`: Number of rows to skip from file. CSV file - `--columns, - {list}`: Columns to be selected from csv file. CSV and Parquet file - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files + - `--truncate-ragged-lines, -`: Truncate lines that are longer than the schema. CSV file ## Parameters diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index 44afeb912a..f307dec58a 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Completes a when expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars otherwise {flags} (otherwise expression)``` diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index a386f71fac..d9ebda6800 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Pivot a DataFrame from wide to long format. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars pivot {flags} ``` diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index 554eb4c0e9..b61581f73d 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Profile a lazy dataframe. This will run the query and return a record containing the materialized DataFrame and a DataFrame that contains profiling information of each node that is executed. @@ -24,6 +24,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars profile {flags} ``` diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index 9223c8c8f8..6529d12257 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars quantile {flags} (quantile)``` diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index a07eda5efa..61395a89e1 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars query {flags} (sql)``` diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index 953c691db3..606661ef42 100644 --- a/commands/docs/polars_rename.md +++ b/commands/docs/polars_rename.md @@ -2,7 +2,7 @@ title: polars rename categories: | dataframe or lazyframe -version: 0.99.0 +version: 0.100.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars rename {flags} (columns) (new names)``` diff --git a/commands/docs/polars_replace-all.md b/commands/docs/polars_replace-all.md index e7faa6960c..0e4b2170ba 100644 --- a/commands/docs/polars_replace-all.md +++ b/commands/docs/polars_replace-all.md @@ -2,7 +2,7 @@ title: polars replace-all categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars replace-all {flags} ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 8fca1870a1..34af6f802d 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars replace {flags} ``` diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index ca9e8bd379..7cb707baa8 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Reverses the LazyFrame usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars reverse {flags} ``` diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 4aa5c6faa1..9bc58aeac4 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Rolling calculation for a series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars rolling {flags} (type) (window)``` diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index a186ddbcf7..0526a7d606 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Create sample dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars sample {flags} ``` diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index bebe8c1c62..789f75ef3a 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson). usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars save {flags} (path)``` diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 38e23ea8fd..99e729c9d7 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Show schema for a dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars schema {flags} ``` diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 2c6fd86357..4370d39f23 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Selects columns from lazyframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars select {flags} ...rest``` diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index 0f3d5090e6..7c5cb94d8b 100644 --- a/commands/docs/polars_set-with-idx.md +++ b/commands/docs/polars_set-with-idx.md @@ -2,7 +2,7 @@ title: polars set-with-idx categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Sets value in the given index. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars set-with-idx {flags} (value)``` diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 75d2e884f6..859a2fd844 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Sets value where given mask is true. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars set {flags} (value)``` diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index 85c3512079..7e3716f60f 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Shows column and row size for a dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars shape {flags} ``` diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index 5f11f839ce..b4b20042ab 100644 --- a/commands/docs/polars_shift.md +++ b/commands/docs/polars_shift.md @@ -2,7 +2,7 @@ title: polars shift categories: | dataframe or lazyframe -version: 0.99.0 +version: 0.100.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars shift {flags} (period)``` diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index 9c5a47d831..6b2b2e655d 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates new dataframe from a slice of rows. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars slice {flags} (offset) (size)``` diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index 3b01e1fb7e..4af0a35e10 100644 --- a/commands/docs/polars_sort-by.md +++ b/commands/docs/polars_sort-by.md @@ -2,7 +2,7 @@ title: polars sort-by categories: | lazyframe -version: 0.99.0 +version: 0.100.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars sort-by {flags} ...rest``` diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index e73625d581..58872ede9b 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars std {flags} ``` diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index de68dc64ec..1c24308980 100644 --- a/commands/docs/polars_store-get.md +++ b/commands/docs/polars_store-get.md @@ -2,7 +2,7 @@ title: polars store-get categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars store-get {flags} (key)``` diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index ffffd44254..0f208288bb 100644 --- a/commands/docs/polars_store-ls.md +++ b/commands/docs/polars_store-ls.md @@ -2,7 +2,7 @@ title: polars store-ls categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Lists stored polars objects. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars store-ls {flags} ``` diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 77b2cb0f54..ba6ad7f090 100644 --- a/commands/docs/polars_store-rm.md +++ b/commands/docs/polars_store-rm.md @@ -2,7 +2,7 @@ title: polars store-rm categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars store-rm {flags} ...rest``` diff --git a/commands/docs/polars_str-join.md b/commands/docs/polars_str-join.md index 158f2c1cd6..f7b119db1e 100644 --- a/commands/docs/polars_str-join.md +++ b/commands/docs/polars_str-join.md @@ -2,7 +2,7 @@ title: polars str-join categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Concatenates strings within a column or dataframes usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars str-join {flags} (other)``` diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 415980d10f..856e4dc0aa 100644 --- a/commands/docs/polars_str-lengths.md +++ b/commands/docs/polars_str-lengths.md @@ -2,7 +2,7 @@ title: polars str-lengths categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Get lengths of all strings. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars str-lengths {flags} ``` diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index 370a64b10d..310ef500af 100644 --- a/commands/docs/polars_str-slice.md +++ b/commands/docs/polars_str-slice.md @@ -2,7 +2,7 @@ title: polars str-slice categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars str-slice {flags} (start)``` diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index 9471fff74a..f423ef664d 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Formats date based on string rule. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars strftime {flags} (fmt)``` diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index abd9ce6839..449b8324b4 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars sum {flags} ``` diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 0949823eb3..10630200a9 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars summary {flags} ``` diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index 8703fd3066..0a0e110e7a 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Creates new dataframe using the given indices. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars take {flags} (indices)``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index 813c92cd5e..5aef050c42 100644 --- a/commands/docs/polars_unique.md +++ b/commands/docs/polars_unique.md @@ -2,7 +2,7 @@ title: polars unique categories: | dataframe or lazyframe -version: 0.99.0 +version: 0.100.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars unique {flags} ``` diff --git a/commands/docs/polars_unnest.md b/commands/docs/polars_unnest.md new file mode 100644 index 0000000000..597317173f --- /dev/null +++ b/commands/docs/polars_unnest.md @@ -0,0 +1,73 @@ +--- +title: polars unnest +categories: | + dataframe +version: 0.100.0 +dataframe: | + Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column. +usage: | + Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column. +--- + + +# `polars unnest` for [dataframe](/commands/categories/dataframe.md) + +
Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column.
+ +::: warning This command requires a plugin +The `polars unnest` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + + +## Signature + +```> polars unnest {flags} ...rest``` + +## Parameters + + - `...rest`: columns to unnest + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Unnest a dataframe +```nu +> [[id person]; [1 {name: "Bob", age: 36}] [2 {name: "Betty", age: 63}]] + | polars into-df -s {id: i64, person: {name: str, age: u8}} + | polars unnest person + | polars get id name age + | polars sort-by id +╭───┬────┬───────┬─────╮ +│ # │ id │ name │ age │ +├───┼────┼───────┼─────┤ +│ 0 │ 1 │ Bob │ 36 │ +│ 1 │ 2 │ Betty │ 63 │ +╰───┴────┴───────┴─────╯ + +``` + +Unnest a lazy dataframe +```nu +> [[id person]; [1 {name: "Bob", age: 36}] [2 {name: "Betty", age: 63}]] + | polars into-df -s {id: i64, person: {name: str, age: u8}} + | polars into-lazy + | polars unnest person + | polars select (polars col id) (polars col name) (polars col age) + | polars collect + | polars sort-by id +╭───┬────┬───────┬─────╮ +│ # │ id │ name │ age │ +├───┼────┼───────┼─────┤ +│ 0 │ 1 │ Bob │ 36 │ +│ 1 │ 2 │ Betty │ 63 │ +╰───┴────┴───────┴─────╯ + +``` diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index 217ffa9634..1deb948a2f 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | @@ -20,17 +20,17 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars unpivot {flags} ``` ## Flags - - `--index, -i {table}`: column names for unpivoting - - `--on, -o {table}`: column names used as value columns + - `--index, -i {list}`: column names for unpivoting + - `--on, -o {list}`: column names used as value columns - `--variable-name, -r {string}`: optional name for variable column - `--value-name, -l {string}`: optional name for value column - - `--streamable, -t`: Whether or not to use the polars streaming engine. Only valid for lazy dataframes ## Input/output types: diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index 93fe4d7366..78d3eb10f4 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Uppercase the strings in the column. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars uppercase {flags} ``` diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index faa63d2f4c..9a2481693a 100644 --- a/commands/docs/polars_value-counts.md +++ b/commands/docs/polars_value-counts.md @@ -2,7 +2,7 @@ title: polars value-counts categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars value-counts {flags} ``` diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 6376c601e9..73fe57625a 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.99.0 +version: 0.100.0 dataframe: | Create a var expression for an aggregation. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars var {flags} ``` diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index fcd5928219..782bc9012e 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.99.0 +version: 0.100.0 expression: | Creates and modifies a when expression. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars when {flags} (when expression) (then expression)``` diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index 461add2cae..d26c2410ed 100644 --- a/commands/docs/polars_with-column.md +++ b/commands/docs/polars_with-column.md @@ -2,7 +2,7 @@ title: polars with-column categories: | dataframe or lazyframe -version: 0.99.0 +version: 0.100.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_polars`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> polars with-column {flags} ...rest``` diff --git a/commands/docs/port.md b/commands/docs/port.md index f7a55bbb15..442367affe 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.99.0 +version: 0.100.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 14e4917262..c8673918b8 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index b350aa367a..61cd85608d 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 83f53d5420..81c3b37210 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 82b46b8679..33de1c141d 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.99.0 +version: 0.100.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 1be72c5583..3f1902a2b6 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Show all the query commands usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_query`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> query {flags} ``` diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 80094442d0..e77ae782f2 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.99.0 +version: 0.100.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 83da827f70..7d0bb8a5d8 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_query`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> query json {flags} (query)``` diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 3923916736..7f209becca 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.99.0 +version: 0.100.0 network: | execute selector query on html/web usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_query`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> query web {flags} ``` diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index aa6789cd2c..bbab3a2f3d 100644 --- a/commands/docs/query_webpage-info.md +++ b/commands/docs/query_webpage-info.md @@ -2,7 +2,7 @@ title: query webpage-info categories: | network -version: 0.99.0 +version: 0.100.0 network: | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_query`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> query webpage-info {flags} ``` diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index 2976ddec73..338ccb8aa1 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | execute xpath query on xml usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_query`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> query xml {flags} (query)``` diff --git a/commands/docs/random.md b/commands/docs/random.md index 83a59053c2..251ef29f0b 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random value. usage: | diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index ea561e746d..022bdb84d9 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 3585177437..9e0739872d 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 880b83fccd..8aad5f9040 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. usage: | diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index 514bdad2ce..fde9bfdb9d 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index e6d226c1f7..4f0127cd42 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random float within a range [min..max]. usage: | diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index b6c6ac6f67..0e0fa26dd7 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 905ae4ac09..ebe763362d 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.99.0 +version: 0.100.0 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index da74d1273e..395dcf04e7 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 08ac20d70f..b0bf42d489 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index 5a6804c481..cfc0cdbd59 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.99.0 +version: 0.100.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 17dd2e9391..92e4fb292c 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | diff --git a/commands/docs/rename.md b/commands/docs/rename.md index 683661006e..7019a269d8 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index b25c101a21..cbed26cfa5 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.99.0 +version: 0.100.0 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 963b6f4e59..3f36f57290 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 32a6eb28e0..09975704f6 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index ed027973b8..8bb3258470 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 23207933e2..1130684dc3 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index d1513c168c..3970800972 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index f46328fdd9..35f78cdde7 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 8afe8a094e..16bbba56a2 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 9107b50969..bfefac406e 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index ab84cfe213..dc54b76463 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.99.0 +version: 0.100.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index bb6ea90d80..23e568fa64 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index 0de54f96a8..fb9d16817b 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.99.0 +version: 0.100.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index cd8c6754a4..6439507cc4 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.99.0 +version: 0.100.0 core: | Commands for getting info about what is in scope. usage: | diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index b6628b60af..55857de885 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.99.0 +version: 0.100.0 core: | Output info on the aliases in the current scope. usage: | diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index faad08a126..387be508a4 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.99.0 +version: 0.100.0 core: | Output info on the commands in the current scope. usage: | diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index ef9b1e0e0d..e3d661f323 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.99.0 +version: 0.100.0 core: | Output stats on the engine in the current state. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index 4c53872d20..252a4b8483 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.99.0 +version: 0.100.0 core: | Output info on the known externals in the current scope. usage: | diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 72d2a5d862..ed83439c70 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.99.0 +version: 0.100.0 core: | Output info on the modules in the current scope. usage: | diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index d6f1d1912e..07d2c2dd79 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.99.0 +version: 0.100.0 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index 90eaf9a18a..16327b23b0 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 1ba05c110f..52663886e8 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.99.0 +version: 0.100.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 2857ae2a0e..ac056a8ff8 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.99.0 +version: 0.100.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 49cee79f7f..940e403ab0 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.99.0 +version: 0.100.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 0ddaa3ceba..1aca4876cc 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 8571f216be..2716d35354 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 24100449a1..0d2cc8b8dd 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Skip elements of the input until a predicate is true. usage: | diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index ded2bcd74b..70ed08cd2c 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Skip elements of the input while a predicate is true. usage: | diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index fdd2f76adc..311d1d2b15 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index ca6e5f408b..67c3d2640d 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 0bebff91f9..4054ae3188 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index c537b53494..93d15a4a22 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.99.0 +version: 0.100.0 core: | Source the environment from a source file into the current environment. usage: | diff --git a/commands/docs/source.md b/commands/docs/source.md index c79b72a11f..720375e9fa 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.99.0 +version: 0.100.0 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 42d64b59cc..8d971ec694 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Split a record into groups. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 086b6cf545..1910d7ccc2 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | diff --git a/commands/docs/split_cell-path.md b/commands/docs/split_cell-path.md index 5a23ebce91..606dd76828 100644 --- a/commands/docs/split_cell-path.md +++ b/commands/docs/split_cell-path.md @@ -2,7 +2,7 @@ title: split cell-path categories: | conversions -version: 0.99.0 +version: 0.100.0 conversions: | Split a cell-path into its components. usage: | diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 2f84b12843..2fea6dc087 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Split a string into a list of characters. usage: | diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index cd53f7bb08..9d2a0d17e9 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Split a string into multiple columns using a separator. usage: | diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index 73932403b0..fa7a4eaa12 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index e826e0bf24..d47cdfdd8c 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Split a string into multiple rows using a separator. usage: | diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index 6bc5a77cd2..0ec8198d8c 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 398f782c9f..15d313020c 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Open a folder, file or website in the default application or viewer. usage: | diff --git a/commands/docs/stor.md b/commands/docs/stor.md index 9ff4356879..0546af06f2 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.99.0 +version: 0.100.0 database: | Various commands for working with the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index 17e9656156..d2a07161a9 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.99.0 +version: 0.100.0 database: | Create a table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index ee69521340..ac036b8afb 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.99.0 +version: 0.100.0 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index 9fbc7b74f5..6b12a1f401 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.99.0 +version: 0.100.0 database: | Export the in-memory sqlite database to a sqlite database file. usage: | diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index 3773bb4d32..8587ce6be0 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.99.0 +version: 0.100.0 database: | Import a sqlite database file into the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index 075c051429..4af7f436b6 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.99.0 +version: 0.100.0 database: | Insert information into a specified table in the in-memory sqlite database. usage: | @@ -30,9 +30,10 @@ usage: | | ------- | ------ | | nothing | table | | record | table | +| table | table | ## Examples -Insert data the in-memory sqlite database using a data-record of column-name and column-value pairs +Insert data in the in-memory sqlite database using a data-record of column-name and column-value pairs ```nu > stor insert --table-name nudb --data-record {bool1: true, int1: 5, float1: 1.1, str1: fdncred, datetime1: 2023-04-17} @@ -43,3 +44,15 @@ Insert data through pipeline input as a record of column-name and column-value p > {bool1: true, int1: 5, float1: 1.1, str1: fdncred, datetime1: 2023-04-17} | stor insert --table-name nudb ``` + +Insert data through pipeline input as a table literal +```nu +> [[bool1 int1 float1]; [true 5 1.1], [false 8 3.14]] | stor insert --table-name nudb + +``` + +Insert ls entries +```nu +> ls | stor insert --table-name files + +``` diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index d16cdb5cf6..5e8eb420ad 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.99.0 +version: 0.100.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index f23f787a6a..a2b2f8ed76 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.99.0 +version: 0.100.0 database: | Reset the in-memory database by dropping all tables. usage: | diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index 5c019ff81e..626127f1f4 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.99.0 +version: 0.100.0 database: | Update information in a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/str.md b/commands/docs/str.md index 015cd8d370..bbd8b4263b 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Various commands for working with string data. usage: | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index d34e9def22..83375b4dd6 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.99.0 +version: 0.100.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 225c01df40..2fd369d500 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index e35a0d8ba4..2fb1a076d2 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index e434193cd4..2105eea2b8 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index 9615eb2184..fd208bfc12 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index ecd17ffd4a..6f4785f9ff 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.99.0 +version: 0.100.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 3739d39e1d..3fa1994de3 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index 980cd0d21a..359824e207 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.99.0 +version: 0.100.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index aea6a47db3..ad4f80cd91 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index ddba7ab025..277c557298 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.99.0 +version: 0.100.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 928f04f4ab..e6689145bf 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 9538b5860d..7db341bfe0 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.99.0 +version: 0.100.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 11f89c0f3a..c608779a86 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index dcc70269fb..d61a3a6717 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Reverse every string in the pipeline. usage: | diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index 7a35516b6c..8f48259951 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.99.0 +version: 0.100.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index 51d15a496f..6708ac1943 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.99.0 +version: 0.100.0 strings: | Convert a string to snake_case. usage: | diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index c7e14c4cc9..cbc675c4ae 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.99.0 +version: 0.100.0 strings: | Check if an input starts with a string. usage: | diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index 045a7507fe..1ff06775c4 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index b0ec9cbdf4..e6e4acb230 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Get part of a string. Note that the first character of a string is index 0. usage: | diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index c0650af007..3d082da582 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.99.0 +version: 0.100.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index a3864ce44c..d6432ae5bd 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index c5cabad2be..0c47803177 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 9305d3de3b..6e5409608a 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 962088283e..a01cd67999 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index e661856478..ee3f751245 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 40db3e5b54..ec795d8de8 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index 4e60fd6c74..dbc4af66b3 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index 0b255c9cdf..0c5194b976 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the system network interfaces. usage: | diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md index d75ad50c21..1c56e51387 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.99.0 +version: 0.100.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index d8a3861705..157f1a9a56 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.99.0 +version: 0.100.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index fa358f13ef..d9352b410c 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.99.0 +version: 0.100.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 5c441b721e..0a8730510a 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 5b2de2aa38..6c8123d87f 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Take elements of the input until a predicate is true. usage: | diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index 091f162e12..dfc6136e56 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Take elements of the input while a predicate is true. usage: | diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 44302b028e..85fcc2c833 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.99.0 +version: 0.100.0 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 39eb7e02d5..534ad30952 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index f5eb1abd21..7dac9d3e9c 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 31be42019d..007805955b 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Translate structured data to a format. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 15fc7011b8..5d2b31a7db 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index a9f86e6a35..92631e5ee7 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 08b05fb198..e4c3c71dcf 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 14c0bf4054..825b7b3578 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index d5d77f0f58..a6febc8d25 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index a64616d3c4..7088558214 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 2c621db356..b0247488cd 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index 1f974ef1e7..68d0b26490 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert Nu values into plist usage: | @@ -20,6 +20,7 @@ To use this command, you must install and register `nu_plugin_formats`. See the [Plugins](/book/plugins.html) chapter in the book for more information. ::: + ## Signature ```> to plist {flags} ``` diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index cf014236c6..431aa74add 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Converts data into simple text. usage: | @@ -18,6 +18,10 @@ usage: | ```> to text {flags} ``` +## Flags + + - `--no-newline, -n`: Do not append a newline to the end of the text + ## Input/output types: @@ -27,9 +31,16 @@ usage: | ## Examples -Outputs data as simple text +Outputs data as simple text with a trailing newline +```nu +> [1] | to text +1 + +``` + +Outputs data as simple text without a trailing newline ```nu -> 1 | to text +> [1] | to text --no-newline 1 ``` diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 1ffdf09d78..055cdeecc4 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index fd28c50aa6..f10e408cc9 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 43352f79a9..119bb686f3 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 77a5ee46ea..b255b16ee6 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.99.0 +version: 0.100.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index ad7f9afc49..415f2a7026 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Creates one or more files. usage: | @@ -24,6 +24,7 @@ usage: | - `--modified, -m`: change the modification time of the file or directory. If no reference file/directory is given, the current time is used - `--access, -a`: change the access time of the file or directory. If no reference file/directory is given, the current time is used - `--no-create, -c`: do not create the file if it does not exist + - `--no-deref, -s`: do not follow symlinks ## Parameters diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index d718b46872..39a18110bb 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | diff --git a/commands/docs/try.md b/commands/docs/try.md index 95d0f39d6f..ba5b23b40e 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.99.0 +version: 0.100.0 core: | Try to run a block, if it fails optionally run a catch closure. usage: | diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 6c3d385a15..14c773bcb5 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.99.0 +version: 0.100.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index a74c54e211..876fafab16 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 9d7d1b0d8a..9178c87b52 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.99.0 +version: 0.100.0 system: | Print certain system information using uutils/coreutils uname. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index f7a74e7827..e1589209be 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Return the distinct values in the input by the given column(s). usage: | diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index 92b4ea661f..92bd5bdea3 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 4f92459a7a..f16e570edb 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Update an existing column to have a new value. usage: | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index a2f5dd2bb3..afd8e85510 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 436912df5f..0d0f153697 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | diff --git a/commands/docs/url.md b/commands/docs/url.md index 82d7a23d58..36c320ad9d 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.99.0 +version: 0.100.0 network: | Various commands for working with URLs. usage: | @@ -36,4 +36,5 @@ You must use one of the following subcommands. Using this command as-is will onl | [`url decode`](/commands/docs/url_decode.md) | Converts a percent-encoded web safe string to a string. | built-in | | [`url encode`](/commands/docs/url_encode.md) | Converts a string to a percent encoded web safe string. | built-in | | [`url join`](/commands/docs/url_join.md) | Converts a record to url. | built-in | -| [`url parse`](/commands/docs/url_parse.md) | Parses a url. | built-in | \ No newline at end of file +| [`url parse`](/commands/docs/url_parse.md) | Parses a url. | built-in | +| [`url split-query`](/commands/docs/url_split-query.md) | Converts query string into table applying percent-decoding. | built-in | \ No newline at end of file diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 5d80f081c4..12813de622 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.99.0 +version: 0.100.0 network: | Converts record or table into query string applying percent-encoding. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------ | ------ | -| record | string | -| table | string | +| input | output | +| --------------------------- | ------ | +| record | string | +| table\ | string | ## Examples Outputs a query string representing the contents of this record @@ -33,14 +33,20 @@ Outputs a query string representing the contents of this record mode=normal&userid=31415 ``` -Outputs a query string representing the contents of this 1-row table +Outputs a query string representing the contents of this record, with a value that needs to be url-encoded ```nu -> [[foo bar]; ["1" "2"]] | url build-query -foo=1&bar=2 +> {a:"AT&T", b: "AT T"} | url build-query +a=AT%26T&b=AT+T ``` -Outputs a query string representing the contents of this record +Outputs a query string representing the contents of this record, "exploding" the list into multiple parameters ```nu -> {a:"AT&T", b: "AT T"} | url build-query -a=AT%26T&b=AT+T +> {a: ["one", "two"], b: "three"} | url build-query +a=one&a=two&b=three +``` + +Outputs a query string representing the contents of this table containing key-value pairs +```nu +> [[key, value]; [a, one], [a, two], [b, three], [a, four]] | url build-query +a=one&a=two&b=three&a=four ``` diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index b6be08480d..a5c7138c7b 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Converts a percent-encoded web safe string to a string. usage: | diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index e74610546d..c9f73b5d51 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.99.0 +version: 0.100.0 strings: | Converts a string to a percent encoded web safe string. usage: | diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index 8e75985d65..4bd595c762 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.99.0 +version: 0.100.0 network: | Converts a record to url. usage: | @@ -27,7 +27,7 @@ usage: | ## Examples -Outputs a url representing the contents of this record +Outputs a url representing the contents of this record, `params` and `query` fields must be equivalent ```nu > { "scheme": "http", @@ -47,6 +47,20 @@ Outputs a url representing the contents of this record http://www.pixiv.net/member_illust.php?mode=medium&illust_id=99260204 ``` +Outputs a url representing the contents of this record, "exploding" the list in `params` into multiple parameters +```nu +> { + "scheme": "http", + "username": "user", + "password": "pwd", + "host": "www.pixiv.net", + "port": "1234", + "params": {a: ["one", "two"], b: "three"}, + "fragment": "" + } | url join +http://user:pwd@www.pixiv.net:1234?a=one&a=two&b=three +``` + Outputs a url representing the contents of this record ```nu > { diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index ec55106f65..d2993e1e0c 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.99.0 +version: 0.100.0 network: | Parses a url. usage: | @@ -34,20 +34,23 @@ usage: | Parses a url ```nu -> 'http://user123:pass567@www.example.com:8081/foo/bar?param1=section&p2=&f[name]=vldc#hello' | url parse -╭──────────┬─────────────────────────────────╮ -│ scheme │ http │ -│ username │ user123 │ -│ password │ pass567 │ -│ host │ www.example.com │ -│ port │ 8081 │ -│ path │ /foo/bar │ -│ query │ param1=section&p2=&f[name]=vldc │ -│ fragment │ hello │ -│ │ ╭─────────┬─────────╮ │ -│ params │ │ param1 │ section │ │ -│ │ │ p2 │ │ │ -│ │ │ f[name] │ vldc │ │ -│ │ ╰─────────┴─────────╯ │ -╰──────────┴─────────────────────────────────╯ +> 'http://user123:pass567@www.example.com:8081/foo/bar?param1=section&p2=&f[name]=vldc&f[no]=42#hello' | url parse +╭──────────┬──────────────────────────────────────────╮ +│ scheme │ http │ +│ username │ user123 │ +│ password │ pass567 │ +│ host │ www.example.com │ +│ port │ 8081 │ +│ path │ /foo/bar │ +│ query │ param1=section&p2=&f[name]=vldc&f[no]=42 │ +│ fragment │ hello │ +│ │ ╭───┬─────────┬─────────╮ │ +│ params │ │ # │ key │ value │ │ +│ │ ├───┼─────────┼─────────┤ │ +│ │ │ 0 │ param1 │ section │ │ +│ │ │ 1 │ p2 │ │ │ +│ │ │ 2 │ f[name] │ vldc │ │ +│ │ │ 3 │ f[no] │ 42 │ │ +│ │ ╰───┴─────────┴─────────╯ │ +╰──────────┴──────────────────────────────────────────╯ ``` diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md new file mode 100644 index 0000000000..6e2a3889d4 --- /dev/null +++ b/commands/docs/url_split-query.md @@ -0,0 +1,65 @@ +--- +title: url split-query +categories: | + network +version: 0.100.0 +network: | + Converts query string into table applying percent-decoding. +usage: | + Converts query string into table applying percent-decoding. +--- + + +# `url split-query` for [network](/commands/categories/network.md) + +
Converts query string into table applying percent-decoding.
+ +## Signature + +```> url split-query {flags} ``` + + +## Input/output types: + +| input | output | +| ------ | --------------------------------- | +| string | table\ | + +## Examples + +Outputs a table representing the contents of this query string +```nu +> "mode=normal&userid=31415" | url split-query +╭───┬────────┬────────╮ +│ # │ key │ value │ +├───┼────────┼────────┤ +│ 0 │ mode │ normal │ +│ 1 │ userid │ 31415 │ +╰───┴────────┴────────╯ + +``` + +Outputs a table representing the contents of this query string, url-decoding the values +```nu +> "a=AT%26T&b=AT+T" | url split-query +╭───┬─────┬───────╮ +│ # │ key │ value │ +├───┼─────┼───────┤ +│ 0 │ a │ AT&T │ +│ 1 │ b │ AT T │ +╰───┴─────┴───────╯ + +``` + +Outputs a table representing the contents of this query string +```nu +> "a=one&a=two&b=three" | url split-query +╭───┬─────┬───────╮ +│ # │ key │ value │ +├───┼─────┼───────┤ +│ 0 │ a │ one │ +│ 1 │ a │ two │ +│ 2 │ b │ three │ +╰───┴─────┴───────╯ + +``` diff --git a/commands/docs/use.md b/commands/docs/use.md index b138d31baf..78e9e4d03a 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.99.0 +version: 0.100.0 core: | Use definitions from a module, making them available in your shell. usage: | diff --git a/commands/docs/values.md b/commands/docs/values.md index 4b59af820d..c71717aa31 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Given a record or table, produce a list of its columns' values. usage: | diff --git a/commands/docs/version.md b/commands/docs/version.md index b54ab2d929..265693f0fe 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.99.0 +version: 0.100.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 5fe0a35b78..aef24356ab 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 0809fe56dd..a4a9dfcc2c 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_ir.md b/commands/docs/view_ir.md index c6cf46ff50..98dc9db00b 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | View the compiled IR code for a block of code. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index 28958be3cd..4c1673ae24 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index af16ad6e6a..62a82dac79 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.99.0 +version: 0.100.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index eb512acbd8..62bff49289 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.99.0 +version: 0.100.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | diff --git a/commands/docs/where.md b/commands/docs/where.md index d987cf62c6..36d8f05cd4 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index bb725be32b..fcf012187d 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.99.0 +version: 0.100.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index f0196ec387..2628996dc8 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.99.0 +version: 0.100.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index e85f1393c7..31d3a6c89a 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.99.0 +version: 0.100.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 17e696d9fb..da005e47b0 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index 031d337832..67bbc55d86 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.99.0 +version: 0.100.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index cb1a02ff74..b0a762cbd2 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 5f2d6c30a9..580cb488ed 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.99.0 +version: 0.100.0 filters: | Combine a stream with the input. usage: |