diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 2dc5ca1b757..68e92ff44fb 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -30,4 +30,4 @@ export const commandCategories = [ '/commands/categories/strings.md', '/commands/categories/system.md', '/commands/categories/viewers.md', -]; \ No newline at end of file +]; diff --git a/commands/docs/alias.md b/commands/docs/alias.md index fbf1157ac95..c805bb3837b 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.86.0 +version: 0.87.0 core: | Alias a command (with optional flags) to a new name. usage: | diff --git a/commands/docs/all.md b/commands/docs/all.md index 0e3dcc58959..78e05c6d6df 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Test if every element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index 902ce5bb86f..34a796a1036 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Output ANSI codes to change color and style of text. usage: | @@ -63,7 +63,7 @@ Hello Nu World Use escape codes, without the '\x1b[' ```nu -> $"(ansi -e '3;93;41m')Hello(ansi reset)" # italic bright yellow on red background +> $"(ansi --escape '3;93;41m')Hello(ansi reset)" # italic bright yellow on red background Hello ``` @@ -74,7 +74,7 @@ Use structured escape codes bg: '#ff0000' attr: b } - $"(ansi -e $bold_blue_on_red)Hello Nu World(ansi reset)" + $"(ansi --escape $bold_blue_on_red)Hello Nu World(ansi reset)" Hello Nu World ``` diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index 9754249f541..5f973b9eed3 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 095eb30b3a8..39c1183c515 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | @@ -55,6 +55,3 @@ Format a table column into links > [[url text]; [https://example.com Text]] | ansi link url ``` - - -**Tips:** Command `ansi link` was not included in the official binaries by default, you have to build it with `--features=extra` flag \ No newline at end of file diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 3a1678b9928..d89deba5ec5 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index a76eede39d0..bae1c1bb67c 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Tests if any element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/append.md b/commands/docs/append.md index 9f88f131731..f42295489c9 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 02817c1ce52..489e5c2e588 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 66514a0027c..6c973a23aad 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index e809d3c0cb2..d2d9e7deeec 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Performs bitwise and for ints. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index f5cb0745f08..b977102a52e 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index fced85ca6de..be9bcccbeee 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Performs bitwise or for ints. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index db83c819f1b..6440886930c 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Bitwise rotate left for ints. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 87fe1558e04..1b908723e24 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Bitwise rotate right for ints. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 7579be2060b..4d6ae1f253d 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Bitwise shift left for ints. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index b1fedd42572..7d3644925b1 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Bitwise shift right for ints. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index 32afd0adb20..14b7ce43b16 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.86.0 +version: 0.87.0 bits: | Performs bitwise xor for ints. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 6fc96194d94..0b982c70a71 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.86.0 +version: 0.87.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index c77699f3ae7..dfa4883f773 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index d187c34c01c..58de3a55dec 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 1113c3e2e88..47269f35867 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Get bytes defined by a range usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 0fe322dd88f..ae7133b4d3a 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index a2dd5d1d9c0..9f2df77cb17 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index 2f03bbd176e..041bcf2e9d9 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.86.0 +version: 0.87.0 bytes: | Check if bytes ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 51e50ff5f6d..13dddb3f178 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.86.0 +version: 0.87.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 2886fcc6dfa..2a51f89a10b 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Output the length of any bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index e2b5f31f9a0..dce5470d003 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 23a361cd554..e330e5ac8f2 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index f59233dd069..77745621e1a 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.86.0 +version: 0.87.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index a42ccbe1741..5a5115a8daf 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.86.0 +version: 0.87.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 88a9f602a3a..4a1bd698a4c 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.86.0 +version: 0.87.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 63851de84de..04f15b33a9e 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 788b492a577..1d23b9dcccb 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Output special characters (e.g., 'newline'). usage: | @@ -60,18 +60,18 @@ Output prompt character, newline and a hamburger menu character Output Unicode character ```nu -> char -u 1f378 +> char --unicode 1f378 ๐Ÿธ ``` Create Unicode from integer codepoint values ```nu -> char -i (0x60 + 1) (0x60 + 2) +> char --integer (0x60 + 1) (0x60 + 2) ab ``` Output multi-byte Unicode character ```nu -> char -u 1F468 200D 1F466 200D 1F466 +> char --unicode 1F468 200D 1F466 200D 1F466 ๐Ÿ‘จโ€๐Ÿ‘ฆโ€๐Ÿ‘ฆ ``` diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 72d4dc7b446..754ae6e4b93 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index e3ebc072e8f..446b476ceca 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Collect the stream and pass it to a block. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 9fda29d1c11..16a9be8f677 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Given a record or table, produce a list of its columns' names. usage: | diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index 860e309113e..a9e1ef429c1 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.86.0 +version: 0.87.0 core: | View or modify the current command line input buffer. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index bf85d9e665e..020f9e422d3 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Creates a table with non-empty rows. usage: | @@ -18,6 +18,10 @@ usage: | ```> compact {flags} ...rest``` +## Flags + + - `--empty, -e`: also compact empty items like "", {}, and [] + ## Parameters - `...rest`: the columns to compact from the table @@ -31,7 +35,7 @@ usage: | | table | table | ## Examples -Filter out all records where 'Hello' is null (returns nothing) +Filter out all records where 'Hello' is null ```nu > [["Hello" "World"]; [null 3]] | compact Hello โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ @@ -39,7 +43,7 @@ Filter out all records where 'Hello' is null (returns nothing) โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ``` -Filter out all records where 'World' is null (Returns the table) +Filter out all records where 'World' is null ```nu > [["Hello" "World"]; [null 3]] | compact World โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ @@ -50,7 +54,7 @@ Filter out all records where 'World' is null (Returns the table) ``` -Filter out all instances of nothing from a list (Returns [1,2]) +Filter out all instances of null from a list ```nu > [1, null, 2] | compact โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ•ฎ @@ -59,3 +63,16 @@ Filter out all instances of nothing from a list (Returns [1,2]) โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ ``` + +Filter out all instances of null and empty items from a list +```nu +> [1, null, 2, "", 3, [], 4, {}, 5] | compact --empty +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ•ฎ +โ”‚ 0 โ”‚ 1 โ”‚ +โ”‚ 1 โ”‚ 2 โ”‚ +โ”‚ 2 โ”‚ 3 โ”‚ +โ”‚ 3 โ”‚ 4 โ”‚ +โ”‚ 4 โ”‚ 5 โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ + +``` diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 18382754eed..374811445fd 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.86.0 +version: 0.87.0 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | diff --git a/commands/docs/config.md b/commands/docs/config.md index 7eda8c7ebea..5f3e693b8f9 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.86.0 +version: 0.87.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 2b50bbd07f5..671cddf11fc 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.86.0 +version: 0.87.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 2b6152e04a5..8f0e36418f6 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.86.0 +version: 0.87.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 0fbf749635c..2fa6c4cc861 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.86.0 +version: 0.87.0 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 6e6833e2170..f4e8289f83d 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index ce8b548400f..213eb2ce014 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.86.0 +version: 0.87.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp-old.md b/commands/docs/cp-old.md index 4bebc2bbef9..5a3c60b3682 100644 --- a/commands/docs/cp-old.md +++ b/commands/docs/cp-old.md @@ -2,7 +2,7 @@ title: cp-old categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Old nushell version of Copy files. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 7b4371504ff..107342fea03 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Copy files using uutils/coreutils cp. usage: | @@ -26,6 +26,7 @@ usage: | again (this option is ignored when the -n option is also used). currently not implemented for windows - `--interactive, -i`: ask before overwriting files + - `--update, -u`: copy only when the SOURCE file is newer than the destination file or when the destination file is missing - `--progress, -p`: display a progress bar - `--no-clobber, -n`: do not overwrite an existing file - `--debug, -`: explain how a file is copied. Implies -v @@ -66,3 +67,9 @@ Move many files into a directory > cp *.txt dir_a ``` + +Copy only if source file is newer than target file +```nu +> cp -u a b + +``` diff --git a/commands/docs/date.md b/commands/docs/date.md index 9c46f065f93..0d02e50906d 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.86.0 +version: 0.87.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 72518ce091a..8c7228261a3 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.86.0 +version: 0.87.0 removed: | Removed command: use `format date` instead usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 9822f2267ed..0d6cbf68f28 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.86.0 +version: 0.87.0 date: | Print a 'humanized' format for the date, relative to now. usage: | diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index 8f8c99d8847..da0045731a7 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.86.0 +version: 0.87.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 3942add37a5..fd767355618 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.86.0 +version: 0.87.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index 3db73cacc35..be1fc12c56a 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.86.0 +version: 0.87.0 date: | Convert the date into a record. usage: | diff --git a/commands/docs/date_to-table.md b/commands/docs/date_to-table.md index 657ebf842e3..7c606994604 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.86.0 +version: 0.87.0 date: | Convert the date into a structured table. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index fb140670fa1..ac83003d7c9 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.86.0 +version: 0.87.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index c1db9b77685..f8282faf088 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 482c9ee4280..8d3039043dc 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | View process memory info. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index a896a423b00..622c4f15677 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 94a3f281446..e3ac7326f8d 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.86.0 +version: 0.87.0 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 886af7b66de..319ab1d7b98 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def-env.md b/commands/docs/def-env.md index b3263afd715..e2fcdd3fc11 100644 --- a/commands/docs/def-env.md +++ b/commands/docs/def-env.md @@ -2,7 +2,7 @@ title: def-env categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a custom command, which participates in the caller environment. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index fc618b3a693..ae5e36a1536 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 1566c001cd8..96371ac6329 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Sets a default row's column if missing. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index 9a9b5fab53a..b41c3a9422b 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.86.0 +version: 0.87.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -21,6 +21,8 @@ usage: | ## Flags - `--no-collect, -n`: do not collect streams of structured data + - `--detailed, -d`: show detailed information about the value + - `--collect-lazyrecords, -l`: collect lazy records ## Input/output types: @@ -36,3 +38,64 @@ Describe the type of a string > 'hello' | describe string ``` + +Describe the type of a record in a detailed way +```nu +> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| print $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d +โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ +โ”‚ type โ”‚ record โ”‚ +โ”‚ lazy โ”‚ false โ”‚ +โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ +โ”‚ columns โ”‚ โ”‚ shell โ”‚ string โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ uwu โ”‚ bool โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ features โ”‚ โ”‚ type โ”‚ record โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ lazy โ”‚ false โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ columns โ”‚ โ”‚ bugs โ”‚ bool โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ multiplatform โ”‚ bool โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ speed โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ fib โ”‚ โ”‚ type โ”‚ list โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ length โ”‚ 6 โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ values โ”‚ โ”‚ 0 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ 1 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ 2 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ 3 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ 4 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ 5 โ”‚ int โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ on_save โ”‚ โ”‚ type โ”‚ closure โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ signature โ”‚ โ”‚ name โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ category โ”‚ default โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ first_commit โ”‚ date โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ my_duration โ”‚ duration โ”‚ โ”‚ +โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ โ”‚ +โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ +``` + +Describe the type of a stream with detailed information +```nu +> [1 2 3] | each {|i| echo $i} | describe -d + +``` + +Describe a stream of data, collecting it first +```nu +> [1 2 3] | each {|i| echo $i} | describe + +``` + +Describe the input but do not collect streams +```nu +> [1 2 3] | each {|i| echo $i} | describe --no-collect + +``` diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 1b3865f5fe5..e669f589d0a 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Attempt to automatically split text into multiple columns. usage: | @@ -35,7 +35,7 @@ usage: | Splits string across multiple columns ```nu -> 'a b c' | detect columns -n +> 'a b c' | detect columns --no-headers โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ column0 โ”‚ column1 โ”‚ column2 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -46,19 +46,19 @@ Splits string across multiple columns ```nu -> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns -c 0..1 +> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns --combine-columns 0..1 ``` Splits a multi-line string into columns with headers detected ```nu -> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns -c -2..-1 +> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns --combine-columns -2..-1 ``` Splits a multi-line string into columns with headers detected ```nu -> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns -c 2.. +> $'c1 c2 c3 c4 c5(char nl)a b c d e' | detect columns --combine-columns 2.. ``` diff --git a/commands/docs/dfr.md b/commands/docs/dfr.md index 1835e218598..ea88a3714b3 100644 --- a/commands/docs/dfr.md +++ b/commands/docs/dfr.md @@ -2,7 +2,7 @@ title: dfr categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Operate with data in a dataframe format. usage: | diff --git a/commands/docs/dfr_agg-groups.md b/commands/docs/dfr_agg-groups.md index ff67a1bdb56..993a861fa97 100644 --- a/commands/docs/dfr_agg-groups.md +++ b/commands/docs/dfr_agg-groups.md @@ -2,7 +2,7 @@ title: dfr agg-groups categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | creates an agg_groups expression usage: | diff --git a/commands/docs/dfr_agg.md b/commands/docs/dfr_agg.md index b1b312c0e27..abadbe70728 100644 --- a/commands/docs/dfr_agg.md +++ b/commands/docs/dfr_agg.md @@ -2,7 +2,7 @@ title: dfr agg categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | diff --git a/commands/docs/dfr_all-false.md b/commands/docs/dfr_all-false.md index 94ee6fcb285..a278c396758 100644 --- a/commands/docs/dfr_all-false.md +++ b/commands/docs/dfr_all-false.md @@ -2,7 +2,7 @@ title: dfr all-false categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns true if all values are false. usage: | diff --git a/commands/docs/dfr_all-true.md b/commands/docs/dfr_all-true.md index 1ff1fa52b15..fc870d9c1cf 100644 --- a/commands/docs/dfr_all-true.md +++ b/commands/docs/dfr_all-true.md @@ -2,7 +2,7 @@ title: dfr all-true categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns true if all values are true. usage: | diff --git a/commands/docs/dfr_append.md b/commands/docs/dfr_append.md index 62452170289..d88d58bf13f 100644 --- a/commands/docs/dfr_append.md +++ b/commands/docs/dfr_append.md @@ -2,7 +2,7 @@ title: dfr append categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/dfr_arg-max.md b/commands/docs/dfr_arg-max.md index 4332048b51f..85fce29fa86 100644 --- a/commands/docs/dfr_arg-max.md +++ b/commands/docs/dfr_arg-max.md @@ -2,7 +2,7 @@ title: dfr arg-max categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Return index for max value in series. usage: | diff --git a/commands/docs/dfr_arg-min.md b/commands/docs/dfr_arg-min.md index be24e01412d..3ea861640b2 100644 --- a/commands/docs/dfr_arg-min.md +++ b/commands/docs/dfr_arg-min.md @@ -2,7 +2,7 @@ title: dfr arg-min categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Return index for min value in series. usage: | diff --git a/commands/docs/dfr_arg-sort.md b/commands/docs/dfr_arg-sort.md index aac77956c8f..5f0eebf7527 100644 --- a/commands/docs/dfr_arg-sort.md +++ b/commands/docs/dfr_arg-sort.md @@ -2,7 +2,7 @@ title: dfr arg-sort categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns indexes for a sorted series. usage: | diff --git a/commands/docs/dfr_arg-true.md b/commands/docs/dfr_arg-true.md index 9d70aa9a8e9..020297e2ef1 100644 --- a/commands/docs/dfr_arg-true.md +++ b/commands/docs/dfr_arg-true.md @@ -2,7 +2,7 @@ title: dfr arg-true categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns indexes where values are true. usage: | diff --git a/commands/docs/dfr_arg-unique.md b/commands/docs/dfr_arg-unique.md index a2c0ca76da5..366a58594b0 100644 --- a/commands/docs/dfr_arg-unique.md +++ b/commands/docs/dfr_arg-unique.md @@ -2,7 +2,7 @@ title: dfr arg-unique categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns indexes for unique values. usage: | diff --git a/commands/docs/dfr_arg-where.md b/commands/docs/dfr_arg-where.md index 9cef8e2c435..9cd22e76548 100644 --- a/commands/docs/dfr_arg-where.md +++ b/commands/docs/dfr_arg-where.md @@ -2,7 +2,7 @@ title: dfr arg-where categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | diff --git a/commands/docs/dfr_as-date.md b/commands/docs/dfr_as-date.md index dea8043552f..13073b44a3b 100644 --- a/commands/docs/dfr_as-date.md +++ b/commands/docs/dfr_as-date.md @@ -2,7 +2,7 @@ title: dfr as-date categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/dfr_as-datetime.md b/commands/docs/dfr_as-datetime.md index 65dca4ba879..863d89eddc6 100644 --- a/commands/docs/dfr_as-datetime.md +++ b/commands/docs/dfr_as-datetime.md @@ -2,7 +2,7 @@ title: dfr as-datetime categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/dfr_as.md b/commands/docs/dfr_as.md index 13712412394..c4fe0279555 100644 --- a/commands/docs/dfr_as.md +++ b/commands/docs/dfr_as.md @@ -2,7 +2,7 @@ title: dfr as categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/dfr_cache.md b/commands/docs/dfr_cache.md index 49b45f14711..2fdc2535d39 100644 --- a/commands/docs/dfr_cache.md +++ b/commands/docs/dfr_cache.md @@ -2,7 +2,7 @@ title: dfr cache categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Caches operations in a new LazyFrame usage: | diff --git a/commands/docs/dfr_col.md b/commands/docs/dfr_col.md index dbf1277d710..9dc8bbf9b38 100644 --- a/commands/docs/dfr_col.md +++ b/commands/docs/dfr_col.md @@ -2,7 +2,7 @@ title: dfr col categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/dfr_collect.md b/commands/docs/dfr_collect.md index 74b8c75dd40..e1fcd9e5560 100644 --- a/commands/docs/dfr_collect.md +++ b/commands/docs/dfr_collect.md @@ -2,7 +2,7 @@ title: dfr collect categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/dfr_columns.md b/commands/docs/dfr_columns.md index e9fd8acf601..e8cddfd94f9 100644 --- a/commands/docs/dfr_columns.md +++ b/commands/docs/dfr_columns.md @@ -2,7 +2,7 @@ title: dfr columns categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/dfr_concat-str.md b/commands/docs/dfr_concat-str.md index 17fc3293216..2a273e57b9e 100644 --- a/commands/docs/dfr_concat-str.md +++ b/commands/docs/dfr_concat-str.md @@ -2,7 +2,7 @@ title: dfr concat-str categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/dfr_concatenate.md b/commands/docs/dfr_concatenate.md index 449e568cfad..0fd4d5e3c36 100644 --- a/commands/docs/dfr_concatenate.md +++ b/commands/docs/dfr_concatenate.md @@ -2,7 +2,7 @@ title: dfr concatenate categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Concatenates strings with other array. usage: | diff --git a/commands/docs/dfr_contains.md b/commands/docs/dfr_contains.md index 219760aad23..9e9793e21ed 100644 --- a/commands/docs/dfr_contains.md +++ b/commands/docs/dfr_contains.md @@ -2,7 +2,7 @@ title: dfr contains categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/dfr_count-null.md b/commands/docs/dfr_count-null.md index 0913fdbcbe7..5270c77b87b 100644 --- a/commands/docs/dfr_count-null.md +++ b/commands/docs/dfr_count-null.md @@ -2,7 +2,7 @@ title: dfr count-null categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/dfr_count.md b/commands/docs/dfr_count.md index 3550e080573..08110dfa6eb 100644 --- a/commands/docs/dfr_count.md +++ b/commands/docs/dfr_count.md @@ -2,7 +2,7 @@ title: dfr count categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | creates a count expression usage: | diff --git a/commands/docs/dfr_cumulative.md b/commands/docs/dfr_cumulative.md index aa97c860e15..2a88b9c1ae8 100644 --- a/commands/docs/dfr_cumulative.md +++ b/commands/docs/dfr_cumulative.md @@ -2,7 +2,7 @@ title: dfr cumulative categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Cumulative calculation for a series. usage: | diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md index 1c6404d8228..9b052c56f76 100644 --- a/commands/docs/dfr_datepart.md +++ b/commands/docs/dfr_datepart.md @@ -2,7 +2,7 @@ title: dfr datepart categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | diff --git a/commands/docs/dfr_drop-duplicates.md b/commands/docs/dfr_drop-duplicates.md index f42eb135307..691064f6005 100644 --- a/commands/docs/dfr_drop-duplicates.md +++ b/commands/docs/dfr_drop-duplicates.md @@ -2,7 +2,7 @@ title: dfr drop-duplicates categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Drops duplicate values in dataframe. usage: | diff --git a/commands/docs/dfr_drop-nulls.md b/commands/docs/dfr_drop-nulls.md index ceedd472954..9ff38af3db0 100644 --- a/commands/docs/dfr_drop-nulls.md +++ b/commands/docs/dfr_drop-nulls.md @@ -2,7 +2,7 @@ title: dfr drop-nulls categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/dfr_drop.md b/commands/docs/dfr_drop.md index 0450443d48d..4ef1cea1ecd 100644 --- a/commands/docs/dfr_drop.md +++ b/commands/docs/dfr_drop.md @@ -2,7 +2,7 @@ title: dfr drop categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | diff --git a/commands/docs/dfr_dtypes.md b/commands/docs/dfr_dtypes.md index a2239cc73f6..c7b0ed50d43 100644 --- a/commands/docs/dfr_dtypes.md +++ b/commands/docs/dfr_dtypes.md @@ -2,7 +2,7 @@ title: dfr dtypes categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Show dataframe data types. usage: | diff --git a/commands/docs/dfr_dummies.md b/commands/docs/dfr_dummies.md index e1569374318..7c0378ee08c 100644 --- a/commands/docs/dfr_dummies.md +++ b/commands/docs/dfr_dummies.md @@ -2,7 +2,7 @@ title: dfr dummies categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/dfr_explode.md b/commands/docs/dfr_explode.md index 4465ee7e1e8..d7e93dca073 100644 --- a/commands/docs/dfr_explode.md +++ b/commands/docs/dfr_explode.md @@ -2,7 +2,7 @@ title: dfr explode categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/dfr_expr-not.md b/commands/docs/dfr_expr-not.md index d6937c37edd..44a45206d56 100644 --- a/commands/docs/dfr_expr-not.md +++ b/commands/docs/dfr_expr-not.md @@ -2,7 +2,7 @@ title: dfr expr-not categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | creates a not expression usage: | diff --git a/commands/docs/dfr_fetch.md b/commands/docs/dfr_fetch.md index 2005d438615..2b68d9fe781 100644 --- a/commands/docs/dfr_fetch.md +++ b/commands/docs/dfr_fetch.md @@ -2,7 +2,7 @@ title: dfr fetch categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | collects the lazyframe to the selected rows. usage: | diff --git a/commands/docs/dfr_fill-nan.md b/commands/docs/dfr_fill-nan.md index 51fd12efd73..fcd7a1a0de0 100644 --- a/commands/docs/dfr_fill-nan.md +++ b/commands/docs/dfr_fill-nan.md @@ -2,7 +2,7 @@ title: dfr fill-nan categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Replaces NaN values with the given expression. usage: | diff --git a/commands/docs/dfr_fill-null.md b/commands/docs/dfr_fill-null.md index e80a2b79882..68d24e7e6a9 100644 --- a/commands/docs/dfr_fill-null.md +++ b/commands/docs/dfr_fill-null.md @@ -2,7 +2,7 @@ title: dfr fill-null categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Replaces NULL values with the given expression. usage: | diff --git a/commands/docs/dfr_filter-with.md b/commands/docs/dfr_filter-with.md index ceb782263f5..44efd795cb6 100644 --- a/commands/docs/dfr_filter-with.md +++ b/commands/docs/dfr_filter-with.md @@ -2,7 +2,7 @@ title: dfr filter-with categories: | dataframe or lazyframe -version: 0.86.0 +version: 0.87.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | diff --git a/commands/docs/dfr_filter.md b/commands/docs/dfr_filter.md index 5a2f53f4690..7c66165cd50 100644 --- a/commands/docs/dfr_filter.md +++ b/commands/docs/dfr_filter.md @@ -2,7 +2,7 @@ title: dfr filter categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/dfr_first.md b/commands/docs/dfr_first.md index 4ba4d5ee72d..c70c058ad8e 100644 --- a/commands/docs/dfr_first.md +++ b/commands/docs/dfr_first.md @@ -2,7 +2,7 @@ title: dfr first categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Show only the first number of rows or create a first expression usage: | diff --git a/commands/docs/dfr_flatten.md b/commands/docs/dfr_flatten.md index d4a0dded377..ad52fdf694f 100644 --- a/commands/docs/dfr_flatten.md +++ b/commands/docs/dfr_flatten.md @@ -2,7 +2,7 @@ title: dfr flatten categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | An alias for dfr explode usage: | diff --git a/commands/docs/dfr_get-day.md b/commands/docs/dfr_get-day.md index ddd2ee5f387..1e008388030 100644 --- a/commands/docs/dfr_get-day.md +++ b/commands/docs/dfr_get-day.md @@ -2,7 +2,7 @@ title: dfr get-day categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/dfr_get-hour.md b/commands/docs/dfr_get-hour.md index 0f691da3e7b..2703c316026 100644 --- a/commands/docs/dfr_get-hour.md +++ b/commands/docs/dfr_get-hour.md @@ -2,7 +2,7 @@ title: dfr get-hour categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets hour from date. usage: | diff --git a/commands/docs/dfr_get-minute.md b/commands/docs/dfr_get-minute.md index 1a5afeefaa1..ea34a6e9542 100644 --- a/commands/docs/dfr_get-minute.md +++ b/commands/docs/dfr_get-minute.md @@ -2,7 +2,7 @@ title: dfr get-minute categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/dfr_get-month.md b/commands/docs/dfr_get-month.md index 9dfc4e497fe..176039c1e70 100644 --- a/commands/docs/dfr_get-month.md +++ b/commands/docs/dfr_get-month.md @@ -2,7 +2,7 @@ title: dfr get-month categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/dfr_get-nanosecond.md b/commands/docs/dfr_get-nanosecond.md index c67774389fc..bd35c63abbb 100644 --- a/commands/docs/dfr_get-nanosecond.md +++ b/commands/docs/dfr_get-nanosecond.md @@ -2,7 +2,7 @@ title: dfr get-nanosecond categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/dfr_get-ordinal.md b/commands/docs/dfr_get-ordinal.md index 7496c74715f..ef4792d703d 100644 --- a/commands/docs/dfr_get-ordinal.md +++ b/commands/docs/dfr_get-ordinal.md @@ -2,7 +2,7 @@ title: dfr get-ordinal categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/dfr_get-second.md b/commands/docs/dfr_get-second.md index 2b5e184af40..e3c3aa69016 100644 --- a/commands/docs/dfr_get-second.md +++ b/commands/docs/dfr_get-second.md @@ -2,7 +2,7 @@ title: dfr get-second categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/dfr_get-week.md b/commands/docs/dfr_get-week.md index af81c7696bf..d178b0a9db4 100644 --- a/commands/docs/dfr_get-week.md +++ b/commands/docs/dfr_get-week.md @@ -2,7 +2,7 @@ title: dfr get-week categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/dfr_get-weekday.md b/commands/docs/dfr_get-weekday.md index 4fe71b649c8..4f1691ea92a 100644 --- a/commands/docs/dfr_get-weekday.md +++ b/commands/docs/dfr_get-weekday.md @@ -2,7 +2,7 @@ title: dfr get-weekday categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/dfr_get-year.md b/commands/docs/dfr_get-year.md index 5b43cee11d1..2fbbde8b60d 100644 --- a/commands/docs/dfr_get-year.md +++ b/commands/docs/dfr_get-year.md @@ -2,7 +2,7 @@ title: dfr get-year categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/dfr_get.md b/commands/docs/dfr_get.md index 5ddfde41377..9c87af9b7ba 100644 --- a/commands/docs/dfr_get.md +++ b/commands/docs/dfr_get.md @@ -2,7 +2,7 @@ title: dfr get categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates dataframe with the selected columns. usage: | diff --git a/commands/docs/dfr_group-by.md b/commands/docs/dfr_group-by.md index a3f0a37a0ae..73bd5f86039 100644 --- a/commands/docs/dfr_group-by.md +++ b/commands/docs/dfr_group-by.md @@ -2,7 +2,7 @@ title: dfr group-by categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/dfr_implode.md b/commands/docs/dfr_implode.md index 91bd7bd6382..b48d852ff41 100644 --- a/commands/docs/dfr_implode.md +++ b/commands/docs/dfr_implode.md @@ -2,7 +2,7 @@ title: dfr implode categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Aggregates a group to a Series usage: | diff --git a/commands/docs/dfr_into-df.md b/commands/docs/dfr_into-df.md index 49337eeecb4..d3798bbc1d3 100644 --- a/commands/docs/dfr_into-df.md +++ b/commands/docs/dfr_into-df.md @@ -2,7 +2,7 @@ title: dfr into-df categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/dfr_into-lazy.md b/commands/docs/dfr_into-lazy.md index ac7c64636b5..7dbc6e5233b 100644 --- a/commands/docs/dfr_into-lazy.md +++ b/commands/docs/dfr_into-lazy.md @@ -2,7 +2,7 @@ title: dfr into-lazy categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | diff --git a/commands/docs/dfr_into-nu.md b/commands/docs/dfr_into-nu.md index c5116b21e08..9d0aa2b1c74 100644 --- a/commands/docs/dfr_into-nu.md +++ b/commands/docs/dfr_into-nu.md @@ -2,7 +2,7 @@ title: dfr into-nu categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Converts a dataframe or an expression into into nushell value for access and exploration. usage: | diff --git a/commands/docs/dfr_is-duplicated.md b/commands/docs/dfr_is-duplicated.md index 03223018c70..43cfb895f63 100644 --- a/commands/docs/dfr_is-duplicated.md +++ b/commands/docs/dfr_is-duplicated.md @@ -2,7 +2,7 @@ title: dfr is-duplicated categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates mask indicating duplicated values. usage: | diff --git a/commands/docs/dfr_is-in.md b/commands/docs/dfr_is-in.md index 00386cd2eef..7fdd5827c23 100644 --- a/commands/docs/dfr_is-in.md +++ b/commands/docs/dfr_is-in.md @@ -2,7 +2,7 @@ title: dfr is-in categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates an is-in expression. usage: | diff --git a/commands/docs/dfr_is-not-null.md b/commands/docs/dfr_is-not-null.md index 2288b80cf38..f01b89fbbf6 100644 --- a/commands/docs/dfr_is-not-null.md +++ b/commands/docs/dfr_is-not-null.md @@ -2,7 +2,7 @@ title: dfr is-not-null categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates mask where value is not null. usage: | diff --git a/commands/docs/dfr_is-null.md b/commands/docs/dfr_is-null.md index 956591dce26..6642cd41e53 100644 --- a/commands/docs/dfr_is-null.md +++ b/commands/docs/dfr_is-null.md @@ -2,7 +2,7 @@ title: dfr is-null categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates mask where value is null. usage: | diff --git a/commands/docs/dfr_is-unique.md b/commands/docs/dfr_is-unique.md index 0bc188e455f..f2d1b2e1942 100644 --- a/commands/docs/dfr_is-unique.md +++ b/commands/docs/dfr_is-unique.md @@ -2,7 +2,7 @@ title: dfr is-unique categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/dfr_join.md b/commands/docs/dfr_join.md index 97f18d3c7a4..13f263e1d6c 100644 --- a/commands/docs/dfr_join.md +++ b/commands/docs/dfr_join.md @@ -2,7 +2,7 @@ title: dfr join categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | diff --git a/commands/docs/dfr_last.md b/commands/docs/dfr_last.md index 06e013fbec9..6ed99b763b1 100644 --- a/commands/docs/dfr_last.md +++ b/commands/docs/dfr_last.md @@ -2,7 +2,7 @@ title: dfr last categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/dfr_lit.md b/commands/docs/dfr_lit.md index 188db2c7049..6d597c5ed4c 100644 --- a/commands/docs/dfr_lit.md +++ b/commands/docs/dfr_lit.md @@ -2,7 +2,7 @@ title: dfr lit categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/dfr_lowercase.md b/commands/docs/dfr_lowercase.md index ba74b2a4754..03875c6a0c5 100644 --- a/commands/docs/dfr_lowercase.md +++ b/commands/docs/dfr_lowercase.md @@ -2,7 +2,7 @@ title: dfr lowercase categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/dfr_ls.md b/commands/docs/dfr_ls.md index c2a98e7107b..b04042376df 100644 --- a/commands/docs/dfr_ls.md +++ b/commands/docs/dfr_ls.md @@ -2,7 +2,7 @@ title: dfr ls categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Lists stored dataframes. usage: | diff --git a/commands/docs/dfr_max.md b/commands/docs/dfr_max.md index 5fd2a1a7637..2a578cb93ac 100644 --- a/commands/docs/dfr_max.md +++ b/commands/docs/dfr_max.md @@ -2,7 +2,7 @@ title: dfr max categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a max expression or aggregates columns to their max value usage: | diff --git a/commands/docs/dfr_mean.md b/commands/docs/dfr_mean.md index d45f4f236df..709c9cfda8c 100644 --- a/commands/docs/dfr_mean.md +++ b/commands/docs/dfr_mean.md @@ -2,7 +2,7 @@ title: dfr mean categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a mean expression for an aggregation or aggregates columns to their mean value usage: | diff --git a/commands/docs/dfr_median.md b/commands/docs/dfr_median.md index bc712aecff5..dd454878afd 100644 --- a/commands/docs/dfr_median.md +++ b/commands/docs/dfr_median.md @@ -2,7 +2,7 @@ title: dfr median categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Aggregates columns to their median value usage: | diff --git a/commands/docs/dfr_melt.md b/commands/docs/dfr_melt.md index 437ab57f337..9346010d415 100644 --- a/commands/docs/dfr_melt.md +++ b/commands/docs/dfr_melt.md @@ -2,7 +2,7 @@ title: dfr melt categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/dfr_min.md b/commands/docs/dfr_min.md index 0cb506309dc..4d7fb93fccb 100644 --- a/commands/docs/dfr_min.md +++ b/commands/docs/dfr_min.md @@ -2,7 +2,7 @@ title: dfr min categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a min expression or aggregates columns to their min value usage: | diff --git a/commands/docs/dfr_n-unique.md b/commands/docs/dfr_n-unique.md index b8715f51c66..bd8e35416c3 100644 --- a/commands/docs/dfr_n-unique.md +++ b/commands/docs/dfr_n-unique.md @@ -2,7 +2,7 @@ title: dfr n-unique categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/dfr_not.md b/commands/docs/dfr_not.md index c1167d7ef71..257869faf2c 100644 --- a/commands/docs/dfr_not.md +++ b/commands/docs/dfr_not.md @@ -2,7 +2,7 @@ title: dfr not categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/dfr_open.md b/commands/docs/dfr_open.md index 69e7e5c40a0..d75f2cc0c99 100644 --- a/commands/docs/dfr_open.md +++ b/commands/docs/dfr_open.md @@ -2,7 +2,7 @@ title: dfr open categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. usage: | diff --git a/commands/docs/dfr_otherwise.md b/commands/docs/dfr_otherwise.md index 186821de369..3835ac09d16 100644 --- a/commands/docs/dfr_otherwise.md +++ b/commands/docs/dfr_otherwise.md @@ -2,7 +2,7 @@ title: dfr otherwise categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | completes a when expression. usage: | diff --git a/commands/docs/dfr_quantile.md b/commands/docs/dfr_quantile.md index 828c2fecb50..b8a569ce03b 100644 --- a/commands/docs/dfr_quantile.md +++ b/commands/docs/dfr_quantile.md @@ -2,7 +2,7 @@ title: dfr quantile categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | diff --git a/commands/docs/dfr_query.md b/commands/docs/dfr_query.md index 1a03a8b8a14..71a200341e8 100644 --- a/commands/docs/dfr_query.md +++ b/commands/docs/dfr_query.md @@ -2,7 +2,7 @@ title: dfr query categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | diff --git a/commands/docs/dfr_rename.md b/commands/docs/dfr_rename.md index 297b38dacde..e84f224a434 100644 --- a/commands/docs/dfr_rename.md +++ b/commands/docs/dfr_rename.md @@ -2,7 +2,7 @@ title: dfr rename categories: | dataframe or lazyframe -version: 0.86.0 +version: 0.87.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/dfr_replace-all.md b/commands/docs/dfr_replace-all.md index 4c17cf73954..5ac395ce83e 100644 --- a/commands/docs/dfr_replace-all.md +++ b/commands/docs/dfr_replace-all.md @@ -2,7 +2,7 @@ title: dfr replace-all categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/dfr_replace.md b/commands/docs/dfr_replace.md index f31027e2d65..e2b20fcf050 100644 --- a/commands/docs/dfr_replace.md +++ b/commands/docs/dfr_replace.md @@ -2,7 +2,7 @@ title: dfr replace categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/dfr_reverse.md b/commands/docs/dfr_reverse.md index 2e920de7f86..fd1db176714 100644 --- a/commands/docs/dfr_reverse.md +++ b/commands/docs/dfr_reverse.md @@ -2,7 +2,7 @@ title: dfr reverse categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/dfr_rolling.md b/commands/docs/dfr_rolling.md index b4b88920144..eaef8c89a4d 100644 --- a/commands/docs/dfr_rolling.md +++ b/commands/docs/dfr_rolling.md @@ -2,7 +2,7 @@ title: dfr rolling categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/dfr_sample.md b/commands/docs/dfr_sample.md index e1f9597e7d5..fa97003af36 100644 --- a/commands/docs/dfr_sample.md +++ b/commands/docs/dfr_sample.md @@ -2,7 +2,7 @@ title: dfr sample categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/dfr_select.md b/commands/docs/dfr_select.md index f70c23f1e76..f19c0cdedef 100644 --- a/commands/docs/dfr_select.md +++ b/commands/docs/dfr_select.md @@ -2,7 +2,7 @@ title: dfr select categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/dfr_set-with-idx.md b/commands/docs/dfr_set-with-idx.md index 159c3d9fa42..70a24afa31a 100644 --- a/commands/docs/dfr_set-with-idx.md +++ b/commands/docs/dfr_set-with-idx.md @@ -2,7 +2,7 @@ title: dfr set-with-idx categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/dfr_set.md b/commands/docs/dfr_set.md index 5a80813be9c..eb4e4e5bb0e 100644 --- a/commands/docs/dfr_set.md +++ b/commands/docs/dfr_set.md @@ -2,7 +2,7 @@ title: dfr set categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Sets value where given mask is true. usage: | diff --git a/commands/docs/dfr_shape.md b/commands/docs/dfr_shape.md index f548463fd76..7e5f769ec76 100644 --- a/commands/docs/dfr_shape.md +++ b/commands/docs/dfr_shape.md @@ -2,7 +2,7 @@ title: dfr shape categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Shows column and row size for a dataframe. usage: | diff --git a/commands/docs/dfr_shift.md b/commands/docs/dfr_shift.md index b7c0b54a176..1f1b0a37552 100644 --- a/commands/docs/dfr_shift.md +++ b/commands/docs/dfr_shift.md @@ -2,7 +2,7 @@ title: dfr shift categories: | dataframe or lazyframe -version: 0.86.0 +version: 0.87.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | diff --git a/commands/docs/dfr_slice.md b/commands/docs/dfr_slice.md index 7e5a82607bb..3bc27534f3e 100644 --- a/commands/docs/dfr_slice.md +++ b/commands/docs/dfr_slice.md @@ -2,7 +2,7 @@ title: dfr slice categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates new dataframe from a slice of rows. usage: | diff --git a/commands/docs/dfr_sort-by.md b/commands/docs/dfr_sort-by.md index c029023bd69..13a320a974d 100644 --- a/commands/docs/dfr_sort-by.md +++ b/commands/docs/dfr_sort-by.md @@ -2,7 +2,7 @@ title: dfr sort-by categories: | lazyframe -version: 0.86.0 +version: 0.87.0 lazyframe: | sorts a lazy dataframe based on expression(s). usage: | diff --git a/commands/docs/dfr_std.md b/commands/docs/dfr_std.md index bc9599773be..8aafb3da1b4 100644 --- a/commands/docs/dfr_std.md +++ b/commands/docs/dfr_std.md @@ -2,7 +2,7 @@ title: dfr std categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a std expression for an aggregation of std value from columns in a dataframe usage: | diff --git a/commands/docs/dfr_str-lengths.md b/commands/docs/dfr_str-lengths.md index e89d53e7d92..f42493da0a9 100644 --- a/commands/docs/dfr_str-lengths.md +++ b/commands/docs/dfr_str-lengths.md @@ -2,7 +2,7 @@ title: dfr str-lengths categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/dfr_str-slice.md b/commands/docs/dfr_str-slice.md index b42f2a6583c..199ef0612ca 100644 --- a/commands/docs/dfr_str-slice.md +++ b/commands/docs/dfr_str-slice.md @@ -2,7 +2,7 @@ title: dfr str-slice categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Slices the string from the start position until the selected length. usage: | diff --git a/commands/docs/dfr_strftime.md b/commands/docs/dfr_strftime.md index 8b325aa62ee..00eb8701fb8 100644 --- a/commands/docs/dfr_strftime.md +++ b/commands/docs/dfr_strftime.md @@ -2,7 +2,7 @@ title: dfr strftime categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/dfr_sum.md b/commands/docs/dfr_sum.md index 566c7fe0caf..a2349f9944f 100644 --- a/commands/docs/dfr_sum.md +++ b/commands/docs/dfr_sum.md @@ -2,7 +2,7 @@ title: dfr sum categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates a sum expression for an aggregation or aggregates columns to their sum value usage: | diff --git a/commands/docs/dfr_summary.md b/commands/docs/dfr_summary.md index 41494739ff5..e45200e20fa 100644 --- a/commands/docs/dfr_summary.md +++ b/commands/docs/dfr_summary.md @@ -2,7 +2,7 @@ title: dfr summary categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | diff --git a/commands/docs/dfr_take.md b/commands/docs/dfr_take.md index 59638be90ec..f41ad7d10fa 100644 --- a/commands/docs/dfr_take.md +++ b/commands/docs/dfr_take.md @@ -2,7 +2,7 @@ title: dfr take categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/dfr_to-arrow.md b/commands/docs/dfr_to-arrow.md index 663095a2e46..2aa64dae97d 100644 --- a/commands/docs/dfr_to-arrow.md +++ b/commands/docs/dfr_to-arrow.md @@ -2,7 +2,7 @@ title: dfr to-arrow categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Saves dataframe to arrow file. usage: | diff --git a/commands/docs/dfr_to-avro.md b/commands/docs/dfr_to-avro.md index f666a677bf6..29f7d116f74 100644 --- a/commands/docs/dfr_to-avro.md +++ b/commands/docs/dfr_to-avro.md @@ -2,7 +2,7 @@ title: dfr to-avro categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Saves dataframe to avro file. usage: | diff --git a/commands/docs/dfr_to-csv.md b/commands/docs/dfr_to-csv.md index 213f4519d19..ccd1e479d15 100644 --- a/commands/docs/dfr_to-csv.md +++ b/commands/docs/dfr_to-csv.md @@ -2,7 +2,7 @@ title: dfr to-csv categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Saves dataframe to CSV file. usage: | diff --git a/commands/docs/dfr_to-jsonl.md b/commands/docs/dfr_to-jsonl.md index 27168a2ef9d..a5fd5407ac8 100644 --- a/commands/docs/dfr_to-jsonl.md +++ b/commands/docs/dfr_to-jsonl.md @@ -2,7 +2,7 @@ title: dfr to-jsonl categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Saves dataframe to a JSON lines file. usage: | diff --git a/commands/docs/dfr_to-parquet.md b/commands/docs/dfr_to-parquet.md index af8c5b6832f..f17f4a52f2c 100644 --- a/commands/docs/dfr_to-parquet.md +++ b/commands/docs/dfr_to-parquet.md @@ -2,7 +2,7 @@ title: dfr to-parquet categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Saves dataframe to parquet file. usage: | diff --git a/commands/docs/dfr_unique.md b/commands/docs/dfr_unique.md index 045c8353306..8c681ad61bf 100644 --- a/commands/docs/dfr_unique.md +++ b/commands/docs/dfr_unique.md @@ -2,7 +2,7 @@ title: dfr unique categories: | dataframe or lazyframe -version: 0.86.0 +version: 0.87.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/dfr_uppercase.md b/commands/docs/dfr_uppercase.md index 78de863b549..09dff3cc008 100644 --- a/commands/docs/dfr_uppercase.md +++ b/commands/docs/dfr_uppercase.md @@ -2,7 +2,7 @@ title: dfr uppercase categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Uppercase the strings in the column. usage: | diff --git a/commands/docs/dfr_value-counts.md b/commands/docs/dfr_value-counts.md index 3f077d876ad..24c704603e7 100644 --- a/commands/docs/dfr_value-counts.md +++ b/commands/docs/dfr_value-counts.md @@ -2,7 +2,7 @@ title: dfr value-counts categories: | dataframe -version: 0.86.0 +version: 0.87.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | diff --git a/commands/docs/dfr_var.md b/commands/docs/dfr_var.md index 1af9ab8f6b1..41e3eab387a 100644 --- a/commands/docs/dfr_var.md +++ b/commands/docs/dfr_var.md @@ -2,7 +2,7 @@ title: dfr var categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Create a var expression for an aggregation usage: | diff --git a/commands/docs/dfr_when.md b/commands/docs/dfr_when.md index f184238222d..4fd2f3fe36c 100644 --- a/commands/docs/dfr_when.md +++ b/commands/docs/dfr_when.md @@ -2,7 +2,7 @@ title: dfr when categories: | expression -version: 0.86.0 +version: 0.87.0 expression: | Creates and modifies a when expression. usage: | diff --git a/commands/docs/dfr_with-column.md b/commands/docs/dfr_with-column.md index 5c3d4f73149..1e135c72680 100644 --- a/commands/docs/dfr_with-column.md +++ b/commands/docs/dfr_with-column.md @@ -2,7 +2,7 @@ title: dfr with-column categories: | dataframe or lazyframe -version: 0.86.0 +version: 0.87.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index cc1dc6832cd..c7b8e66198b 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.86.0 +version: 0.87.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 2091377a3e7..deb3bc76496 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index 1c07e61453c..2c3836565ec 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ----- | ------ | -| table | table | - +| input | output | +| ------ | ------ | +| record | record | +| table | table | ## Examples Remove the last column of a table @@ -42,3 +42,11 @@ Remove the last column of a table โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ``` + +Remove the last column of a record +```nu +> {lib: nu-lib, extension: rs} | drop column +โ•ญโ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ +โ”‚ lib โ”‚ nu-lib โ”‚ +โ•ฐโ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ +``` diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index e9a99882579..13ef0845877 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index c542c28aae7..e55ca397898 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | core -version: 0.86.0 +version: 0.87.0 core: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index 6a1728263bc..7e5ff43d469 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 2e4c8e89ad0..cf9de94ed16 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Run a block on each row of the input list until a null is found, then create a new list with the results. usage: | diff --git a/commands/docs/echo.md b/commands/docs/echo.md index 3bd819312de..4249aa59b76 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.86.0 +version: 0.87.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 381bdbc7516..759162f4b5c 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Encode a string into bytes. usage: | @@ -47,7 +47,7 @@ Length: 40 (0x28) bytes | printable whitespace ascii_other non_ascii Replace characters with HTML entities if they can't be encoded ```nu -> "๐ŸŽˆ" | encode -i shift-jis +> "๐ŸŽˆ" | encode --ignore-errors shift-jis Length: 9 (0x9) bytes | printable whitespace ascii_other non_ascii 00000000: 26 23 31 32 37 38 38 30 3b 🎈 diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 7c827d9a576..c349d1c37be 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.86.0 +version: 0.87.0 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 c5c2e747936..b7f04f1b98a 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Encode a binary value using hex. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 4f2195cd975..d9eb1dcf9e4 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 53c6eca4525..b9cd572a298 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create an error. usage: | @@ -47,23 +47,26 @@ Create a more complex custom error msg: "my custom error message" label: { text: "my custom label text" # not mandatory unless $.label exists - start: 123 # not mandatory unless $.label.end is set - end: 456 # not mandatory unless $.label.start is set + # optional + span: { + # if $.label.span exists, both start and end must be present + start: 123 + end: 456 + } } + help: "A help string, suggesting a fix to the user" # optional } -{msg: my custom error message, debug: GenericError("my custom error message", "my custom label text", Some(Span { start: 123, end: 456 }), None, []), raw: GenericError("my custom error message", "my custom label text", Some(Span { start: 123, end: 456 }), None, [])} +{msg: my custom error message, debug: GenericError("my custom error message", "my custom label text", Some(Span { start: 123, end: 456 }), Some("A help string, suggesting a fix to the user"), []), raw: GenericError("my custom error message", "my custom label text", Some(Span { start: 123, end: 456 }), Some("A help string, suggesting a fix to the user"), [])} ``` Create a custom error for a custom command that shows the span of the argument ```nu > def foo [x] { - let span = (metadata $x).span; error make { msg: "this is fishy" label: { text: "fish right here" - start: $span.start - end: $span.end + span: (metadata $x).span } } } diff --git a/commands/docs/every.md b/commands/docs/every.md index edf6ab58f9a..cbee3902242 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Show (or skip) every n-th row, starting from the first one. usage: | diff --git a/commands/docs/exec.md b/commands/docs/exec.md index 2086842e8e6..233b16f1896 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,11 +2,11 @@ title: exec categories: | system -version: 0.86.0 +version: 0.87.0 system: | - Execute a command, replacing the current process. + Execute a command, replacing or exiting the current process, depending on platform. usage: | - Execute a command, replacing the current process. + Execute a command, replacing or exiting the current process, depending on platform. --- @@ -44,4 +44,5 @@ Execute 'nautilus' ``` ## Notes -Currently supported only on Unix-based systems. \ No newline at end of file +On Unix-based systems, the current process is replaced with the command. +On Windows based systems, Nushell will wait for the command to finish and then exit with the command's exit code. \ No newline at end of file diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 2b14eabf2f9..11cb0e78028 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.86.0 +version: 0.87.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 4c1e8da4583..11e12d2ce13 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 56cd36c6f7c..536d2ae6429 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.86.0 +version: 0.87.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | @@ -48,13 +48,13 @@ Explore the output of `ls` without column names Explore a list of Markdown files' contents, with row indexes ```nu -> glob *.md | each {|| open } | explore -i +> glob *.md | each {|| open } | explore --index ``` Explore a JSON file, then save the last visited sub-structure to a file ```nu -> open file.json | explore -p | to json | save part.json +> open file.json | explore --peek | to json | save part.json ``` diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 16562ac4aee..f053f3ed3db 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.86.0 +version: 0.87.0 env: | Run a block and preserve its environment in a current scope. usage: | diff --git a/commands/docs/export.md b/commands/docs/export.md index 0cbd332530e..d1f246e74d3 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.86.0 +version: 0.87.0 core: | Export definitions or environment variables from a module. usage: | diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 79f093d8c13..77de12ddf7f 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.86.0 +version: 0.87.0 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index d83e0abcbb4..f042ac9422c 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.86.0 +version: 0.87.0 core: | Use parse-time constant from a module and export them from this module. usage: | diff --git a/commands/docs/export_def-env.md b/commands/docs/export_def-env.md index 7dcc4c3ab14..c21d131e9e2 100644 --- a/commands/docs/export_def-env.md +++ b/commands/docs/export_def-env.md @@ -2,7 +2,7 @@ title: export def-env categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a custom command that participates in the environment and export it from a module. usage: | diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index 6d4fb38ff31..6e434a70c79 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a custom command and export it from a module. usage: | diff --git a/commands/docs/export_extern-wrapped.md b/commands/docs/export_extern-wrapped.md index 3cdc178f6a2..5f39903babb 100644 --- a/commands/docs/export_extern-wrapped.md +++ b/commands/docs/export_extern-wrapped.md @@ -2,7 +2,7 @@ title: export extern-wrapped categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define an extern with a custom code block and export it from a module. usage: | diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index e35b9eee94e..9b7cce0d355 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define an extern and export it from a module. usage: | diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index d89582d5f34..3d30a87d27b 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.86.0 +version: 0.87.0 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 05256571a7e..ed255ecfb8b 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.86.0 +version: 0.87.0 core: | Use definitions from a module and export them from this module. usage: | diff --git a/commands/docs/extern-wrapped.md b/commands/docs/extern-wrapped.md index 9d343bdd26b..19786ecb78f 100644 --- a/commands/docs/extern-wrapped.md +++ b/commands/docs/extern-wrapped.md @@ -2,7 +2,7 @@ title: extern-wrapped categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a signature for an external command with a custom code block. usage: | diff --git a/commands/docs/extern.md b/commands/docs/extern.md index d1391959c49..e7b1c3a56cd 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index fb3b1188e08..516279b02e3 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 92b18dbf74f..f000ed24317 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index cc219a88978..61f849108f6 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index ade25e4384b..612c4f50483 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 0757effa042..6cc39e909ce 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Flatten the table. usage: | @@ -70,7 +70,7 @@ restrict the flattening by passing column names Flatten inner table ```nu -> { a: b, d: [ 1 2 3 4 ], e: [ 4 3 ] } | flatten d --all +> { a: b, d: [ 1 2 3 4 ], e: [ 4 3 ] } | flatten d --all โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ a โ”‚ d โ”‚ e โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index d2df2bb8b69..3ec8fda445d 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index 74233c679b4..04db0561381 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.86.0 +version: 0.87.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index b92f818492b..966f487d1b8 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 872c59476e3..39be25b8029 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | date -version: 0.86.0 +version: 0.87.0 date: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 79b3ccc37f6..606f36d02ff 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Outputs duration with a specified unit of time. usage: | diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index f0c1ef9864c..5094a6da9dc 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 4dad2d88ce7..c66335e7420 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse a string or binary data into structured data. usage: | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 89f0ae5be88..814a566d156 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index bad09c24994..ad9afe84475 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .eml and create record. usage: | diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index 74f17c1a2aa..c2f8bd46d5d 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .ics and create table. usage: | diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 0ff03e9c26e..a37ca26415b 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .ini and create table. usage: | diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 32fc42fd67e..55625c73d7a 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 7b23bfd1517..1728e9e70f4 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 24d72529797..bc122b87a9b 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 248ed9a9ad8..02c2db1a775 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 3d5a9abf7e3..771c25d4656 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index 4f10f17ba71..82ad117b515 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 083b68d0a5e..34ebffa3718 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index cbec569db7e..37229037d5b 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .vcf and create table. usage: | diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 1a442358a1b..0c8e88b4283 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index f4438b6a69a..5b8dae5f1a5 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 0d2e997e0cd..d71a1c9eec6 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index 03afc056f33..10ef3b9c0bf 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md new file mode 100644 index 00000000000..31b48d28d10 --- /dev/null +++ b/commands/docs/generate.md @@ -0,0 +1,71 @@ +--- +title: generate +categories: | + generators +version: 0.87.0 +generators: | + Generate a list of values by successively invoking a closure. +usage: | + Generate a list of values by successively invoking a closure. +--- + + +# {{ $frontmatter.title }} for generators + +
{{ $frontmatter.generators }}
+ +## Signature + +```> generate {flags} (initial) (closure)``` + +## Parameters + + - `initial`: initial value + - `closure`: generator function + + +## Input/output types: + +| input | output | +| --------- | --------- | +| list\ | list\ | +| nothing | list\ | +## Examples + +Generate a sequence of numbers +```nu +> generate 0 {|i| if $i <= 10 { {out: $i, next: ($i + 2)} }} +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ +โ”‚ 0 โ”‚ 0 โ”‚ +โ”‚ 1 โ”‚ 2 โ”‚ +โ”‚ 2 โ”‚ 4 โ”‚ +โ”‚ 3 โ”‚ 6 โ”‚ +โ”‚ 4 โ”‚ 8 โ”‚ +โ”‚ 5 โ”‚ 10 โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ•ฏ + +``` + +Generate a stream of fibonacci numbers +```nu +> generate [0, 1] {|fib| {out: $fib.0, next: [$fib.1, ($fib.0 + $fib.1)]} } | first 10 +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ +โ”‚ 0 โ”‚ 0 โ”‚ +โ”‚ 1 โ”‚ 1 โ”‚ +โ”‚ 2 โ”‚ 1 โ”‚ +โ”‚ 3 โ”‚ 2 โ”‚ +โ”‚ 4 โ”‚ 3 โ”‚ +โ”‚ 5 โ”‚ 5 โ”‚ +โ”‚ 6 โ”‚ 8 โ”‚ +โ”‚ 7 โ”‚ 13 โ”‚ +โ”‚ 8 โ”‚ 21 โ”‚ +โ”‚ 9 โ”‚ 34 โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ•ฏ + +``` + +## Notes +The generator closure accepts a single argument and returns a record +containing two optional keys: 'out' and 'next'. Each invocation, the 'out' +value, if present, is added to the stream. If a 'next' key is present, it is +used as the next argument to the closure, otherwise generation stops. diff --git a/commands/docs/get.md b/commands/docs/get.md index d3119207ec3..de190d13da2 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 5c2b69ce33c..9e9ec6c0d8a 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | @@ -24,7 +24,8 @@ usage: | - `--no-dir, -D`: Whether to filter out directories from the returned paths - `--no-file, -F`: Whether to filter out files from the returned paths - `--no-symlink, -S`: Whether to filter out symlinks from the returned paths - - `--not, -n {list}`: Patterns to exclude from the results + - `--not, -n {list}`: DEPRECATED OPTION: Patterns to exclude from the results + - `--exclude, -e {list}`: Patterns to exclude from the search: `glob` will not walk the inside of directories matching the excluded patterns. ## Parameters @@ -95,13 +96,13 @@ Search for folders that begin with an uppercase ASCII letter, ignoring files and Search for files named tsconfig.json that are not in node_modules directories ```nu -> glob **/tsconfig.json --not [**/node_modules/**] +> glob **/tsconfig.json --exclude [**/node_modules/**] ``` Search for all files that are not in the target nor .git directories ```nu -> glob **/* --not [**/target/** **/.git/** */] +> glob **/* --exclude [**/target/** **/.git/** */] ``` diff --git a/commands/docs/grid.md b/commands/docs/grid.md index 26f71a43713..5c8d88ea819 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.86.0 +version: 0.87.0 viewers: | Renders the output to a textual terminal grid. usage: | diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index a2d315303b9..2591872a75c 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | @@ -18,6 +18,10 @@ usage: | ```> group-by {flags} (grouper)``` +## Flags + + - `--to-table, -`: Return a table with "groups" and "items" columns + ## Parameters - `grouper`: the path to the column to group on @@ -76,3 +80,26 @@ You can also group by raw values by leaving out the argument โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ``` + +You can also output a table instead of a record +```nu +> ['1' '3' '1' '3' '2' '1' '1'] | group-by --to-table +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ +โ”‚ # โ”‚ group โ”‚ items โ”‚ +โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ 0 โ”‚ 1 โ”‚ โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ•ฎ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 0 โ”‚ 1 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 1 โ”‚ 1 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 2 โ”‚ 1 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 3 โ”‚ 1 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ โ”‚ +โ”‚ 1 โ”‚ 3 โ”‚ โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ•ฎ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 0 โ”‚ 3 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 1 โ”‚ 3 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ โ”‚ +โ”‚ 2 โ”‚ 2 โ”‚ โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ•ฎ โ”‚ +โ”‚ โ”‚ โ”‚ โ”‚ 0 โ”‚ 2 โ”‚ โ”‚ +โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ•ฏ โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ + +``` diff --git a/commands/docs/group.md b/commands/docs/group.md index 64dab22fed0..dda4e2c9143 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 10d02f4d256..bcbab3478de 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.86.0 +version: 0.87.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index fa82b2cb76d..815df5ba376 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.86.0 +version: 0.87.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 8ca0262d76d..0acbb4cccf5 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.86.0 +version: 0.87.0 hash: | Hash a value using the md5 hash algorithm usage: | diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index df758c0d7da..2a9c0cd96d1 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.86.0 +version: 0.87.0 hash: | Hash a value using the sha256 hash algorithm usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 3914d9d9686..434165b2610 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Use the first row of the table as column names. usage: | diff --git a/commands/docs/help.md b/commands/docs/help.md index dd24131d0d8..fb293b6118d 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.86.0 +version: 0.87.0 core: | Display help information about different parts of Nushell. usage: | diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index 1c2fd25a808..f60b13e25aa 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 3045e6912b9..3331ce177bb 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index c4e0c0d7165..f9c722e24d7 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index c0cde632164..3112fb9920f 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 48cf95ecd7e..c9dafbe921d 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 1e4942a858c..f328b2b630d 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.86.0 +version: 0.87.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 0cf7c18b60f..759a91cfd6f 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.86.0 +version: 0.87.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 262378ed426..4fa6260011c 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.86.0 +version: 0.87.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index a6559ea9ef3..cfad764f5dc 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.86.0 +version: 0.87.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | diff --git a/commands/docs/history.md b/commands/docs/history.md index 94170152bc4..26d965514be 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | misc -version: 0.86.0 +version: 0.87.0 misc: | Get the command history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index bcd62c3844d..6c2360d22f6 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | misc -version: 0.86.0 +version: 0.87.0 misc: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index b7ffa9743fe..ea4e5375690 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.86.0 +version: 0.87.0 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 8c5a57d36d0..5fa31390867 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.86.0 +version: 0.87.0 network: | Delete the specified resource. usage: | @@ -52,25 +52,25 @@ http delete from example.com http delete from example.com, with username and password ```nu -> http delete -u myuser -p mypass https://www.example.com +> http delete --user myuser --password mypass https://www.example.com ``` http delete from example.com, with custom header ```nu -> http delete -H [my-header-key my-header-value] https://www.example.com +> http delete --headers [my-header-key my-header-value] https://www.example.com ``` http delete from example.com, with body ```nu -> http delete -d 'body' https://www.example.com +> http delete --data 'body' https://www.example.com ``` http delete from example.com, with JSON body ```nu -> http delete -t application/json -d { field: value } https://www.example.com +> http delete --content-type application/json --data { field: value } https://www.example.com ``` diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index c86d0fb6e34..104f1b1c63f 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.86.0 +version: 0.87.0 network: | Fetch the contents from a URL. usage: | @@ -50,19 +50,19 @@ Get content from example.com Get content from example.com, with username and password ```nu -> http get -u myuser -p mypass https://www.example.com +> http get --user myuser --password mypass https://www.example.com ``` Get content from example.com, with custom header ```nu -> http get -H [my-header-key my-header-value] https://www.example.com +> http get --headers [my-header-key my-header-value] https://www.example.com ``` Get content from example.com, with custom headers ```nu -> http get -H [my-header-key-A my-header-value-A my-header-key-B my-header-value-B] https://www.example.com +> http get --headers [my-header-key-A my-header-value-A my-header-key-B my-header-value-B] https://www.example.com ``` diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 934dabd0247..df17d983251 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.86.0 +version: 0.87.0 network: | Get the headers from a URL. usage: | @@ -47,13 +47,13 @@ Get headers from example.com Get headers from example.com, with username and password ```nu -> http head -u myuser -p mypass https://www.example.com +> http head --user myuser --password mypass https://www.example.com ``` Get headers from example.com, with custom header ```nu -> http head -H [my-header-key my-header-value] https://www.example.com +> http head --headers [my-header-key my-header-value] https://www.example.com ``` diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 56ca59210bb..1a0a6256ff7 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.86.0 +version: 0.87.0 network: | Requests permitted communication options for a given URL. usage: | @@ -48,25 +48,25 @@ Get options from example.com Get options from example.com, with username and password ```nu -> http options -u myuser -p mypass https://www.example.com +> http options --user myuser --password mypass https://www.example.com ``` Get options from example.com, with custom header ```nu -> http options -H [my-header-key my-header-value] https://www.example.com +> http options --headers [my-header-key my-header-value] https://www.example.com ``` Get options from example.com, with custom headers ```nu -> http options -H [my-header-key-A my-header-value-A my-header-key-B my-header-value-B] https://www.example.com +> http options --headers [my-header-key-A my-header-value-A my-header-key-B my-header-value-B] https://www.example.com ``` Simulate a browser cross-origin preflight request from www.example.com to media.example.com ```nu -> http options https://media.example.com/api/ -H [Origin https://www.example.com Access-Control-Request-Headers "Content-Type, X-Custom-Header" Access-Control-Request-Method GET] +> http options https://media.example.com/api/ --headers [Origin https://www.example.com Access-Control-Request-Headers "Content-Type, X-Custom-Header" Access-Control-Request-Method GET] ``` diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 72c658d906d..d5842522af0 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.86.0 +version: 0.87.0 network: | Patch a body to a URL. usage: | @@ -52,19 +52,19 @@ Patch content to example.com Patch content to example.com, with username and password ```nu -> http patch -u myuser -p mypass https://www.example.com 'body' +> http patch --user myuser --password mypass https://www.example.com 'body' ``` Patch content to example.com, with custom header ```nu -> http patch -H [my-header-key my-header-value] https://www.example.com +> http patch --headers [my-header-key my-header-value] https://www.example.com ``` Patch content to example.com, with JSON body ```nu -> http patch -t application/json https://www.example.com { field: value } +> http patch --content-type application/json https://www.example.com { field: value } ``` diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 238d09c5680..7485f504736 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.86.0 +version: 0.87.0 network: | Post a body to a URL. usage: | @@ -52,19 +52,19 @@ Post content to example.com Post content to example.com, with username and password ```nu -> http post -u myuser -p mypass https://www.example.com 'body' +> http post --user myuser --password mypass https://www.example.com 'body' ``` Post content to example.com, with custom header ```nu -> http post -H [my-header-key my-header-value] https://www.example.com +> http post --headers [my-header-key my-header-value] https://www.example.com ``` Post content to example.com, with JSON body ```nu -> http post -t application/json https://www.example.com { field: value } +> http post --content-type application/json https://www.example.com { field: value } ``` diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index c43bf972c42..7a274d6e7fc 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.86.0 +version: 0.87.0 network: | Put a body to a URL. usage: | @@ -52,19 +52,19 @@ Put content to example.com Put content to example.com, with username and password ```nu -> http put -u myuser -p mypass https://www.example.com 'body' +> http put --user myuser --password mypass https://www.example.com 'body' ``` Put content to example.com, with custom header ```nu -> http put -H [my-header-key my-header-value] https://www.example.com +> http put --headers [my-header-key my-header-value] https://www.example.com ``` Put content to example.com, with JSON body ```nu -> http put -t application/json https://www.example.com { field: value } +> http put --content-type application/json https://www.example.com { field: value } ``` diff --git a/commands/docs/if.md b/commands/docs/if.md index 19e03a2bb14..e74f97e97e3 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.86.0 +version: 0.87.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index c45e8e7b227..d662820a987 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.86.0 +version: 0.87.0 core: | Ignore the output of the previous command in the pipeline. usage: | diff --git a/commands/docs/inc.md b/commands/docs/inc.md index 074797006e9..ed2201ffd32 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.86.0 +version: 0.87.0 default: | Increment a value or version. Optionally use the column of a table. usage: | diff --git a/commands/docs/input.md b/commands/docs/input.md index a1580554913..4d223fc6c32 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index cf0181a5be9..98f1a80032d 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Interactive list selection. usage: | @@ -44,13 +44,13 @@ Return a single value from a list Return multiple values from a list ```nu -> [Banana Kiwi Pear Peach Strawberry] | input list -m 'Add fruits to the basket' +> [Banana Kiwi Pear Peach Strawberry] | input list --multi 'Add fruits to the basket' ``` Return a single record from a table with fuzzy search ```nu -> ls | input list -f 'Select the target' +> ls | input list --fuzzy 'Select the target' ``` diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 4cfeb0c3bdd..4bf997250fe 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Listen for user interface event usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index d0435328548..c60c6275457 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 4da0a296129..ceba0169d61 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index fca81f28c40..c57553ed48f 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Commands to convert data from one type to another. usage: | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 4d9e6b8ec09..3b64ad75bc4 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index bb2ef6c2746..1c0b6667b9b 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 11242864c3b..2d7d845ed03 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index b3c485aa292..3cfbabbef00 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -75,9 +75,9 @@ Convert list of timestamps to datetimes ```nu > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ -โ”‚ 0 โ”‚ 6 months ago โ”‚ -โ”‚ 1 โ”‚ 5 months ago โ”‚ -โ”‚ 2 โ”‚ 4 months ago โ”‚ +โ”‚ 0 โ”‚ 7 months ago โ”‚ +โ”‚ 1 โ”‚ 6 months ago โ”‚ +โ”‚ 2 โ”‚ 5 months ago โ”‚ โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ``` diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index f259f3124ff..54130b86dc4 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index d15a74e37d6..fa75faafccc 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index f030b3809a2..06ad7af81dd 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index d275575e218..3147e10bf0f 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index 1b75ba48892..924fbc7a7f5 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index bfb4deb93d2..3b921f25c7d 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 877c7615d48..1e7d41484d5 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.86.0 +version: 0.87.0 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index d9168fea7c8..a8ef8ba7546 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Infer nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 6cf1ac54a59..3f43f38ab0b 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.86.0 +version: 0.87.0 core: | Check if nushell is running with administrator or root privileges. usage: | diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index 0f7182cad88..2837d0588a2 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index d2ab0e0e7be..4195db30e53 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index ed1c792ee61..206cd615a10 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Join two tables usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 878e5db72b7..f70b0801601 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index fc0631e91a3..f70decc80b8 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 316091f920b..ab1bc082974 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | List available options that can be used to create keybindings. usage: | @@ -37,7 +37,7 @@ usage: | Get list of key modifiers ```nu -> keybindings list -m +> keybindings list --modifiers ``` diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index fa9f5d423b0..32833567a9d 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index d6e1a16f298..8537d00167b 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 9f1d87d8452..18d5c474a05 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/lazy_make.md b/commands/docs/lazy_make.md index 46e792221cf..f5ea41daf23 100644 --- a/commands/docs/lazy_make.md +++ b/commands/docs/lazy_make.md @@ -2,7 +2,7 @@ title: lazy make categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create a lazy record. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index a4784012653..efc2a385e7c 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.86.0 +version: 0.87.0 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 7b388f1caf9..f66a1635919 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.86.0 +version: 0.87.0 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | diff --git a/commands/docs/let.md b/commands/docs/let.md index a291555eba4..bbf4a9041aa 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index a8a9535307a..ef2ac9996a3 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index c45b5ff948d..bfeffcbcf25 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index f604a49801b..6af49516b3d 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.86.0 +version: 0.87.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 9506f28e203..043464842b0 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | diff --git a/commands/docs/match.md b/commands/docs/match.md index c5725492523..61a9a88f2f4 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.86.0 +version: 0.87.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 4464d98aad2..5561f6d7bf6 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.86.0 +version: 0.87.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 86aaa595d23..24a5b07d4f2 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 78e52ef4e22..88af45d5058 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the arccosine of the number. usage: | @@ -39,7 +39,7 @@ Get the arccosine of 1 Get the arccosine of -1 in degrees ```nu -> -1 | math arccos -d +> -1 | math arccos --degrees 180 ``` diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 8d5202ad0b5..d1c62013bf0 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index e208acb081b..7666f7ab773 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the arcsine of the number. usage: | @@ -39,7 +39,7 @@ Get the arcsine of 1 Get the arcsine of 1 in degrees ```nu -> 1 | math arcsin -d +> 1 | math arcsin --degrees 90 ``` diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 146cdf634e0..a1978ae0883 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the inverse of the hyperbolic sine function. usage: | diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index 67d19d8fb37..62be90761a0 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the arctangent of the number. usage: | @@ -39,7 +39,7 @@ Get the arctangent of 1 Get the arctangent of -1 in degrees ```nu -> -1 | math arctan -d +> -1 | math arctan --degrees -45 ``` diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 81ceed2f335..9dc71bc4e9e 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 409678101ff..1886b04db5f 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the average of a list of numbers. usage: | diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index bd5bfdb7c7f..7a51a736935 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index e8bdd8875fe..73c5d85a8f2 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the cosine of the number. usage: | @@ -39,7 +39,7 @@ Apply the cosine to ฯ€ Apply the cosine to a list of angles in degrees ```nu -> [0 90 180 270 360] | math cos -d +> [0 90 180 270 360] | math cos --degrees โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ 1.00 โ”‚ โ”‚ 1 โ”‚ 0.00 โ”‚ diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 28a750327a5..1a3469be715 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index db1c049e677..e7cbc47caf4 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns e raised to the power of x. usage: | diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 8a22acc39d3..2e4bf4bbb7b 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 5ae403ac1ff..f35f15490e9 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 4395a919e65..17737b2846a 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 8e62459f063..202158ae70e 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the maximum of a list of values, or of columns in a table. usage: | diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index 89770dd078c..02e423b92b6 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.86.0 +version: 0.87.0 math: | Computes the median of a list of numbers. usage: | diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index 4e3a7feb9eb..161d8340511 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.86.0 +version: 0.87.0 math: | Finds the minimum within a list of values or tables. usage: | diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index c7177589034..1d3a1766b42 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index ea09a9772fb..0743507d8b1 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index fbb3ac41f47..08bdf061727 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the input number rounded to the specified precision. usage: | @@ -44,7 +44,7 @@ Apply the round function to a list of numbers Apply the round function with precision specified ```nu -> [1.555 2.333 -3.111] | math round -p 2 +> [1.555 2.333 -3.111] | math round --precision 2 โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ 1.56 โ”‚ โ”‚ 1 โ”‚ 2.33 โ”‚ @@ -55,7 +55,7 @@ Apply the round function with precision specified Apply negative precision to a list of numbers ```nu -> [123, 123.3, -123.4] | math round -p -1 +> [123, 123.3, -123.4] | math round --precision -1 โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ 120 โ”‚ โ”‚ 1 โ”‚ 120 โ”‚ diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index 6dacaa57a4e..a5d67f7a1b3 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 9c1f662ed33..d1feb56e94b 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 6e455a5cd36..09e8fa1d686 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the square root of the input number. usage: | diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index ab4dd97be0b..ac9a5c7b928 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | @@ -39,6 +39,6 @@ Compute the standard deviation of a list of numbers Compute the sample standard deviation of a list of numbers ```nu -> [1 2 3 4 5] | math stddev -s +> [1 2 3 4 5] | math stddev --sample 1.5811388300841898 ``` diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index d6684c4d16a..f958c420dd1 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the sum of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index 63396856626..e08971c9dae 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the tangent of the number. usage: | @@ -39,7 +39,7 @@ Apply the tangent to ฯ€/4 Apply the tangent to a list of angles in degrees ```nu -> [-45 0 45] | math tan -d +> [-45 0 45] | math tan --degrees โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ -1.00 โ”‚ โ”‚ 1 โ”‚ 0.00 โ”‚ diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 4c34e546961..6753de9c237 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 295bc026350..f96069efd42 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.86.0 +version: 0.87.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | @@ -39,6 +39,6 @@ Get the variance of a list of numbers Get the sample variance of a list of numbers ```nu -> [1 2 3 4 5] | math variance -s +> [1 2 3 4 5] | math variance --sample 2.5 ``` diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 55ddcf36f57..4fc23e6612d 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index ca804e7ec92..b00ab087c3f 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index f06729f338e..7b8f1af9610 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Make directories, creates intermediary directories as required. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index d047dcee79e..820dabe5552 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.86.0 +version: 0.87.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 0e4824208da..16519cd5889 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index 30581fab716..eec7455af07 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index 20aea55d193..1df59179225 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Move files or directories. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index dd577af3827..0d1f80a1e51 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Validate and parse input content. usage: | @@ -51,19 +51,19 @@ Parse a input file as module Parse a input file by showing error message ```nu -> nu-check -d script.nu +> nu-check --debug script.nu ``` Parse an external stream as script by showing error message ```nu -> open foo.nu | nu-check -d script.nu +> open foo.nu | nu-check --debug script.nu ``` Parse an internal stream as module by showing error message ```nu -> open module.nu | lines | nu-check -d --as-module module.nu +> open module.nu | lines | nu-check --debug --as-module module.nu ``` @@ -81,6 +81,6 @@ Heuristically parse which begins with script first, if it sees a failure, try mo Heuristically parse by showing error message ```nu -> open foo.nu | lines | nu-check -ad +> open foo.nu | lines | nu-check --all --debug ``` diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 56e9e8170ae..5a9b3df5538 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 05cf6973021..5dbd9f8c224 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index 876d5849cf7..63d25df24c5 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.86.0 +version: 0.87.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index d93521632b5..beb0d68fefd 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.86.0 +version: 0.87.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 7c676443318..274e3430ef2 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.86.0 +version: 0.87.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 6260df4685d..391d273d9ed 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.86.0 +version: 0.87.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index b690eae3142..3b1e23858a2 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.86.0 +version: 0.87.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index cfc13245ef5..793a2e1101e 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 1bb99b3cb43..307969f2cc0 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Parse columns from string data using a simple pattern. usage: | @@ -48,7 +48,7 @@ Parse a string into two named columns Parse a string using regex pattern ```nu -> "hi there" | parse -r '(?P\w+) (?P\w+)' +> "hi there" | parse --regex '(?P\w+) (?P\w+)' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ foo โ”‚ bar โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -59,7 +59,7 @@ Parse a string using regex pattern Parse a string using fancy-regex named capture group pattern ```nu -> "foo bar." | parse -r '\s*(?\w+)(?=\.)' +> "foo bar." | parse --regex '\s*(?\w+)(?=\.)' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ name โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -70,7 +70,7 @@ Parse a string using fancy-regex named capture group pattern Parse a string using fancy-regex capture group pattern ```nu -> "foo! bar." | parse -r '(\w+)(?=\.)|(\w+)(?=!)' +> "foo! bar." | parse --regex '(\w+)(?=\.)|(\w+)(?=!)' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ capture0 โ”‚ capture1 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -82,7 +82,7 @@ Parse a string using fancy-regex capture group pattern Parse a string using fancy-regex look behind pattern ```nu -> " @another(foo bar) " | parse -r '\s*(?<=[() ])(@\w+)(\([^)]*\))?\s*' +> " @another(foo bar) " | parse --regex '\s*(?<=[() ])(@\w+)(\([^)]*\))?\s*' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ capture0 โ”‚ capture1 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -93,7 +93,7 @@ Parse a string using fancy-regex look behind pattern Parse a string using fancy-regex look ahead atomic group pattern ```nu -> "abcd" | parse -r '^a(bc(?=d)|b)cd$' +> "abcd" | parse --regex '^a(bc(?=d)|b)cd$' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ capture0 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค diff --git a/commands/docs/path.md b/commands/docs/path.md index 42013def3b7..eadf78f7dd8 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.86.0 +version: 0.87.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index fc59cb92307..47c1fbcc0ed 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.86.0 +version: 0.87.0 path: | Get the final component of a path. usage: | @@ -49,6 +49,6 @@ Get basename of a list of paths Replace basename of a path ```nu -> '/home/joe/test.txt' | path basename -r 'spam.png' +> '/home/joe/test.txt' | path basename --replace 'spam.png' /home/joe/spam.png ``` diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index cdacb57ac4d..e5147adfd94 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.86.0 +version: 0.87.0 path: | Get the parent directory of a path. usage: | @@ -50,12 +50,12 @@ Get dirname of a list of paths Walk up two levels ```nu -> '/home/joe/code/test.txt' | path dirname -n 2 +> '/home/joe/code/test.txt' | path dirname --num-levels 2 /home/joe ``` Replace the part that would be returned with a custom path ```nu -> '/home/joe/code/test.txt' | path dirname -n 2 -r /home/viking +> '/home/joe/code/test.txt' | path dirname --num-levels 2 --replace /home/viking /home/viking/code/test.txt ``` diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 825601d3e56..00844b4d209 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.86.0 +version: 0.87.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index fe7c46e1226..85ddea0449b 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.86.0 +version: 0.87.0 path: | Try to expand a path to its absolute form. usage: | diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index 842c3a3cd85..01693b44eca 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.86.0 +version: 0.87.0 path: | Join a structured path or a list of path parts. usage: | diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index 359df5a919f..10a76b8144e 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.86.0 +version: 0.87.0 path: | Convert a path into structured data. usage: | @@ -43,13 +43,13 @@ Parse a path Replace a complex extension ```nu -> '/home/viking/spam.tar.gz' | path parse -e tar.gz | upsert extension { 'txt' } +> '/home/viking/spam.tar.gz' | path parse --extension tar.gz | upsert extension { 'txt' } ``` Ignore the extension ```nu -> '/etc/conf.d' | path parse -e '' +> '/etc/conf.d' | path parse --extension '' โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ parent โ”‚ /etc โ”‚ โ”‚ stem โ”‚ conf.d โ”‚ diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index 4d2f2cd1c79..a18a35e842f 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.86.0 +version: 0.87.0 path: | Express a path as relative to another path. usage: | diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index cb9256f9fef..c5c94702c09 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.86.0 +version: 0.87.0 path: | Split a path into a list based on the system's path separator. usage: | diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index b48ef9b1b7a..fee10d8e144 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.86.0 +version: 0.87.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index 8a8c3ab5219..139a64c35dd 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.86.0 +version: 0.87.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index a6ea5bf1782..49f69a73585 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 4213683cf6b..ea335669b25 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/profile.md b/commands/docs/profile.md deleted file mode 100644 index 13f15b1d388..00000000000 --- a/commands/docs/profile.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: profile -categories: | - debug -version: 0.86.0 -debug: | - Profile each pipeline element in a closure. -usage: | - Profile each pipeline element in a closure. ---- - - -# {{ $frontmatter.title }} for debug - -
{{ $frontmatter.debug }}
- -## Signature - -```> profile {flags} (closure)``` - -## Flags - - - `--source, -s`: Collect source code in the report - - `--values, -v`: Collect values in the report - - `--max-depth, -d {int}`: How many levels of blocks to step into (default: 1) - -## Parameters - - - `closure`: the closure to run - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | table | - -## Examples - -Profile some code, stepping into the `spam` command and collecting source. -```nu -> def spam [] { "spam" }; profile {|| spam | str length } --max-depth 2 --source - -``` - -## Notes -The command collects run time of every pipeline element, recursively stepping into child closures -until a maximum depth. Optionally, it also collects the source code and intermediate values. - -Current known limitations are: -* profiling data from subexpressions is not tracked -* it does not step into loop iterations \ No newline at end of file diff --git a/commands/docs/ps.md b/commands/docs/ps.md index b5ccf8304cc..13b0b690627 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.86.0 +version: 0.87.0 system: | View information about system processes. usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 027e096a2dc..09d82a34bfc 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index bde41925970..e37d54ebc5c 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.86.0 +version: 0.87.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 47f7805c375..41e50e51c32 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 8e129b71907..dca0c6547e7 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.86.0 +version: 0.87.0 network: | execute selector query on html/web usage: | @@ -37,20 +37,20 @@ usage: | Retrieve all `
` elements from phoronix.com website ```nu -> http get https://phoronix.com | query web -q 'header' +> http get https://phoronix.com | query web --query 'header' ``` 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 -t [Rank City 'Population(2011)[3]' 'Population(2001)[3][a]' 'State or union territory'] + | query web --as-table [Rank City 'Population(2011)[3]' 'Population(2001)[3][a]' 'State or union territory'] ``` 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 -q 'h2, h2 + p' | group 2 | each {rotate --ccw tagline description} | flatten +> http get https://www.nushell.sh | query web --query 'h2, h2 + p' | group 2 | each {rotate --ccw tagline description} | flatten ``` diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index 14d746e4227..4901e71bc9f 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | execute xpath query on xml usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 77c64c2581f..cd1e37cf1d6 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random value. usage: | @@ -30,12 +30,11 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------------- | ------- | -------------------------------------------------- | -| [`random bool`](/commands/docs/random_bool.md) | Builtin | Generate a random boolean value. | -| [`random chars`](/commands/docs/random_chars.md) | Builtin | Generate random chars. | -| [`random dice`](/commands/docs/random_dice.md) | Builtin | Generate a random dice roll. | -| [`random float`](/commands/docs/random_float.md) | Builtin | Generate a random float within a range [min..max]. | -| [`random int`](/commands/docs/random_int.md) | Builtin | Generate a random integer [min..max]. | -| [`random integer`](/commands/docs/random_integer.md) | Builtin | deprecated: Generate a random integer [min..max]. | -| [`random uuid`](/commands/docs/random_uuid.md) | Builtin | Generate a random uuid4 string. | \ No newline at end of file +| name | type | usage | +| ------------------------------------------------ | ------- | -------------------------------------------------- | +| [`random bool`](/commands/docs/random_bool.md) | Builtin | Generate a random boolean value. | +| [`random chars`](/commands/docs/random_chars.md) | Builtin | Generate random chars. | +| [`random dice`](/commands/docs/random_dice.md) | Builtin | Generate a random dice roll. | +| [`random float`](/commands/docs/random_float.md) | Builtin | Generate a random float within a range [min..max]. | +| [`random int`](/commands/docs/random_int.md) | Builtin | Generate a random integer [min..max]. | +| [`random uuid`](/commands/docs/random_uuid.md) | Builtin | Generate a random uuid4 string. | \ No newline at end of file diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index a662434b3b2..4f49e629d70 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index c9dfcf85e6c..c81ca4ad5ed 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate random chars. usage: | @@ -39,6 +39,6 @@ Generate random chars Generate random chars with specified length ```nu -> random chars -l 20 +> random chars --length 20 ``` diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index c8d428d8791..2cda4755cd5 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random dice roll. usage: | @@ -40,6 +40,6 @@ Roll 1 dice with 6 sides each Roll 10 dice with 12 sides each ```nu -> random dice -d 10 -s 12 +> random dice --dice 10 --sides 12 ``` diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 521d0c7a0ab..f93eb295abc 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random float within a range [min..max]. usage: | diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 3ee8896cd46..6ec3af8c77d 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_integer.md b/commands/docs/random_integer.md deleted file mode 100644 index 614b7cb9679..00000000000 --- a/commands/docs/random_integer.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: random integer -categories: | - random -version: 0.86.0 -random: | - deprecated: Generate a random integer [min..max]. -usage: | - deprecated: Generate a random integer [min..max]. ---- - - -# {{ $frontmatter.title }} for random - -
{{ $frontmatter.random }}
- -## Signature - -```> random integer {flags} (range)``` - -## Parameters - - - `range`: Range of values - - -## Input/output types: - -| input | output | -| ------- | ------ | -| nothing | int | - -## Examples - -Generate an unconstrained random integer -```nu -> random integer - -``` - -Generate a random integer less than or equal to 500 -```nu -> random integer ..500 - -``` - -Generate a random integer greater than or equal to 100000 -```nu -> random integer 100000.. - -``` - -Generate a random integer between 1 and 10 -```nu -> random integer 1..10 - -``` - -## Notes -Use `random int` instead \ No newline at end of file diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 7b186f6ceca..60b9815303b 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.86.0 +version: 0.87.0 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index d842e692666..f641c24382f 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 092cab43cfc..262e13a6aa6 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Aggregate a list to a single value using an accumulator closure. usage: | diff --git a/commands/docs/register.md b/commands/docs/register.md index 3c99d0e7a29..186c9d27c09 100644 --- a/commands/docs/register.md +++ b/commands/docs/register.md @@ -2,7 +2,7 @@ title: register categories: | core -version: 0.86.0 +version: 0.87.0 core: | Register a plugin. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 9021562e734..3ad5afb4d17 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | @@ -18,6 +18,10 @@ usage: | ```> reject {flags} ...rest``` +## Flags + + - `--ignore-errors, -i`: ignore missing data (make all cell path members optional) + ## Parameters - `...rest`: the names of columns to remove from the table @@ -83,6 +87,18 @@ Reject columns by a provided list of columns ``` +Reject columns by a list of columns directly +```nu +> [[name type size]; [Cargo.toml toml 1kb] [Cargo.lock toml 2kb]] | reject ["size", "type"] +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ +โ”‚ # โ”‚ name โ”‚ +โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ 0 โ”‚ Cargo.toml โ”‚ +โ”‚ 1 โ”‚ Cargo.lock โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ + +``` + Reject rows by a provided list of rows ```nu > let rows = [0 2];[[name type size]; [Cargo.toml toml 1kb] [Cargo.lock toml 2kb] [file.json json 3kb]] | reject $rows diff --git a/commands/docs/rename.md b/commands/docs/rename.md index e889c6ac0f5..e15d9a74b5c 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index ea9a3ad96d6..37b8eb2cee6 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.86.0 +version: 0.87.0 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index ea9cf62a0e2..965448e94d8 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 816576a7860..6f8dcac53f4 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Remove files and directories. usage: | @@ -30,7 +30,7 @@ usage: | ## Parameters - - `filename`: the path of the file you want to remove + - `filename`: the file or files you want to remove - `...rest`: additional file path(s) to remove diff --git a/commands/docs/roll.md b/commands/docs/roll.md index e4f64790b31..51b07aa4048 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index fe223e521df..edd37f9bf96 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 0b5b55e912b..93f6ddd5996 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 0f489a17933..15622e3b1c1 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 0fe671cb106..8ba72b558a7 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 9b5ec772c41..805a356f392 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index 2a3810a6309..6be56bb7e77 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.86.0 +version: 0.87.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 4079c6c2227..dcb706a8c9e 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index a477b27d2f9..8dbcc0a570d 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.86.0 +version: 0.87.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 5511236a32c..c51c766b624 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.86.0 +version: 0.87.0 core: | Commands for getting info about what is in scope. usage: | diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index 2ff22b5a417..f0b1a5a00ad 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -1,18 +1,18 @@ --- title: scope aliases categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output info on the aliases in the current scope. usage: | Output info on the aliases in the current scope. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 3c1da344192..d1812843b76 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -1,18 +1,18 @@ --- title: scope commands categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output info on the commands in the current scope. usage: | Output info on the commands in the current scope. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index d2855ce520c..4b0bf4f020a 100644 --- a/commands/docs/scope_engine-stats.md +++ b/commands/docs/scope_engine-stats.md @@ -1,18 +1,18 @@ --- title: scope engine-stats categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output stats on the engine in the current state. usage: | Output stats on the engine in the current state. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index 1efd717f0c5..c92261edd9d 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -1,18 +1,18 @@ --- title: scope externs categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output info on the known externals in the current scope. usage: | Output info on the known externals in the current scope. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index a45a662a9b3..d0b37fa1061 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -1,18 +1,18 @@ --- title: scope modules categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output info on the modules in the current scope. usage: | Output info on the modules in the current scope. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index 7424e8330e6..a9b7d7342b8 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -1,18 +1,18 @@ --- title: scope variables categories: | - filters -version: 0.86.0 -filters: | + core +version: 0.87.0 +core: | Output info on the variables in the current scope. usage: | Output info on the variables in the current scope. --- -# {{ $frontmatter.title }} for filters +# {{ $frontmatter.title }} for core -
{{ $frontmatter.filters }}
+
{{ $frontmatter.core }}
## Signature diff --git a/commands/docs/select.md b/commands/docs/select.md index 48dbec30d1c..f4475ab9a15 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | @@ -73,6 +73,18 @@ Select columns by a provided list of columns ``` +Select columns by a provided list of columns +```nu +> [[name type size]; [Cargo.toml toml 1kb] [Cargo.lock toml 2kb]] | select ["name", "type"] +โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ +โ”‚ # โ”‚ name โ”‚ type โ”‚ +โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ 0 โ”‚ Cargo.toml โ”‚ toml โ”‚ +โ”‚ 1 โ”‚ Cargo.lock โ”‚ toml โ”‚ +โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ + +``` + Select rows by a provided list of rows ```nu > let rows = [0 2];[[name type size]; [Cargo.toml toml 1kb] [Cargo.lock toml 2kb] [file.json json 3kb]] | select $rows diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 453f9550eb2..09c62f7df39 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.86.0 +version: 0.87.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 9803b66eb82..8452e781901 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.86.0 +version: 0.87.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index a1b98b4a5b2..0ff07a6a913 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.86.0 +version: 0.87.0 generators: | Print sequences of dates. usage: | @@ -45,19 +45,19 @@ print the next 10 days in YYYY-MM-DD format with newline separator print the previous 10 days in YYYY-MM-DD format with newline separator ```nu -> seq date --days 10 -r +> seq date --days 10 --reverse ``` print the previous 10 days starting today in MM/DD/YYYY format with newline separator ```nu -> seq date --days 10 -o '%m/%d/%Y' -r +> seq date --days 10 -o '%m/%d/%Y' --reverse ``` print the first 10 days in January, 2020 ```nu -> seq date -b '2020-01-01' -e '2020-01-10' +> seq date --begin-date '2020-01-01' --end-date '2020-01-10' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ 2020-01-01 โ”‚ โ”‚ 1 โ”‚ 2020-01-02 โ”‚ @@ -75,7 +75,7 @@ print the first 10 days in January, 2020 print every fifth day between January 1st 2020 and January 31st 2020 ```nu -> seq date -b '2020-01-01' -e '2020-01-31' -n 5 +> seq date --begin-date '2020-01-01' --end-date '2020-01-31' --increment 5 โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ 2020-01-01 โ”‚ โ”‚ 1 โ”‚ 2020-01-06 โ”‚ diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index e4007f5033d..d010af7a64a 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/size.md b/commands/docs/size.md index 1bdc91d1dd9..7653659a0fe 100644 --- a/commands/docs/size.md +++ b/commands/docs/size.md @@ -2,7 +2,7 @@ title: size categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index b1d9f217953..7f645a3dda9 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index fa65fe6f975..70bd7c4b50c 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Skip elements of the input until a predicate is true. usage: | diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index 039a19ef92a..7a3dec59d69 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Skip elements of the input while a predicate is true. usage: | diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index 7641e9040b6..b13aee97fcf 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index fba3693d421..826d6bfb93e 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Sort by the given columns, in increasing order. usage: | @@ -34,6 +34,7 @@ usage: | | input | output | | --------- | --------- | | list\ | list\ | +| record | table | | table | table | ## Examples diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 5ed878df66c..d9fe71f7862 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 90f15cc6409..b60365d1cd8 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.86.0 +version: 0.87.0 core: | Source the environment from a source file into the current environment. usage: | diff --git a/commands/docs/source.md b/commands/docs/source.md index 780498327dd..27c7272e9db 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.86.0 +version: 0.87.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split-by.md b/commands/docs/split-by.md index af945c60c45..cb32c9e065b 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,11 +2,11 @@ title: split-by categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | - Create a new table split. + Split a record into groups usage: | - Create a new table split. + Split a record into groups --- @@ -34,13 +34,13 @@ usage: | split items by column named "lang" ```nu > { - '2019': [ - { name: 'andres', lang: 'rb', year: '2019' }, - { name: 'jt', lang: 'rs', year: '2019' } - ], - '2021': [ - { name: 'storm', lang: 'rs', 'year': '2021' } - ] + '2019': [ + { name: 'andres', lang: 'rb', year: '2019' }, + { name: 'jt', lang: 'rs', year: '2019' } + ], + '2021': [ + { name: 'storm', lang: 'rs', 'year': '2021' } + ] } | split-by lang โ•ญโ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ diff --git a/commands/docs/split.md b/commands/docs/split.md index 6351cf19199..ba7964f5c2a 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.86.0 +version: 0.87.0 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 935d6980946..7b3739d3285 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Split a string into a list of characters. usage: | @@ -47,7 +47,7 @@ Split the string into a list of characters Split on grapheme clusters ```nu -> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’' | split chars -g +> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’' | split chars --grapheme-clusters โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ ๐Ÿ‡ฏ๐Ÿ‡ต โ”‚ โ”‚ 1 โ”‚ ใป โ”‚ diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index 18f18bf053d..c125b5995c0 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Split a string into multiple columns using a separator. usage: | @@ -50,7 +50,7 @@ Split a string into columns by the specified separator Split a string into columns of char and remove the empty columns ```nu -> 'abc' | split column -c '' +> 'abc' | split column --collapse-empty '' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ column1 โ”‚ column2 โ”‚ column3 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -73,7 +73,7 @@ Split a list of strings into a table Split a list of strings into a table, ignoring padding ```nu -> ['a - b' 'c - d'] | split column -r '\s*-\s*' +> ['a - b' 'c - d'] | split column --regex '\s*-\s*' โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ column1 โ”‚ column2 โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index ef9c99542ee..4a2fbe922cf 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 6cb39a1293d..ac54a69cec9 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Split a string into multiple rows using a separator. usage: | diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index 13e623b5405..8906e7ad504 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Split a string's words into separate rows. usage: | @@ -45,7 +45,7 @@ Split the string's words into separate rows Split the string's words, of at least 3 characters, into separate rows ```nu -> 'hello to the world' | split words -l 3 +> 'hello to the world' | split words --min-word-length 3 โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ hello โ”‚ โ”‚ 1 โ”‚ the โ”‚ @@ -56,6 +56,6 @@ Split the string's words, of at least 3 characters, into separate rows A real-world example of splitting words ```nu -> http get https://www.gutenberg.org/files/11/11-0.txt | str downcase | split words -l 2 | uniq --count | sort-by count --reverse | first 10 +> http get https://www.gutenberg.org/files/11/11-0.txt | str downcase | split words --min-word-length 2 | uniq --count | sort-by count --reverse | first 10 ``` diff --git a/commands/docs/start.md b/commands/docs/start.md index b1ec6b25380..4f87ade890c 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Open a folder, file or website in the default application or viewer. usage: | diff --git a/commands/docs/str.md b/commands/docs/str.md index 03041a2eda4..4592602b695 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Various commands for working with string data. usage: | @@ -49,6 +49,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`str screaming-snake-case`](/commands/docs/str_screaming-snake-case.md) | Builtin | Convert a string to SCREAMING_SNAKE_CASE. | | [`str snake-case`](/commands/docs/str_snake-case.md) | Builtin | Convert a string to snake_case. | | [`str starts-with`](/commands/docs/str_starts-with.md) | Builtin | Check if an input starts with a string. | +| [`str stats`](/commands/docs/str_stats.md) | Builtin | Gather word count statistics on the text. | | [`str substring`](/commands/docs/str_substring.md) | Builtin | Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. | | [`str title-case`](/commands/docs/str_title-case.md) | Builtin | Convert a string to Title Case. | | [`str trim`](/commands/docs/str_trim.md) | Builtin | Trim whitespace or specific character. | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index e2b00abe2bb..5f9dc857419 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.86.0 +version: 0.87.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 9ba3c192aa0..17b36c87daa 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 823a488f6c6..2c033d3f580 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Checks if string input contains a substring. usage: | @@ -47,7 +47,7 @@ true Check if input contains string case insensitive ```nu -> 'my_library.rb' | str contains -i '.RB' +> 'my_library.rb' | str contains --ignore-case '.RB' true ``` @@ -62,7 +62,7 @@ Check if input contains string in a record Check if input contains string in a table ```nu -> [[ColA ColB]; [test 100]] | str contains -i 'E' ColA +> [[ColA ColB]; [test 100]] | str contains --ignore-case 'E' ColA โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ # โ”‚ ColA โ”‚ ColB โ”‚ โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”ค @@ -101,7 +101,7 @@ Check if list contains string Check if list does not contain string ```nu -> [one two three] | str contains -n o +> [one two three] | str contains --not o โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ 0 โ”‚ false โ”‚ โ”‚ 1 โ”‚ false โ”‚ diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 65449ba5eaf..c6a425d3043 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index a3bcd6a7f1f..cf3f33b21bb 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index eea74d7565b..0ae6acf93f6 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.86.0 +version: 0.87.0 strings: | Check if an input ends with a string. usage: | @@ -56,6 +56,6 @@ Checks if strings end with '.txt' Checks if string ends with '.RB', case-insensitive ```nu -> 'my_library.rb' | str ends-with -i '.RB' +> 'my_library.rb' | str ends-with --ignore-case '.RB' true ``` diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 9edeb083a01..d6712758487 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index 7eeda526957..4078fd6705b 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.86.0 +version: 0.87.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | @@ -49,25 +49,25 @@ Returns index of string in input Count length using grapheme clusters ```nu -> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str index-of -g 'ใตใŒ' +> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str index-of --grapheme-clusters 'ใตใŒ' 4 ``` Returns index of string in input within a`rhs open range` ```nu -> '.rb.rb' | str index-of '.rb' -r 1.. +> '.rb.rb' | str index-of '.rb' --range 1.. 3 ``` Returns index of string in input within a lhs open range ```nu -> '123456' | str index-of '6' -r ..4 +> '123456' | str index-of '6' --range ..4 -1 ``` Returns index of string in input within a range ```nu -> '123456' | str index-of '3' -r 1..4 +> '123456' | str index-of '3' --range 1..4 2 ``` diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index 357fb692329..edaa43cedec 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index 2a8693b79ba..b2b64ad9dcb 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.86.0 +version: 0.87.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 06679c42ad6..41cb464f94f 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Output the length of any strings in the pipeline. usage: | @@ -46,7 +46,7 @@ Return the lengths of a string Count length using grapheme clusters ```nu -> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str length -g +> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str length --grapheme-clusters 9 ``` diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 5107f51a3d5..ffaa4ff7a4d 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.86.0 +version: 0.87.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 9296f6e0d3e..66adc485521 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index abf9fac63f8..4db7b06115e 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Reverse every string in the pipeline. usage: | diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index 51b66cb094f..d03aedae143 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.86.0 +version: 0.87.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index dddb7114aad..534d4e29d3a 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.86.0 +version: 0.87.0 strings: | Convert a string to snake_case. usage: | diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index 82ced96e041..2982d6e4d84 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.86.0 +version: 0.87.0 strings: | Check if an input starts with a string. usage: | @@ -58,6 +58,6 @@ false Checks if input string starts with 'cargo', case-insensitive ```nu -> 'Cargo.toml' | str starts-with -i 'cargo' +> 'Cargo.toml' | str starts-with --ignore-case 'cargo' true ``` diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md new file mode 100644 index 00000000000..32627631e3f --- /dev/null +++ b/commands/docs/str_stats.md @@ -0,0 +1,64 @@ +--- +title: str stats +categories: | + strings +version: 0.87.0 +strings: | + Gather word count statistics on the text. +usage: | + Gather word count statistics on the text. +--- + + +# {{ $frontmatter.title }} for strings + +
{{ $frontmatter.strings }}
+ +## Signature + +```> str stats {flags} ``` + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | record | + +## Examples + +Count the number of words in a string +```nu +> "There are seven words in this sentence" | str stats +โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ +โ”‚ lines โ”‚ 1 โ”‚ +โ”‚ words โ”‚ 7 โ”‚ +โ”‚ bytes โ”‚ 38 โ”‚ +โ”‚ chars โ”‚ 38 โ”‚ +โ”‚ graphemes โ”‚ 38 โ”‚ +โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ•ฏ +``` + +Counts unicode characters +```nu +> 'ไปŠๅคฉๅคฉๆฐ”็œŸๅฅฝ' | str stats +โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ +โ”‚ lines โ”‚ 1 โ”‚ +โ”‚ words โ”‚ 6 โ”‚ +โ”‚ bytes โ”‚ 18 โ”‚ +โ”‚ chars โ”‚ 6 โ”‚ +โ”‚ graphemes โ”‚ 6 โ”‚ +โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ•ฏ +``` + +Counts Unicode characters correctly in a string +```nu +> "Ameฬlie Amelie" | str stats +โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ•ฎ +โ”‚ lines โ”‚ 1 โ”‚ +โ”‚ words โ”‚ 2 โ”‚ +โ”‚ bytes โ”‚ 15 โ”‚ +โ”‚ chars โ”‚ 14 โ”‚ +โ”‚ graphemes โ”‚ 13 โ”‚ +โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ•ฏ +``` diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 8f1ee6abba4..4bdde9773f2 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. usage: | @@ -47,6 +47,6 @@ nushell Count indexes and split using grapheme clusters ```nu -> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str substring -g 4..6 +> '๐Ÿ‡ฏ๐Ÿ‡ตใปใ’ ใตใŒ ใดใ‚ˆ' | str substring --grapheme-clusters 4..6 ใตใŒ ``` diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index 51484b3645c..2c9a9b78a3b 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.86.0 +version: 0.87.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 3d6934e7acd..21b2dfc62e0 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Trim whitespace or specific character. usage: | @@ -47,30 +47,30 @@ Nu shell Trim a specific character ```nu -> '=== Nu shell ===' | str trim -c '=' | str trim +> '=== Nu shell ===' | str trim --char '=' | str trim Nu shell ``` Trim whitespace from the beginning of string ```nu -> ' Nu shell ' | str trim -l +> ' Nu shell ' | str trim --left Nu shell ``` Trim a specific character ```nu -> '=== Nu shell ===' | str trim -c '=' +> '=== Nu shell ===' | str trim --char '=' Nu shell ``` Trim whitespace from the end of string ```nu -> ' Nu shell ' | str trim -r +> ' Nu shell ' | str trim --right Nu shell ``` Trim a specific character ```nu -> '=== Nu shell ===' | str trim -r -c '=' +> '=== Nu shell ===' | str trim --right --char '=' === Nu shell ``` diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index 193eb83f7b5..ba9e4727f08 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index fb077a296dc..80c42afbfbc 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.86.0 +version: 0.87.0 system: | View information about the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 75cdc598d41..a65f5b73704 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.86.0 +version: 0.87.0 viewers: | Render the table. usage: | @@ -42,7 +42,7 @@ Be aware collapse mode currently doesn't support width control List the files in current directory, with indexes starting from 1. ```nu -> ls | table -n 1 +> ls | table --start-number 1 ``` diff --git a/commands/docs/take.md b/commands/docs/take.md index ee00ca4545e..400d4d7e2d7 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 65f21cbcd30..e00b5a9bcdb 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Take elements of the input until a predicate is true. usage: | diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index bb8e218f58a..8d2787cb003 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Take elements of the input while a predicate is true. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index be740bd5e68..c68f653d4ba 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.86.0 +version: 0.87.0 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index 18e19abd70b..30f1693267a 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 2f201dae874..ceb795d511e 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Translate structured data to a format. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index b8c11d9930c..f2384553b4d 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index b8743134cea..b3119310234 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 1f9bdb1447f..9cb75f0375c 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index e9d29a9eb59..b35b710da47 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 8ce6d270a0f..7373e13d468 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 6cab362eff8..e277ce8c9ac 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 9041efc9b96..f1ca0be0a66 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 173f70a5417..b3a0c5c535d 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 8a59fddcea0..b6259d8d8bb 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert special record structure into .xml text. usage: | @@ -20,7 +20,6 @@ usage: | ## Flags - - `--pretty, -p {int}`: DEPRECATED option, will be removed in 0.87. Please use `--indent {int}` instead. - `--indent, -i {int}`: Formats the XML text with the provided indentation setting diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 482c9f2fca1..211a1201285 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.86.0 +version: 0.87.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 27614a4ebd2..2dc7f5f3b82 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index 87a18f441c6..6b1c4acf619 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | diff --git a/commands/docs/try.md b/commands/docs/try.md index a8d841ede2a..8388fad3b43 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.86.0 +version: 0.87.0 core: | Try to run a block, if it fails optionally run a catch block. usage: | diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 15d74ea743d..4247679f730 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.86.0 +version: 0.87.0 misc: | Run the tutorial. To begin, run: tutor. usage: | @@ -43,6 +43,6 @@ Begin the tutorial Search a tutorial by phrase ```nu -> tutor -f "$in" +> tutor --find "$in" ``` diff --git a/commands/docs/umkdir.md b/commands/docs/umkdir.md new file mode 100644 index 00000000000..7df520179fa --- /dev/null +++ b/commands/docs/umkdir.md @@ -0,0 +1,48 @@ +--- +title: umkdir +categories: | + filesystem +version: 0.87.0 +filesystem: | + Create directories, with intermediary directories if required using uutils/coreutils mkdir. +usage: | + Create directories, with intermediary directories if required using uutils/coreutils mkdir. +--- + + +# {{ $frontmatter.title }} for filesystem + +
{{ $frontmatter.filesystem }}
+ +## Signature + +```> umkdir {flags} ...rest``` + +## Flags + + - `--verbose, -v`: print a message for each created directory. + +## Parameters + + - `...rest`: the name(s) of the path(s) to create + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Make a directory named foo +```nu +> umkdir foo + +``` + +Make multiple directories and show the paths created +```nu +> umkdir -v foo/bar foo2 + +``` diff --git a/commands/docs/unfold.md b/commands/docs/unfold.md index a2d961be755..d30876f3662 100644 --- a/commands/docs/unfold.md +++ b/commands/docs/unfold.md @@ -2,7 +2,7 @@ title: unfold categories: | generators -version: 0.86.0 +version: 0.87.0 generators: | Generate a list of values by successively invoking a closure. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index 71ceb458334..a01375a3951 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Return the distinct values in the input by the given column(s). usage: | diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index a69f647003d..39ddef04c77 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 2548677e27c..cecf237b0d4 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Update an existing column to have a new value. usage: | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index d756d0a83b3..bb9f3700a5b 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 1ddc72ef8bd..309dc79d778 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | diff --git a/commands/docs/url.md b/commands/docs/url.md index 1da2c85b472..775f80593d5 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.86.0 +version: 0.87.0 network: | Various commands for working with URLs. usage: | diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 648b23870cd..bc4ce67167a 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.86.0 +version: 0.87.0 network: | Converts record or table into query string applying percent-encoding. usage: | diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index 755452831b1..42dc2644cb5 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Converts a percent-encoded web safe string to a string. usage: | diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index 33dd8e1a630..1b4575069f9 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.86.0 +version: 0.87.0 strings: | Converts a string to a percent encoded web safe string. usage: | diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index 0796de3cd91..aba22f5849b 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.86.0 +version: 0.87.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index a51dd5b235c..04bb4da1ec9 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.86.0 +version: 0.87.0 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index d402c98c919..6d94e75ccdf 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.86.0 +version: 0.87.0 core: | Use definitions from a module, making them available in your shell. usage: | diff --git a/commands/docs/values.md b/commands/docs/values.md index 7a90eb90a8e..10c6f980452 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Given a record or table, produce a list of its columns' values. usage: | diff --git a/commands/docs/version.md b/commands/docs/version.md index 735657d16c2..efaf8c1cfed 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.86.0 +version: 0.87.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 36926577b42..c334126449c 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index c56fd853b08..39c37ac80bc 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index 4acdcacad86..8b8c65b94a0 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 22effc4867d..b9db92a7e5e 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.86.0 +version: 0.87.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index e3bd3903ad2..8697f55c69b 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.86.0 +version: 0.87.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | diff --git a/commands/docs/where.md b/commands/docs/where.md index 6bcaf476064..629be4791c1 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 462398bb2d6..ab21a885c8e 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.86.0 +version: 0.87.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 67f13be34af..b4130ff9ba4 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.86.0 +version: 0.87.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md new file mode 100644 index 00000000000..7094aa0cff9 --- /dev/null +++ b/commands/docs/whoami.md @@ -0,0 +1,34 @@ +--- +title: whoami +categories: | + platform +version: 0.87.0 +platform: | + Get the current username using uutils/coreutils whoami. +usage: | + Get the current username using uutils/coreutils whoami. +--- + + +# {{ $frontmatter.title }} for platform + +
{{ $frontmatter.platform }}
+ +## Signature + +```> whoami {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | + +## Examples + +Get the current username +```nu +> whoami + +``` diff --git a/commands/docs/window.md b/commands/docs/window.md index 75aed5046e7..66153dafddd 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index 68a4629603a..b662126027c 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.86.0 +version: 0.87.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 07e4067e9dc..5cb524f203a 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index dfe7f9d5d63..dfdcdc3eeee 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.86.0 +version: 0.87.0 filters: | Combine a stream with the input. usage: |