diff --git a/commands/docs/alias.md b/commands/docs/alias.md index c99daa9a9f5..7eb533a7308 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.96.0 +version: 0.97.1 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 6234a11e0ea..749c1cd0ff3 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.96.0 +version: 0.97.1 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 afd828a181d..9775897f760 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.96.0 +version: 0.97.1 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 ebd4b6463e1..e1676757705 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.96.0 +version: 0.97.1 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 05f3612cb9a..44102049267 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.96.0 +version: 0.97.1 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 3f233e1c315..78f54a753f8 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index b17336c667d..81518ce0541 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.96.0 +version: 0.97.1 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 f2c94884f9e..5ae300044b5 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 47821d940b0..bb541d4c797 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index cb1a5e369d2..acb0bb58adc 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.96.0 +version: 0.97.1 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 40db2548182..37239d3f613 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.96.0 +version: 0.97.1 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 35f74bd6d6d..ce44abee0f0 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.96.0 +version: 0.97.1 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 56f89852d2f..b99704da10a 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.96.0 +version: 0.97.1 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 cdd33b591ed..0b872c1e198 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.96.0 +version: 0.97.1 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 eaa6b975144..3cf709e3a4f 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.96.0 +version: 0.97.1 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 23c1964cfef..9e1ed00e4a7 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.96.0 +version: 0.97.1 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 e119c97b9e8..1f8d493d22a 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.96.0 +version: 0.97.1 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 4eb4a93911a..4f585e371ad 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.96.0 +version: 0.97.1 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index cd47cb90c09..0d4814cbbfc 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.96.0 +version: 0.97.1 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 9d34d5ac9a5..74eab4fb71e 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index bc704d358a2..963680ad115 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index c69619eb464..4d4a48a646c 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 7eab2090c56..511daabccb4 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index 8901fb4a630..c6a3d207ddd 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.96.0 +version: 0.97.1 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 8d5672d1d1f..90cfb48aa19 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.96.0 +version: 0.97.1 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 7e5ca08b7e0..446a9235905 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.96.0 +version: 0.97.1 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 279d16151ec..fd521bb2b2e 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.96.0 +version: 0.97.1 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 4fa2eedd4f6..26d84b73609 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index f80152f4937..6d7712e480d 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.96.0 +version: 0.97.1 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 2ce16176b1d..8ad498c1193 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.96.0 +version: 0.97.1 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 ae611e4fc31..383bfee9fbc 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.96.0 +version: 0.97.1 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 5749efaea6f..3a65badd449 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.96.0 +version: 0.97.1 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 0935bc6fb76..d381a365e0d 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Change directory. usage: | @@ -41,7 +41,7 @@ Change to your home directory ``` -Change to the previous working directory ($OLDPWD) +Change to the previous working directory (same as "cd $env.OLDPWD") ```nu > cd - @@ -52,3 +52,15 @@ Changing directory with a custom command requires 'def --env' > def --env gohome [] { cd ~ } ``` + +Move two directories up in the tree (the parent directory's parent). Additional dots can be added for additional levels. +```nu +> cd ... + +``` + +The cd command itself is often optional. Simply entering a path to a directory will cd to it. +```nu +> /home + +``` diff --git a/commands/docs/char.md b/commands/docs/char.md index 3581017edd7..6e1f994cc25 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index b8e14dc2aa3..37654f5e3db 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.96.0 +version: 0.97.1 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 99a4a28dd0e..17b36846a69 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index f1854ece84a..dbb7b5cba58 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 3cef8a28ba9..87a77858cae 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.96.0 +version: 0.97.1 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 8f7ee2a9941..b416371f61a 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.96.0 +version: 0.97.1 core: | View the current command line input buffer. usage: | diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index a2b6417b267..b35077a955e 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.96.0 +version: 0.97.1 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 8083e0a16c1..7aab1f6f1bc 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.96.0 +version: 0.97.1 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 844bb257d6c..6d1144fba1a 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.96.0 +version: 0.97.1 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index d3ecc545fac..05bfeb032b4 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 16622370b22..60d981b6a14 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.96.0 +version: 0.97.1 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 706a9984f52..786e3dd2921 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.96.0 +version: 0.97.1 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index e9d2226247a..9005802789f 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.96.0 +version: 0.97.1 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 2e5c7f33688..8c3845ec03f 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.96.0 +version: 0.97.1 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 65c0dbe7a3c..6ab0a7c4437 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.96.0 +version: 0.97.1 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 a3c179d1845..4da28e10056 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.96.0 +version: 0.97.1 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 0f7940eae6e..24a2afa7406 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.96.0 +version: 0.97.1 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index d7aca1f1892..4a1ea1187ac 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Copy files using uutils/coreutils cp. usage: | @@ -73,18 +73,24 @@ Move many files into a directory Copy only if source file is newer than target file ```nu -> cp -u a b +> cp -u myfile newfile ``` Copy file preserving mode and timestamps attributes ```nu -> cp --preserve [ mode timestamps ] a b +> cp --preserve [ mode timestamps ] myfile newfile ``` Copy file erasing all attributes ```nu -> cp --preserve [] a b +> cp --preserve [] myfile newfile + +``` + +Copy file to a directory three levels above its current location +```nu +> cp myfile .... ``` diff --git a/commands/docs/date.md b/commands/docs/date.md index fbdcf6075f2..1ad407a2ec2 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.96.0 +version: 0.97.1 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index b25ecf10a1a..4fb224116d4 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.96.0 +version: 0.97.1 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index f531a7c44cc..ab9ba253d21 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.96.0 +version: 0.97.1 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 0c72b6e5a49..e63b38e2611 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.96.0 +version: 0.97.1 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index fc3c82377a1..799b4bf0208 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.96.0 +version: 0.97.1 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index 33eb3444e34..d2640fe6bf3 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.96.0 +version: 0.97.1 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 a89157205f0..0bbabe8f996 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.96.0 +version: 0.97.1 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 7608a1dec99..3001985e81d 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.96.0 +version: 0.97.1 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 3445746af8c..55d86ea0eb2 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index a16b4391c65..3c68ba3acd1 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 9fac4601d3d..617b14723b7 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 3e51b25cecb..5cfe92f87e4 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 974a22a3048..b009de59ef6 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.96.0 +version: 0.97.1 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 604a55e9004..d45114c73bc 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index 4a284b0bd17..dae61404a31 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.96.0 +version: 0.97.1 core: | Define a custom command. usage: | @@ -68,6 +68,12 @@ Define a custom wrapper for an external command spamspam ``` +Define a custom command with a type signature. Passing a non-int value will result in an error +```nu +> def only_int []: int -> int { $in }; 42 | only_int +42 +``` + ## Notes This command is a parser keyword. For details, check: https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file diff --git a/commands/docs/default.md b/commands/docs/default.md index 6144b214df6..eebd1ccc7bf 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,17 +2,17 @@ title: default categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | - Sets a default row's column if missing. + Sets a default value if a row's column is missing or null. usage: | - Sets a default row's column if missing. + Sets a default value if a row's column is missing or null. --- # `default` for [filters](/commands/categories/filters.md) -
Sets a default row's column if missing.
+
Sets a default value if a row's column is missing or null.
## Signature @@ -55,3 +55,15 @@ Replace the `null` value in a list ╰───┴───╯ ``` + +Replace the missing value in the "a" column of a list +```nu +> [{a:1 b:2} {b:1}] | default 'N/A' a +╭───┬─────┬───╮ +│ # │ a │ b │ +├───┼─────┼───┤ +│ 0 │ 1 │ 2 │ +│ 1 │ N/A │ 1 │ +╰───┴─────┴───╯ + +``` diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 5e8c66a91c2..f1053892bcc 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.96.0 +version: 0.97.1 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 9a559029678..9ead63a0938 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index 7b4df1c4f6d..0b196ac4730 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.96.0 +version: 0.97.1 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 63f6e21adfb..490cce17e25 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.96.0 +version: 0.97.1 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 d2787bda098..3d6560dd90e 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.96.0 +version: 0.97.1 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 02d1d7224a0..598e9ee1427 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index d7ac79d792e..86ddaac88b1 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index edccd295331..b7aec317e84 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.96.0 +version: 0.97.1 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 6aaaed37dcf..6281bdd7749 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.96.0 +version: 0.97.1 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 dff9bb932b8..b94d408bad2 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.96.0 +version: 0.97.1 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 7cd25734060..fa1a92d3e8e 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 061a267b9e4..bfb65c99b9d 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.96.0 +version: 0.97.1 hash: | Encode a string or binary value using Base64. usage: | diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index ab442af1fcf..eed4c0eb443 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Encode a binary value using hex. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index d35a8945bd0..8ac73fd6a1c 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 220e2cfeb82..90c1b2e46e6 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.96.0 +version: 0.97.1 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 28bf54ae5e9..efaf87e5ddd 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.96.0 +version: 0.97.1 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 d9d11011c75..99e0ee14dbb 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.96.0 +version: 0.97.1 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 6780a2d5a93..2c6f8d1e68f 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.96.0 +version: 0.97.1 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 6313a2fd43e..743c53ea4a4 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 6adbbe16a07..205754cbb46 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.96.0 +version: 0.97.1 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 59e0747ccf1..4034c905b3d 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.96.0 +version: 0.97.1 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 e4bcd92bc06..c30d5d8f80c 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.96.0 +version: 0.97.1 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 c78364fc9ff..42ab3ebadb9 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.96.0 +version: 0.97.1 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 92a014f697a..3e5ecd76c16 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.96.0 +version: 0.97.1 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 80e5bd7e6a6..c35cc0578ed 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.96.0 +version: 0.97.1 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 0e7346ba58e..cc725bbc981 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.96.0 +version: 0.97.1 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 ecbeba3f582..c224d8de655 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.96.0 +version: 0.97.1 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 3a655685cd1..ea1fa0bf7f0 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.96.0 +version: 0.97.1 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 22f6ae9eec5..464e735a70f 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.96.0 +version: 0.97.1 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 27cf8c4b76c..3355b171fd2 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 36db4c4719e..829fedc9f76 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 6726c4a9dce..ddb527656e6 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index eaacebeb21c..97cc65f21e6 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.96.0 +version: 0.97.1 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 9de875855ce..3c84475af61 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index 1b05921c5e0..deb8fbf99d4 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index be0e34f91ac..b0983366361 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.96.0 +version: 0.97.1 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index f1891668191..ab7dad9898f 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index e785ce24788..db36a4a95ce 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.96.0 +version: 0.97.1 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 ab7a1b9b2ed..90866e6dfcc 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.96.0 +version: 0.97.1 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 3553c11d9b5..f679fe89b28 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.96.0 +version: 0.97.1 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 4e696798be1..13e9548beec 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 68c2638cddd..082b8d68277 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse a string or binary data into structured data. usage: | @@ -41,6 +41,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`from msgpackz`](/commands/docs/from_msgpackz.md) | Convert brotli-compressed MessagePack data into Nu values. | built-in | | [`from nuon`](/commands/docs/from_nuon.md) | Convert from nuon to structured data. | built-in | | [`from ods`](/commands/docs/from_ods.md) | Parse OpenDocument Spreadsheet(.ods) data and create table. | built-in | +| [`from plist`](/commands/docs/from_plist.md) | Convert plist to Nushell values | plugin | | [`from ssv`](/commands/docs/from_ssv.md) | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | built-in | | [`from toml`](/commands/docs/from_toml.md) | Parse text as .toml and create record. | built-in | | [`from tsv`](/commands/docs/from_tsv.md) | Parse text as .tsv and create table. | built-in | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index d454422fddd..fb6f9611770 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index 3894e88b9a8..4b72b8defc1 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .eml and create record. usage: | @@ -14,8 +14,10 @@ usage: |
Parse text as .eml and create record.
-::: warning -Command `from eml` resides in [plugin](/book/plugins.html) [`nu_plugin_formats`](https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats +::: warning This command requires a plugin +The `from eml` command resides in the `formats` plugin. +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 diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index fe70b28584a..eb6636edec3 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .ics and create table. usage: | @@ -14,8 +14,10 @@ usage: |
Parse text as .ics and create table.
-::: warning -Command `from ics` resides in [plugin](/book/plugins.html) [`nu_plugin_formats`](https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats +::: warning This command requires a plugin +The `from ics` command resides in the `formats` plugin. +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 diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 5bdd56639f2..2b8d53d5219 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .ini and create table. usage: | @@ -14,8 +14,10 @@ usage: |
Parse text as .ini and create table.
-::: warning -Command `from ini` resides in [plugin](/book/plugins.html) [`nu_plugin_formats`](https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats +::: warning This command requires a plugin +The `from ini` command resides in the `formats` plugin. +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 diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 216a259bfa8..1fd36098936 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 045702e9ff4..7b21daa62ea 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index 394e7519987..5896b0af17a 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.96.0 +version: 0.97.1 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 158b7c778fe..52b9875fd5f 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 15495fda0fa..709e8e5780a 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_plist.md b/commands/docs/from_plist.md new file mode 100644 index 00000000000..a837b269562 --- /dev/null +++ b/commands/docs/from_plist.md @@ -0,0 +1,49 @@ +--- +title: from plist +categories: | + formats +version: 0.97.1 +formats: | + Convert plist to Nushell values +usage: | + Convert plist to Nushell values +--- + + +# `from plist` for [formats](/commands/categories/formats.md) + +
Convert plist to Nushell values
+ +::: warning This command requires a plugin +The `from plist` command resides in the `formats` plugin. +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} ``` + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Convert a table into a plist file +```nu +> ' + + + + a + 3 + +' | from plist +╭───┬───╮ +│ a │ 3 │ +╰───┴───╯ +``` diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index b51f7df33d9..6e80d26f711 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.96.0 +version: 0.97.1 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 9f6bfcf090a..210e3977cdc 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 089298bc91d..9ae6d4bd749 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 536aa14bfc7..04ff16709f1 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index 23e0c276dc6..1339f789235 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .vcf and create table. usage: | @@ -14,8 +14,10 @@ usage: |
Parse text as .vcf and create table.
-::: warning -Command `from vcf` resides in [plugin](/book/plugins.html) [`nu_plugin_formats`](https://crates.io/crates/nu_plugin_formats). To use this command, you must install/compile and register nu_plugin_formats +::: warning This command requires a plugin +The `from vcf` command resides in the `formats` plugin. +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 diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index f267c374e7c..1ae7bf97253 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.96.0 +version: 0.97.1 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 532c405f19d..a833c0e2516 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 31a84695334..8748eba4ada 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.96.0 +version: 0.97.1 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 e0c28ca9914..a005042bce7 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index 30bb6aaa06e..e3737459bf4 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.96.0 +version: 0.97.1 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 ea94fff2999..1d021909b02 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index da4ae858f1b..979b2de6807 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 d6a070d1e42..63aaef35a78 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.96.0 +version: 0.97.1 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 bd13f1d696e..eaf576a8905 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/group.md b/commands/docs/group.md index 147687c420d..81e144f25e3 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 5d48d904583..80b04b9a1f3 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.96.0 +version: 0.97.1 prompt: | Get the git status of a repo usage: | @@ -14,6 +14,12 @@ usage: |
Get the git status of a repo
+::: warning This command requires a plugin +The `gstat` command resides in the `gstat` plugin. +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 17cc2b260dc..d4d2a032f62 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.96.0 +version: 0.97.1 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 5c7090575e8..d6d3be94b4a 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.96.0 +version: 0.97.1 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 746f364c8c5..6110ae3be6a 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.96.0 +version: 0.97.1 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index c369d998b1f..99814def474 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.96.0 +version: 0.97.1 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 4c1d6d4a267..3a9a12fd494 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.96.0 +version: 0.97.1 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 b69aafaed55..acffbeca135 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 1e684aaf91d..3aa460e07bf 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 4c238b3ff81..11ce10919a7 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 57148ecf215..76f149b23d8 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 8d8be61b2b5..c0257441225 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 3c85ed80fb3..a62c7cafe7e 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.96.0 +version: 0.97.1 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 4816a6ad663..428ff07f107 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.96.0 +version: 0.97.1 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index f85493c31ae..22f782926e1 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.96.0 +version: 0.97.1 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index e1cbf703488..a4ba7e284b0 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.96.0 +version: 0.97.1 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 f8bc6ac0c07..b7eb8f5fd4f 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.96.0 +version: 0.97.1 history: | Get the command history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index dbf029d51c0..c7c70c23f32 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.96.0 +version: 0.97.1 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 9960891bc1a..608c188ac7e 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.96.0 +version: 0.97.1 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index abd7b74cc50..4d82f4aff7c 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.96.0 +version: 0.97.1 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index ea920802b5f..54837dc4979 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.96.0 +version: 0.97.1 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 705bf239180..379d306fbf9 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.96.0 +version: 0.97.1 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index fa65891492c..0170719d52a 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.96.0 +version: 0.97.1 network: | Requests permitted communication options for a given URL. usage: | diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 6583412e613..2fda1a35fca 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.96.0 +version: 0.97.1 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 5bf5e274247..ee90bfca5fa 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.96.0 +version: 0.97.1 network: | Post a body to a URL. usage: | @@ -75,5 +75,11 @@ Post JSON content from a pipeline to example.com ``` +Upload a file to example.com +```nu +> http post --content-type multipart/form-data https://www.example.com { audio: (open -r file.mp3) } + +``` + ## Notes Performs HTTP POST operation. \ No newline at end of file diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 38632a16986..9fe0eed54a6 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.96.0 +version: 0.97.1 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index a2edeee37fa..4eb9a73438f 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.96.0 +version: 0.97.1 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index e5a8798b159..112ff7ca140 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.96.0 +version: 0.97.1 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 c5cda2c5238..44d6d2e812a 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.96.0 +version: 0.97.1 default: | Increment a value or version. Optionally use the column of a table. usage: | @@ -14,6 +14,12 @@ usage: |
Increment a value or version. Optionally use the column of a table.
+::: warning This command requires a plugin +The `inc` command resides in the `inc` plugin. +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 85661b52588..1eb3acae532 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index 56f42cd30b0..3037ccd5c69 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index ad16fe877a3..d88f6c8a103 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 2a12f5e6abe..2cbbb85f74c 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.96.0 +version: 0.97.1 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 d0b9ac292f5..b14884696b8 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 6fa4f54f1af..c1be8d5b6b8 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.96.0 +version: 0.97.1 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 ae8154c5ea1..9e2eeb36cd3 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.96.0 +version: 0.97.1 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 a04db0b3de0..254169f00e8 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index 46a69ec9cb4..b0d86fd721b 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index b66da942bd6..627b7889604 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 67fec697186..a999d92db8f 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.96.0 +version: 0.97.1 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 8ed09ed93ab..daf90b848b0 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert text or timestamp into a datetime. usage: | diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index c9d446a44f5..f270185f058 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 4086162f592..bc868646d0e 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index cb7ed1a4907..fc3a3b5343e 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index e22072dd929..6d80e1dd90e 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 53c1ece5480..a3753f84b74 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index 44dd16a8a77..b87150535d8 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index bc7c807814e..288afbbd9ea 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index ec6f52f7e9e..6c27f10372b 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.96.0 +version: 0.97.1 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index a5711d4826d..a745258ca59 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Infer nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 1c792fec1cf..84269037717 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.96.0 +version: 0.97.1 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 b31a18c6707..55f3a47abcc 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 8f100ab69c8..cd2a34fcd61 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.96.0 +version: 0.97.1 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 9eb6ec08156..34d34b610aa 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index 1973e16d1f0..8fcb973b44d 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.96.0 +version: 0.97.1 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 b501d3472bd..0ae81e159a8 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 26791c11883..aeb3027e820 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 8d2078774bc..be22b585795 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 0ab85ffe39b..f76a1d1ceed 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.96.0 +version: 0.97.1 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 52eb44670c6..3427befd9ef 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index c64bd9ecfff..20517a457d1 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 200efa38d42..3e3ebb6a93b 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.96.0 +version: 0.97.1 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 ac172d2ee29..e51f99ffed4 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Count the number of items in an input list or rows in a table. usage: | diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 5a3f77f88d8..2f9511ac4ba 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.96.0 +version: 0.97.1 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 ccbd8dcef1d..ee67488845b 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.96.0 +version: 0.97.1 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 057b59fe702..0ac89586f47 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 8fa59ea13c0..b745664bb4a 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 017b8a5621e..c4c99697dff 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.96.0 +version: 0.97.1 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 4b97ccb47e0..9cee3c1de0d 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 446f94462a5..21c907d0048 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.96.0 +version: 0.97.1 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 02c0f0083d9..bdcd56e28dd 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.96.0 +version: 0.97.1 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 5f04a8a67a2..4887a0e2bc3 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 10d2e401286..6c63d682bb5 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index dc4dce5e2f7..b8b4d0c4594 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.96.0 +version: 0.97.1 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 0b537cadada..b36960d95a1 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 2d744753109..da18b30bb0c 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.96.0 +version: 0.97.1 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 2257ecdd7e0..c75395d8811 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index df3d9ed9c6a..a9d7ee81093 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.96.0 +version: 0.97.1 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 51ff05387b1..f4d403e1c37 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.96.0 +version: 0.97.1 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 7afe9fbe5ba..b9af5130afb 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.96.0 +version: 0.97.1 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 181ea5c2286..ab7e58a146a 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 09a8e74eb94..50d8cfc52c4 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 7f2eebc4a32..d4b54ff154c 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.96.0 +version: 0.97.1 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 a495b744683..f43baa081f7 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.96.0 +version: 0.97.1 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 8939859b124..6d7fdd84cef 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 4ab4b12888f..a4b3e6b8e62 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 1b6740ffd51..33b622e70f1 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.96.0 +version: 0.97.1 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 18f0f67a2ae..b41ef06637a 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.96.0 +version: 0.97.1 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 b8d28fde7df..f9c95d0cdaa 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.96.0 +version: 0.97.1 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 9da401cc586..cb2131ed74f 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.96.0 +version: 0.97.1 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 0bbf4a153ef..7bb2d848c9d 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.96.0 +version: 0.97.1 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 0469ba36c40..8e609006ec1 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.96.0 +version: 0.97.1 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 a9bcd305a2f..99e19bf176d 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 17df99fed61..11a8df6a7f2 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 71a2928c176..2372807dc61 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.96.0 +version: 0.97.1 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 325500e270e..72dfacdf039 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.96.0 +version: 0.97.1 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 cfcb7627875..3d657b67c7f 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.96.0 +version: 0.97.1 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 bb951026146..4e130ce0783 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index a99c36175cf..3f7bce5bfc9 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.96.0 +version: 0.97.1 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 626ee57df49..142695df793 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.96.0 +version: 0.97.1 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 a1655187d74..1e52ef0ab6a 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.96.0 +version: 0.97.1 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 135d31058c4..136b721ce2c 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index d4063ce2172..2fc565480b6 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index ba61132a422..7ea37165519 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 6ad47a503cd..a1f4f9d922a 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 1d04ea60552..3eca518f219 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.96.0 +version: 0.97.1 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index eaccf9b4d67..5c6c4f74697 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index 88811232e01..6b9aba049b1 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.96.0 +version: 0.97.1 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index a5c2aa0009b..7cf9a5a0efa 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Move files or directories using uutils/coreutils mv. usage: | @@ -24,6 +24,7 @@ usage: | - `--verbose, -v`: explain what is being done. - `--progress, -p`: display a progress bar - `--interactive, -i`: prompt before overwriting + - `--update, -u`: move and overwrite only when the SOURCE file is newer than the destination file or when the destination file is missing - `--no-clobber, -n`: do not overwrite an existing file ## Parameters @@ -51,8 +52,20 @@ Move a file into a directory ``` +Move only if source file is newer than target file +```nu +> mv -u new/test.txt old/ + +``` + Move many files into a directory ```nu > mv *.txt my/subdirectory ``` + +Move a file into the "my" directory two levels up in the directory tree +```nu +> mv test.txt .../my/ + +``` diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 64dc514d18c..6393876438c 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 1d005506edf..a47499b87c9 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 9feb75af159..9cdc6e808db 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 dff3ef3b0e7..3ed9c44f34a 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.96.0 +version: 0.97.1 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 05f0c7e98eb..3511ac7e338 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.96.0 +version: 0.97.1 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 5318b17f8c4..96e9c1fee7a 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.96.0 +version: 0.97.1 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 45fec01984f..3f3a4ee287a 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.96.0 +version: 0.97.1 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 6603828995c..8877d3eed89 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.96.0 +version: 0.97.1 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index b8bd1087ba0..f453f65ba3e 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | experimental -version: 0.96.0 +version: 0.97.1 experimental: | Executes a rust panic, useful only for testing. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 175e4752fbb..9bcc0f0bbb3 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.96.0 +version: 0.97.1 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 67070f6ab9c..fa083c8be38 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.96.0 +version: 0.97.1 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 b2c970b177d..84814f575c5 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.96.0 +version: 0.97.1 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index ea982d49e08..7c2e67b7a4b 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.96.0 +version: 0.97.1 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index bfa7ad4de7d..08278d9ed0e 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.96.0 +version: 0.97.1 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 2f869933644..8c16f924c9a 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.96.0 +version: 0.97.1 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 6122f7b172c..1bb0db80421 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.96.0 +version: 0.97.1 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 e2124731f53..235d63a58b8 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.96.0 +version: 0.97.1 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 b8bc8bd742d..5fa204c7dba 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.96.0 +version: 0.97.1 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 9be0225f6ff..c7d5346bd3a 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.96.0 +version: 0.97.1 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 5dafe14801b..45b5906c010 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.96.0 +version: 0.97.1 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 72a8e053447..08d46096ab3 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.96.0 +version: 0.97.1 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 d264dd48b92..dc1f524c903 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.96.0 +version: 0.97.1 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 5d40bdc5f57..b2c697fb5de 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.96.0 +version: 0.97.1 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 c0fe4abce12..3947ff036d9 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.96.0 +version: 0.97.1 plugin: | List installed plugins. usage: | @@ -33,7 +33,7 @@ List installed plugins. ╭───┬──────┬─────────┬────────────┬────────┬───────────────────────────────┬───────┬─────────────╮ │ # │ name │ version │ is_running │ pid │ filename │ shell │ commands │ ├───┼──────┼─────────┼────────────┼────────┼───────────────────────────────┼───────┼─────────────┤ -│ 0 │ inc │ 0.96.0 │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ 0 │ inc │ 0.97.1 │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ │ │ │ │ │ │ │ │ │ 0 │ inc │ │ │ │ │ │ │ │ │ │ ╰───┴─────╯ │ ╰───┴──────┴─────────┴────────────┴────────┴───────────────────────────────┴───────┴─────────────╯ diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 1ce0bc23b02..53f808f2a17 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.96.0 +version: 0.97.1 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 53f57f9c513..026709dda16 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.96.0 +version: 0.97.1 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 d73fefc008d..9557c548e0e 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.96.0 +version: 0.97.1 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 d009f338f93..fae1d454e09 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Operate with data in a dataframe format. usage: | @@ -14,6 +14,12 @@ usage: |
Operate with data in a dataframe format.
+::: warning This command requires a plugin +The `polars` 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 {flags} ``` @@ -30,116 +36,112 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | -| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------ | -| [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | -| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | -| [`polars all-false`](/commands/docs/polars_all-false.md) | Returns true if all values are false. | plugin | -| [`polars all-true`](/commands/docs/polars_all-true.md) | Returns true if all values are true. | plugin | -| [`polars append`](/commands/docs/polars_append.md) | Appends a new dataframe. | plugin | -| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Return index for max value in series. | plugin | -| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Return index for min value in series. | plugin | -| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Returns indexes for a sorted series. | plugin | -| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Returns indexes where values are true. | plugin | -| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Returns indexes for unique values. | plugin | -| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Creates an expression that returns the arguments where expression is true. | plugin | -| [`polars as`](/commands/docs/polars_as.md) | Creates an alias expression. | plugin | -| [`polars as-date`](/commands/docs/polars_as-date.md) | Converts string to date. | plugin | -| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Converts string to datetime. | plugin | -| [`polars cache`](/commands/docs/polars_cache.md) | Caches operations in a new LazyFrame. | plugin | -| [`polars cast`](/commands/docs/polars_cast.md) | Cast a column to a different dtype. | plugin | -| [`polars col`](/commands/docs/polars_col.md) | Creates a named column expression. | plugin | -| [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | -| [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | -| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | -| [`polars concatenate`](/commands/docs/polars_concatenate.md) | Concatenates strings with other array. | plugin | -| [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | -| [`polars count`](/commands/docs/polars_count.md) | Creates a count expression. | plugin | -| [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | -| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a series. | plugin | -| [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | -| [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | -| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | -| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | -| [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | -| [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | -| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | -| [`polars fetch`](/commands/docs/polars_fetch.md) | Collects the lazyframe to the selected rows. | plugin | -| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | -| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | -| [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | -| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Filters dataframe using a mask or expression as reference. | plugin | -| [`polars first`](/commands/docs/polars_first.md) | Show only the first number of rows or create a first expression | plugin | -| [`polars flatten`](/commands/docs/polars_flatten.md) | An alias for polars explode. | plugin | -| [`polars get`](/commands/docs/polars_get.md) | Creates dataframe with the selected columns. | plugin | -| [`polars get-day`](/commands/docs/polars_get-day.md) | Gets day from date. | plugin | -| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Gets hour from date. | plugin | -| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Gets minute from date. | plugin | -| [`polars get-month`](/commands/docs/polars_get-month.md) | Gets month from date. | plugin | -| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Gets nanosecond from date. | plugin | -| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Gets ordinal from date. | plugin | -| [`polars get-second`](/commands/docs/polars_get-second.md) | Gets second from date. | plugin | -| [`polars get-week`](/commands/docs/polars_get-week.md) | Gets week from date. | plugin | -| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | -| [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | -| [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | -| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates a group to a Series. | plugin | -| [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | -| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | -| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into into nushell value for access and exploration. | plugin | -| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Creates mask indicating duplicated values. | plugin | -| [`polars is-in`](/commands/docs/polars_is-in.md) | Creates an is-in expression or checks to see if the elements are contained in the right series | plugin | -| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Creates mask where value is not null. | plugin | -| [`polars is-null`](/commands/docs/polars_is-null.md) | Creates mask where value is null. | plugin | -| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | -| [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | -| [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | 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 | -| [`polars mean`](/commands/docs/polars_mean.md) | Creates a mean expression for an aggregation or aggregates columns to their mean value. | plugin | -| [`polars median`](/commands/docs/polars_median.md) | Median value from columns in a dataframe or creates expression for an aggregation | plugin | -| [`polars min`](/commands/docs/polars_min.md) | Creates a min expression or aggregates columns to their min value. | plugin | -| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Counts unique values. | plugin | -| [`polars not`](/commands/docs/polars_not.md) | Inverts boolean mask. | plugin | -| [`polars open`](/commands/docs/polars_open.md) | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. | plugin | -| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Completes a when expression. | plugin | -| [`polars pivot`](/commands/docs/polars_pivot.md) | Pivot a DataFrame from wide to long format. | plugin | -| [`polars quantile`](/commands/docs/polars_quantile.md) | Aggregates the columns to the selected quantile. | plugin | -| [`polars query`](/commands/docs/polars_query.md) | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | plugin | -| [`polars rename`](/commands/docs/polars_rename.md) | Rename a dataframe column. | plugin | -| [`polars replace`](/commands/docs/polars_replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | -| [`polars replace-all`](/commands/docs/polars_replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | -| [`polars reverse`](/commands/docs/polars_reverse.md) | Reverses the LazyFrame | plugin | -| [`polars rolling`](/commands/docs/polars_rolling.md) | Rolling calculation for a series. | plugin | -| [`polars sample`](/commands/docs/polars_sample.md) | Create sample dataframe. | plugin | -| [`polars schema`](/commands/docs/polars_schema.md) | Show schema for a dataframe. | plugin | -| [`polars select`](/commands/docs/polars_select.md) | Selects columns from lazyframe. | plugin | -| [`polars set`](/commands/docs/polars_set.md) | Sets value where given mask is true. | plugin | -| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Sets value in the given index. | plugin | -| [`polars shape`](/commands/docs/polars_shape.md) | Shows column and row size for a dataframe. | plugin | -| [`polars shift`](/commands/docs/polars_shift.md) | Shifts the values by a given period. | plugin | -| [`polars slice`](/commands/docs/polars_slice.md) | Creates new dataframe from a slice of rows. | plugin | -| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Sorts a lazy dataframe based on expression(s). | plugin | -| [`polars std`](/commands/docs/polars_std.md) | Creates a std expression for an aggregation of std value from columns in a dataframe. | plugin | -| [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | -| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored polars objects. | plugin | -| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | -| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | -| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | -| [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | -| [`polars sum`](/commands/docs/polars_sum.md) | Creates a sum expression for an aggregation or aggregates columns to their sum value. | plugin | -| [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | -| [`polars take`](/commands/docs/polars_take.md) | Creates new dataframe using the given indices. | plugin | -| [`polars to-arrow`](/commands/docs/polars_to-arrow.md) | Saves dataframe to arrow file. | plugin | -| [`polars to-avro`](/commands/docs/polars_to-avro.md) | Saves dataframe to avro file. | plugin | -| [`polars to-csv`](/commands/docs/polars_to-csv.md) | Saves dataframe to CSV file. | plugin | -| [`polars to-jsonl`](/commands/docs/polars_to-jsonl.md) | Saves dataframe to a JSON lines file. | plugin | -| [`polars to-parquet`](/commands/docs/polars_to-parquet.md) | Saves dataframe to parquet file. | plugin | -| [`polars unique`](/commands/docs/polars_unique.md) | Returns unique values from a dataframe. | plugin | -| [`polars unpivot`](/commands/docs/polars_unpivot.md) | Unpivot a DataFrame from wide to long format. | plugin | -| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | -| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | -| [`polars var`](/commands/docs/polars_var.md) | Create a var expression for an aggregation. | plugin | -| [`polars when`](/commands/docs/polars_when.md) | Creates and modifies a when expression. | plugin | -| [`polars with-column`](/commands/docs/polars_with-column.md) | Adds a series to the dataframe. | plugin | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | +| [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | +| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | +| [`polars all-false`](/commands/docs/polars_all-false.md) | Returns true if all values are false. | plugin | +| [`polars all-true`](/commands/docs/polars_all-true.md) | Returns true if all values are true. | plugin | +| [`polars append`](/commands/docs/polars_append.md) | Appends a new dataframe. | plugin | +| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Return index for max value in series. | plugin | +| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Return index for min value in series. | plugin | +| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Returns indexes for a sorted series. | plugin | +| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Returns indexes where values are true. | plugin | +| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Returns indexes for unique values. | plugin | +| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Creates an expression that returns the arguments where expression is true. | plugin | +| [`polars as`](/commands/docs/polars_as.md) | Creates an alias expression. | plugin | +| [`polars as-date`](/commands/docs/polars_as-date.md) | Converts string to date. | plugin | +| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Converts string to datetime. | plugin | +| [`polars cache`](/commands/docs/polars_cache.md) | Caches operations in a new LazyFrame. | plugin | +| [`polars cast`](/commands/docs/polars_cast.md) | Cast a column to a different dtype. | plugin | +| [`polars col`](/commands/docs/polars_col.md) | Creates a named column expression. | plugin | +| [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | +| [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | +| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | +| [`polars concatenate`](/commands/docs/polars_concatenate.md) | Concatenates strings with other array. | plugin | +| [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | +| [`polars count`](/commands/docs/polars_count.md) | Creates a count expression. | plugin | +| [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | +| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a series. | plugin | +| [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | +| [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | +| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | +| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | +| [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | +| [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | +| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | +| [`polars fetch`](/commands/docs/polars_fetch.md) | Collects the lazyframe to the selected rows. | plugin | +| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | +| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | +| [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | +| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Filters dataframe using a mask or expression as reference. | plugin | +| [`polars first`](/commands/docs/polars_first.md) | Show only the first number of rows or create a first expression | plugin | +| [`polars flatten`](/commands/docs/polars_flatten.md) | An alias for polars explode. | plugin | +| [`polars get`](/commands/docs/polars_get.md) | Creates dataframe with the selected columns. | plugin | +| [`polars get-day`](/commands/docs/polars_get-day.md) | Gets day from date. | plugin | +| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Gets hour from date. | plugin | +| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Gets minute from date. | plugin | +| [`polars get-month`](/commands/docs/polars_get-month.md) | Gets month from date. | plugin | +| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Gets nanosecond from date. | plugin | +| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Gets ordinal from date. | plugin | +| [`polars get-second`](/commands/docs/polars_get-second.md) | Gets second from date. | plugin | +| [`polars get-week`](/commands/docs/polars_get-week.md) | Gets week from date. | plugin | +| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | +| [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | +| [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | +| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates a group to a Series. | plugin | +| [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | +| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | +| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into nushell value for access and exploration. | plugin | +| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Creates mask indicating duplicated values. | plugin | +| [`polars is-in`](/commands/docs/polars_is-in.md) | Creates an is-in expression or checks to see if the elements are contained in the right series | plugin | +| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Creates mask where value is not null. | plugin | +| [`polars is-null`](/commands/docs/polars_is-null.md) | Creates mask where value is null. | plugin | +| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | +| [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | +| [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | 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 | +| [`polars mean`](/commands/docs/polars_mean.md) | Creates a mean expression for an aggregation or aggregates columns to their mean value. | plugin | +| [`polars median`](/commands/docs/polars_median.md) | Median value from columns in a dataframe or creates expression for an aggregation | plugin | +| [`polars min`](/commands/docs/polars_min.md) | Creates a min expression or aggregates columns to their min value. | plugin | +| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Counts unique values. | plugin | +| [`polars not`](/commands/docs/polars_not.md) | Inverts boolean mask. | plugin | +| [`polars open`](/commands/docs/polars_open.md) | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. | plugin | +| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Completes a when expression. | plugin | +| [`polars pivot`](/commands/docs/polars_pivot.md) | Pivot a DataFrame from wide to long format. | plugin | +| [`polars quantile`](/commands/docs/polars_quantile.md) | Aggregates the columns to the selected quantile. | plugin | +| [`polars query`](/commands/docs/polars_query.md) | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | plugin | +| [`polars rename`](/commands/docs/polars_rename.md) | Rename a dataframe column. | plugin | +| [`polars replace`](/commands/docs/polars_replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | +| [`polars replace-all`](/commands/docs/polars_replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | +| [`polars reverse`](/commands/docs/polars_reverse.md) | Reverses the LazyFrame | plugin | +| [`polars rolling`](/commands/docs/polars_rolling.md) | Rolling calculation for a series. | plugin | +| [`polars sample`](/commands/docs/polars_sample.md) | Create sample dataframe. | plugin | +| [`polars save`](/commands/docs/polars_save.md) | Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson). | plugin | +| [`polars schema`](/commands/docs/polars_schema.md) | Show schema for a dataframe. | plugin | +| [`polars select`](/commands/docs/polars_select.md) | Selects columns from lazyframe. | plugin | +| [`polars set`](/commands/docs/polars_set.md) | Sets value where given mask is true. | plugin | +| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Sets value in the given index. | plugin | +| [`polars shape`](/commands/docs/polars_shape.md) | Shows column and row size for a dataframe. | plugin | +| [`polars shift`](/commands/docs/polars_shift.md) | Shifts the values by a given period. | plugin | +| [`polars slice`](/commands/docs/polars_slice.md) | Creates new dataframe from a slice of rows. | plugin | +| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Sorts a lazy dataframe based on expression(s). | plugin | +| [`polars std`](/commands/docs/polars_std.md) | Creates a std expression for an aggregation of std value from columns in a dataframe. | plugin | +| [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | +| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored polars objects. | plugin | +| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | +| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | +| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | +| [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | +| [`polars sum`](/commands/docs/polars_sum.md) | Creates a sum expression for an aggregation or aggregates columns to their sum value. | plugin | +| [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | +| [`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 unpivot`](/commands/docs/polars_unpivot.md) | Unpivot a DataFrame from wide to long format. | plugin | +| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | +| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | +| [`polars var`](/commands/docs/polars_var.md) | Create a var expression for an aggregation. | plugin | +| [`polars when`](/commands/docs/polars_when.md) | Creates and modifies a when expression. | plugin | +| [`polars with-column`](/commands/docs/polars_with-column.md) | Adds a series to the dataframe. | plugin | \ No newline at end of file diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index d67bc1984d1..5e463b70989 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -2,7 +2,7 @@ title: polars agg-groups categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates an agg_groups expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates an agg_groups expression.
+::: warning This command requires a plugin +The `polars agg-groups` 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 agg-groups {flags} ``` diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index c7f1a8da807..7f633f8a174 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -14,6 +14,12 @@ usage: |
Performs a series of aggregations from a group-by.
+::: warning This command requires a plugin +The `polars agg` 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 agg {flags} ...rest``` diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index e0b4456b5a4..4bf68f200d7 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.96.0 +version: 0.97.1 dataframe: | Returns true if all values are false. usage: | @@ -14,6 +14,12 @@ usage: |
Returns true if all values are false.
+::: warning This command requires a plugin +The `polars all-false` 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 all-false {flags} ``` diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index 394b0c75d3e..df311271676 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.96.0 +version: 0.97.1 dataframe: | Returns true if all values are true. usage: | @@ -14,6 +14,12 @@ usage: |
Returns true if all values are true.
+::: warning This command requires a plugin +The `polars all-true` 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 all-true {flags} ``` diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index af20a487796..2ce13a2292b 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Appends a new dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Appends a new dataframe.
+::: warning This command requires a plugin +The `polars append` 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 append {flags} (other)``` diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index e33aba86d76..35fac8264a4 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.96.0 +version: 0.97.1 dataframe: | Return index for max value in series. usage: | @@ -14,6 +14,12 @@ usage: |
Return index for max value in series.
+::: warning This command requires a plugin +The `polars arg-max` 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 arg-max {flags} ``` diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index a8780797b9c..30052d8cce0 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.96.0 +version: 0.97.1 dataframe: | Return index for min value in series. usage: | @@ -14,6 +14,12 @@ usage: |
Return index for min value in series.
+::: warning This command requires a plugin +The `polars arg-min` 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 arg-min {flags} ``` diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index cbba9904836..702e01e7c91 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.96.0 +version: 0.97.1 dataframe: | Returns indexes for a sorted series. usage: | @@ -14,6 +14,12 @@ usage: |
Returns indexes for a sorted series.
+::: warning This command requires a plugin +The `polars arg-sort` 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 arg-sort {flags} ``` diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index bdc5e6a3f38..70e3aea0d52 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.96.0 +version: 0.97.1 dataframe: | Returns indexes where values are true. usage: | @@ -14,6 +14,12 @@ usage: |
Returns indexes where values are true.
+::: warning This command requires a plugin +The `polars arg-true` 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 arg-true {flags} ``` diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 177a7c8a15a..6d41bc1446c 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.96.0 +version: 0.97.1 dataframe: | Returns indexes for unique values. usage: | @@ -14,6 +14,12 @@ usage: |
Returns indexes for unique values.
+::: warning This command requires a plugin +The `polars arg-unique` 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 arg-unique {flags} ``` diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index 9d46c875aeb..d3c14816de2 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.96.0 +version: 0.97.1 expression: | Creates an expression that returns the arguments where expression is true. usage: | @@ -14,6 +14,12 @@ usage: |
Creates an expression that returns the arguments where expression is true.
+::: warning This command requires a plugin +The `polars arg-where` 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 arg-where {flags} (column name)``` diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index 0e23bcb0729..97b2e1637ea 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.96.0 +version: 0.97.1 dataframe: | Converts string to date. usage: | @@ -14,6 +14,12 @@ usage: |
Converts string to date.
+::: warning This command requires a plugin +The `polars as-date` 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 as-date {flags} (format)``` diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 1f697e1c311..ec2fa1e6121 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.96.0 +version: 0.97.1 dataframe: | Converts string to datetime. usage: | @@ -14,6 +14,12 @@ usage: |
Converts string to datetime.
+::: warning This command requires a plugin +The `polars as-datetime` 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 as-datetime {flags} (format)``` diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 19499f308f1..1c090999654 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates an alias expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates an alias expression.
+::: warning This command requires a plugin +The `polars as` 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 as {flags} (Alias name)``` diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index 76c085f8eb9..1b8f07c06d8 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Caches operations in a new LazyFrame. usage: | @@ -14,6 +14,12 @@ usage: |
Caches operations in a new LazyFrame.
+::: warning This command requires a plugin +The `polars cache` 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 cache {flags} ``` diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 77634ff0d36..fb051bea7de 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Cast a column to a different dtype. usage: | @@ -14,6 +14,12 @@ usage: |
Cast a column to a different dtype.
+::: warning This command requires a plugin +The `polars cast` 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 cast {flags} (dtype) (column)``` diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index f82d59d5bc6..6222654695a 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a named column expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a named column expression.
+::: warning This command requires a plugin +The `polars col` 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 col {flags} (column name)``` diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 45b872f009e..556317561ea 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Collect lazy dataframe into eager dataframe.
+::: warning This command requires a plugin +The `polars collect` 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 collect {flags} ``` diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index cf38feecb79..3febd0c87fc 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Show dataframe columns. usage: | @@ -14,6 +14,12 @@ usage: |
Show dataframe columns.
+::: warning This command requires a plugin +The `polars columns` 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 columns {flags} ``` diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 172e5785a80..45ba858d9f9 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.96.0 +version: 0.97.1 expression: | Creates a concat string expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a concat string expression.
+::: warning This command requires a plugin +The `polars concat-str` 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 concat-str {flags} (separator) (concat expressions)``` diff --git a/commands/docs/polars_concatenate.md b/commands/docs/polars_concatenate.md index c01befabefa..7bb8ecf478f 100644 --- a/commands/docs/polars_concatenate.md +++ b/commands/docs/polars_concatenate.md @@ -2,7 +2,7 @@ title: polars concatenate categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Concatenates strings with other array. usage: | @@ -14,6 +14,12 @@ usage: |
Concatenates strings with other array.
+::: warning This command requires a plugin +The `polars concatenate` 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 concatenate {flags} (other)``` diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index e907ed49ca1..3d3c16f2840 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -14,6 +14,12 @@ usage: |
Checks if a pattern is contained in a string.
+::: warning This command requires a plugin +The `polars contains` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + ## Signature ```> polars contains {flags} (pattern)``` diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 1c04e0e8d7f..241e35e0a05 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.96.0 +version: 0.97.1 dataframe: | Counts null values. usage: | @@ -14,6 +14,12 @@ usage: |
Counts null values.
+::: warning This command requires a plugin +The `polars count-null` 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 count-null {flags} ``` diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index f99bc031810..6873458c987 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a count expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a count expression.
+::: warning This command requires a plugin +The `polars count` 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 count {flags} ``` diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 70674738d0d..687f7124ed8 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Cumulative calculation for a series. usage: | @@ -14,6 +14,12 @@ usage: |
Cumulative calculation for a series.
+::: warning This command requires a plugin +The `polars cumulative` 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 cumulative {flags} (type)``` diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index 88f6b395bd7..f75e24dad00 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -14,6 +14,12 @@ usage: |
Creates an expression for capturing the specified datepart in a column.
+::: warning This command requires a plugin +The `polars datepart` 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 datepart {flags} (Datepart name)``` diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index c9bb4e3ac6e..44e23c3c548 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.96.0 +version: 0.97.1 dataframe: | Drops duplicate values in dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Drops duplicate values in dataframe.
+::: warning This command requires a plugin +The `polars drop-duplicates` 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 drop-duplicates {flags} (subset)``` diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index 5fc3bc4fdf7..fa9264c9da5 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.96.0 +version: 0.97.1 dataframe: | Drops null values in dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Drops null values in dataframe.
+::: warning This command requires a plugin +The `polars drop-nulls` 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 drop-nulls {flags} (subset)``` diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index 84c49313ea5..24efa6f705b 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a new dataframe by dropping the selected columns.
+::: warning This command requires a plugin +The `polars drop` 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 drop {flags} ...rest``` diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index 6cb9a0dea0f..33d89d2aa12 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates a new dataframe with dummy variables. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a new dataframe with dummy variables.
+::: warning This command requires a plugin +The `polars dummies` 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 dummies {flags} ``` diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 98265812749..6cbed01ecd7 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -14,6 +14,12 @@ usage: |
Explodes a dataframe or creates a explode expression.
+::: warning This command requires a plugin +The `polars explode` 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 explode {flags} ...rest``` diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 7767973cd34..f33ffb8fefa 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -2,7 +2,7 @@ title: polars expr-not categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a not expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a not expression.
+::: warning This command requires a plugin +The `polars expr-not` 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 expr-not {flags} ``` diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md index 2a2982344a2..3f94db09a0a 100644 --- a/commands/docs/polars_fetch.md +++ b/commands/docs/polars_fetch.md @@ -2,7 +2,7 @@ title: polars fetch categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Collects the lazyframe to the selected rows. usage: | @@ -14,6 +14,12 @@ usage: |
Collects the lazyframe to the selected rows.
+::: warning This command requires a plugin +The `polars fetch` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + ## Signature ```> polars fetch {flags} (rows)``` diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index 846f7e73d2d..c15451c9aa7 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.96.0 +version: 0.97.1 lazyframe: | Replaces NaN values with the given expression. usage: | @@ -14,6 +14,12 @@ usage: |
Replaces NaN values with the given expression.
+::: warning This command requires a plugin +The `polars fill-nan` 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 fill-nan {flags} (fill)``` diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index 74fbc3ff8e5..c02734dfce8 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.96.0 +version: 0.97.1 lazyframe: | Replaces NULL values with the given expression. usage: | @@ -14,6 +14,12 @@ usage: |
Replaces NULL values with the given expression.
+::: warning This command requires a plugin +The `polars fill-null` 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 fill-null {flags} (fill)``` diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index 46e92fefbb9..b5ae516032b 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.96.0 +version: 0.97.1 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | @@ -14,6 +14,12 @@ usage: |
Filters dataframe using a mask or expression as reference.
+::: warning This command requires a plugin +The `polars filter-with` 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 filter-with {flags} (mask or expression)``` diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 00b95e884be..3ae1c4f206f 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Filter dataframe based in expression. usage: | @@ -14,6 +14,12 @@ usage: |
Filter dataframe based in expression.
+::: warning This command requires a plugin +The `polars filter` 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 filter {flags} (filter expression)``` diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index 344376cdc08..44712aad4f6 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Show only the first number of rows or create a first expression usage: | @@ -14,6 +14,12 @@ usage: |
Show only the first number of rows or create a first expression
+::: warning This command requires a plugin +The `polars first` 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 first {flags} (rows)``` diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index 6810d55fc48..97461dd4d63 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | An alias for polars explode. usage: | @@ -14,6 +14,12 @@ usage: |
An alias for polars explode.
+::: warning This command requires a plugin +The `polars flatten` 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 flatten {flags} ...rest``` diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index abbaa357ae7..ddfa57244fd 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.96.0 +version: 0.97.1 dataframe: | Gets day from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets day from date.
+::: warning This command requires a plugin +The `polars get-day` 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 get-day {flags} ``` diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index a7dc439522c..e22a90675c8 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.96.0 +version: 0.97.1 dataframe: | Gets hour from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets hour from date.
+::: warning This command requires a plugin +The `polars get-hour` 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 get-hour {flags} ``` diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 119baf72e74..2915b7cd949 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.96.0 +version: 0.97.1 dataframe: | Gets minute from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets minute from date.
+::: warning This command requires a plugin +The `polars get-minute` 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 get-minute {flags} ``` diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index da457cdcfff..3f724f9174c 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.96.0 +version: 0.97.1 dataframe: | Gets month from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets month from date.
+::: warning This command requires a plugin +The `polars get-month` 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 get-month {flags} ``` diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index c1e28de9f2e..13446d18aaf 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.96.0 +version: 0.97.1 dataframe: | Gets nanosecond from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets nanosecond from date.
+::: warning This command requires a plugin +The `polars get-nanosecond` 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 get-nanosecond {flags} ``` diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 60d6ba8572e..6c58520b946 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.96.0 +version: 0.97.1 dataframe: | Gets ordinal from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets ordinal from date.
+::: warning This command requires a plugin +The `polars get-ordinal` 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 get-ordinal {flags} ``` diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index aec3e5904d5..f3c49f1672c 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.96.0 +version: 0.97.1 dataframe: | Gets second from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets second from date.
+::: warning This command requires a plugin +The `polars get-second` 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 get-second {flags} ``` diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index f89a29d15f0..b4953836717 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.96.0 +version: 0.97.1 dataframe: | Gets week from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets week from date.
+::: warning This command requires a plugin +The `polars get-week` 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 get-week {flags} ``` diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 8ecc430d6fc..b34df98825b 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.96.0 +version: 0.97.1 dataframe: | Gets weekday from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets weekday from date.
+::: warning This command requires a plugin +The `polars get-weekday` 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 get-weekday {flags} ``` diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 571c8a90e73..d2e22c64064 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.96.0 +version: 0.97.1 dataframe: | Gets year from date. usage: | @@ -14,6 +14,12 @@ usage: |
Gets year from date.
+::: warning This command requires a plugin +The `polars get-year` 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 get-year {flags} ``` diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 905e9d401ce..515407808e4 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates dataframe with the selected columns. usage: | @@ -14,6 +14,12 @@ usage: |
Creates dataframe with the selected columns.
+::: warning This command requires a plugin +The `polars get` 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 get {flags} ...rest``` diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index 72d524015ca..ea4f6fabece 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.96.0 +version: 0.97.1 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a group-by object that can be used for other aggregations.
+::: warning This command requires a plugin +The `polars group-by` 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 group-by {flags} ...rest``` diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index c7fdcef8aef..c26b26baec8 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Aggregates a group to a Series. usage: | @@ -14,6 +14,12 @@ usage: |
Aggregates a group to a Series.
+::: warning This command requires a plugin +The `polars implode` 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 implode {flags} ``` diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index a6be25bfa76..90f354c88c4 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.96.0 +version: 0.97.1 dataframe: | Converts a list, table or record into a dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Converts a list, table or record into a dataframe.
+::: warning This command requires a plugin +The `polars into-df` 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 into-df {flags} ``` @@ -21,6 +27,7 @@ usage: | ## Flags - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files + - `--as-columns, -c`: When input shape is record of lists, treat each list as column values. ## Input/output types: @@ -43,6 +50,18 @@ Takes a dictionary and creates a dataframe ``` +Takes a record of lists and creates a dataframe +```nu +> {a: [1 3], b: [2 4]} | polars into-df --as-columns +╭───┬───┬───╮ +│ # │ a │ b │ +├───┼───┼───┤ +│ 0 │ 1 │ 2 │ +│ 1 │ 3 │ 4 │ +╰───┴───┴───╯ + +``` + Takes a list of tables and creates a dataframe ```nu > [[1 2 a] [3 4 b] [5 6 c]] | polars into-df diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 9d6c3bb29d5..699737ecb58 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.96.0 +version: 0.97.1 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Converts a dataframe into a lazy dataframe.
+::: warning This command requires a plugin +The `polars into-lazy` 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 into-lazy {flags} ``` diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index ef81df93712..1fe0508a2aa 100644 --- a/commands/docs/polars_into-nu.md +++ b/commands/docs/polars_into-nu.md @@ -2,17 +2,23 @@ title: polars into-nu categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | - Converts a dataframe or an expression into into nushell value for access and exploration. + Converts a dataframe or an expression into nushell value for access and exploration. usage: | - Converts a dataframe or an expression into into nushell value for access and exploration. + Converts a dataframe or an expression into nushell value for access and exploration. --- # `polars into-nu` for [dataframe](/commands/categories/dataframe.md) -
Converts a dataframe or an expression into into nushell value for access and exploration.
+
Converts a dataframe or an expression into nushell value for access and exploration.
+ +::: warning This command requires a plugin +The `polars into-nu` 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 diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 6bd0158d477..f854bec4289 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.96.0 +version: 0.97.1 dataframe: | Creates mask indicating duplicated values. usage: | @@ -14,6 +14,12 @@ usage: |
Creates mask indicating duplicated values.
+::: warning This command requires a plugin +The `polars is-duplicated` 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 is-duplicated {flags} ``` diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index bfb64266cfd..238b894fd6a 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.96.0 +version: 0.97.1 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | @@ -14,6 +14,12 @@ usage: |
Creates an is-in expression or checks to see if the elements are contained in the right series
+::: warning This command requires a plugin +The `polars is-in` 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 is-in {flags} (list)``` diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index 2e8255fa3df..0d563402749 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.96.0 +version: 0.97.1 dataframe: | Creates mask where value is not null. usage: | @@ -14,6 +14,12 @@ usage: |
Creates mask where value is not null.
+::: warning This command requires a plugin +The `polars is-not-null` 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 is-not-null {flags} ``` diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index 7423059d530..af642e0566c 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.96.0 +version: 0.97.1 dataframe: | Creates mask where value is null. usage: | @@ -14,6 +14,12 @@ usage: |
Creates mask where value is null.
+::: warning This command requires a plugin +The `polars is-null` 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 is-null {flags} ``` diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index 4956ef6a3a7..d17c525c33a 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.96.0 +version: 0.97.1 dataframe: | Creates mask indicating unique values. usage: | @@ -14,6 +14,12 @@ usage: |
Creates mask indicating unique values.
+::: warning This command requires a plugin +The `polars is-unique` 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 is-unique {flags} ``` diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index e621b11a588..fc5ddafcf40 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Joins a lazy frame with other lazy frame. usage: | @@ -14,6 +14,12 @@ usage: |
Joins a lazy frame with other lazy frame.
+::: warning This command requires a plugin +The `polars join` 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 join {flags} (other) (left_on) (right_on)``` diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 90d6884f770..4564c10b25c 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates new dataframe with tail rows or creates a last expression.
+::: warning This command requires a plugin +The `polars last` 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 last {flags} (rows)``` diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 9b5467c598d..01acbe60d34 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a literal expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a literal expression.
+::: warning This command requires a plugin +The `polars lit` 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 lit {flags} (literal)``` diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index fd6164d50c1..f519482effe 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Lowercase the strings in the column. usage: | @@ -14,6 +14,12 @@ usage: |
Lowercase the strings in the column.
+::: warning This command requires a plugin +The `polars lowercase` 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 lowercase {flags} ``` diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 313105d3005..d1fd42089a5 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a max expression or aggregates columns to their max value. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a max expression or aggregates columns to their max value.
+::: warning This command requires a plugin +The `polars max` 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 max {flags} ``` diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 63e26ea6bfb..4de278d7c3a 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a mean expression for an aggregation or aggregates columns to their mean value.
+::: warning This command requires a plugin +The `polars mean` 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 mean {flags} ``` diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index d3e6233a6b4..311420b311a 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | @@ -14,6 +14,12 @@ usage: |
Median value from columns in a dataframe or creates expression for an aggregation
+::: warning This command requires a plugin +The `polars median` 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 median {flags} ``` diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 8e824bc71af..1a61733b22b 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a min expression or aggregates columns to their min value. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a min expression or aggregates columns to their min value.
+::: warning This command requires a plugin +The `polars min` 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 min {flags} ``` diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index 93cd4310bef..242a18b88c3 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.96.0 +version: 0.97.1 dataframe: | Counts unique values. usage: | @@ -14,6 +14,12 @@ usage: |
Counts unique values.
+::: warning This command requires a plugin +The `polars n-unique` 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 n-unique {flags} ``` diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index acd378c450a..547f14edfe9 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Inverts boolean mask. usage: | @@ -14,6 +14,12 @@ usage: |
Inverts boolean mask.
+::: warning This command requires a plugin +The `polars not` 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 not {flags} ``` diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index c4a438d9fac..01b9790932e 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,17 +2,23 @@ title: polars open categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | - Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create 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: | - Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create 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. --- # `polars open` for [dataframe](/commands/categories/dataframe.md) -
Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create 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.
+ +::: warning This command requires a plugin +The `polars open` 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 @@ -20,7 +26,7 @@ usage: | ## Flags - - `--lazy, -l`: creates a lazy dataframe + - `--eager, -`: Open dataframe as an eager dataframe - `--type, -t {string}`: File type: csv, tsv, json, parquet, arrow, avro. If omitted, derive from file extension - `--delimiter, -d {string}`: file delimiter character. CSV file - `--no-header, -`: Indicates if file doesn't have header. CSV file diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index a65db25fa4e..49c6694377f 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Completes a when expression. usage: | @@ -14,6 +14,12 @@ usage: |
Completes a when expression.
+::: warning This command requires a plugin +The `polars otherwise` 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 otherwise {flags} (otherwise expression)``` diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 07a04607bef..3859951230d 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Pivot a DataFrame from wide to long format. usage: | @@ -14,6 +14,12 @@ usage: |
Pivot a DataFrame from wide to long format.
+::: warning This command requires a plugin +The `polars pivot` 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 pivot {flags} ``` diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index d068c3e9f06..0e6d067867a 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -14,6 +14,12 @@ usage: |
Aggregates the columns to the selected quantile.
+::: warning This command requires a plugin +The `polars quantile` 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 quantile {flags} (quantile)``` diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index fea8b779b76..53f76150e89 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | @@ -14,6 +14,12 @@ usage: |
Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause.
+::: warning This command requires a plugin +The `polars query` 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 query {flags} (sql)``` diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index 3b1955b9c5e..b224865af6d 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.96.0 +version: 0.97.1 dataframe_or_lazyframe: | Rename a dataframe column. usage: | @@ -14,6 +14,12 @@ usage: |
Rename a dataframe column.
+::: warning This command requires a plugin +The `polars rename` 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 rename {flags} (columns) (new names)``` diff --git a/commands/docs/polars_replace-all.md b/commands/docs/polars_replace-all.md index 1d63b727c85..2fa70ebe234 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.96.0 +version: 0.97.1 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -14,6 +14,12 @@ usage: |
Replace all (sub)strings by a regex pattern.
+::: warning This command requires a plugin +The `polars replace-all` 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 replace-all {flags} ``` diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 4ae79c19619..3044e0a9e05 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -14,6 +14,12 @@ usage: |
Replace the leftmost (sub)string by a regex pattern.
+::: warning This command requires a plugin +The `polars replace` 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 replace {flags} ``` diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index c90969f6e72..daada104b14 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Reverses the LazyFrame usage: | @@ -14,6 +14,12 @@ usage: |
Reverses the LazyFrame
+::: warning This command requires a plugin +The `polars reverse` 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 reverse {flags} ``` diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index bbfa8c0cce1..a5cfa41ddd6 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Rolling calculation for a series. usage: | @@ -14,6 +14,12 @@ usage: |
Rolling calculation for a series.
+::: warning This command requires a plugin +The `polars rolling` 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 rolling {flags} (type) (window)``` diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index 39f31b744b1..af3b0607094 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Create sample dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Create sample dataframe.
+::: warning This command requires a plugin +The `polars sample` 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 sample {flags} ``` diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md new file mode 100644 index 00000000000..79bc38570c4 --- /dev/null +++ b/commands/docs/polars_save.md @@ -0,0 +1,87 @@ +--- +title: polars save +categories: | + lazyframe +version: 0.97.1 +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: | + 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). +--- + + +# `polars save` for [lazyframe](/commands/categories/lazyframe.md) + +
Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson).
+ +::: warning This command requires a plugin +The `polars save` 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 save {flags} (path)``` + +## Flags + + - `--type, -t {string}`: File type: csv, json, parquet, arrow/ipc. If omitted, derive from file extension + - `--avro-compression, - {string}`: Compression for avro supports deflate or snappy + - `--csv-delimiter, - {string}`: file delimiter character + - `--csv-no-header, -`: Indicates to exclude a header row for CSV files. + +## Parameters + + - `path`: Path to write to. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | string | + +## Examples + +Performs a streaming collect and save the output to the specified file +```nu +> [[a b];[1 2] [3 4]] | polars into-lazy | polars save test.parquet + +``` + +Saves dataframe to parquet file +```nu +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.parquet + +``` + +Saves dataframe to arrow file +```nu +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.arrow + +``` + +Saves dataframe to NDJSON file +```nu +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.ndjson + +``` + +Saves dataframe to avro file +```nu +> [[a b]; [1 2] [3 4]] | polars into-df | polars save test.avro + +``` + +Saves dataframe to CSV file +```nu +> [[a b]; [1 2] [3 4]] | dfr into-df | dfr save test.csv + +``` + +Saves dataframe to CSV file using other delimiter +```nu +> [[a b]; [1 2] [3 4]] | dfr into-df | dfr save test.csv --delimiter '|' + +``` diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index dce55c343e8..4b36a544074 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Show schema for a dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Show schema for a dataframe.
+::: warning This command requires a plugin +The `polars schema` 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 schema {flags} ``` diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 543b3ce76a9..829938798c4 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.96.0 +version: 0.97.1 lazyframe: | Selects columns from lazyframe. usage: | @@ -14,6 +14,12 @@ usage: |
Selects columns from lazyframe.
+::: warning This command requires a plugin +The `polars select` 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 select {flags} ...rest``` diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index 54210f6ea77..adbda1c5591 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.96.0 +version: 0.97.1 dataframe: | Sets value in the given index. usage: | @@ -14,6 +14,12 @@ usage: |
Sets value in the given index.
+::: warning This command requires a plugin +The `polars set-with-idx` 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 set-with-idx {flags} (value)``` diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 11ae2f876f1..130804b25e2 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Sets value where given mask is true. usage: | @@ -14,6 +14,12 @@ usage: |
Sets value where given mask is true.
+::: warning This command requires a plugin +The `polars set` 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 set {flags} (value)``` diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index 95765b55c7f..db893a42254 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Shows column and row size for a dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Shows column and row size for a dataframe.
+::: warning This command requires a plugin +The `polars shape` 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 shape {flags} ``` diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index a0f1e0eeafb..422d9214c5d 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.96.0 +version: 0.97.1 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | @@ -14,6 +14,12 @@ usage: |
Shifts the values by a given period.
+::: warning This command requires a plugin +The `polars shift` 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 shift {flags} (period)``` diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index 9b627948e94..d5ad035928e 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates new dataframe from a slice of rows. usage: | @@ -14,6 +14,12 @@ usage: |
Creates new dataframe from a slice of rows.
+::: warning This command requires a plugin +The `polars slice` 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 slice {flags} (offset) (size)``` diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index b2fdae3f65f..564b0986961 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.96.0 +version: 0.97.1 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | @@ -14,6 +14,12 @@ usage: |
Sorts a lazy dataframe based on expression(s).
+::: warning This command requires a plugin +The `polars sort-by` 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 sort-by {flags} ...rest``` diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index ec69283d60b..aa4d5423efe 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a std expression for an aggregation of std value from columns in a dataframe.
+::: warning This command requires a plugin +The `polars std` 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 std {flags} ``` diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index 2cfc1ba7249..1c4a84f1e1f 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.96.0 +version: 0.97.1 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | @@ -14,6 +14,12 @@ usage: |
Gets a Dataframe or other object from the plugin cache.
+::: warning This command requires a plugin +The `polars store-get` 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 store-get {flags} (key)``` diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 743bf4f2a28..5868e9e42c2 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.96.0 +version: 0.97.1 dataframe: | Lists stored polars objects. usage: | @@ -14,6 +14,12 @@ usage: |
Lists stored polars objects.
+::: warning This command requires a plugin +The `polars store-ls` 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 store-ls {flags} ``` diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 3c3a0c3c9b3..53d71b06130 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.96.0 +version: 0.97.1 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | @@ -14,6 +14,12 @@ usage: |
Removes a stored Dataframe or other object from the plugin cache.
+::: warning This command requires a plugin +The `polars store-rm` 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 store-rm {flags} ...rest``` diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index c470e231961..83c626afb0c 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.96.0 +version: 0.97.1 dataframe: | Get lengths of all strings. usage: | @@ -14,6 +14,12 @@ usage: |
Get lengths of all strings.
+::: warning This command requires a plugin +The `polars str-lengths` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + ## Signature ```> polars str-lengths {flags} ``` diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index f78f5012e85..c0370e3b269 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.96.0 +version: 0.97.1 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -14,6 +14,12 @@ usage: |
Slices the string from the start position until the selected length.
+::: warning This command requires a plugin +The `polars str-slice` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + ## Signature ```> polars str-slice {flags} (start)``` diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index 44c0fda28f1..e48c82ee351 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Formats date based on string rule. usage: | @@ -14,6 +14,12 @@ usage: |
Formats date based on string rule.
+::: warning This command requires a plugin +The `polars strftime` 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 strftime {flags} (fmt)``` diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index 66008b2564b..f3e816353bd 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | @@ -14,6 +14,12 @@ usage: |
Creates a sum expression for an aggregation or aggregates columns to their sum value.
+::: warning This command requires a plugin +The `polars sum` 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 sum {flags} ``` diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index d451b85075d..5d659435a46 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | @@ -14,6 +14,12 @@ usage: |
For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns.
+::: warning This command requires a plugin +The `polars summary` 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 summary {flags} ``` diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index 4761cd2092d..84817dae590 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Creates new dataframe using the given indices. usage: | @@ -14,6 +14,12 @@ usage: |
Creates new dataframe using the given indices.
+::: warning This command requires a plugin +The `polars take` 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 take {flags} (indices)``` diff --git a/commands/docs/polars_to-arrow.md b/commands/docs/polars_to-arrow.md deleted file mode 100644 index ae0af0bca96..00000000000 --- a/commands/docs/polars_to-arrow.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: polars to-arrow -categories: | - dataframe -version: 0.96.0 -dataframe: | - Saves dataframe to arrow file. -usage: | - Saves dataframe to arrow file. ---- - - -# `polars to-arrow` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to arrow file.
- -## Signature - -```> polars to-arrow {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to arrow file -```nu -> [[a b]; [1 2] [3 4]] | polars into-df | polars to-arrow test.arrow - -``` diff --git a/commands/docs/polars_to-avro.md b/commands/docs/polars_to-avro.md deleted file mode 100644 index 0c201f8a008..00000000000 --- a/commands/docs/polars_to-avro.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: polars to-avro -categories: | - dataframe -version: 0.96.0 -dataframe: | - Saves dataframe to avro file. -usage: | - Saves dataframe to avro file. ---- - - -# `polars to-avro` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to avro file.
- -## Signature - -```> polars to-avro {flags} (file)``` - -## Flags - - - `--compression, -c {string}`: use compression, supports deflate or snappy - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to avro file -```nu -> [[a b]; [1 2] [3 4]] | polars into-df | polars to-avro test.avro - -``` diff --git a/commands/docs/polars_to-csv.md b/commands/docs/polars_to-csv.md deleted file mode 100644 index edf9b02f0e6..00000000000 --- a/commands/docs/polars_to-csv.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: polars to-csv -categories: | - dataframe -version: 0.96.0 -dataframe: | - Saves dataframe to CSV file. -usage: | - Saves dataframe to CSV file. ---- - - -# `polars to-csv` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to CSV file.
- -## Signature - -```> polars to-csv {flags} (file)``` - -## Flags - - - `--delimiter, -d {string}`: file delimiter character - - `--no-header, -`: Indicates if file doesn't have header - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to CSV file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv - -``` - -Saves dataframe to CSV file using other delimiter -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv --delimiter '|' - -``` diff --git a/commands/docs/polars_to-jsonl.md b/commands/docs/polars_to-jsonl.md deleted file mode 100644 index bc9c6a794c5..00000000000 --- a/commands/docs/polars_to-jsonl.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: polars to-jsonl -categories: | - dataframe -version: 0.96.0 -dataframe: | - Saves dataframe to a JSON lines file. -usage: | - Saves dataframe to a JSON lines file. ---- - - -# `polars to-jsonl` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to a JSON lines file.
- -## Signature - -```> polars to-jsonl {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to JSON lines file -```nu -> [[a b]; [1 2] [3 4]] | polars into-df | polars to-jsonl test.jsonl - -``` diff --git a/commands/docs/polars_to-parquet.md b/commands/docs/polars_to-parquet.md deleted file mode 100644 index b9f492ce096..00000000000 --- a/commands/docs/polars_to-parquet.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: polars to-parquet -categories: | - dataframe -version: 0.96.0 -dataframe: | - Saves dataframe to parquet file. -usage: | - Saves dataframe to parquet file. ---- - - -# `polars to-parquet` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to parquet file.
- -## Signature - -```> polars to-parquet {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to parquet file -```nu -> [[a b]; [1 2] [3 4]] | polars into-df | polars to-parquet test.parquet - -``` diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index f1ca2b1285f..dc43325c52f 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.96.0 +version: 0.97.1 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Returns unique values from a dataframe.
+::: warning This command requires a plugin +The `polars unique` 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 unique {flags} ``` diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index 6caff59d3b0..039f87fdb9c 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Unpivot a DataFrame from wide to long format. usage: | @@ -14,6 +14,12 @@ usage: |
Unpivot a DataFrame from wide to long format.
+::: warning This command requires a plugin +The `polars unpivot` 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 unpivot {flags} ``` diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index 89123259d04..cd3829f3c98 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.96.0 +version: 0.97.1 dataframe: | Uppercase the strings in the column. usage: | @@ -14,6 +14,12 @@ usage: |
Uppercase the strings in the column.
+::: warning This command requires a plugin +The `polars uppercase` 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 uppercase {flags} ``` diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 5b4cc854b6e..39159bb998e 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.96.0 +version: 0.97.1 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -14,6 +14,12 @@ usage: |
Returns a dataframe with the counts for unique values in series.
+::: warning This command requires a plugin +The `polars value-counts` 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 value-counts {flags} ``` diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 0ad42ce6b00..e4d6a12c26e 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Create a var expression for an aggregation. usage: | @@ -14,6 +14,12 @@ usage: |
Create a var expression for an aggregation.
+::: warning This command requires a plugin +The `polars var` 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 var {flags} ``` diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index 0d63f49648d..6ae30982c37 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.96.0 +version: 0.97.1 expression: | Creates and modifies a when expression. usage: | @@ -14,6 +14,12 @@ usage: |
Creates and modifies a when expression.
+::: warning This command requires a plugin +The `polars when` 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 when {flags} (when expression) (then expression)``` diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index 63986fef0c6..1700473072b 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.96.0 +version: 0.97.1 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | @@ -14,6 +14,12 @@ usage: |
Adds a series to the dataframe.
+::: warning This command requires a plugin +The `polars with-column` 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 with-column {flags} ...rest``` diff --git a/commands/docs/port.md b/commands/docs/port.md index 967eaec0bcd..bd775546da5 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.96.0 +version: 0.97.1 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 6ca970c1a86..176c1925b32 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 9a2fc4bf0d4..cda7383d615 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Print the given values to stdout. usage: | @@ -22,6 +22,7 @@ usage: | - `--no-newline, -n`: print without inserting a newline for the line ending - `--stderr, -e`: print to stderr instead of stdout + - `--raw, -r`: print without formatting (including binary data) ## Parameters @@ -48,6 +49,12 @@ Print the sum of 2 and 3 ``` +Print 'ABC' from binary data +```nu +> 0x[41 42 43] | print --raw + +``` + ## Notes Unlike `echo`, this command does not return any value (`print | describe` will return "nothing"). Since this command has no output, there is no point in piping it with other commands. diff --git a/commands/docs/ps.md b/commands/docs/ps.md index c747fc3acd2..39d25d1b29f 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 6ea0500abe2..dd2764bd85f 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.96.0 +version: 0.97.1 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 44893552382..7b7094d3780 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Show all the query commands usage: | @@ -14,8 +14,10 @@ usage: |
Show all the query commands
-::: warning -Command `query` resides in [plugin](/book/plugins.html) [`nu_plugin_query`](https://crates.io/crates/nu_plugin_query). To use this command, you must install/compile and register nu_plugin_query +::: warning This command requires a plugin +The `query` command resides in the `query` plugin. +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 diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 7eefd6fb44c..7562c4356ae 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.96.0 +version: 0.97.1 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 8b89da5b731..023ceb7eb27 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -14,8 +14,10 @@ usage: |
execute json query on json file (open --raw <file> | query json 'query string')
-::: warning -Command `query json` resides in [plugin](/book/plugins.html) [`nu_plugin_query`](https://crates.io/crates/nu_plugin_query). To use this command, you must install/compile and register nu_plugin_query +::: warning This command requires a plugin +The `query json` command resides in the `query` plugin. +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 diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 5aeef134146..e072c82f023 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.96.0 +version: 0.97.1 network: | execute selector query on html/web usage: | @@ -14,8 +14,10 @@ usage: |
execute selector query on html/web
-::: warning -Command `query web` resides in [plugin](/book/plugins.html) [`nu_plugin_query`](https://crates.io/crates/nu_plugin_query). To use this command, you must install/compile and register nu_plugin_query +::: warning This command requires a plugin +The `query web` command resides in the `query` plugin. +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 @@ -48,13 +50,13 @@ Retrieve all `
` elements from phoronix.com website Retrieve a html table from Wikipedia and parse it into a nushell table using table headers as guides ```nu > http get https://en.wikipedia.org/wiki/List_of_cities_in_India_by_population | - query web --as-table [City 'Population(2011)[3]' 'Population(2001)[3][a]' 'State or unionterritory' 'Ref'] + query web --as-table [City 'Population(2011)[3]' 'Population(2001)[3][a]' 'State or unionterritory' 'Reference'] ``` Pass multiple css selectors to extract several elements within single query, group the query results together and rotate them to create a table ```nu -> http get https://www.nushell.sh | query web --query 'h2, h2 + p' | each {str join} | group 2 | each {rotate --ccw tagline description} | flatten +> http get https://www.nushell.sh | query web --query 'h2, h2 + p' | each {str join} | chunks 2 | each {rotate --ccw tagline description} | flatten ``` diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index 86d75e516c2..20cb2259871 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.96.0 +version: 0.97.1 network: | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more usage: | @@ -14,6 +14,12 @@ usage: |
uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more
+::: warning This command requires a plugin +The `query webpage-info` command resides in the `query` plugin. +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 508b5fb9a78..e6d72786c3a 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | execute xpath query on xml usage: | @@ -14,8 +14,10 @@ usage: |
execute xpath query on xml
-::: warning -Command `query xml` resides in [plugin](/book/plugins.html) [`nu_plugin_query`](https://crates.io/crates/nu_plugin_query). To use this command, you must install/compile and register nu_plugin_query +::: warning This command requires a plugin +The `query xml` command resides in the `query` plugin. +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 diff --git a/commands/docs/random.md b/commands/docs/random.md index fecdc19be51..b17ac85a3ed 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.96.0 +version: 0.97.1 random: | Generate a random value. usage: | @@ -30,11 +30,12 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | -| ------------------------------------------------ | -------------------------------------------------- | -------- | -| [`random bool`](/commands/docs/random_bool.md) | Generate a random boolean value. | built-in | -| [`random chars`](/commands/docs/random_chars.md) | Generate random chars. | built-in | -| [`random dice`](/commands/docs/random_dice.md) | Generate a random dice roll. | built-in | -| [`random float`](/commands/docs/random_float.md) | Generate a random float within a range [min..max]. | built-in | -| [`random int`](/commands/docs/random_int.md) | Generate a random integer [min..max]. | built-in | -| [`random uuid`](/commands/docs/random_uuid.md) | Generate a random uuid4 string. | built-in | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | --------------------------------------------------------------------------------------------- | -------- | +| [`random binary`](/commands/docs/random_binary.md) | Generate random bytes. | built-in | +| [`random bool`](/commands/docs/random_bool.md) | Generate a random boolean value. | built-in | +| [`random chars`](/commands/docs/random_chars.md) | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. | built-in | +| [`random dice`](/commands/docs/random_dice.md) | Generate a random dice roll. | built-in | +| [`random float`](/commands/docs/random_float.md) | Generate a random float within a range [min..max]. | built-in | +| [`random int`](/commands/docs/random_int.md) | Generate a random integer [min..max]. | built-in | +| [`random uuid`](/commands/docs/random_uuid.md) | Generate a random uuid4 string. | built-in | \ No newline at end of file diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md new file mode 100644 index 00000000000..291e19b39b2 --- /dev/null +++ b/commands/docs/random_binary.md @@ -0,0 +1,38 @@ +--- +title: random binary +categories: | + random +version: 0.97.1 +random: | + Generate random bytes. +usage: | + Generate random bytes. +--- + + +# `random binary` for [random](/commands/categories/random.md) + +
Generate random bytes.
+ +## Signature + +```> random binary {flags} (length)``` + +## Parameters + + - `length`: Length of the output binary. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | binary | + +## Examples + +Generate 16 random bytes +```nu +> random binary 16 + +``` diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index d649d171376..2408f1dc761 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.96.0 +version: 0.97.1 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 72959b34b69..e13d2d6e7d1 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,17 +2,17 @@ title: random chars categories: | random -version: 0.96.0 +version: 0.97.1 random: | - Generate random chars. + Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. usage: | - Generate random chars. + Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. --- # `random chars` for [random](/commands/categories/random.md) -
Generate random chars.
+
Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9.
## Signature @@ -20,7 +20,7 @@ usage: | ## Flags - - `--length, -l {int}`: Number of chars + - `--length, -l {int}`: Number of chars (default 25) ## Input/output types: @@ -31,7 +31,7 @@ usage: | ## Examples -Generate random chars +Generate a string with 25 random chars ```nu > random chars diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index 466b5151f91..ca57ee6058e 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.96.0 +version: 0.97.1 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 2b49d2aa531..ed18aaafdb9 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.96.0 +version: 0.97.1 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 b6e158189f2..43c490e7cc6 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.96.0 +version: 0.97.1 random: | Generate a random integer [min..max]. usage: | @@ -20,7 +20,7 @@ usage: | ## Parameters - - `range`: Range of values. + - `range`: Range of potential values, inclusive of both start and end values. ## Input/output types: @@ -31,13 +31,13 @@ usage: | ## Examples -Generate an unconstrained random integer +Generate a non-negative random integer ```nu > random int ``` -Generate a random integer less than or equal to 500 +Generate a random integer between 0 (inclusive) and 500 (inclusive) ```nu > random int ..500 @@ -49,8 +49,8 @@ Generate a random integer greater than or equal to 100000 ``` -Generate a random integer between 1 and 10 +Generate a random integer between -10 (inclusive) and 10 (inclusive) ```nu -> random int 1..10 +> random int (-10)..10 ``` diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 70bea8d6623..529e4692bd9 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.96.0 +version: 0.97.1 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index f8b24c74378..98f8600f780 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index aae01b5a7f5..de9fcae662a 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 38b52e4c445..e45c09641bf 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.96.0 +version: 0.97.1 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 822e8e9365f..dc797e72024 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 379a0d94d13..9b73443c384 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.96.0 +version: 0.97.1 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 1a5aa5aa58e..062e3323e65 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 3b532391ae2..f4f0fa86e21 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index a2e8d08b580..b9a35558576 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index f4beb7f4ac9..1ab3f9e623f 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 39e58709d57..42ffc7fb1d5 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 12c3fa7675f..533793f7ddd 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 1c2564a183f..e5a4324fa6c 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 8e03f790e95..5c7f687ec5d 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.96.0 +version: 0.97.1 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 2262dc2a338..e6a8f83f899 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.96.0 +version: 0.97.1 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 00fe2a3ff3c..2e2a5ca73d5 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index d3eea3a8a35..086026cc3e9 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.96.0 +version: 0.97.1 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 687fedd0623..a53950812e2 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.96.0 +version: 0.97.1 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 6715374700e..c319631a33b 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.96.0 +version: 0.97.1 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 629c2282384..5629590a051 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.96.0 +version: 0.97.1 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 1826c1920f2..80ee699e032 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.96.0 +version: 0.97.1 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 3df57c168cb..a3458f99806 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.96.0 +version: 0.97.1 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 c5c9e268c88..910b4643dce 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.96.0 +version: 0.97.1 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 1dd4d2f52c6..71bcdd86a24 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.96.0 +version: 0.97.1 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index 17dbdc19326..3d8ec2fc6d4 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.96.0 +version: 0.97.1 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 0cf2eb07ef3..d3e7c712cf7 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.96.0 +version: 0.97.1 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 6f9c3b91327..c3061d405f3 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.96.0 +version: 0.97.1 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 7744a19774e..c4465140045 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.96.0 +version: 0.97.1 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 5ebf0534028..64399aea0df 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 585f0175c70..0380461d3f1 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.96.0 +version: 0.97.1 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 96c7f800df7..50543a4c60d 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.96.0 +version: 0.97.1 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 baaef8662f5..61962d489e5 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.96.0 +version: 0.97.1 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 d1ea0312196..cf60a8ec72f 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index f39c647c1a6..f4af1cdfd8c 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Sort by the given columns, in increasing order. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index ec13333eaad..356288f2241 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index ea7febc2e44..291f2a0532e 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.96.0 +version: 0.97.1 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 b01ae6316db..4f0f5385954 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.96.0 +version: 0.97.1 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 892eec5c426..fc2bf01b449 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Split a record into groups. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 1b569b91ec3..36ba1572af1 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index d79d44d384f..890559ae4a2 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.96.0 +version: 0.97.1 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 7784d910e1f..eefa5b16f35 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.96.0 +version: 0.97.1 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 f12e12ca902..db3dce396e8 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.96.0 +version: 0.97.1 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 74aa1b8f21e..ebf5e27ced6 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.96.0 +version: 0.97.1 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 5c7cbfec216..b5d9cb1875a 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 408e10c92ab..c5ebf0af965 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 2bb3f71ffa8..d09f32d02fe 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.96.0 +version: 0.97.1 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 70a3d3d1cec..aad6d0fd56e 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.96.0 +version: 0.97.1 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 ce4028e105b..069fe150a4e 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.96.0 +version: 0.97.1 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 b300968124f..695e288a003 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.96.0 +version: 0.97.1 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 d9aedb91d1d..06e8fd8a76e 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.96.0 +version: 0.97.1 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 b3dfaa88b23..3cad169e034 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.96.0 +version: 0.97.1 database: | Insert information into a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index 4e0cc7b49c6..dd9e5259373 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.96.0 +version: 0.97.1 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index ed880e4fa2f..d1a98e2a843 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.96.0 +version: 0.97.1 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 698fb7dd9c5..fd21d743f74 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.96.0 +version: 0.97.1 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 743eee5d8cd..6fd7fde5e83 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.96.0 +version: 0.97.1 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 a85b1f45531..134c9de2f9b 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.96.0 +version: 0.97.1 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index cf85b32c667..3dd21915dfd 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 3d1b2293e3c..eb7f46b32c4 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_deunicode.md b/commands/docs/str_deunicode.md index f7444130dbe..e7d70088928 100644 --- a/commands/docs/str_deunicode.md +++ b/commands/docs/str_deunicode.md @@ -2,7 +2,7 @@ title: str deunicode categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Convert Unicode string to pure ASCII. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 375a91aecea..afcb68ab8ed 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.96.0 +version: 0.97.1 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 8bcd7f4088f..5a969e2da83 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 218b5e7d5e7..ab71a18f652 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.96.0 +version: 0.97.1 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 4716bb4da68..e734c77687c 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.96.0 +version: 0.97.1 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 fa42e82e8a4..7088b9317a1 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.96.0 +version: 0.97.1 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 a3d6f634855..74e855d5301 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.96.0 +version: 0.97.1 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 61089d36466..949f95833ca 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.96.0 +version: 0.97.1 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 84fb0bada35..bd3ce17d9e7 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.96.0 +version: 0.97.1 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 2617acd7412..2e72c98765b 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.96.0 +version: 0.97.1 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 424bb959a60..8a828b8310b 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index 3b5eb17bca4..05150cabafa 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.96.0 +version: 0.97.1 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 0a42f583cbb..363adcd0ecf 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.96.0 +version: 0.97.1 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 e872b1edd6a..ddc8fbee2e1 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.96.0 +version: 0.97.1 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 5f5fbe5945b..d527aa631a9 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.96.0 +version: 0.97.1 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 488f3dd4d0e..bd63c1a81c7 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 0161b986c8d..615f2184d72 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.96.0 +version: 0.97.1 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 f56874af89f..965939039fb 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.96.0 +version: 0.97.1 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 76bdcb2398b..33aadaf9a5b 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 2c925d4b86d..ac60d3d8ab4 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.96.0 +version: 0.97.1 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index b98c704d5c8..e63b3c1e1bd 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 52336bede29..6a5da3664ad 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index b239765131b..e68ed49a20a 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 17f6e40cc4a..ca3e6a3c78d 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index e242a5e978f..0fc3c2c2f35 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index 9fbff7388dc..e262da94ec4 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the system network interfaces. usage: | diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md index f144c7ea67d..78dda0aa0d5 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.96.0 +version: 0.97.1 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index e0c57684ac5..74d304d40aa 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.96.0 +version: 0.97.1 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 03b069d4bca..1ecb33b8404 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.96.0 +version: 0.97.1 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 4949ef3c8b4..544cbdc4a09 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.96.0 +version: 0.97.1 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 c93ea704af0..c61fab5e144 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.96.0 +version: 0.97.1 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 4c57e7212f8..377c7fce275 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.96.0 +version: 0.97.1 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 a9d642d600f..895a44f691e 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.96.0 +version: 0.97.1 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 830f3128a3f..e92ef7a8db0 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.96.0 +version: 0.97.1 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 e43bb4ec70a..568f19811bf 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 449acd61b9a..c834ecf6d97 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Translate structured data to a format. usage: | @@ -39,6 +39,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`to msgpack`](/commands/docs/to_msgpack.md) | Convert Nu values into MessagePack. | built-in | | [`to msgpackz`](/commands/docs/to_msgpackz.md) | Convert Nu values into brotli-compressed MessagePack. | built-in | | [`to nuon`](/commands/docs/to_nuon.md) | Converts table data into Nuon (Nushell Object Notation) text. | built-in | +| [`to plist`](/commands/docs/to_plist.md) | Convert Nu values into plist | plugin | | [`to text`](/commands/docs/to_text.md) | Converts data into simple text. | built-in | | [`to toml`](/commands/docs/to_toml.md) | Convert record into .toml text. | built-in | | [`to tsv`](/commands/docs/to_tsv.md) | Convert table into .tsv text. | built-in | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 05151872506..7f7c04a5d5a 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 4cf3b559322..8461938fd52 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index bda2cb9e865..2bcac0b7a13 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 38e6a514b09..fad02fb434f 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 0dff34552d3..d20dba78d57 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 39127b48ee8..7cf3b8a671a 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index ce2fa0464b6..5e5ec11b1ea 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.96.0 +version: 0.97.1 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 new file mode 100644 index 00000000000..21b4c804379 --- /dev/null +++ b/commands/docs/to_plist.md @@ -0,0 +1,44 @@ +--- +title: to plist +categories: | + formats +version: 0.97.1 +formats: | + Convert Nu values into plist +usage: | + Convert Nu values into plist +--- + + +# `to plist` for [formats](/commands/categories/formats.md) + +
Convert Nu values into plist
+ +::: warning This command requires a plugin +The `to plist` command resides in the `formats` plugin. +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} ``` + +## Flags + + - `--binary, -b`: Output plist in binary format + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Convert a table into a plist file +```nu +> { a: 3 } | to plist + +``` diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 06b64a9812b..1a00cad2a0d 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index d760df46bb0..fcf0222d28b 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 3c239fab3eb..443fa76d137 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 8d217b4e449..02b5676ecfb 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index f9de0c4046b..68ab44c791a 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.96.0 +version: 0.97.1 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 8c57599cace..5748869f81b 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.96.0 +version: 0.97.1 filesystem: | Creates one or more files. usage: | @@ -56,12 +56,6 @@ Changes the last modified time of "fixture.json" to today's date ``` -Changes the last modified time of files a, b and c to a date -```nu -> touch -m -d "yesterday" a b c - -``` - Changes the last modified time of file d and e to "fixture.json"'s last modified time ```nu > touch -m -r fixture.json d e diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index 2dccb8a995d..73398d9404e 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.96.0 +version: 0.97.1 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 5778588aba6..37380d8755d 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.96.0 +version: 0.97.1 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 9b74ecce680..6a73f9e1d74 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.96.0 +version: 0.97.1 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index f8787ac2e54..a229643cf49 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 421657121d9..792421977c0 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.96.0 +version: 0.97.1 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 23b88b55b19..1f5ba983393 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.96.0 +version: 0.97.1 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 f089d727fe2..6c6b19b34c6 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 4d11dcde644..7db6355a97d 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.96.0 +version: 0.97.1 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 bb20b6d2ff1..b60db126013 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index df7bd332206..90ca983925c 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.96.0 +version: 0.97.1 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 5e40280b689..3e06285a480 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.96.0 +version: 0.97.1 network: | Various commands for working with URLs. usage: | diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 83d51a7d158..3bf7fe3b118 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.96.0 +version: 0.97.1 network: | Converts record or table into query string applying percent-encoding. usage: | diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index 4a897d7f98c..43048fb2392 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.96.0 +version: 0.97.1 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 b1c0293baaa..96c4d213b26 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.96.0 +version: 0.97.1 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 84376278505..27dff05b700 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.96.0 +version: 0.97.1 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index 9a2c2391452..40976593a60 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.96.0 +version: 0.97.1 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 3c77ac618d5..ce409db581d 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.96.0 +version: 0.97.1 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 3e44ecd6ea8..d9de1b69896 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.96.0 +version: 0.97.1 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 48a42a2c7ee..03fc23f4712 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.96.0 +version: 0.97.1 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 9aea09aef97..b817519a190 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index daf6d51368e..2e0e271413f 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.96.0 +version: 0.97.1 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 a17c518f169..a43c412ce3e 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.96.0 +version: 0.97.1 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 1fb1665a3ae..8114a76d60e 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 7e1ab3232c7..a88de06c943 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.96.0 +version: 0.97.1 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index db8e92963b9..0fa551b6aac 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.96.0 +version: 0.97.1 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 96a948ef91d..fe222b2baa9 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 76ee6b5f069..2c9ae6c27d7 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.96.0 +version: 0.97.1 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 2221eaba497..fb42e621d55 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.96.0 +version: 0.97.1 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 24a6e753381..83082c76747 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.96.0 +version: 0.97.1 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 60135b59ee2..eabed4f08ac 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.96.0 +version: 0.97.1 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 03d3c9d0a1a..19ebb63b792 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.96.0 +version: 0.97.1 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 93cf1e1d92e..ede649ea385 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 5be453fa2d9..234c430af6f 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.96.0 +version: 0.97.1 filters: | Combine a stream with the input. usage: |