From 308e38f9453fef2be41adfc55928d951e8fb9e8f Mon Sep 17 00:00:00 2001 From: Justin Ma Date: Wed, 18 Oct 2023 09:59:43 +0800 Subject: [PATCH] Refresh command docs for Nu v0.86 (#1112) * Refresh docs for Nu v0.86 * ci skip * remove some unused commands --- .../configs/sidebar/command_categories.ts | 2 +- commands/docs/alias.md | 2 +- commands/docs/all.md | 2 +- commands/docs/ansi.md | 4 +- commands/docs/ansi_gradient.md | 2 +- commands/docs/ansi_link.md | 2 +- commands/docs/ansi_strip.md | 2 +- commands/docs/any.md | 2 +- commands/docs/append.md | 10 +- commands/docs/ast.md | 4 +- commands/docs/bits.md | 16 +- commands/docs/bits_and.md | 8 +- commands/docs/bits_not.md | 6 +- commands/docs/bits_or.md | 8 +- commands/docs/bits_rol.md | 6 +- commands/docs/bits_ror.md | 8 +- commands/docs/bits_shl.md | 10 +- commands/docs/bits_shr.md | 6 +- commands/docs/bits_xor.md | 8 +- commands/docs/break.md | 2 +- commands/docs/bytes.md | 2 +- commands/docs/bytes_add.md | 8 +- commands/docs/bytes_at.md | 2 +- commands/docs/bytes_build.md | 2 +- commands/docs/bytes_collect.md | 2 +- commands/docs/bytes_ends-with.md | 2 +- commands/docs/bytes_index-of.md | 8 +- commands/docs/bytes_length.md | 2 +- commands/docs/bytes_remove.md | 6 +- commands/docs/bytes_replace.md | 6 +- commands/docs/bytes_reverse.md | 2 +- commands/docs/bytes_starts-with.md | 2 +- commands/docs/cal.md | 2 +- commands/docs/cd.md | 8 +- commands/docs/char.md | 2 +- commands/docs/clear.md | 2 +- commands/docs/collect.md | 2 +- commands/docs/columns.md | 2 +- commands/docs/commandline.md | 2 +- commands/docs/compact.md | 2 +- commands/docs/complete.md | 2 +- commands/docs/config.md | 2 +- commands/docs/config_env.md | 18 ++- commands/docs/config_nu.md | 18 ++- commands/docs/config_reset.md | 2 +- commands/docs/const.md | 2 +- commands/docs/continue.md | 2 +- commands/docs/cp-old.md | 72 +++++++++ commands/docs/cp.md | 32 ++-- commands/docs/date.md | 2 +- commands/docs/date_format.md | 2 +- commands/docs/date_humanize.md | 2 +- commands/docs/date_list-timezone.md | 2 +- commands/docs/date_now.md | 2 +- commands/docs/date_to-record.md | 2 +- commands/docs/date_to-table.md | 2 +- commands/docs/date_to-timezone.md | 6 +- commands/docs/debug.md | 9 +- commands/docs/debug_info.md | 38 +++++ commands/docs/decode.md | 2 +- commands/docs/decode_base64.md | 2 +- commands/docs/decode_hex.md | 2 +- commands/docs/def-env.md | 2 +- commands/docs/def.md | 28 +++- commands/docs/default.md | 4 +- commands/docs/describe.md | 2 +- commands/docs/detect_columns.md | 2 +- commands/docs/dfr.md | 143 ++++++++++++++++++ commands/docs/dfr_agg-groups.md | 2 +- commands/docs/dfr_agg.md | 2 +- commands/docs/dfr_all-false.md | 2 +- commands/docs/dfr_all-true.md | 2 +- commands/docs/dfr_append.md | 2 +- commands/docs/dfr_arg-max.md | 2 +- commands/docs/dfr_arg-min.md | 2 +- commands/docs/dfr_arg-sort.md | 4 +- commands/docs/dfr_arg-true.md | 2 +- commands/docs/dfr_arg-unique.md | 2 +- commands/docs/dfr_arg-where.md | 2 +- commands/docs/dfr_as-date.md | 2 +- commands/docs/dfr_as-datetime.md | 2 +- commands/docs/dfr_as.md | 2 +- commands/docs/dfr_cache.md | 2 +- commands/docs/dfr_col.md | 2 +- commands/docs/dfr_collect.md | 2 +- commands/docs/dfr_columns.md | 2 +- commands/docs/dfr_concat-str.md | 2 +- commands/docs/dfr_concatenate.md | 2 +- commands/docs/dfr_contains.md | 2 +- commands/docs/dfr_count-null.md | 2 +- commands/docs/dfr_count.md | 2 +- commands/docs/dfr_cumulative.md | 2 +- commands/docs/dfr_datepart.md | 12 +- commands/docs/dfr_drop-duplicates.md | 2 +- commands/docs/dfr_drop-nulls.md | 2 +- commands/docs/dfr_drop.md | 2 +- commands/docs/dfr_dtypes.md | 2 +- commands/docs/dfr_dummies.md | 2 +- commands/docs/dfr_explode.md | 2 +- commands/docs/dfr_expr-not.md | 2 +- commands/docs/dfr_fetch.md | 2 +- commands/docs/dfr_fill-nan.md | 2 +- commands/docs/dfr_fill-null.md | 2 +- commands/docs/dfr_filter-with.md | 2 +- commands/docs/dfr_filter.md | 2 +- commands/docs/dfr_first.md | 2 +- commands/docs/dfr_flatten.md | 2 +- commands/docs/dfr_get-day.md | 4 +- commands/docs/dfr_get-hour.md | 4 +- commands/docs/dfr_get-minute.md | 4 +- commands/docs/dfr_get-month.md | 4 +- commands/docs/dfr_get-nanosecond.md | 4 +- commands/docs/dfr_get-ordinal.md | 4 +- commands/docs/dfr_get-second.md | 4 +- commands/docs/dfr_get-week.md | 4 +- commands/docs/dfr_get-weekday.md | 4 +- commands/docs/dfr_get-year.md | 4 +- commands/docs/dfr_get.md | 2 +- commands/docs/dfr_group-by.md | 2 +- commands/docs/dfr_implode.md | 2 +- commands/docs/dfr_into-df.md | 2 +- commands/docs/dfr_into-lazy.md | 2 +- commands/docs/dfr_into-nu.md | 4 +- commands/docs/dfr_is-duplicated.md | 2 +- commands/docs/dfr_is-in.md | 2 +- commands/docs/dfr_is-not-null.md | 2 +- commands/docs/dfr_is-null.md | 2 +- commands/docs/dfr_is-unique.md | 2 +- commands/docs/dfr_join.md | 2 +- commands/docs/dfr_last.md | 2 +- commands/docs/dfr_lit.md | 2 +- commands/docs/dfr_lowercase.md | 2 +- commands/docs/dfr_ls.md | 2 +- commands/docs/dfr_max.md | 2 +- commands/docs/dfr_mean.md | 2 +- commands/docs/dfr_median.md | 2 +- commands/docs/dfr_melt.md | 2 +- commands/docs/dfr_min.md | 2 +- commands/docs/dfr_n-unique.md | 2 +- commands/docs/dfr_not.md | 2 +- commands/docs/dfr_open.md | 2 +- commands/docs/dfr_otherwise.md | 2 +- commands/docs/dfr_quantile.md | 2 +- commands/docs/dfr_query.md | 2 +- commands/docs/dfr_rename.md | 2 +- commands/docs/dfr_replace-all.md | 4 +- commands/docs/dfr_replace.md | 4 +- commands/docs/dfr_reverse.md | 2 +- commands/docs/dfr_rolling.md | 2 +- commands/docs/dfr_sample.md | 6 +- commands/docs/dfr_select.md | 2 +- commands/docs/dfr_set-with-idx.md | 4 +- commands/docs/dfr_set.md | 2 +- commands/docs/dfr_shape.md | 2 +- commands/docs/dfr_shift.md | 2 +- commands/docs/dfr_slice.md | 2 +- commands/docs/dfr_sort-by.md | 2 +- commands/docs/dfr_std.md | 2 +- commands/docs/dfr_str-lengths.md | 2 +- commands/docs/dfr_str-slice.md | 4 +- commands/docs/dfr_strftime.md | 4 +- commands/docs/dfr_sum.md | 2 +- commands/docs/dfr_summary.md | 2 +- commands/docs/dfr_take.md | 2 +- commands/docs/dfr_to-arrow.md | 2 +- commands/docs/dfr_to-avro.md | 2 +- commands/docs/dfr_to-csv.md | 4 +- commands/docs/dfr_to-jsonl.md | 2 +- commands/docs/dfr_to-parquet.md | 2 +- commands/docs/dfr_unique.md | 2 +- commands/docs/dfr_uppercase.md | 2 +- commands/docs/dfr_value-counts.md | 2 +- commands/docs/dfr_var.md | 2 +- commands/docs/dfr_when.md | 2 +- commands/docs/dfr_with-column.md | 2 +- commands/docs/do.md | 17 ++- commands/docs/drop.md | 2 +- commands/docs/drop_column.md | 2 +- commands/docs/drop_nth.md | 2 +- commands/docs/du.md | 2 +- commands/docs/each.md | 2 +- commands/docs/each_while.md | 2 +- commands/docs/echo.md | 2 +- commands/docs/encode.md | 2 +- commands/docs/encode_base64.md | 2 +- commands/docs/encode_hex.md | 2 +- commands/docs/enumerate.md | 2 +- commands/docs/error_make.md | 2 +- commands/docs/every.md | 2 +- commands/docs/exec.md | 2 +- commands/docs/exit.md | 2 +- commands/docs/explain.md | 4 +- commands/docs/explore.md | 2 +- commands/docs/export-env.md | 2 +- commands/docs/export.md | 2 +- commands/docs/export_alias.md | 2 +- commands/docs/export_const.md | 2 +- commands/docs/export_def-env.md | 2 +- commands/docs/export_def.md | 11 +- commands/docs/export_extern-wrapped.md | 2 +- commands/docs/export_extern.md | 2 +- commands/docs/export_module.md | 2 +- commands/docs/export_use.md | 2 +- commands/docs/extern-wrapped.md | 2 +- commands/docs/extern.md | 2 +- commands/docs/fill.md | 12 +- commands/docs/filter.md | 2 +- commands/docs/find.md | 12 +- commands/docs/first.md | 2 +- commands/docs/flatten.md | 2 +- commands/docs/fmt.md | 2 +- commands/docs/for.md | 6 +- commands/docs/format.md | 2 +- commands/docs/format_date.md | 2 +- commands/docs/format_duration.md | 2 +- commands/docs/format_filesize.md | 2 +- commands/docs/from.md | 34 +++-- commands/docs/from_csv.md | 2 +- commands/docs/from_eml.md | 8 +- commands/docs/from_ics.md | 4 +- commands/docs/from_ini.md | 4 +- commands/docs/from_json.md | 2 +- commands/docs/from_nuon.md | 2 +- commands/docs/from_ods.md | 4 +- commands/docs/from_ssv.md | 4 +- commands/docs/from_toml.md | 2 +- commands/docs/from_tsv.md | 4 +- commands/docs/from_url.md | 2 +- commands/docs/from_vcf.md | 4 +- commands/docs/from_xlsx.md | 4 +- commands/docs/from_xml.md | 2 +- commands/docs/from_yaml.md | 2 +- commands/docs/from_yml.md | 2 +- commands/docs/get.md | 4 +- commands/docs/glob.md | 4 +- commands/docs/grid.md | 2 +- commands/docs/group-by.md | 2 +- commands/docs/group.md | 2 +- commands/docs/gstat.md | 4 +- commands/docs/hash.md | 2 +- commands/docs/hash_md5.md | 2 +- commands/docs/hash_sha256.md | 2 +- commands/docs/headers.md | 2 +- commands/docs/help.md | 17 ++- commands/docs/help_aliases.md | 2 +- commands/docs/help_commands.md | 2 +- commands/docs/help_escapes.md | 26 ++++ commands/docs/help_externs.md | 2 +- commands/docs/help_modules.md | 2 +- commands/docs/help_operators.md | 2 +- commands/docs/hide-env.md | 2 +- commands/docs/hide.md | 2 +- commands/docs/histogram.md | 14 +- commands/docs/history.md | 2 +- commands/docs/history_session.md | 2 +- commands/docs/http.md | 2 +- commands/docs/http_delete.md | 2 +- commands/docs/http_get.md | 2 +- commands/docs/http_head.md | 2 +- commands/docs/http_options.md | 2 +- commands/docs/http_patch.md | 2 +- commands/docs/http_post.md | 2 +- commands/docs/http_put.md | 2 +- commands/docs/if.md | 2 +- commands/docs/ignore.md | 2 +- commands/docs/inc.md | 13 +- commands/docs/input.md | 2 +- commands/docs/input_list.md | 2 +- commands/docs/input_listen.md | 2 +- commands/docs/insert.md | 2 +- commands/docs/inspect.md | 2 +- commands/docs/into.md | 30 ++-- commands/docs/into_binary.md | 4 +- commands/docs/into_bits.md | 2 +- commands/docs/into_bool.md | 4 +- commands/docs/into_datetime.md | 4 +- commands/docs/into_decimal.md | 73 --------- commands/docs/into_duration.md | 2 +- commands/docs/into_filesize.md | 2 +- commands/docs/into_float.md | 20 +-- commands/docs/into_int.md | 32 ++-- commands/docs/into_record.md | 2 +- commands/docs/into_sqlite.md | 2 +- commands/docs/into_string.md | 18 +-- commands/docs/into_value.md | 44 ++++++ commands/docs/is-admin.md | 2 +- commands/docs/is-empty.md | 2 +- commands/docs/items.md | 2 +- commands/docs/join.md | 2 +- commands/docs/keybindings.md | 2 +- commands/docs/keybindings_default.md | 2 +- commands/docs/keybindings_list.md | 2 +- commands/docs/keybindings_listen.md | 2 +- commands/docs/kill.md | 2 +- commands/docs/last.md | 2 +- commands/docs/lazy_make.md | 4 +- commands/docs/length.md | 2 +- commands/docs/let-env.md | 2 +- commands/docs/let.md | 2 +- commands/docs/lines.md | 2 +- commands/docs/load-env.md | 2 +- commands/docs/loop.md | 2 +- commands/docs/ls.md | 2 +- commands/docs/match.md | 2 +- commands/docs/math.md | 2 +- commands/docs/math_abs.md | 2 +- commands/docs/math_arccos.md | 10 +- commands/docs/math_arccosh.md | 10 +- commands/docs/math_arcsin.md | 10 +- commands/docs/math_arcsinh.md | 10 +- commands/docs/math_arctan.md | 10 +- commands/docs/math_arctanh.md | 10 +- commands/docs/math_avg.md | 2 +- commands/docs/math_ceil.md | 2 +- commands/docs/math_cos.md | 10 +- commands/docs/math_cosh.md | 10 +- commands/docs/math_exp.md | 10 +- commands/docs/math_floor.md | 2 +- commands/docs/math_ln.md | 10 +- commands/docs/math_log.md | 10 +- commands/docs/math_max.md | 2 +- commands/docs/math_median.md | 2 +- commands/docs/math_min.md | 2 +- commands/docs/math_mode.md | 2 +- commands/docs/math_product.md | 2 +- commands/docs/math_round.md | 2 +- commands/docs/math_sin.md | 10 +- commands/docs/math_sinh.md | 10 +- commands/docs/math_sqrt.md | 18 +-- commands/docs/math_stddev.md | 2 +- commands/docs/math_sum.md | 2 +- commands/docs/math_tan.md | 10 +- commands/docs/math_tanh.md | 10 +- commands/docs/math_variance.md | 2 +- commands/docs/merge.md | 2 +- commands/docs/metadata.md | 2 +- commands/docs/mkdir.md | 2 +- commands/docs/module.md | 4 +- commands/docs/move.md | 2 +- commands/docs/mut.md | 2 +- commands/docs/mv.md | 2 +- commands/docs/nu-check.md | 2 +- commands/docs/nu-highlight.md | 2 +- commands/docs/open.md | 2 +- commands/docs/overlay.md | 2 +- commands/docs/overlay_hide.md | 2 +- commands/docs/overlay_list.md | 2 +- commands/docs/overlay_new.md | 2 +- commands/docs/overlay_use.md | 2 +- commands/docs/par-each.md | 2 +- commands/docs/parse.md | 2 +- commands/docs/path.md | 2 +- commands/docs/path_basename.md | 2 +- commands/docs/path_dirname.md | 2 +- commands/docs/path_exists.md | 2 +- commands/docs/path_expand.md | 2 +- commands/docs/path_join.md | 14 +- commands/docs/path_parse.md | 2 +- commands/docs/path_relative-to.md | 2 +- commands/docs/path_split.md | 2 +- commands/docs/path_type.md | 2 +- commands/docs/port.md | 2 +- commands/docs/prepend.md | 8 +- commands/docs/print.md | 2 +- commands/docs/profile.md | 8 +- commands/docs/ps.md | 2 +- commands/docs/query.md | 4 +- commands/docs/query_db.md | 2 +- commands/docs/query_json.md | 4 +- commands/docs/query_web.md | 16 +- commands/docs/query_xml.md | 4 +- commands/docs/random.md | 20 +-- commands/docs/random_bool.md | 2 +- commands/docs/random_chars.md | 2 +- commands/docs/random_decimal.md | 59 -------- commands/docs/random_dice.md | 2 +- commands/docs/random_float.md | 4 +- commands/docs/random_int.md | 56 +++++++ commands/docs/random_integer.md | 9 +- commands/docs/random_uuid.md | 2 +- commands/docs/range.md | 2 +- commands/docs/reduce.md | 12 +- commands/docs/register.md | 2 +- commands/docs/registry_query.md | 40 +++-- commands/docs/reject.md | 2 +- commands/docs/rename.md | 8 +- commands/docs/return.md | 2 +- commands/docs/reverse.md | 2 +- commands/docs/rm.md | 2 +- commands/docs/roll.md | 2 +- commands/docs/roll_down.md | 2 +- commands/docs/roll_left.md | 2 +- commands/docs/roll_right.md | 2 +- commands/docs/roll_up.md | 2 +- commands/docs/rotate.md | 2 +- commands/docs/run-external.md | 2 +- commands/docs/save.md | 2 +- commands/docs/schema.md | 2 +- commands/docs/scope.md | 2 +- commands/docs/scope_aliases.md | 2 +- commands/docs/scope_commands.md | 2 +- commands/docs/scope_engine-stats.md | 2 +- commands/docs/scope_externs.md | 2 +- commands/docs/scope_modules.md | 2 +- commands/docs/scope_variables.md | 2 +- commands/docs/select.md | 2 +- commands/docs/seq.md | 2 +- commands/docs/seq_char.md | 2 +- commands/docs/seq_date.md | 2 +- commands/docs/shuffle.md | 2 +- commands/docs/size.md | 2 +- commands/docs/skip.md | 2 +- commands/docs/skip_until.md | 2 +- commands/docs/skip_while.md | 2 +- commands/docs/sleep.md | 2 +- commands/docs/sort-by.md | 6 +- commands/docs/sort.md | 6 +- commands/docs/source-env.md | 2 +- commands/docs/source.md | 2 +- commands/docs/split-by.md | 2 +- commands/docs/split.md | 2 +- commands/docs/split_chars.md | 2 +- commands/docs/split_column.md | 2 +- commands/docs/split_list.md | 4 +- commands/docs/split_row.md | 2 +- commands/docs/split_words.md | 4 +- commands/docs/start.md | 2 +- commands/docs/str.md | 2 +- commands/docs/str_camel-case.md | 2 +- commands/docs/str_capitalize.md | 2 +- commands/docs/str_contains.md | 2 +- commands/docs/str_distance.md | 2 +- commands/docs/str_downcase.md | 2 +- commands/docs/str_ends-with.md | 2 +- commands/docs/str_expand.md | 2 +- commands/docs/str_index-of.md | 2 +- commands/docs/str_join.md | 2 +- commands/docs/str_kebab-case.md | 2 +- commands/docs/str_length.md | 2 +- commands/docs/str_pascal-case.md | 2 +- commands/docs/str_replace.md | 12 +- commands/docs/str_reverse.md | 2 +- commands/docs/str_screaming-snake-case.md | 2 +- commands/docs/str_snake-case.md | 2 +- commands/docs/str_starts-with.md | 2 +- commands/docs/str_substring.md | 2 +- commands/docs/str_title-case.md | 2 +- commands/docs/str_trim.md | 2 +- commands/docs/str_upcase.md | 2 +- commands/docs/sys.md | 2 +- commands/docs/table.md | 35 ++--- commands/docs/take.md | 2 +- commands/docs/take_until.md | 2 +- commands/docs/take_while.md | 2 +- commands/docs/term_size.md | 2 +- commands/docs/timeit.md | 2 +- commands/docs/to.md | 2 +- commands/docs/to_csv.md | 4 +- commands/docs/to_html.md | 2 +- commands/docs/to_json.md | 4 +- commands/docs/to_md.md | 2 +- commands/docs/to_nuon.md | 4 +- commands/docs/to_text.md | 2 +- commands/docs/to_toml.md | 2 +- commands/docs/to_tsv.md | 2 +- commands/docs/to_xml.md | 7 +- commands/docs/to_yaml.md | 2 +- commands/docs/touch.md | 2 +- commands/docs/transpose.md | 6 +- commands/docs/try.md | 2 +- commands/docs/tutor.md | 2 +- commands/docs/ucp.md | 68 --------- commands/docs/unfold.md | 71 +++++++++ commands/docs/uniq-by.md | 2 +- commands/docs/uniq.md | 8 +- commands/docs/update.md | 2 +- commands/docs/update_cells.md | 22 +-- commands/docs/upsert.md | 2 +- commands/docs/url.md | 3 +- commands/docs/url_build-query.md | 2 +- commands/docs/url_decode.md | 51 +++++++ commands/docs/url_encode.md | 2 +- commands/docs/url_join.md | 2 +- commands/docs/url_parse.md | 2 +- commands/docs/use.md | 4 +- commands/docs/values.md | 2 +- commands/docs/version.md | 2 +- commands/docs/view.md | 2 +- commands/docs/view_files.md | 2 +- commands/docs/view_source.md | 4 +- commands/docs/view_span.md | 6 +- commands/docs/watch.md | 2 +- commands/docs/where.md | 4 +- commands/docs/which.md | 2 +- commands/docs/while.md | 2 +- commands/docs/window.md | 2 +- commands/docs/with-env.md | 2 +- commands/docs/wrap.md | 2 +- commands/docs/zip.md | 2 +- 499 files changed, 1465 insertions(+), 1075 deletions(-) create mode 100644 commands/docs/cp-old.md create mode 100644 commands/docs/debug_info.md create mode 100644 commands/docs/dfr.md create mode 100644 commands/docs/help_escapes.md delete mode 100644 commands/docs/into_decimal.md create mode 100644 commands/docs/into_value.md delete mode 100644 commands/docs/random_decimal.md create mode 100644 commands/docs/random_int.md delete mode 100644 commands/docs/ucp.md create mode 100644 commands/docs/unfold.md create mode 100644 commands/docs/url_decode.md diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 68e92ff44fb..2dc5ca1b757 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 9a04250c5d0..fbf1157ac95 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.85.0 +version: 0.86.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 bf11fdecb9b..0e3dcc58959 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.85.0 +version: 0.86.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 1532b84283e..902ce5bb86f 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Output ANSI codes to change color and style of text. usage: | @@ -93,6 +93,7 @@ Escape sequences usual values: │ 3 │ foreground │ 33 │ 93 │ yellow │ │ 4 │ foreground │ 34 │ 94 │ blue │ │ 5 │ foreground │ 35 │ 95 │ magenta │ +│ 5 │ foreground │ 35 │ 95 │ purple │ │ 6 │ foreground │ 36 │ 96 │ cyan │ │ 7 │ foreground │ 37 │ 97 │ white │ │ 8 │ foreground │ 39 │ │ default │ @@ -102,6 +103,7 @@ Escape sequences usual values: │ 12 │ background │ 43 │ 103 │ yellow │ │ 13 │ background │ 44 │ 104 │ blue │ │ 14 │ background │ 45 │ 105 │ magenta │ +│ 14 │ background │ 45 │ 105 │ purple │ │ 15 │ background │ 46 │ 106 │ cyan │ │ 16 │ background │ 47 │ 107 │ white │ │ 17 │ background │ 49 │ │ default │ diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index 5569b05524b..9754249f541 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.85.0 +version: 0.86.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 4d37e993e21..095eb30b3a8 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index 1d6e766f591..3a1678b9928 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 632ba89b242..a76eede39d0 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.85.0 +version: 0.86.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 9fd1cb7db37..9f88f131731 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Append any number of rows to a table. usage: | @@ -31,7 +31,7 @@ usage: | ## Examples -Append one integer to a list +Append one int to a list ```nu > [0 1 2 3] | append 4 ╭───┬───╮ @@ -66,7 +66,7 @@ Append a list of string to a string ``` -Append three integer items +Append three int items ```nu > [0 1] | append [2 3 4] ╭───┬───╮ @@ -79,7 +79,7 @@ Append three integer items ``` -Append integers and strings +Append ints and strings ```nu > [0 1] | append [2 nu 4 shell] ╭───┬───────╮ @@ -93,7 +93,7 @@ Append integers and strings ``` -Append a range of integers to a list +Append a range of ints to a list ```nu > [0 1] | append 2..4 ╭───┬───╮ diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 6f3885be1c1..02817c1ce52 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | @@ -62,6 +62,6 @@ Print the ast of a pipeline with an error, as json, in a nushell table Print the ast of a pipeline with an error, as json, minified ```nu -> ast 'for x in 1..10 { echo $x ' -j -m +> ast 'for x in 1..10 { echo $x ' --json --minify ``` diff --git a/commands/docs/bits.md b/commands/docs/bits.md index 2fc9602e439..66514a0027c 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | Various commands for working with bits. usage: | @@ -32,13 +32,13 @@ You must use one of the following subcommands. Using this command as-is will onl | name | type | usage | | ---------------------------------------- | ------- | -------------------------------------- | -| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for integers. | +| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for ints. | | [`bits not`](/commands/docs/bits_not.md) | Builtin | Performs logical negation on each bit. | -| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for integers. | -| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for integers. | -| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for integers. | -| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for integers. | -| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for integers. | -| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for integers. | +| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for ints. | +| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for ints. | +| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for ints. | +| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for ints. | +| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for ints. | +| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for ints. | **Tips:** Command `bits` 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/bits_and.md b/commands/docs/bits_and.md index 998973ae816..e809d3c0cb2 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,11 +2,11 @@ title: bits and categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Performs bitwise and for integers. + Performs bitwise and for ints. usage: | - Performs bitwise and for integers. + Performs bitwise and for ints. --- @@ -20,7 +20,7 @@ usage: | ## Parameters - - `target`: target integer to perform bit and + - `target`: target int to perform bit and ## Input/output types: diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index d1e523f2c88..f5cb0745f08 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | Performs logical negation on each bit. usage: | @@ -45,7 +45,7 @@ Apply logical negation to a list of numbers Apply logical negation to a list of numbers, treat input as 2 bytes number ```nu -> [4 3 2] | bits not -n '2' +> [4 3 2] | bits not --number-bytes '2' ╭───┬───────╮ │ 0 │ 65531 │ │ 1 │ 65532 │ @@ -56,7 +56,7 @@ Apply logical negation to a list of numbers, treat input as 2 bytes number Apply logical negation to a list of numbers, treat input as signed number ```nu -> [4 3 2] | bits not -s +> [4 3 2] | bits not --signed ╭───┬────╮ │ 0 │ -5 │ │ 1 │ -4 │ diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 31502dbd972..fced85ca6de 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,11 +2,11 @@ title: bits or categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Performs bitwise or for integers. + Performs bitwise or for ints. usage: | - Performs bitwise or for integers. + Performs bitwise or for ints. --- @@ -20,7 +20,7 @@ usage: | ## Parameters - - `target`: target integer to perform bit or + - `target`: target int to perform bit or ## Input/output types: diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 82116b78bb6..db83c819f1b 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,11 +2,11 @@ title: bits rol categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Bitwise rotate left for integers. + Bitwise rotate left for ints. usage: | - Bitwise rotate left for integers. + Bitwise rotate left for ints. --- diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index a5a8c0a4b47..87fe1558e04 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,11 +2,11 @@ title: bits ror categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Bitwise rotate right for integers. + Bitwise rotate right for ints. usage: | - Bitwise rotate right for integers. + Bitwise rotate right for ints. --- @@ -44,7 +44,7 @@ Rotate right a number with 60 bits Rotate right a list of numbers of one byte ```nu -> [15 33 92] | bits ror 2 -n '1' +> [15 33 92] | bits ror 2 --number-bytes '1' ╭───┬─────╮ │ 0 │ 195 │ │ 1 │ 72 │ diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 3737532ae7d..7579be2060b 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,11 +2,11 @@ title: bits shl categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Bitwise shift left for integers. + Bitwise shift left for ints. usage: | - Bitwise shift left for integers. + Bitwise shift left for ints. --- @@ -44,13 +44,13 @@ Shift left a number by 7 bits Shift left a number with 1 byte by 7 bits ```nu -> 2 | bits shl 7 -n '1' +> 2 | bits shl 7 --number-bytes '1' 0 ``` Shift left a signed number by 1 bit ```nu -> 0x7F | bits shl 1 -s +> 0x7F | bits shl 1 --signed 254 ``` diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index d7283c5d8ee..b1fedd42572 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,11 +2,11 @@ title: bits shr categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Bitwise shift right for integers. + Bitwise shift right for ints. usage: | - Bitwise shift right for integers. + Bitwise shift right for ints. --- diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index d8cb66b3edd..32afd0adb20 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,11 +2,11 @@ title: bits xor categories: | bits -version: 0.85.0 +version: 0.86.0 bits: | - Performs bitwise xor for integers. + Performs bitwise xor for ints. usage: | - Performs bitwise xor for integers. + Performs bitwise xor for ints. --- @@ -20,7 +20,7 @@ usage: | ## Parameters - - `target`: target integer to perform bit xor + - `target`: target int to perform bit xor ## Input/output types: diff --git a/commands/docs/break.md b/commands/docs/break.md index d5480e73c72..6fc96194d94 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.85.0 +version: 0.86.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 35680acf5fc..c77699f3ae7 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.85.0 +version: 0.86.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 4a1e91b6fa7..d187c34c01c 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.85.0 +version: 0.86.0 bytes: | Add specified bytes to the input. usage: | @@ -49,7 +49,7 @@ Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[AA BB]` to `0x[1F FF AA AA]` at index 1 ```nu -> 0x[1F FF AA AA] | bytes add 0x[AA BB] -i 1 +> 0x[1F FF AA AA] | bytes add 0x[AA BB] --index 1 Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii 00000000: 1f aa bb ff aa aa •××××× @@ -57,7 +57,7 @@ Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[11]` to `0x[FF AA AA]` at the end ```nu -> 0x[FF AA AA] | bytes add 0x[11] -e +> 0x[FF AA AA] | bytes add 0x[11] --end Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii 00000000: ff aa aa 11 ××ו @@ -65,7 +65,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Add bytes `0x[11 22 33]` to `0x[FF AA AA]` at the end, at index 1(the index is start from end) ```nu -> 0x[FF AA BB] | bytes add 0x[11 22 33] -e -i 1 +> 0x[FF AA BB] | bytes add 0x[11 22 33] --end --index 1 Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii 00000000: ff aa 11 22 33 bb ×ו"3× diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index eedae312241..1113c3e2e88 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.85.0 +version: 0.86.0 bytes: | Get bytes defined by a range usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 1da73309dbb..0fe322dd88f 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.85.0 +version: 0.86.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index 8b76527a4b5..a2dd5d1d9c0 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.85.0 +version: 0.86.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 d48a8bc7843..2f03bbd176e 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.85.0 +version: 0.86.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 df6d20bb8be..51e50ff5f6d 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.85.0 +version: 0.86.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | @@ -46,13 +46,13 @@ Returns index of pattern in bytes Returns index of pattern, search from end ```nu -> 0x[33 44 55 10 01 13 44 55] | bytes index-of -e 0x[44 55] +> 0x[33 44 55 10 01 13 44 55] | bytes index-of --end 0x[44 55] 6 ``` Returns all matched index ```nu -> 0x[33 44 55 10 01 33 44 33 44] | bytes index-of -a 0x[33 44] +> 0x[33 44 55 10 01 33 44 33 44] | bytes index-of --all 0x[33 44] ╭───┬───╮ │ 0 │ 0 │ │ 1 │ 5 │ @@ -63,7 +63,7 @@ Returns all matched index Returns all matched index, searching from end ```nu -> 0x[33 44 55 10 01 33 44 33 44] | bytes index-of -a -e 0x[33 44] +> 0x[33 44 55 10 01 33 44 33 44] | bytes index-of --all --end 0x[33 44] ╭───┬───╮ │ 0 │ 7 │ │ 1 │ 5 │ diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 3d2dac8462b..2886fcc6dfa 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.85.0 +version: 0.86.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 bafd861e106..e2b5f31f9a0 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.85.0 +version: 0.86.0 bytes: | Remove bytes. usage: | @@ -48,7 +48,7 @@ Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii Remove all occurrences of find binary in record field ```nu -> { data: 0x[10 AA 10 BB 10] } | bytes remove -a 0x[10] data +> { data: 0x[10 AA 10 BB 10] } | bytes remove --all 0x[10] data ╭──────┬────────────╮ │ data │ [170, 187] │ ╰──────┴────────────╯ @@ -56,7 +56,7 @@ Remove all occurrences of find binary in record field Remove occurrences of find binary from end ```nu -> 0x[10 AA 10 BB CC AA 10] | bytes remove -e 0x[10] +> 0x[10 AA 10 BB CC AA 10] | bytes remove --end 0x[10] Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii 00000000: 10 aa 10 bb cc aa •×•××× diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 2b1442d1748..23a361cd554 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.85.0 +version: 0.86.0 bytes: | Find and replace binary. usage: | @@ -48,7 +48,7 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii Find and replace all occurrences of find binary ```nu -> 0x[10 AA 10 BB 10] | bytes replace -a 0x[10] 0x[A0] +> 0x[10 AA 10 BB 10] | bytes replace --all 0x[10] 0x[A0] Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii 00000000: a0 aa a0 bb a0 ××××× @@ -56,7 +56,7 @@ Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii Find and replace all occurrences of find binary in table ```nu -> [[ColA ColB ColC]; [0x[11 12 13] 0x[14 15 16] 0x[17 18 19]]] | bytes replace -a 0x[11] 0x[13] ColA ColC +> [[ColA ColB ColC]; [0x[11 12 13] 0x[14 15 16] 0x[17 18 19]]] | bytes replace --all 0x[11] 0x[13] ColA ColC ╭───┬──────────────┬──────────────┬──────────────╮ │ # │ ColA │ ColB │ ColC │ ├───┼──────────────┼──────────────┼──────────────┤ diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index a7059aa85fa..f59233dd069 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.85.0 +version: 0.86.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 9bd976ded91..a42ccbe1741 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.85.0 +version: 0.86.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 4160352e551..88a9f602a3a 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.85.0 +version: 0.86.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 17d0523fc00..63851de84de 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Change directory. usage: | @@ -37,12 +37,6 @@ Change to your home directory ``` -Change to a directory via abbreviations -```nu -> cd d/s/9 - -``` - Change to the previous working directory ($OLDPWD) ```nu > cd - diff --git a/commands/docs/char.md b/commands/docs/char.md index 44d40f58e51..788b492a577 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 808a1a8f712..72d4dc7b446 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 2622e5984c4..e3ebc072e8f 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.85.0 +version: 0.86.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 64a22ef0f99..9fda29d1c11 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.85.0 +version: 0.86.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 69d3990f5d2..860e309113e 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.85.0 +version: 0.86.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 7678fc6ad4a..bf85d9e665e 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index c281c11a4c1..18382754eed 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.85.0 +version: 0.86.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 ce049aee4a5..7eda8c7ebea 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.85.0 +version: 0.86.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 738861ac33c..2b50bbd07f5 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.85.0 +version: 0.86.0 env: | Edit nu environment configurations. usage: | @@ -18,6 +18,10 @@ usage: | ```> config env {flags} ``` +## Flags + + - `--default, -d`: Print default `env.nu` file instead. + ## Input/output types: @@ -32,3 +36,15 @@ allow user to open and update nu env > config env ``` + +allow user to print default `env.nu` file +```nu +> config env --default, + +``` + +allow saving the default `env.nu` locally +```nu +> config env --default | save -f ~/.config/nushell/default_env.nu + +``` diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 6b4dfd05ab8..2b6152e04a5 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.85.0 +version: 0.86.0 env: | Edit nu configurations. usage: | @@ -18,6 +18,10 @@ usage: | ```> config nu {flags} ``` +## Flags + + - `--default, -d`: Print default `config.nu` file instead. + ## Input/output types: @@ -32,3 +36,15 @@ allow user to open and update nu config > config nu ``` + +allow user to print default `config.nu` file +```nu +> config nu --default, + +``` + +allow saving the default `config.nu` locally +```nu +> config nu --default | save -f ~/.config/nushell/default_config.nu + +``` diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 0790b331e2e..0fbf749635c 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.85.0 +version: 0.86.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 33c0744f5a0..6e6833e2170 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.85.0 +version: 0.86.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index a0dd3dda0cb..ce8b548400f 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.85.0 +version: 0.86.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp-old.md b/commands/docs/cp-old.md new file mode 100644 index 00000000000..4bebc2bbef9 --- /dev/null +++ b/commands/docs/cp-old.md @@ -0,0 +1,72 @@ +--- +title: cp-old +categories: | + filesystem +version: 0.86.0 +filesystem: | + Old nushell version of Copy files. +usage: | + Old nushell version of Copy files. +--- + + +# {{ $frontmatter.title }} for filesystem + +
{{ $frontmatter.filesystem }}
+ +## Signature + +```> cp-old {flags} (source) (destination)``` + +## Flags + + - `--recursive, -r`: copy recursively through subdirectories + - `--verbose, -v`: show successful copies in addition to failed copies (default:false) + - `--update, -u`: copy only when the SOURCE file is newer than the destination file or when the destination file is missing + - `--interactive, -i`: ask user to confirm action + - `--no-symlink, -n`: no symbolic links are followed, only works if -r is active + - `--progress, -p`: enable progress bar + +## Parameters + + - `source`: the place to copy from + - `destination`: the place to copy to + + +## Input/output types: + +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Copy myfile to dir_b +```nu +> cp myfile dir_b + +``` + +Recursively copy dir_a to dir_b +```nu +> cp -r dir_a dir_b + +``` + +Recursively copy dir_a to dir_b, and print the feedbacks +```nu +> cp -r -v dir_a dir_b + +``` + +Move many files into a directory +```nu +> cp *.txt dir_a + +``` + +Copy only if source file is newer than target file +```nu +> cp -u a b + +``` diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 2ffcacf33f9..7b4371504ff 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,11 +2,11 @@ title: cp categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | - Copy files. + Copy files using uutils/coreutils cp. usage: | - Copy files. + Copy files using uutils/coreutils cp. --- @@ -16,21 +16,23 @@ usage: | ## Signature -```> cp {flags} (source) (destination)``` +```> cp {flags} ...rest``` ## Flags - - `--recursive, -r`: copy recursively through subdirectories - - `--verbose, -v`: show successful copies in addition to failed copies (default:false) - - `--update, -u`: copy only when the SOURCE file is newer than the destination file or when the destination file is missing - - `--interactive, -i`: ask user to confirm action - - `--no-symlink, -n`: no symbolic links are followed, only works if -r is active - - `--progress, -p`: enable progress bar + - `--recursive, -r`: copy directories recursively + - `--verbose, -v`: explicitly state what is being done + - `--force, -f`: if an existing destination file cannot be opened, remove it and try + again (this option is ignored when the -n option is also used). + currently not implemented for windows + - `--interactive, -i`: ask before overwriting files + - `--progress, -p`: display a progress bar + - `--no-clobber, -n`: do not overwrite an existing file + - `--debug, -`: explain how a file is copied. Implies -v ## Parameters - - `source`: the place to copy from - - `destination`: the place to copy to + - `...rest`: Copy SRC file/s to DEST ## Input/output types: @@ -64,9 +66,3 @@ 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 52fdb1a6ac5..9c46f065f93 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.85.0 +version: 0.86.0 date: | Date-related commands. usage: | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index af43405c44f..72518ce091a 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.85.0 +version: 0.86.0 removed: | Removed command: use `format date` instead usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 17430f6a78a..9822f2267ed 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.85.0 +version: 0.86.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 1d64971b22e..8f8c99d8847 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.85.0 +version: 0.86.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 384d7f56ad2..3942add37a5 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.85.0 +version: 0.86.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index fdb6e1b8593..3db73cacc35 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.85.0 +version: 0.86.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 4361b2d84a4..657ebf842e3 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.85.0 +version: 0.86.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 ea75aed9f79..fb140670fa1 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.85.0 +version: 0.86.0 date: | Convert a date to a given time zone. usage: | @@ -52,13 +52,13 @@ Get the current date in Hawaii Get the current date in Hawaii ```nu > "2020-10-10 10:00:00 +02:00" | date to-timezone "+0500" -Sat, 10 Oct 2020 13:00:00 +0500 (2 years ago) +Sat, 10 Oct 2020 13:00:00 +0500 (3 years ago) ``` Get the current date in Hawaii, from a datetime object ```nu > "2020-10-10 10:00:00 +02:00" | into datetime | date to-timezone "+0500" -Sat, 10 Oct 2020 13:00:00 +0500 (2 years ago) +Sat, 10 Oct 2020 13:00:00 +0500 (3 years ago) ``` ## Notes diff --git a/commands/docs/debug.md b/commands/docs/debug.md index b13498ea53f..c1db9b77685 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Debug print the value(s) piped in. usage: | @@ -57,3 +57,10 @@ Debug print a table ╰───┴────────────────────────────────╯ ``` + + +## Subcommands: + +| name | type | usage | +| -------------------------------------------- | ------- | ------------------------- | +| [`debug info`](/commands/docs/debug_info.md) | Builtin | View process memory info. | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md new file mode 100644 index 00000000000..482c9ee4280 --- /dev/null +++ b/commands/docs/debug_info.md @@ -0,0 +1,38 @@ +--- +title: debug info +categories: | + debug +version: 0.86.0 +debug: | + View process memory info. +usage: | + View process memory info. +--- + + +# {{ $frontmatter.title }} for debug + +
{{ $frontmatter.debug }}
+ +## Signature + +```> debug info {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | + +## Examples + +View process information +```nu +> debug info + +``` + +## Notes +This command is meant for debugging purposes. +It shows you the process information and system memory information. \ No newline at end of file diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 755ee008708..a896a423b00 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 7943787275f..94a3f281446 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.85.0 +version: 0.86.0 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index aae7862c3b2..886af7b66de 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def-env.md b/commands/docs/def-env.md index f31a7cfb2aa..b3263afd715 100644 --- a/commands/docs/def-env.md +++ b/commands/docs/def-env.md @@ -2,7 +2,7 @@ title: def-env categories: | core -version: 0.85.0 +version: 0.86.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 f34305e57b0..fc618b3a693 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.85.0 +version: 0.86.0 core: | Define a custom command. usage: | @@ -16,13 +16,18 @@ usage: | ## Signature -```> def {flags} (def_name) (params) (body)``` +```> def {flags} (def_name) (params) (block)``` + +## Flags + + - `--env, -`: keep the environment defined inside the command + - `--wrapped, -`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature) ## Parameters - - `def_name`: definition name + - `def_name`: command name - `params`: parameters - - `body`: body of the definition + - `block`: body of the definition ## Input/output types: @@ -45,6 +50,21 @@ Define a command and run it with parameter(s) hi ``` +Set environment variable by call a custom command +```nu +> def --env foo [] { $env.BAR = "BAZ" }; foo; $env.BAR +BAZ +``` + +Define a custom wrapper for an external command +```nu +> def --wrapped my-echo [...rest] { echo $rest }; my-echo spam +╭───┬──────╮ +│ 0 │ spam │ +╰───┴──────╯ + +``` + ## Notes This command is a parser keyword. For details, check: https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file diff --git a/commands/docs/default.md b/commands/docs/default.md index 2ff2fdf1cd0..1566c001cd8 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Sets a default row's column if missing. usage: | @@ -40,7 +40,7 @@ Give a default 'target' column to all file entries Get the env value of `MY_ENV` with a default value 'abc' if not present ```nu -> $env | get -i MY_ENV | default 'abc' +> $env | get --ignore-errors MY_ENV | default 'abc' ``` diff --git a/commands/docs/describe.md b/commands/docs/describe.md index d0ad2fd61f5..9a9b5fab53a 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.85.0 +version: 0.86.0 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 5ceab4d7989..1b3865f5fe5 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/dfr.md b/commands/docs/dfr.md new file mode 100644 index 00000000000..1835e218598 --- /dev/null +++ b/commands/docs/dfr.md @@ -0,0 +1,143 @@ +--- +title: dfr +categories: | + dataframe +version: 0.86.0 +dataframe: | + Operate with data in a dataframe format. +usage: | + Operate with data in a dataframe format. +--- + + +# {{ $frontmatter.title }} for dataframe + +
{{ $frontmatter.dataframe }}
+ +## Signature + +```> dfr {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | + +## Notes +You must use one of the following subcommands. Using this command as-is will only produce this help message. + +## Subcommands: + +| name | type | usage | +| -------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------ | +| [`dfr agg`](/commands/docs/dfr_agg.md) | Builtin | Performs a series of aggregations from a group-by. | +| [`dfr agg-groups`](/commands/docs/dfr_agg-groups.md) | Builtin | creates an agg_groups expression | +| [`dfr all-false`](/commands/docs/dfr_all-false.md) | Builtin | Returns true if all values are false. | +| [`dfr all-true`](/commands/docs/dfr_all-true.md) | Builtin | Returns true if all values are true. | +| [`dfr append`](/commands/docs/dfr_append.md) | Builtin | Appends a new dataframe. | +| [`dfr arg-max`](/commands/docs/dfr_arg-max.md) | Builtin | Return index for max value in series. | +| [`dfr arg-min`](/commands/docs/dfr_arg-min.md) | Builtin | Return index for min value in series. | +| [`dfr arg-sort`](/commands/docs/dfr_arg-sort.md) | Builtin | Returns indexes for a sorted series. | +| [`dfr arg-true`](/commands/docs/dfr_arg-true.md) | Builtin | Returns indexes where values are true. | +| [`dfr arg-unique`](/commands/docs/dfr_arg-unique.md) | Builtin | Returns indexes for unique values. | +| [`dfr arg-where`](/commands/docs/dfr_arg-where.md) | Builtin | Creates an expression that returns the arguments where expression is true. | +| [`dfr as`](/commands/docs/dfr_as.md) | Builtin | Creates an alias expression. | +| [`dfr as-date`](/commands/docs/dfr_as-date.md) | Builtin | Converts string to date. | +| [`dfr as-datetime`](/commands/docs/dfr_as-datetime.md) | Builtin | Converts string to datetime. | +| [`dfr cache`](/commands/docs/dfr_cache.md) | Builtin | Caches operations in a new LazyFrame | +| [`dfr col`](/commands/docs/dfr_col.md) | Builtin | Creates a named column expression. | +| [`dfr collect`](/commands/docs/dfr_collect.md) | Builtin | Collect lazy dataframe into eager dataframe. | +| [`dfr columns`](/commands/docs/dfr_columns.md) | Builtin | Show dataframe columns. | +| [`dfr concat-str`](/commands/docs/dfr_concat-str.md) | Builtin | Creates a concat string expression. | +| [`dfr concatenate`](/commands/docs/dfr_concatenate.md) | Builtin | Concatenates strings with other array. | +| [`dfr contains`](/commands/docs/dfr_contains.md) | Builtin | Checks if a pattern is contained in a string. | +| [`dfr count`](/commands/docs/dfr_count.md) | Builtin | creates a count expression | +| [`dfr count-null`](/commands/docs/dfr_count-null.md) | Builtin | Counts null values. | +| [`dfr cumulative`](/commands/docs/dfr_cumulative.md) | Builtin | Cumulative calculation for a series. | +| [`dfr datepart`](/commands/docs/dfr_datepart.md) | Builtin | Creates an expression for capturing the specified datepart in a column. | +| [`dfr drop`](/commands/docs/dfr_drop.md) | Builtin | Creates a new dataframe by dropping the selected columns. | +| [`dfr drop-duplicates`](/commands/docs/dfr_drop-duplicates.md) | Builtin | Drops duplicate values in dataframe. | +| [`dfr drop-nulls`](/commands/docs/dfr_drop-nulls.md) | Builtin | Drops null values in dataframe. | +| [`dfr dtypes`](/commands/docs/dfr_dtypes.md) | Builtin | Show dataframe data types. | +| [`dfr dummies`](/commands/docs/dfr_dummies.md) | Builtin | Creates a new dataframe with dummy variables. | +| [`dfr explode`](/commands/docs/dfr_explode.md) | Builtin | Explodes a dataframe or creates a explode expression. | +| [`dfr expr-not`](/commands/docs/dfr_expr-not.md) | Builtin | creates a not expression | +| [`dfr fetch`](/commands/docs/dfr_fetch.md) | Builtin | collects the lazyframe to the selected rows. | +| [`dfr fill-nan`](/commands/docs/dfr_fill-nan.md) | Builtin | Replaces NaN values with the given expression. | +| [`dfr fill-null`](/commands/docs/dfr_fill-null.md) | Builtin | Replaces NULL values with the given expression. | +| [`dfr filter`](/commands/docs/dfr_filter.md) | Builtin | Filter dataframe based in expression. | +| [`dfr filter-with`](/commands/docs/dfr_filter-with.md) | Builtin | Filters dataframe using a mask or expression as reference. | +| [`dfr first`](/commands/docs/dfr_first.md) | Builtin | Show only the first number of rows or create a first expression | +| [`dfr flatten`](/commands/docs/dfr_flatten.md) | Builtin | An alias for dfr explode | +| [`dfr get`](/commands/docs/dfr_get.md) | Builtin | Creates dataframe with the selected columns. | +| [`dfr get-day`](/commands/docs/dfr_get-day.md) | Builtin | Gets day from date. | +| [`dfr get-hour`](/commands/docs/dfr_get-hour.md) | Builtin | Gets hour from date. | +| [`dfr get-minute`](/commands/docs/dfr_get-minute.md) | Builtin | Gets minute from date. | +| [`dfr get-month`](/commands/docs/dfr_get-month.md) | Builtin | Gets month from date. | +| [`dfr get-nanosecond`](/commands/docs/dfr_get-nanosecond.md) | Builtin | Gets nanosecond from date. | +| [`dfr get-ordinal`](/commands/docs/dfr_get-ordinal.md) | Builtin | Gets ordinal from date. | +| [`dfr get-second`](/commands/docs/dfr_get-second.md) | Builtin | Gets second from date. | +| [`dfr get-week`](/commands/docs/dfr_get-week.md) | Builtin | Gets week from date. | +| [`dfr get-weekday`](/commands/docs/dfr_get-weekday.md) | Builtin | Gets weekday from date. | +| [`dfr get-year`](/commands/docs/dfr_get-year.md) | Builtin | Gets year from date. | +| [`dfr group-by`](/commands/docs/dfr_group-by.md) | Builtin | Creates a group-by object that can be used for other aggregations. | +| [`dfr implode`](/commands/docs/dfr_implode.md) | Builtin | Aggregates a group to a Series | +| [`dfr into-df`](/commands/docs/dfr_into-df.md) | Builtin | Converts a list, table or record into a dataframe. | +| [`dfr into-lazy`](/commands/docs/dfr_into-lazy.md) | Builtin | Converts a dataframe into a lazy dataframe. | +| [`dfr into-nu`](/commands/docs/dfr_into-nu.md) | Builtin | Converts a dataframe or an expression into into nushell value for access and exploration. | +| [`dfr is-duplicated`](/commands/docs/dfr_is-duplicated.md) | Builtin | Creates mask indicating duplicated values. | +| [`dfr is-in`](/commands/docs/dfr_is-in.md) | Builtin | Creates an is-in expression. | +| [`dfr is-not-null`](/commands/docs/dfr_is-not-null.md) | Builtin | Creates mask where value is not null. | +| [`dfr is-null`](/commands/docs/dfr_is-null.md) | Builtin | Creates mask where value is null. | +| [`dfr is-unique`](/commands/docs/dfr_is-unique.md) | Builtin | Creates mask indicating unique values. | +| [`dfr join`](/commands/docs/dfr_join.md) | Builtin | Joins a lazy frame with other lazy frame. | +| [`dfr last`](/commands/docs/dfr_last.md) | Builtin | Creates new dataframe with tail rows or creates a last expression. | +| [`dfr lit`](/commands/docs/dfr_lit.md) | Builtin | Creates a literal expression. | +| [`dfr lowercase`](/commands/docs/dfr_lowercase.md) | Builtin | Lowercase the strings in the column. | +| [`dfr ls`](/commands/docs/dfr_ls.md) | Builtin | Lists stored dataframes. | +| [`dfr max`](/commands/docs/dfr_max.md) | Builtin | Creates a max expression or aggregates columns to their max value | +| [`dfr mean`](/commands/docs/dfr_mean.md) | Builtin | Creates a mean expression for an aggregation or aggregates columns to their mean value | +| [`dfr median`](/commands/docs/dfr_median.md) | Builtin | Aggregates columns to their median value | +| [`dfr melt`](/commands/docs/dfr_melt.md) | Builtin | Unpivot a DataFrame from wide to long format. | +| [`dfr min`](/commands/docs/dfr_min.md) | Builtin | Creates a min expression or aggregates columns to their min value | +| [`dfr n-unique`](/commands/docs/dfr_n-unique.md) | Builtin | Counts unique values. | +| [`dfr not`](/commands/docs/dfr_not.md) | Builtin | Inverts boolean mask. | +| [`dfr open`](/commands/docs/dfr_open.md) | Builtin | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. | +| [`dfr otherwise`](/commands/docs/dfr_otherwise.md) | Builtin | completes a when expression. | +| [`dfr quantile`](/commands/docs/dfr_quantile.md) | Builtin | Aggregates the columns to the selected quantile. | +| [`dfr query`](/commands/docs/dfr_query.md) | Builtin | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | +| [`dfr rename`](/commands/docs/dfr_rename.md) | Builtin | Rename a dataframe column. | +| [`dfr replace`](/commands/docs/dfr_replace.md) | Builtin | Replace the leftmost (sub)string by a regex pattern. | +| [`dfr replace-all`](/commands/docs/dfr_replace-all.md) | Builtin | Replace all (sub)strings by a regex pattern. | +| [`dfr reverse`](/commands/docs/dfr_reverse.md) | Builtin | Reverses the LazyFrame | +| [`dfr rolling`](/commands/docs/dfr_rolling.md) | Builtin | Rolling calculation for a series. | +| [`dfr sample`](/commands/docs/dfr_sample.md) | Builtin | Create sample dataframe. | +| [`dfr select`](/commands/docs/dfr_select.md) | Builtin | Selects columns from lazyframe. | +| [`dfr set`](/commands/docs/dfr_set.md) | Builtin | Sets value where given mask is true. | +| [`dfr set-with-idx`](/commands/docs/dfr_set-with-idx.md) | Builtin | Sets value in the given index. | +| [`dfr shape`](/commands/docs/dfr_shape.md) | Builtin | Shows column and row size for a dataframe. | +| [`dfr shift`](/commands/docs/dfr_shift.md) | Builtin | Shifts the values by a given period. | +| [`dfr slice`](/commands/docs/dfr_slice.md) | Builtin | Creates new dataframe from a slice of rows. | +| [`dfr sort-by`](/commands/docs/dfr_sort-by.md) | Builtin | sorts a lazy dataframe based on expression(s). | +| [`dfr std`](/commands/docs/dfr_std.md) | Builtin | Creates a std expression for an aggregation of std value from columns in a dataframe | +| [`dfr str-lengths`](/commands/docs/dfr_str-lengths.md) | Builtin | Get lengths of all strings. | +| [`dfr str-slice`](/commands/docs/dfr_str-slice.md) | Builtin | Slices the string from the start position until the selected length. | +| [`dfr strftime`](/commands/docs/dfr_strftime.md) | Builtin | Formats date based on string rule. | +| [`dfr sum`](/commands/docs/dfr_sum.md) | Builtin | Creates a sum expression for an aggregation or aggregates columns to their sum value | +| [`dfr summary`](/commands/docs/dfr_summary.md) | Builtin | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | +| [`dfr take`](/commands/docs/dfr_take.md) | Builtin | Creates new dataframe using the given indices. | +| [`dfr to-arrow`](/commands/docs/dfr_to-arrow.md) | Builtin | Saves dataframe to arrow file. | +| [`dfr to-avro`](/commands/docs/dfr_to-avro.md) | Builtin | Saves dataframe to avro file. | +| [`dfr to-csv`](/commands/docs/dfr_to-csv.md) | Builtin | Saves dataframe to CSV file. | +| [`dfr to-jsonl`](/commands/docs/dfr_to-jsonl.md) | Builtin | Saves dataframe to a JSON lines file. | +| [`dfr to-parquet`](/commands/docs/dfr_to-parquet.md) | Builtin | Saves dataframe to parquet file. | +| [`dfr unique`](/commands/docs/dfr_unique.md) | Builtin | Returns unique values from a dataframe. | +| [`dfr uppercase`](/commands/docs/dfr_uppercase.md) | Builtin | Uppercase the strings in the column. | +| [`dfr value-counts`](/commands/docs/dfr_value-counts.md) | Builtin | Returns a dataframe with the counts for unique values in series. | +| [`dfr var`](/commands/docs/dfr_var.md) | Builtin | Create a var expression for an aggregation | +| [`dfr when`](/commands/docs/dfr_when.md) | Builtin | Creates and modifies a when expression. | +| [`dfr with-column`](/commands/docs/dfr_with-column.md) | Builtin | Adds a series to the dataframe. | + +**Tips:** Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag \ No newline at end of file diff --git a/commands/docs/dfr_agg-groups.md b/commands/docs/dfr_agg-groups.md index e69e3d32c1e..ff67a1bdb56 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.85.0 +version: 0.86.0 expression: | creates an agg_groups expression usage: | diff --git a/commands/docs/dfr_agg.md b/commands/docs/dfr_agg.md index d4cd8b5f371..b1b312c0e27 100644 --- a/commands/docs/dfr_agg.md +++ b/commands/docs/dfr_agg.md @@ -2,7 +2,7 @@ title: dfr agg categories: | lazyframe -version: 0.85.0 +version: 0.86.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 ac4952ef880..94ee6fcb285 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.85.0 +version: 0.86.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 413bae619bd..1ff1fa52b15 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.85.0 +version: 0.86.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 af2337c1311..62452170289 100644 --- a/commands/docs/dfr_append.md +++ b/commands/docs/dfr_append.md @@ -2,7 +2,7 @@ title: dfr append categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/dfr_arg-max.md b/commands/docs/dfr_arg-max.md index 68f3ad4a845..4332048b51f 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.85.0 +version: 0.86.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 bad4ed73000..be24e01412d 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.85.0 +version: 0.86.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 67f1736da97..aac77956c8f 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.85.0 +version: 0.86.0 dataframe: | Returns indexes for a sorted series. usage: | @@ -50,7 +50,7 @@ Returns indexes for a sorted series Returns indexes for a sorted series ```nu -> [1 2 2 3 3] | dfr into-df | dfr arg-sort -r +> [1 2 2 3 3] | dfr into-df | dfr arg-sort --reverse ╭───┬──────────╮ │ # │ arg_sort │ ├───┼──────────┤ diff --git a/commands/docs/dfr_arg-true.md b/commands/docs/dfr_arg-true.md index 53ee484c9da..9d70aa9a8e9 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.85.0 +version: 0.86.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 4ad2be757b6..a2c0ca76da5 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.85.0 +version: 0.86.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 2f4412f2df6..9cef8e2c435 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.85.0 +version: 0.86.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 eada82ea629..dea8043552f 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.85.0 +version: 0.86.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/dfr_as-datetime.md b/commands/docs/dfr_as-datetime.md index 0f336ae11f8..65dca4ba879 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.85.0 +version: 0.86.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/dfr_as.md b/commands/docs/dfr_as.md index b500948ca41..13712412394 100644 --- a/commands/docs/dfr_as.md +++ b/commands/docs/dfr_as.md @@ -2,7 +2,7 @@ title: dfr as categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/dfr_cache.md b/commands/docs/dfr_cache.md index 2615e60ae23..49b45f14711 100644 --- a/commands/docs/dfr_cache.md +++ b/commands/docs/dfr_cache.md @@ -2,7 +2,7 @@ title: dfr cache categories: | lazyframe -version: 0.85.0 +version: 0.86.0 lazyframe: | Caches operations in a new LazyFrame usage: | diff --git a/commands/docs/dfr_col.md b/commands/docs/dfr_col.md index bfada20e94d..dbf1277d710 100644 --- a/commands/docs/dfr_col.md +++ b/commands/docs/dfr_col.md @@ -2,7 +2,7 @@ title: dfr col categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/dfr_collect.md b/commands/docs/dfr_collect.md index 1230bc23ae9..74b8c75dd40 100644 --- a/commands/docs/dfr_collect.md +++ b/commands/docs/dfr_collect.md @@ -2,7 +2,7 @@ title: dfr collect categories: | lazyframe -version: 0.85.0 +version: 0.86.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/dfr_columns.md b/commands/docs/dfr_columns.md index 09d1a221423..e9fd8acf601 100644 --- a/commands/docs/dfr_columns.md +++ b/commands/docs/dfr_columns.md @@ -2,7 +2,7 @@ title: dfr columns categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/dfr_concat-str.md b/commands/docs/dfr_concat-str.md index bf5e95821da..17fc3293216 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.85.0 +version: 0.86.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/dfr_concatenate.md b/commands/docs/dfr_concatenate.md index 824ebbf4370..449e568cfad 100644 --- a/commands/docs/dfr_concatenate.md +++ b/commands/docs/dfr_concatenate.md @@ -2,7 +2,7 @@ title: dfr concatenate categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Concatenates strings with other array. usage: | diff --git a/commands/docs/dfr_contains.md b/commands/docs/dfr_contains.md index 9c0a0af121b..219760aad23 100644 --- a/commands/docs/dfr_contains.md +++ b/commands/docs/dfr_contains.md @@ -2,7 +2,7 @@ title: dfr contains categories: | dataframe -version: 0.85.0 +version: 0.86.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 2a77c926d14..0913fdbcbe7 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.85.0 +version: 0.86.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/dfr_count.md b/commands/docs/dfr_count.md index ac8edd236b9..3550e080573 100644 --- a/commands/docs/dfr_count.md +++ b/commands/docs/dfr_count.md @@ -2,7 +2,7 @@ title: dfr count categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | creates a count expression usage: | diff --git a/commands/docs/dfr_cumulative.md b/commands/docs/dfr_cumulative.md index 14596352c87..aa97c860e15 100644 --- a/commands/docs/dfr_cumulative.md +++ b/commands/docs/dfr_cumulative.md @@ -2,7 +2,7 @@ title: dfr cumulative categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Cumulative calculation for a series. usage: | diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md index 1beb68852f5..1c6404d8228 100644 --- a/commands/docs/dfr_datepart.md +++ b/commands/docs/dfr_datepart.md @@ -2,7 +2,7 @@ title: dfr datepart categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -52,11 +52,11 @@ Creates an expression to capture multiple date parts (dfr col datetime | dfr datepart minute | dfr as datetime_minute ), (dfr col datetime | dfr datepart second | dfr as datetime_second ), (dfr col datetime | dfr datepart nanosecond | dfr as datetime_ns ) ] -╭─────┬───────────────┬────────────────┬─────────────────┬───────────────┬────────────────┬──────────────────┬──────╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ ... │ -├─────┼───────────────┼────────────────┼─────────────────┼───────────────┼────────────────┼──────────────────┼──────┤ -│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ ... │ -╰─────┴───────────────┴────────────────┴─────────────────┴───────────────┴────────────────┴──────────────────┴──────╯ +╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮ +│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ +├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤ +│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ +╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯ ``` diff --git a/commands/docs/dfr_drop-duplicates.md b/commands/docs/dfr_drop-duplicates.md index 7c126e31463..f42eb135307 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.85.0 +version: 0.86.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 a5ca2a5e248..ceedd472954 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.85.0 +version: 0.86.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/dfr_drop.md b/commands/docs/dfr_drop.md index f11ac7569b8..0450443d48d 100644 --- a/commands/docs/dfr_drop.md +++ b/commands/docs/dfr_drop.md @@ -2,7 +2,7 @@ title: dfr drop categories: | dataframe -version: 0.85.0 +version: 0.86.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 51e4877c731..a2239cc73f6 100644 --- a/commands/docs/dfr_dtypes.md +++ b/commands/docs/dfr_dtypes.md @@ -2,7 +2,7 @@ title: dfr dtypes categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Show dataframe data types. usage: | diff --git a/commands/docs/dfr_dummies.md b/commands/docs/dfr_dummies.md index ee62201079d..e1569374318 100644 --- a/commands/docs/dfr_dummies.md +++ b/commands/docs/dfr_dummies.md @@ -2,7 +2,7 @@ title: dfr dummies categories: | dataframe -version: 0.85.0 +version: 0.86.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 f5f0d497f0f..4465ee7e1e8 100644 --- a/commands/docs/dfr_explode.md +++ b/commands/docs/dfr_explode.md @@ -2,7 +2,7 @@ title: dfr explode categories: | lazyframe -version: 0.85.0 +version: 0.86.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 e5b8ca0c2f9..d6937c37edd 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.85.0 +version: 0.86.0 expression: | creates a not expression usage: | diff --git a/commands/docs/dfr_fetch.md b/commands/docs/dfr_fetch.md index de0388a219b..2005d438615 100644 --- a/commands/docs/dfr_fetch.md +++ b/commands/docs/dfr_fetch.md @@ -2,7 +2,7 @@ title: dfr fetch categories: | lazyframe -version: 0.85.0 +version: 0.86.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 0d00deb3660..51fd12efd73 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.85.0 +version: 0.86.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 3caff0cbedd..e80a2b79882 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.85.0 +version: 0.86.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 b7fc0e309a7..ceb782263f5 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.85.0 +version: 0.86.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 50e7ccb8eee..5a2f53f4690 100644 --- a/commands/docs/dfr_filter.md +++ b/commands/docs/dfr_filter.md @@ -2,7 +2,7 @@ title: dfr filter categories: | lazyframe -version: 0.85.0 +version: 0.86.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/dfr_first.md b/commands/docs/dfr_first.md index b006c777e4e..4ba4d5ee72d 100644 --- a/commands/docs/dfr_first.md +++ b/commands/docs/dfr_first.md @@ -2,7 +2,7 @@ title: dfr first categories: | dataframe -version: 0.85.0 +version: 0.86.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 5e3f768075b..d4a0dded377 100644 --- a/commands/docs/dfr_flatten.md +++ b/commands/docs/dfr_flatten.md @@ -2,7 +2,7 @@ title: dfr flatten categories: | lazyframe -version: 0.85.0 +version: 0.86.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 a271b4cbfbc..ddd2ee5f387 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.85.0 +version: 0.86.0 dataframe: | Gets day from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns day from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-day ╭───┬───╮ diff --git a/commands/docs/dfr_get-hour.md b/commands/docs/dfr_get-hour.md index 26b90bf14c6..0f691da3e7b 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.85.0 +version: 0.86.0 dataframe: | Gets hour from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns hour from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-hour ╭───┬────╮ diff --git a/commands/docs/dfr_get-minute.md b/commands/docs/dfr_get-minute.md index c45353aff41..1a5afeefaa1 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.85.0 +version: 0.86.0 dataframe: | Gets minute from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns minute from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-minute ╭───┬────╮ diff --git a/commands/docs/dfr_get-month.md b/commands/docs/dfr_get-month.md index 83632d05073..9dfc4e497fe 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.85.0 +version: 0.86.0 dataframe: | Gets month from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns month from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-month ╭───┬───╮ diff --git a/commands/docs/dfr_get-nanosecond.md b/commands/docs/dfr_get-nanosecond.md index 9b6ed8e08a8..c67774389fc 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.85.0 +version: 0.86.0 dataframe: | Gets nanosecond from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns nanosecond from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-nanosecond ╭───┬───╮ diff --git a/commands/docs/dfr_get-ordinal.md b/commands/docs/dfr_get-ordinal.md index fad378a4bed..7496c74715f 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.85.0 +version: 0.86.0 dataframe: | Gets ordinal from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns ordinal from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-ordinal ╭───┬─────╮ diff --git a/commands/docs/dfr_get-second.md b/commands/docs/dfr_get-second.md index e25ac0fa211..2b5e184af40 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.85.0 +version: 0.86.0 dataframe: | Gets second from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns second from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-second ╭───┬────╮ diff --git a/commands/docs/dfr_get-week.md b/commands/docs/dfr_get-week.md index 5aca5288d66..af81c7696bf 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.85.0 +version: 0.86.0 dataframe: | Gets week from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns week from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-week ╭───┬────╮ diff --git a/commands/docs/dfr_get-weekday.md b/commands/docs/dfr_get-weekday.md index fb42f879354..4fe71b649c8 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.85.0 +version: 0.86.0 dataframe: | Gets weekday from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns weekday from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-weekday ╭───┬───╮ diff --git a/commands/docs/dfr_get-year.md b/commands/docs/dfr_get-year.md index a08b3a2eec1..5b43cee11d1 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.85.0 +version: 0.86.0 dataframe: | Gets year from date. usage: | @@ -29,7 +29,7 @@ usage: | Returns year from a date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-year ╭───┬──────╮ diff --git a/commands/docs/dfr_get.md b/commands/docs/dfr_get.md index f31289935cb..5ddfde41377 100644 --- a/commands/docs/dfr_get.md +++ b/commands/docs/dfr_get.md @@ -2,7 +2,7 @@ title: dfr get categories: | dataframe -version: 0.85.0 +version: 0.86.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 560bb45e2a8..a3f0a37a0ae 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.85.0 +version: 0.86.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 d0a4ac14dc3..91bd7bd6382 100644 --- a/commands/docs/dfr_implode.md +++ b/commands/docs/dfr_implode.md @@ -2,7 +2,7 @@ title: dfr implode categories: | expression -version: 0.85.0 +version: 0.86.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 97c09c6538e..49337eeecb4 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.85.0 +version: 0.86.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 f34364013ea..ac7c64636b5 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.85.0 +version: 0.86.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 e3c8d73dabf..c5116b21e08 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.85.0 +version: 0.86.0 dataframe: | Converts a dataframe or an expression into into nushell value for access and exploration. usage: | @@ -46,7 +46,7 @@ Shows head rows from dataframe Shows tail rows from dataframe ```nu -> [[a b]; [1 2] [5 6] [3 4]] | dfr into-df | dfr into-nu -t -n 1 +> [[a b]; [1 2] [5 6] [3 4]] | dfr into-df | dfr into-nu --tail --rows 1 ╭───┬───┬───╮ │ # │ a │ b │ ├───┼───┼───┤ diff --git a/commands/docs/dfr_is-duplicated.md b/commands/docs/dfr_is-duplicated.md index 58b59772001..03223018c70 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.85.0 +version: 0.86.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 15a95e4de04..00386cd2eef 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.85.0 +version: 0.86.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 19acadd1cc4..2288b80cf38 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.85.0 +version: 0.86.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 0666a1263d3..956591dce26 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.85.0 +version: 0.86.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 25e37d98ca9..0bc188e455f 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.85.0 +version: 0.86.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/dfr_join.md b/commands/docs/dfr_join.md index 0939cc00ecc..97f18d3c7a4 100644 --- a/commands/docs/dfr_join.md +++ b/commands/docs/dfr_join.md @@ -2,7 +2,7 @@ title: dfr join categories: | lazyframe -version: 0.85.0 +version: 0.86.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 315622f3d63..06e013fbec9 100644 --- a/commands/docs/dfr_last.md +++ b/commands/docs/dfr_last.md @@ -2,7 +2,7 @@ title: dfr last categories: | dataframe -version: 0.85.0 +version: 0.86.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 db36e17a76f..188db2c7049 100644 --- a/commands/docs/dfr_lit.md +++ b/commands/docs/dfr_lit.md @@ -2,7 +2,7 @@ title: dfr lit categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/dfr_lowercase.md b/commands/docs/dfr_lowercase.md index c04270ee9b5..ba74b2a4754 100644 --- a/commands/docs/dfr_lowercase.md +++ b/commands/docs/dfr_lowercase.md @@ -2,7 +2,7 @@ title: dfr lowercase categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/dfr_ls.md b/commands/docs/dfr_ls.md index 3d366999e7d..c2a98e7107b 100644 --- a/commands/docs/dfr_ls.md +++ b/commands/docs/dfr_ls.md @@ -2,7 +2,7 @@ title: dfr ls categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Lists stored dataframes. usage: | diff --git a/commands/docs/dfr_max.md b/commands/docs/dfr_max.md index ca6841be0ed..5fd2a1a7637 100644 --- a/commands/docs/dfr_max.md +++ b/commands/docs/dfr_max.md @@ -2,7 +2,7 @@ title: dfr max categories: | expression -version: 0.85.0 +version: 0.86.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 b1333a27b6f..d45f4f236df 100644 --- a/commands/docs/dfr_mean.md +++ b/commands/docs/dfr_mean.md @@ -2,7 +2,7 @@ title: dfr mean categories: | expression -version: 0.85.0 +version: 0.86.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 c053afe39be..bc712aecff5 100644 --- a/commands/docs/dfr_median.md +++ b/commands/docs/dfr_median.md @@ -2,7 +2,7 @@ title: dfr median categories: | lazyframe -version: 0.85.0 +version: 0.86.0 lazyframe: | Aggregates columns to their median value usage: | diff --git a/commands/docs/dfr_melt.md b/commands/docs/dfr_melt.md index 21ba56328d8..437ab57f337 100644 --- a/commands/docs/dfr_melt.md +++ b/commands/docs/dfr_melt.md @@ -2,7 +2,7 @@ title: dfr melt categories: | dataframe -version: 0.85.0 +version: 0.86.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 bfd5ef7df5b..0cb506309dc 100644 --- a/commands/docs/dfr_min.md +++ b/commands/docs/dfr_min.md @@ -2,7 +2,7 @@ title: dfr min categories: | expression -version: 0.85.0 +version: 0.86.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 45508dbb034..b8715f51c66 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.85.0 +version: 0.86.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/dfr_not.md b/commands/docs/dfr_not.md index 6b587e8bab7..c1167d7ef71 100644 --- a/commands/docs/dfr_not.md +++ b/commands/docs/dfr_not.md @@ -2,7 +2,7 @@ title: dfr not categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/dfr_open.md b/commands/docs/dfr_open.md index f372433b4cf..69e7e5c40a0 100644 --- a/commands/docs/dfr_open.md +++ b/commands/docs/dfr_open.md @@ -2,7 +2,7 @@ title: dfr open categories: | dataframe -version: 0.85.0 +version: 0.86.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 4cbff78835f..186821de369 100644 --- a/commands/docs/dfr_otherwise.md +++ b/commands/docs/dfr_otherwise.md @@ -2,7 +2,7 @@ title: dfr otherwise categories: | expression -version: 0.85.0 +version: 0.86.0 expression: | completes a when expression. usage: | diff --git a/commands/docs/dfr_quantile.md b/commands/docs/dfr_quantile.md index dbda88a57f7..828c2fecb50 100644 --- a/commands/docs/dfr_quantile.md +++ b/commands/docs/dfr_quantile.md @@ -2,7 +2,7 @@ title: dfr quantile categories: | lazyframe -version: 0.85.0 +version: 0.86.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 09453403edb..1a03a8b8a14 100644 --- a/commands/docs/dfr_query.md +++ b/commands/docs/dfr_query.md @@ -2,7 +2,7 @@ title: dfr query categories: | dataframe -version: 0.85.0 +version: 0.86.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 3d3fa9eb75c..297b38dacde 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.85.0 +version: 0.86.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 86a8ebbb739..4c17cf73954 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.85.0 +version: 0.86.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -34,7 +34,7 @@ usage: | Replaces string ```nu -> [abac abac abac] | dfr into-df | dfr replace-all -p a -r A +> [abac abac abac] | dfr into-df | dfr replace-all --pattern a --replace A ╭───┬──────╮ │ # │ 0 │ ├───┼──────┤ diff --git a/commands/docs/dfr_replace.md b/commands/docs/dfr_replace.md index ff9a76d3efa..f31027e2d65 100644 --- a/commands/docs/dfr_replace.md +++ b/commands/docs/dfr_replace.md @@ -2,7 +2,7 @@ title: dfr replace categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -34,7 +34,7 @@ usage: | Replaces string ```nu -> [abc abc abc] | dfr into-df | dfr replace -p ab -r AB +> [abc abc abc] | dfr into-df | dfr replace --pattern ab --replace AB ╭───┬─────╮ │ # │ 0 │ ├───┼─────┤ diff --git a/commands/docs/dfr_reverse.md b/commands/docs/dfr_reverse.md index 52579592769..2e920de7f86 100644 --- a/commands/docs/dfr_reverse.md +++ b/commands/docs/dfr_reverse.md @@ -2,7 +2,7 @@ title: dfr reverse categories: | lazyframe -version: 0.85.0 +version: 0.86.0 lazyframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/dfr_rolling.md b/commands/docs/dfr_rolling.md index 991188fe1dd..b4b88920144 100644 --- a/commands/docs/dfr_rolling.md +++ b/commands/docs/dfr_rolling.md @@ -2,7 +2,7 @@ title: dfr rolling categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/dfr_sample.md b/commands/docs/dfr_sample.md index 3475f7cddca..e1f9597e7d5 100644 --- a/commands/docs/dfr_sample.md +++ b/commands/docs/dfr_sample.md @@ -2,7 +2,7 @@ title: dfr sample categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Create sample dataframe. usage: | @@ -37,13 +37,13 @@ usage: | Sample rows from dataframe ```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr sample -n 1 +> [[a b]; [1 2] [3 4]] | dfr into-df | dfr sample --n-rows 1 ``` Shows sample row using fraction and replace ```nu -> [[a b]; [1 2] [3 4] [5 6]] | dfr into-df | dfr sample -f 0.5 -e +> [[a b]; [1 2] [3 4] [5 6]] | dfr into-df | dfr sample --fraction 0.5 --replace ``` diff --git a/commands/docs/dfr_select.md b/commands/docs/dfr_select.md index 105b731e1c3..f70c23f1e76 100644 --- a/commands/docs/dfr_select.md +++ b/commands/docs/dfr_select.md @@ -2,7 +2,7 @@ title: dfr select categories: | lazyframe -version: 0.85.0 +version: 0.86.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 1b3f22bc112..159c3d9fa42 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.85.0 +version: 0.86.0 dataframe: | Sets value in the given index. usage: | @@ -39,7 +39,7 @@ Set value in selected rows from series ```nu > let series = ([4 1 5 2 4 3] | dfr into-df); let indices = ([0 2] | dfr into-df); - $series | dfr set-with-idx 6 -i $indices + $series | dfr set-with-idx 6 --indices $indices ╭───┬───╮ │ # │ 0 │ ├───┼───┤ diff --git a/commands/docs/dfr_set.md b/commands/docs/dfr_set.md index d295fb36af5..5a80813be9c 100644 --- a/commands/docs/dfr_set.md +++ b/commands/docs/dfr_set.md @@ -2,7 +2,7 @@ title: dfr set categories: | dataframe -version: 0.85.0 +version: 0.86.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 f85145739f6..f548463fd76 100644 --- a/commands/docs/dfr_shape.md +++ b/commands/docs/dfr_shape.md @@ -2,7 +2,7 @@ title: dfr shape categories: | dataframe -version: 0.85.0 +version: 0.86.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 a55ed414063..b7c0b54a176 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.85.0 +version: 0.86.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 aac31e85d8a..7e5a82607bb 100644 --- a/commands/docs/dfr_slice.md +++ b/commands/docs/dfr_slice.md @@ -2,7 +2,7 @@ title: dfr slice categories: | dataframe -version: 0.85.0 +version: 0.86.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 fb9108588c9..c029023bd69 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.85.0 +version: 0.86.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 3f04f8ea92d..bc9599773be 100644 --- a/commands/docs/dfr_std.md +++ b/commands/docs/dfr_std.md @@ -2,7 +2,7 @@ title: dfr std categories: | expression -version: 0.85.0 +version: 0.86.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 4f141c7b580..e89d53e7d92 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.85.0 +version: 0.86.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 a9bc8496762..b42f2a6583c 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.85.0 +version: 0.86.0 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -37,7 +37,7 @@ usage: | Creates slices from the strings ```nu -> [abcded abc321 abc123] | dfr into-df | dfr str-slice 1 -l 2 +> [abcded abc321 abc123] | dfr into-df | dfr str-slice 1 --length 2 ╭───┬────╮ │ # │ 0 │ ├───┼────┤ diff --git a/commands/docs/dfr_strftime.md b/commands/docs/dfr_strftime.md index 5e73fd9e6d3..8b325aa62ee 100644 --- a/commands/docs/dfr_strftime.md +++ b/commands/docs/dfr_strftime.md @@ -2,7 +2,7 @@ title: dfr strftime categories: | dataframe -version: 0.85.0 +version: 0.86.0 dataframe: | Formats date based on string rule. usage: | @@ -33,7 +33,7 @@ usage: | Formats date ```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); +> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr strftime "%Y/%m/%d" ╭───┬────────────╮ diff --git a/commands/docs/dfr_sum.md b/commands/docs/dfr_sum.md index e2c710bdd43..566c7fe0caf 100644 --- a/commands/docs/dfr_sum.md +++ b/commands/docs/dfr_sum.md @@ -2,7 +2,7 @@ title: dfr sum categories: | expression -version: 0.85.0 +version: 0.86.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 e1c220c6c68..41494739ff5 100644 --- a/commands/docs/dfr_summary.md +++ b/commands/docs/dfr_summary.md @@ -2,7 +2,7 @@ title: dfr summary categories: | dataframe -version: 0.85.0 +version: 0.86.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 f26d384e527..59638be90ec 100644 --- a/commands/docs/dfr_take.md +++ b/commands/docs/dfr_take.md @@ -2,7 +2,7 @@ title: dfr take categories: | dataframe -version: 0.85.0 +version: 0.86.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 2d3e9c24aeb..663095a2e46 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.85.0 +version: 0.86.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 408e97645e7..f666a677bf6 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.85.0 +version: 0.86.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 e2d8919ee0d..213f4519d19 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.85.0 +version: 0.86.0 dataframe: | Saves dataframe to CSV file. usage: | @@ -44,7 +44,7 @@ Saves dataframe to CSV file Saves dataframe to CSV file using other delimiter ```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv -d '|' +> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv --delimiter '|' ``` diff --git a/commands/docs/dfr_to-jsonl.md b/commands/docs/dfr_to-jsonl.md index a06237f6b2f..27168a2ef9d 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.85.0 +version: 0.86.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 35a1de32ee0..af8c5b6832f 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.85.0 +version: 0.86.0 dataframe: | Saves dataframe to parquet file. usage: | diff --git a/commands/docs/dfr_unique.md b/commands/docs/dfr_unique.md index 93ef2db0f35..045c8353306 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.85.0 +version: 0.86.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 958fb922f40..78de863b549 100644 --- a/commands/docs/dfr_uppercase.md +++ b/commands/docs/dfr_uppercase.md @@ -2,7 +2,7 @@ title: dfr uppercase categories: | dataframe -version: 0.85.0 +version: 0.86.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 60a9a7e6961..3f077d876ad 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.85.0 +version: 0.86.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 5a9dfe2988b..1af9ab8f6b1 100644 --- a/commands/docs/dfr_var.md +++ b/commands/docs/dfr_var.md @@ -2,7 +2,7 @@ title: dfr var categories: | expression -version: 0.85.0 +version: 0.86.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 eeb7299e595..f184238222d 100644 --- a/commands/docs/dfr_when.md +++ b/commands/docs/dfr_when.md @@ -2,7 +2,7 @@ title: dfr when categories: | expression -version: 0.85.0 +version: 0.86.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 ba5597345fc..5c3d4f73149 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.85.0 +version: 0.86.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index 74fed726185..cc1dc6832cd 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.85.0 +version: 0.86.0 core: | Run a closure, providing it with the pipeline input. usage: | @@ -24,6 +24,7 @@ usage: | - `--ignore-shell-errors, -s`: ignore shell errors as the closure runs - `--ignore-program-errors, -p`: ignore external program errors as the closure runs - `--capture-errors, -c`: catch errors as the closure runs, and return them + - `--env, -`: keep the environment defined inside the command ## Parameters @@ -53,25 +54,25 @@ I am enclosed Run the closure and ignore both shell and external program errors ```nu -> do -i { thisisnotarealcommand } +> do --ignore-errors { thisisnotarealcommand } ``` Run the closure and ignore shell errors ```nu -> do -s { thisisnotarealcommand } +> do --ignore-shell-errors { thisisnotarealcommand } ``` Run the closure and ignore external program errors ```nu -> do -p { nu -c 'exit 1' }; echo "I'll still run" +> do --ignore-program-errors { nu --commands 'exit 1' }; echo "I'll still run" ``` Abort the pipeline if a program returns a non-zero exit code ```nu -> do -c { nu -c 'exit 1' } | myscarycommand +> do --capture-errors { nu --commands 'exit 1' } | myscarycommand ``` @@ -86,3 +87,9 @@ Run the closure, with input > 77 | do {|x| 100 + $in } ``` + +Run the closure and keep changes to the environment +```nu +> do --env { $env.foo = 'bar' }; $env.foo +bar +``` diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 7faf5f8b2c7..2091377a3e7 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.85.0 +version: 0.86.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 6e9b8d1be48..1c07e61453c 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index f7c31151e59..e9a99882579 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 29eaf2ca8af..c542c28aae7 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | core -version: 0.85.0 +version: 0.86.0 core: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index d4149045913..6a1728263bc 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.85.0 +version: 0.86.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 fcd65eb0153..2e4c8e89ad0 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.85.0 +version: 0.86.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 ff22a594632..3bd819312de 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.85.0 +version: 0.86.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index ab8175e5fd5..381bdbc7516 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index cb0319b244e..7c827d9a576 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.85.0 +version: 0.86.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 3a29af95265..c5c2e747936 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Encode a binary value using hex. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 56c35f92564..4f2195cd975 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index be0983eccdf..53c6eca4525 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.85.0 +version: 0.86.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 557ca66eac7..edf6ab58f9a 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.85.0 +version: 0.86.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 fb143065b64..2086842e8e6 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.85.0 +version: 0.86.0 system: | Execute a command, replacing the current process. usage: | diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 8c72c72a394..2b14eabf2f9 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.85.0 +version: 0.86.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 587e8afb0c5..4c1e8da4583 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Explain closure contents. usage: | @@ -33,6 +33,6 @@ usage: | Explain a command within a closure ```nu -> explain {|| ls | sort-by name type -i | get name } | table -e +> explain {|| ls | sort-by name type --ignore-case | get name } | table --expand ``` diff --git a/commands/docs/explore.md b/commands/docs/explore.md index a2f9881fea9..56cd36c6f7c 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.85.0 +version: 0.86.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index ae0754f5a11..16562ac4aee 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.85.0 +version: 0.86.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 36805c5182f..0cbd332530e 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.85.0 +version: 0.86.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 259dda18571..79f093d8c13 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.85.0 +version: 0.86.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 3940145dea4..d83e0abcbb4 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.85.0 +version: 0.86.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 37e351fc98b..7dcc4c3ab14 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.85.0 +version: 0.86.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 66d7f37dc72..6d4fb38ff31 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.85.0 +version: 0.86.0 core: | Define a custom command and export it from a module. usage: | @@ -16,11 +16,16 @@ usage: | ## Signature -```> export def {flags} (name) (params) (block)``` +```> export def {flags} (def_name) (params) (block)``` + +## Flags + + - `--env, -`: keep the environment defined inside the command + - `--wrapped, -`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature) ## Parameters - - `name`: definition name + - `def_name`: command name - `params`: parameters - `block`: body of the definition diff --git a/commands/docs/export_extern-wrapped.md b/commands/docs/export_extern-wrapped.md index e46208ebd51..3cdc178f6a2 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.85.0 +version: 0.86.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 8fb143c8d9d..e35b9eee94e 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.85.0 +version: 0.86.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 d786b945edb..d89582d5f34 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.85.0 +version: 0.86.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 e8c1ca6f539..05256571a7e 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.85.0 +version: 0.86.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 b1186b7bfb0..9d343bdd26b 100644 --- a/commands/docs/extern-wrapped.md +++ b/commands/docs/extern-wrapped.md @@ -2,7 +2,7 @@ title: extern-wrapped categories: | core -version: 0.85.0 +version: 0.86.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 76bbbae6356..d1391959c49 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.85.0 +version: 0.86.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 253dbf97007..fb3b1188e08 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Fill and Align. usage: | @@ -30,31 +30,31 @@ usage: | | input | output | | -------------- | ------------ | | filesize | string | +| float | string | | int | string | | list\ | list\ | | list\ | list\ | +| list\ | list\ | | list\ | list\ | -| list\ | list\ | | list\ | list\ | -| number | string | | string | string | ## Examples Fill a string on the left side to a width of 15 with the character '─' ```nu -> 'nushell' | fill -a l -c '─' -w 15 +> 'nushell' | fill --alignment l --character '─' --width 15 nushell──────── ``` Fill a string on the right side to a width of 15 with the character '─' ```nu -> 'nushell' | fill -a r -c '─' -w 15 +> 'nushell' | fill --alignment r --character '─' --width 15 ────────nushell ``` Fill a string on both sides to a width of 15 with the character '─' ```nu -> 'nushell' | fill -a m -c '─' -w 15 +> 'nushell' | fill --alignment m --character '─' --width 15 ────nushell──── ``` diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 2b898006da6..92b18dbf74f 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index cbb5ac386d6..cc219a88978 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Searches terms in the input. usage: | @@ -95,7 +95,7 @@ Find using regex case insensitive Find value in records using regex ```nu -> [[version name]; ['0.1.0' nushell] ['0.1.1' fish] ['0.2.0' zsh]] | find -r "nu" +> [[version name]; ['0.1.0' nushell] ['0.1.1' fish] ['0.2.0' zsh]] | find --regex "nu" ╭───┬─────────┬─────────╮ │ # │ version │ name │ ├───┼─────────┼─────────┤ @@ -106,7 +106,7 @@ Find value in records using regex Find inverted values in records using regex ```nu -> [[version name]; ['0.1.0' nushell] ['0.1.1' fish] ['0.2.0' zsh]] | find -r "nu" --invert +> [[version name]; ['0.1.0' nushell] ['0.1.1' fish] ['0.2.0' zsh]] | find --regex "nu" --invert ╭───┬─────────┬──────╮ │ # │ version │ name │ ├───┼─────────┼──────┤ @@ -118,7 +118,7 @@ Find inverted values in records using regex Find value in list using regex ```nu -> [["Larry", "Moe"], ["Victor", "Marina"]] | find -r "rr" +> [["Larry", "Moe"], ["Victor", "Marina"]] | find --regex "rr" ╭───┬───────────────╮ │ 0 │ ╭───┬───────╮ │ │ │ │ 0 │ Larry │ │ @@ -130,7 +130,7 @@ Find value in list using regex Find inverted values in records using regex ```nu -> [["Larry", "Moe"], ["Victor", "Marina"]] | find -r "rr" --invert +> [["Larry", "Moe"], ["Victor", "Marina"]] | find --regex "rr" --invert ╭───┬────────────────╮ │ 0 │ ╭───┬────────╮ │ │ │ │ 0 │ Victor │ │ @@ -148,7 +148,7 @@ Remove ANSI sequences from result Find and highlight text in specific columns ```nu -> [[col1 col2 col3]; [moe larry curly] [larry curly moe]] | find moe -c [col1] +> [[col1 col2 col3]; [moe larry curly] [larry curly moe]] | find moe --columns [col1] ╭───┬──────┬───────┬───────╮ │ # │ col1 │ col2 │ col3 │ ├───┼──────┼───────┼───────┤ diff --git a/commands/docs/first.md b/commands/docs/first.md index f5eeecdfcc9..ade25e4384b 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.85.0 +version: 0.86.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 b840009da83..0757effa042 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index 04cdb906d9d..d2df2bb8b69 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index 1e3acf05071..74233c679b4 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.85.0 +version: 0.86.0 core: | Loop over a range. usage: | @@ -37,7 +37,7 @@ usage: | ## Examples -Echo the square of each integer +Print the square of each integer ```nu > for x in [1 2 3] { print ($x * $x) } @@ -49,7 +49,7 @@ Work with elements of a range ``` -Number each item and echo a message +Number each item and print a message ```nu > for $it in ['bob' 'fred'] --numbered { print $"($it.index) is ($it.item)" } diff --git a/commands/docs/format.md b/commands/docs/format.md index 16b729addca..b92f818492b 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.85.0 +version: 0.86.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 66d90f613a7..872c59476e3 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | date -version: 0.85.0 +version: 0.86.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 8976bf24904..79b3ccc37f6 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.85.0 +version: 0.86.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 f637fd6eacd..f0c1ef9864c 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.85.0 +version: 0.86.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 db85126afca..4dad2d88ce7 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse a string or binary data into structured data. usage: | @@ -30,17 +30,21 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | -| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | -| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | -| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | -| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | -| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | -| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | -| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | -| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | -| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | -| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | -| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file +| name | type | usage | +| ------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------- | +| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | +| [`from eml`](/commands/docs/from_eml.md) | Builtin,Plugin | Parse text as .eml and create record. | +| [`from ics`](/commands/docs/from_ics.md) | Builtin,Plugin | Parse text as .ics and create table. | +| [`from ini`](/commands/docs/from_ini.md) | Builtin,Plugin | Parse text as .ini and create table. | +| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | +| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | +| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | +| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | +| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | +| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | +| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | +| [`from vcf`](/commands/docs/from_vcf.md) | Builtin,Plugin | Parse text as .vcf and create table. | +| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | +| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | +| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | +| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 3a31958ca87..89f0ae5be88 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.85.0 +version: 0.86.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 ede4b336f9b..bad09c24994 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .eml and create record. usage: | @@ -16,11 +16,11 @@ usage: | ## Signature -```> from eml --preview-body``` +```> from eml {flags} ``` -## Parameters +## Flags - - `--preview-body {int}`: How many bytes of the body to preview + - `--preview-body, -b {int}`: How many bytes of the body to preview ## Input/output types: diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index cc7e822a038..74f17c1a2aa 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .ics and create table. usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> from ics ``` +```> from ics {flags} ``` ## Input/output types: diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 3f6306abaae..0ff03e9c26e 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .ini and create table. usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> from ini ``` +```> from ini {flags} ``` ## Input/output types: diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index a1aa3bd4e72..32fc42fd67e 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 69e35e205f9..7b23bfd1517 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 923f438937d..24d72529797 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | @@ -39,6 +39,6 @@ Convert binary .ods data to a table Convert binary .ods data to a table, specifying the tables ```nu -> open --raw test.ods | from ods -s [Spreadsheet1] +> open --raw test.ods | from ods --sheets [Spreadsheet1] ``` diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 8d6e4d3982c..248ed9a9ad8 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.85.0 +version: 0.86.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: | @@ -48,7 +48,7 @@ Converts ssv formatted string to table Converts ssv formatted string to table but not treating the first row as column names ```nu > 'FOO BAR -1 2' | from ssv -n +1 2' | from ssv --noheaders ╭───┬─────────┬─────────╮ │ # │ column1 │ column2 │ ├───┼─────────┼─────────┤ diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 638c535593f..3d5a9abf7e3 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.85.0 +version: 0.86.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 6759720d0ca..4f10f17ba71 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .tsv and create table. usage: | @@ -57,7 +57,7 @@ Create a tsv file with header columns and open it Create a tsv file without header columns and open it ```nu -> $'a1(char tab)b1(char tab)c1(char nl)a2(char tab)b2(char tab)c2' | save tsv-data | open tsv-data | from tsv -n +> $'a1(char tab)b1(char tab)c1(char nl)a2(char tab)b2(char tab)c2' | save tsv-data | open tsv-data | from tsv --noheaders ``` diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index dc7c597cb73..083b68d0a5e 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.85.0 +version: 0.86.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 2a020edd1f6..cbec569db7e 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .vcf and create table. usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> from vcf ``` +```> from vcf {flags} ``` ## Input/output types: diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index f89876e54d7..1a442358a1b 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | @@ -39,6 +39,6 @@ Convert binary .xlsx data to a table Convert binary .xlsx data to a table, specifying the tables ```nu -> open --raw test.xlsx | from xlsx -s [Spreadsheet1] +> open --raw test.xlsx | from xlsx --sheets [Spreadsheet1] ``` diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 4d607ed2c2d..f4438b6a69a 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.85.0 +version: 0.86.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 74a62c5c9ba..0d2e997e0cd 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.85.0 +version: 0.86.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 a6233f472be..03afc056f33 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/get.md b/commands/docs/get.md index 7be3f1c5d5c..d3119207ec3 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Extract data using a cell path. usage: | @@ -85,7 +85,7 @@ Getting Path/PATH in a case insensitive way Getting Path in a case sensitive way, won't work for 'PATH' ```nu -> $env | get -s Path +> $env | get --sensitive Path ``` diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 279b1ae75b0..5c2b69ce33c 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | @@ -106,4 +106,4 @@ Search for all files that are not in the target nor .git directories ``` ## Notes -For more glob pattern help, please refer to https://github.com/olson-sean-k/wax \ No newline at end of file +For more glob pattern help, please refer to https://docs.rs/crate/wax/latest \ No newline at end of file diff --git a/commands/docs/grid.md b/commands/docs/grid.md index d6358a0f19a..26f71a43713 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.85.0 +version: 0.86.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 8012dd88898..a2d315303b9 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/group.md b/commands/docs/group.md index 708d21a9a5c..64dab22fed0 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index d19c291c968..10d02f4d256 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.85.0 +version: 0.86.0 prompt: | Get the git status of a repo usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> gstat (path)``` +```> gstat {flags} (path)``` ## Parameters diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 99ebe9b894b..fa82b2cb76d 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.85.0 +version: 0.86.0 hash: | Apply hash function. usage: | diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index e3827c1dce2..8ca0262d76d 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.85.0 +version: 0.86.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 af41da06c1f..df758c0d7da 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.85.0 +version: 0.86.0 hash: | Hash a value using the sha256 hash algorithm usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index b36bcaad145..3914d9d9686 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.85.0 +version: 0.86.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 ff67a73db56..dd24131d0d8 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.85.0 +version: 0.86.0 core: | Display help information about different parts of Nushell. usage: | @@ -58,10 +58,11 @@ search for string in command names, usage and search terms ## Subcommands: -| name | type | usage | -| ---------------------------------------------------- | ------- | ------------------------------- | -| [`help aliases`](/commands/docs/help_aliases.md) | Builtin | Show help on nushell aliases. | -| [`help commands`](/commands/docs/help_commands.md) | Builtin | Show help on nushell commands. | -| [`help externs`](/commands/docs/help_externs.md) | Builtin | Show help on nushell externs. | -| [`help modules`](/commands/docs/help_modules.md) | Builtin | Show help on nushell modules. | -| [`help operators`](/commands/docs/help_operators.md) | Builtin | Show help on nushell operators. | \ No newline at end of file +| name | type | usage | +| ---------------------------------------------------- | ------- | ------------------------------------ | +| [`help aliases`](/commands/docs/help_aliases.md) | Builtin | Show help on nushell aliases. | +| [`help commands`](/commands/docs/help_commands.md) | Builtin | Show help on nushell commands. | +| [`help escapes`](/commands/docs/help_escapes.md) | Builtin | Show help on nushell string escapes. | +| [`help externs`](/commands/docs/help_externs.md) | Builtin | Show help on nushell externs. | +| [`help modules`](/commands/docs/help_modules.md) | Builtin | Show help on nushell modules. | +| [`help operators`](/commands/docs/help_operators.md) | Builtin | Show help on nushell operators. | \ No newline at end of file diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index f78d0099d79..1c2fd25a808 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.85.0 +version: 0.86.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 03f558a16ad..3045e6912b9 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.85.0 +version: 0.86.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md new file mode 100644 index 00000000000..c4e0c0d7165 --- /dev/null +++ b/commands/docs/help_escapes.md @@ -0,0 +1,26 @@ +--- +title: help escapes +categories: | + core +version: 0.86.0 +core: | + Show help on nushell string escapes. +usage: | + Show help on nushell string escapes. +--- + + +# {{ $frontmatter.title }} for core + +
{{ $frontmatter.core }}
+ +## Signature + +```> help escapes {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 1d70215eea9..c0cde632164 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.85.0 +version: 0.86.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index 0b49b171cea..48cf95ecd7e 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.85.0 +version: 0.86.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index a434d015000..1e4942a858c 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.85.0 +version: 0.86.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 3d3e1954f07..0cf7c18b60f 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.85.0 +version: 0.86.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 27221781a91..262378ed426 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.85.0 +version: 0.86.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index 912e1685039..a6559ea9ef3 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.85.0 +version: 0.86.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | @@ -51,12 +51,12 @@ Compute a histogram for the types of files, with frequency column named freq Compute a histogram for a list of numbers ```nu > [1 2 1] | histogram -╭────┬────────┬────────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮ -│ # │ value │ count │ quantile │ percentage │ frequency │ -├────┼────────┼────────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤ -│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ -│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ -╰────┴────────┴────────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯ +╭───┬───────┬───────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮ +│ # │ value │ count │ quantile │ percentage │ frequency │ +├───┼───────┼───────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤ +│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ +│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ +╰───┴───────┴───────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯ ``` diff --git a/commands/docs/history.md b/commands/docs/history.md index 10defec7c4f..94170152bc4 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | misc -version: 0.85.0 +version: 0.86.0 misc: | Get the command history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 19b3ab125b2..bcd62c3844d 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | misc -version: 0.85.0 +version: 0.86.0 misc: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 5d7d912a2b3..b7ffa9743fe 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.85.0 +version: 0.86.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 58c55c1d96b..8c5a57d36d0 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.85.0 +version: 0.86.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 48160d48181..c86d0fb6e34 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.85.0 +version: 0.86.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index cb9ed80741b..934dabd0247 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.85.0 +version: 0.86.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 947cfbf2eb6..56ca59210bb 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.85.0 +version: 0.86.0 network: | Requests permitted communication options for a given URL. usage: | diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 9594a34029c..72c658d906d 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.85.0 +version: 0.86.0 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 415db7376db..238d09c5680 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.85.0 +version: 0.86.0 network: | Post a body to a URL. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 9f1f2779f1b..c43bf972c42 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.85.0 +version: 0.86.0 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index 357751fb83d..19e03a2bb14 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.85.0 +version: 0.86.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 72de95c14c8..c45e8e7b227 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.85.0 +version: 0.86.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 d1aef5a487c..074797006e9 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.85.0 +version: 0.86.0 default: | Increment a value or version. Optionally use the column of a table. usage: | @@ -16,14 +16,17 @@ usage: | ## Signature -```> inc (cell_path) --major --minor --patch``` +```> inc {flags} (cell_path)``` + +## Flags + + - `--major, -M`: increment the major version (eg 1.2.1 -> 2.0.0) + - `--minor, -m`: increment the minor version (eg 1.2.1 -> 1.3.0) + - `--patch, -p`: increment the patch version (eg 1.2.1 -> 1.2.2) ## Parameters - `cell_path`: cell path to update - - `--major` `(-M)`: increment the major version (eg 1.2.1 -> 2.0.0) - - `--minor` `(-m)`: increment the minor version (eg 1.2.1 -> 1.3.0) - - `--patch` `(-p)`: increment the patch version (eg 1.2.1 -> 1.2.2) ## Input/output types: diff --git a/commands/docs/input.md b/commands/docs/input.md index 83af2471fdf..a1580554913 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index a774279a078..cf0181a5be9 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index 0dd6ff12f53..4cfeb0c3bdd 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Listen for user interface event usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index c3808382188..d0435328548 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.85.0 +version: 0.86.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 b3b6f1563f6..4da0a296129 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index c5e88fbabe0..fca81f28c40 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Commands to convert data from one type to another. usage: | @@ -30,17 +30,17 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | ------------------------------------------------------ | -| [`into binary`](/commands/docs/into_binary.md) | Builtin | Convert value to a binary primitive. | -| [`into bits`](/commands/docs/into_bits.md) | Builtin | Convert value to a binary primitive. | -| [`into bool`](/commands/docs/into_bool.md) | Builtin | Convert value to boolean. | -| [`into datetime`](/commands/docs/into_datetime.md) | Builtin | Convert text or timestamp into a datetime. | -| [`into decimal`](/commands/docs/into_decimal.md) | Builtin | deprecated: convert data into a floating point number. | -| [`into duration`](/commands/docs/into_duration.md) | Builtin | Convert value to duration. | -| [`into filesize`](/commands/docs/into_filesize.md) | Builtin | Convert value to filesize. | -| [`into float`](/commands/docs/into_float.md) | Builtin | Convert data into floating point number. | -| [`into int`](/commands/docs/into_int.md) | Builtin | Convert value to integer. | -| [`into record`](/commands/docs/into_record.md) | Builtin | Convert value to record. | -| [`into sqlite`](/commands/docs/into_sqlite.md) | Builtin | Convert table into a SQLite database. | -| [`into string`](/commands/docs/into_string.md) | Builtin | Convert value to string. | \ No newline at end of file +| name | type | usage | +| -------------------------------------------------- | ------- | ------------------------------------------ | +| [`into binary`](/commands/docs/into_binary.md) | Builtin | Convert value to a binary primitive. | +| [`into bits`](/commands/docs/into_bits.md) | Builtin | Convert value to a binary primitive. | +| [`into bool`](/commands/docs/into_bool.md) | Builtin | Convert value to boolean. | +| [`into datetime`](/commands/docs/into_datetime.md) | Builtin | Convert text or timestamp into a datetime. | +| [`into duration`](/commands/docs/into_duration.md) | Builtin | Convert value to duration. | +| [`into filesize`](/commands/docs/into_filesize.md) | Builtin | Convert value to filesize. | +| [`into float`](/commands/docs/into_float.md) | Builtin | Convert data into floating point number. | +| [`into int`](/commands/docs/into_int.md) | Builtin | Convert value to integer. | +| [`into record`](/commands/docs/into_record.md) | Builtin | Convert value to record. | +| [`into sqlite`](/commands/docs/into_sqlite.md) | Builtin | Convert table into a SQLite database. | +| [`into string`](/commands/docs/into_string.md) | Builtin | Convert value to string. | +| [`into value`](/commands/docs/into_value.md) | Builtin | Infer nushell datatype for each cell. | \ No newline at end of file diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index dac6ab55c2a..4d9e6b8ec09 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to a binary primitive. usage: | @@ -89,7 +89,7 @@ Length: 8 (0x8) bytes | printable whitespace ascii_other non_ascii ``` -convert an integer to a nushell binary primitive with compact enabled +convert an int to a nushell binary primitive with compact enabled ```nu > 10 | into binary --compact Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index 8b10e6604fc..bb2ef6c2746 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 61c4a79a0f4..11242864c3b 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to boolean. usage: | @@ -57,7 +57,7 @@ Convert bool to boolean true ``` -convert integer to boolean +convert int to boolean ```nu > 1 | into bool true diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 7f563cd0577..b3c485aa292 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -55,7 +55,7 @@ Sat, 27 Feb 2021 13:55:40 +0000 (2 years ago) Convert non-standard timestamp string to datetime using a custom format ```nu -> '20210227_135540+0000' | into datetime -f '%Y%m%d_%H%M%S%z' +> '20210227_135540+0000' | into datetime --format '%Y%m%d_%H%M%S%z' Sat, 27 Feb 2021 13:55:40 +0000 (2 years ago) ``` diff --git a/commands/docs/into_decimal.md b/commands/docs/into_decimal.md deleted file mode 100644 index 1995d3aaa5f..00000000000 --- a/commands/docs/into_decimal.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: into decimal -categories: | - conversions -version: 0.85.0 -conversions: | - deprecated: convert data into a floating point number. -usage: | - deprecated: convert data into a floating point number. ---- - - -# {{ $frontmatter.title }} for conversions - -
{{ $frontmatter.conversions }}
- -## Signature - -```> into decimal {flags} ...rest``` - -## Parameters - - - `...rest`: for a data structure input, convert data at the given cell paths - - -## Input/output types: - -| input | output | -| --------- | ------------ | -| bool | number | -| int | number | -| list\ | list\ | -| number | number | -| record | record | -| string | number | -| table | table | -## Examples - -Convert string to float in table -```nu -> [[num]; ['5.01']] | into decimal num -╭───┬──────╮ -│ # │ num │ -├───┼──────┤ -│ 0 │ 5.01 │ -╰───┴──────╯ - -``` - -Convert string to float -```nu -> '1.345' | into decimal -1.345 -``` - -Coerce list of ints and floats to float -```nu -> [4 -5.9] | into decimal -╭───┬───────╮ -│ 0 │ 4.00 │ -│ 1 │ -5.90 │ -╰───┴───────╯ - -``` - -Convert boolean to float -```nu -> true | into decimal -1 -``` - -## Notes -Use `into float` instead \ No newline at end of file diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index d0f25e1a2b0..f259f3124ff 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 548af63b432..d15a74e37d6 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 30fe762bde0..f030b3809a2 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert data into floating point number. usage: | @@ -25,15 +25,15 @@ usage: | ## Input/output types: -| input | output | -| --------- | ------------ | -| bool | number | -| int | number | -| list\ | list\ | -| number | number | -| record | record | -| string | number | -| table | table | +| input | output | +| --------- | ----------- | +| bool | float | +| float | float | +| int | float | +| list\ | list\ | +| record | record | +| string | float | +| table | table | ## Examples Convert string to float in table diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 9dd9146ad83..d275575e218 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to integer. usage: | @@ -50,37 +50,37 @@ usage: | | table | table | ## Examples -Convert string to integer in table +Convert string to int in table ```nu > [[num]; ['-5'] [4] [1.5]] | into int num ``` -Convert string to integer +Convert string to int ```nu > '2' | into int 2 ``` -Convert float to integer +Convert float to int ```nu > 5.9 | into int 5 ``` -Convert decimal string to integer +Convert decimal string to int ```nu > '5.9' | into int 5 ``` -Convert file size to integer +Convert file size to int ```nu > 4KB | into int 4000 ``` -Convert bool to integer +Convert bool to int ```nu > [false, true] | into int ╭───┬───╮ @@ -90,38 +90,38 @@ Convert bool to integer ``` -Convert date to integer (Unix nanosecond timestamp) +Convert date to int (Unix nanosecond timestamp) ```nu > 1983-04-13T12:09:14.123456789-05:00 | into int 419101754123456789 ``` -Convert to integer from binary +Convert to int from binary data (radix: 2) ```nu -> '1101' | into int -r 2 +> '1101' | into int --radix 2 13 ``` -Convert to integer from hex +Convert to int from hex ```nu -> 'FF' | into int -r 16 +> 'FF' | into int --radix 16 255 ``` -Convert octal string to integer +Convert octal string to int ```nu > '0o10132' | into int 4186 ``` -Convert 0 padded string to integer +Convert 0 padded string to int ```nu > '0010132' | into int 10132 ``` -Convert 0 padded string to integer with radix +Convert 0 padded string to int with radix 8 ```nu -> '0010132' | into int -r 8 +> '0010132' | into int --radix 8 4186 ``` diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index 2920f5be7b5..1b75ba48892 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 75007be4566..bfb4deb93d2 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 3b4c462e8e0..877c7615d48 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.85.0 +version: 0.86.0 conversions: | Convert value to string. usage: | @@ -44,36 +44,30 @@ usage: | | table | table | ## Examples -convert integer to string and append three decimal places +convert int to string and append three decimal places ```nu -> 5 | into string -d 3 +> 5 | into string --decimals 3 5.000 ``` convert float to string and round to nearest integer ```nu -> 1.7 | into string -d 0 +> 1.7 | into string --decimals 0 2 ``` convert float to string ```nu -> 1.7 | into string -d 1 +> 1.7 | into string --decimals 1 1.7 ``` convert float to string and limit to 2 decimals ```nu -> 1.734 | into string -d 2 +> 1.734 | into string --decimals 2 1.73 ``` -try to convert float to string and provide negative decimal points -```nu -> 1.734 | into string -d -2 - -``` - convert float to string ```nu > 4.3 | into string diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md new file mode 100644 index 00000000000..d9168fea7c8 --- /dev/null +++ b/commands/docs/into_value.md @@ -0,0 +1,44 @@ +--- +title: into value +categories: | + filters +version: 0.86.0 +filters: | + Infer nushell datatype for each cell. +usage: | + Infer nushell datatype for each cell. +--- + + +# {{ $frontmatter.title }} for filters + +
{{ $frontmatter.filters }}
+ +## Signature + +```> into value {flags} ``` + +## Flags + + - `--columns, -c {table}`: list of columns to update + + +## Input/output types: + +| input | output | +| ----- | ------ | +| table | table | + +## Examples + +Infer Nushell values for each cell. +```nu +> $table | into value + +``` + +Infer Nushell values for each cell in the given columns. +```nu +> $table | into value -c [column1, column5] + +``` diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 59f3c527f4c..6cf1ac54a59 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.85.0 +version: 0.86.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 6fcd7bc5340..0f7182cad88 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index 55f9a8064ff..d2ab0e0e7be 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.85.0 +version: 0.86.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 94d4314a6e9..ed1c792ee61 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Join two tables usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 3ba8859c983..878e5db72b7 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index 9070f07ba5f..fc0631e91a3 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 82a803a7528..316091f920b 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | List available options that can be used to create keybindings. usage: | diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index e25a2e62255..fa9f5d423b0 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 94902025e2a..d6e1a16f298 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.85.0 +version: 0.86.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index a55e65d1543..9f1d87d8452 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.85.0 +version: 0.86.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 869b24b29a3..46e792221cf 100644 --- a/commands/docs/lazy_make.md +++ b/commands/docs/lazy_make.md @@ -2,7 +2,7 @@ title: lazy make categories: | core -version: 0.85.0 +version: 0.86.0 core: | Create a lazy record. usage: | @@ -40,7 +40,7 @@ Create a lazy record Test the laziness of lazy records ```nu -> lazy make -c ["hello"] -g { |key| print $"getting ($key)!"; $key | str upcase } +> lazy make --columns ["hello"] --get-value { |key| print $"getting ($key)!"; $key | str upcase } ``` diff --git a/commands/docs/length.md b/commands/docs/length.md index 07283d9844a..a4784012653 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.85.0 +version: 0.86.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 5276ff75d65..7b388f1caf9 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.85.0 +version: 0.86.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 3448ec5b695..a291555eba4 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.85.0 +version: 0.86.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 0770f4d5890..a8a9535307a 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index fb14d0df169..c45b5ff948d 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 5a09bae4380..f604a49801b 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.85.0 +version: 0.86.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 6c7a3a9bb9d..9506f28e203 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.85.0 +version: 0.86.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 6987a5f13a5..c5725492523 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.85.0 +version: 0.86.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index e98ac17ff99..4464d98aad2 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.85.0 +version: 0.86.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 d3f15a6d424..86aaa595d23 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.85.0 +version: 0.86.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 334eb6f28ba..78e52ef4e22 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the arccosine of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arccosine of 1 diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index a049f0c5ee1..8d5202ad0b5 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arccosh of 1 diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index 7df269240f5..e208acb081b 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the arcsine of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arcsine of 1 diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index f228f4b9888..146cdf634e0 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the inverse of the hyperbolic sine function. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arcsinh of 0 diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index 06ae452d20b..67d19d8fb37 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the arctangent of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arctangent of 1 diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 3e9b6ea7c44..81ceed2f335 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the arctanh of 1 diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 2568e6dff9a..409678101ff 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.85.0 +version: 0.86.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 b24659d520a..bd5bfdb7c7f 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.85.0 +version: 0.86.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 b1733a925b6..e8bdd8875fe 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the cosine of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the cosine to π diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 8bdf4ef796e..28a750327a5 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the hyperbolic cosine of the number. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the hyperbolic cosine to 1 diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 71e313a0ae9..db1c049e677 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns e raised to the power of x. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get e raised to the power of zero diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 744de19925f..8a22acc39d3 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.85.0 +version: 0.86.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 8c94a68b826..5ae403ac1ff 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the natural logarithm. Base: (math e). usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the natural logarithm of e diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index d6f4d683e44..4395a919e65 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the logarithm for an arbitrary base. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Get the logarithm of 100 to the base 10 diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index abf1cac9950..8e62459f063 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.85.0 +version: 0.86.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 3ba8c37ddd5..89770dd078c 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.85.0 +version: 0.86.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 acfce0be080..4e3a7feb9eb 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.85.0 +version: 0.86.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 dce512981a1..c7177589034 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.85.0 +version: 0.86.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 4bc0c0efd77..ea09a9772fb 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.85.0 +version: 0.86.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 522583564a4..fbb3ac41f47 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the input number rounded to the specified precision. usage: | diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index aa381b31cf6..6dacaa57a4e 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the sine of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the sine to π/2 diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index e0af9458bb3..9c1f662ed33 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the hyperbolic sine of the number. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the hyperbolic sine to 1 diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 13e97cedbdc..6e455a5cd36 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the square root of the input number. usage: | @@ -21,18 +21,18 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Compute the square root of each number in a list ```nu > [9 16] | math sqrt -╭───┬───╮ -│ 0 │ 3 │ -│ 1 │ 4 │ -╰───┴───╯ +╭───┬──────╮ +│ 0 │ 3.00 │ +│ 1 │ 4.00 │ +╰───┴──────╯ ``` diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index 1c8268ede48..ab4dd97be0b 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index 7e9683ad672..d6684c4d16a 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.85.0 +version: 0.86.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 6fc3ab6ab9f..63396856626 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the tangent of the number. usage: | @@ -25,10 +25,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the tangent to π/4 diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index e7f91649748..4c34e546961 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the hyperbolic tangent of the number. usage: | @@ -21,10 +21,10 @@ usage: | ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| number | number | +| input | output | +| ------------ | ----------- | +| list\ | list\ | +| number | float | ## Examples Apply the hyperbolic tangent to 10*π diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 2eaf86771bb..295bc026350 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.85.0 +version: 0.86.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/merge.md b/commands/docs/merge.md index ead76ac19d2..55ddcf36f57 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.85.0 +version: 0.86.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 d523c4b8941..ca804e7ec92 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 71827d567b3..f06729f338e 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Make directories, creates intermediary directories as required. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 5d2e6e83a27..d047dcee79e 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.85.0 +version: 0.86.0 core: | Define a custom module. usage: | @@ -46,7 +46,7 @@ BAZ Define a custom command that participates in the environment in a module and call it ```nu -> module foo { export def-env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR +> module foo { export def --env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR BAZ ``` diff --git a/commands/docs/move.md b/commands/docs/move.md index 7905d873cb2..0e4824208da 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index cd45059a4d9..30581fab716 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.85.0 +version: 0.86.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 214315859d3..20aea55d193 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Move files or directories. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 9670bb1e769..dd577af3827 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 4b720346e27..56e9e8170ae 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index a2a7b845a24..05cf6973021 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.85.0 +version: 0.86.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 226f14bcf68..876d5849cf7 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.85.0 +version: 0.86.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index c7a8cb0f6db..d93521632b5 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.85.0 +version: 0.86.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 3c50a93292f..7c676443318 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.85.0 +version: 0.86.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index dedcc9e6168..6260df4685d 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.85.0 +version: 0.86.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index ef8b85ce014..b690eae3142 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.85.0 +version: 0.86.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 24e43ee53f9..cfc13245ef5 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.85.0 +version: 0.86.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 e632b962c5d..1bb99b3cb43 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Parse columns from string data using a simple pattern. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index 0c4f0021685..42013def3b7 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.85.0 +version: 0.86.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index e64d92c18cc..fc59cb92307 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.85.0 +version: 0.86.0 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index cec8f9eca66..cdacb57ac4d 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.85.0 +version: 0.86.0 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index f40f7b7f302..825601d3e56 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.85.0 +version: 0.86.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index be3a336d81b..fe7c46e1226 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.85.0 +version: 0.86.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 a4ddd4ea6dd..842c3a3cd85 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.85.0 +version: 0.86.0 path: | Join a structured path or a list of path parts. usage: | @@ -45,6 +45,18 @@ Append a filename to a path /home/viking/spams/this_spam.txt ``` +Use relative paths, e.g. '..' will go up one directory +```nu +> '/home/viking' | path join .. folder +/home/viking/../folder +``` + +Use absolute paths, e.g. '/' will bring you to the top level directory +```nu +> '/home/viking' | path join / folder +/folder +``` + Join a list of parts into a path ```nu > [ '/' 'home' 'viking' 'spam.txt' ] | path join diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index 1641fee9281..359df5a919f 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.85.0 +version: 0.86.0 path: | Convert a path into structured data. usage: | diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index 84a4736f3fb..4d2f2cd1c79 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.85.0 +version: 0.86.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 24744dbd0a7..cb9256f9fef 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.85.0 +version: 0.86.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 14d4341dfc1..b48ef9b1b7a 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.85.0 +version: 0.86.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 2f0550eb6dc..8a8c3ab5219 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.85.0 +version: 0.86.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index e132a1d3f75..a6ea5bf1782 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Prepend any number of rows to a table. usage: | @@ -53,7 +53,7 @@ Prepend a list of strings to a string ``` -Prepend one integer item +Prepend one int item ```nu > [1 2 3 4] | prepend 0 ╭───┬───╮ @@ -66,7 +66,7 @@ Prepend one integer item ``` -Prepend two integer items +Prepend two int items ```nu > [2 3 4] | prepend [0 1] ╭───┬───╮ @@ -79,7 +79,7 @@ Prepend two integer items ``` -Prepend integers and strings +Prepend ints and strings ```nu > [2 nu 4 shell] | prepend [0 1 rocks] ╭───┬───────╮ diff --git a/commands/docs/print.md b/commands/docs/print.md index 258088e2352..4213683cf6b 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/profile.md b/commands/docs/profile.md index 0b8907704aa..13f15b1d388 100644 --- a/commands/docs/profile.md +++ b/commands/docs/profile.md @@ -2,7 +2,7 @@ title: profile categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Profile each pipeline element in a closure. usage: | @@ -20,8 +20,8 @@ usage: | ## Flags - - `--source, -`: Collect source code in the report - - `--values, -`: Collect values in the report + - `--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 @@ -39,7 +39,7 @@ usage: | Profile some code, stepping into the `spam` command and collecting source. ```nu -> def spam [] { "spam" }; profile {|| spam | str length } -d 2 --source +> def spam [] { "spam" }; profile {|| spam | str length } --max-depth 2 --source ``` diff --git a/commands/docs/ps.md b/commands/docs/ps.md index d69f995cde1..b5ccf8304cc 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.85.0 +version: 0.86.0 system: | View information about system processes. usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 7b2deb24fe6..027e096a2dc 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Show all the query commands usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> query ``` +```> query {flags} ``` ## Input/output types: diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index f9440433fe6..bde41925970 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.85.0 +version: 0.86.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 64b1f710d7e..47f7805c375 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> query json (query)``` +```> query json {flags} (query)``` ## Parameters diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 462e7a8cd99..8e129b71907 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.85.0 +version: 0.86.0 network: | execute selector query on html/web usage: | @@ -16,15 +16,15 @@ usage: | ## Signature -```> query web --query --as-html --attribute --as-table --inspect``` +```> query web {flags} ``` -## Parameters +## Flags - - `--query {string}`: selector query - - `--as-html` `(-m)`: return the query output as html - - `--attribute {string}`: downselect based on the given attribute - - `--as-table {table}`: find table based on column header list - - `--inspect` `(-i)`: run in inspect mode to provide more information for determining column headers + - `--query, -q {string}`: selector query + - `--as-html, -m`: return the query output as html + - `--attribute, -a {string}`: downselect based on the given attribute + - `--as-table, -t {table}`: find table based on column header list + - `--inspect, -i`: run in inspect mode to provide more information for determining column headers ## Input/output types: diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index 3ed99172133..14d746e4227 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | execute xpath query on xml usage: | @@ -16,7 +16,7 @@ usage: | ## Signature -```> query xml (query)``` +```> query xml {flags} (query)``` ## Parameters diff --git a/commands/docs/random.md b/commands/docs/random.md index 602828eeee8..77c64c2581f 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate a random value. usage: | @@ -30,12 +30,12 @@ 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 decimal`](/commands/docs/random_decimal.md) | Builtin | deprecated: Generate a random float within a range [min..max]. | -| [`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 integer`](/commands/docs/random_integer.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 +| 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 diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index e6357b4ec07..a662434b3b2 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 1c01373e1f2..c9dfcf85e6c 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate random chars. usage: | diff --git a/commands/docs/random_decimal.md b/commands/docs/random_decimal.md deleted file mode 100644 index 341c8079430..00000000000 --- a/commands/docs/random_decimal.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: random decimal -categories: | - random -version: 0.85.0 -random: | - deprecated: Generate a random float within a range [min..max]. -usage: | - deprecated: Generate a random float within a range [min..max]. ---- - - -# {{ $frontmatter.title }} for random - -
{{ $frontmatter.random }}
- -## Signature - -```> random decimal {flags} (range)``` - -## Parameters - - - `range`: Range of values - - -## Input/output types: - -| input | output | -| ------- | ------ | -| nothing | number | - -## Examples - -Generate a default float value between 0 and 1 -```nu -> random decimal - -``` - -Generate a random float less than or equal to 500 -```nu -> random decimal ..500 - -``` - -Generate a random float greater than or equal to 100000 -```nu -> random decimal 100000.. - -``` - -Generate a random float between 1.0 and 1.1 -```nu -> random decimal 1.0..1.1 - -``` - -## Notes -Use `random float` instead \ No newline at end of file diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index 64aa5be3675..c8d428d8791 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 31b80e65efe..521d0c7a0ab 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate a random float within a range [min..max]. usage: | @@ -27,7 +27,7 @@ usage: | | input | output | | ------- | ------ | -| nothing | number | +| nothing | float | ## Examples diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md new file mode 100644 index 00000000000..3ee8896cd46 --- /dev/null +++ b/commands/docs/random_int.md @@ -0,0 +1,56 @@ +--- +title: random int +categories: | + random +version: 0.86.0 +random: | + Generate a random integer [min..max]. +usage: | + Generate a random integer [min..max]. +--- + + +# {{ $frontmatter.title }} for random + +
{{ $frontmatter.random }}
+ +## Signature + +```> random int {flags} (range)``` + +## Parameters + + - `range`: Range of values + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | int | + +## Examples + +Generate an unconstrained random integer +```nu +> random int + +``` + +Generate a random integer less than or equal to 500 +```nu +> random int ..500 + +``` + +Generate a random integer greater than or equal to 100000 +```nu +> random int 100000.. + +``` + +Generate a random integer between 1 and 10 +```nu +> random int 1..10 + +``` diff --git a/commands/docs/random_integer.md b/commands/docs/random_integer.md index 19ab418cc64..614b7cb9679 100644 --- a/commands/docs/random_integer.md +++ b/commands/docs/random_integer.md @@ -2,11 +2,11 @@ title: random integer categories: | random -version: 0.85.0 +version: 0.86.0 random: | - Generate a random integer [min..max]. + deprecated: Generate a random integer [min..max]. usage: | - Generate a random integer [min..max]. + deprecated: Generate a random integer [min..max]. --- @@ -54,3 +54,6 @@ Generate a random integer between 1 and 10 > 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 38a06d3a7b4..7b186f6ceca 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.85.0 +version: 0.86.0 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index 21e17344557..d842e692666 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index fb41a1ffced..092cab43cfc 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Aggregate a list to a single value using an accumulator closure. usage: | @@ -44,30 +44,30 @@ Sum values of a list (same as 'math sum') Sum values of a list, plus their indexes ```nu -> [ 8 7 6 ] | enumerate | reduce -f 0 {|it, acc| $acc + $it.item + $it.index } +> [ 8 7 6 ] | enumerate | reduce --fold 0 {|it, acc| $acc + $it.item + $it.index } 24 ``` Sum values with a starting value (fold) ```nu -> [ 1 2 3 4 ] | reduce -f 10 {|it, acc| $acc + $it } +> [ 1 2 3 4 ] | reduce --fold 10 {|it, acc| $acc + $it } 20 ``` Replace selected characters in a string with 'X' ```nu -> [ i o t ] | reduce -f "Arthur, King of the Britons" {|it, acc| $acc | str replace -a $it "X" } +> [ i o t ] | reduce --fold "Arthur, King of the Britons" {|it, acc| $acc | str replace --all $it "X" } ArXhur, KXng Xf Xhe BrXXXns ``` Add ascending numbers to each of the filenames, and join with semicolons. ```nu -> ['foo.gz', 'bar.gz', 'baz.gz'] | enumerate | reduce -f '' {|str all| $"($all)(if $str.index != 0 {'; '})($str.index + 1)-($str.item)" } +> ['foo.gz', 'bar.gz', 'baz.gz'] | enumerate | reduce --fold '' {|str all| $"($all)(if $str.index != 0 {'; '})($str.index + 1)-($str.item)" } 1-foo.gz; 2-bar.gz; 3-baz.gz ``` Concatenate a string with itself, using a range to determine the number of times. ```nu -> let s = "Str"; 0..2 | reduce -f '' {|it, acc| $acc + $s} +> let s = "Str"; 0..2 | reduce --fold '' {|it, acc| $acc + $s} StrStrStr ``` diff --git a/commands/docs/register.md b/commands/docs/register.md index d306fe8a223..3c99d0e7a29 100644 --- a/commands/docs/register.md +++ b/commands/docs/register.md @@ -2,7 +2,7 @@ title: register categories: | core -version: 0.85.0 +version: 0.86.0 core: | Register a plugin. usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index 43bf44d59c1..67f468004ff 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,12 +2,13 @@ title: registry query categories: | system -version: 0.79.0 +version: 0.86.0 system: | Query the Windows registry. usage: | Query the Windows registry. --- + # {{ $frontmatter.title }} for system @@ -15,25 +16,33 @@ usage: | ## Signature -```> registry query (key) (value) --hkcr --hkcu --hklm --hku --hkpd --hkpt --hkpnls --hkcc --hkdd --hkculs``` +```> registry query {flags} (key) (value)``` + +## Flags + + - `--hkcr, -`: query the hkey_classes_root hive + - `--hkcu, -`: query the hkey_current_user hive + - `--hklm, -`: query the hkey_local_machine hive + - `--hku, -`: query the hkey_users hive + - `--hkpd, -`: query the hkey_performance_data hive + - `--hkpt, -`: query the hkey_performance_text hive + - `--hkpnls, -`: query the hkey_performance_nls_text hive + - `--hkcc, -`: query the hkey_current_config hive + - `--hkdd, -`: query the hkey_dyn_data hive + - `--hkculs, -`: query the hkey_current_user_local_settings hive ## Parameters - `key`: registry key to query - `value`: optionally supply a registry value to query - - `--hkcr` `(-)`: query the hkey_classes_root hive - - `--hkcu` `(-)`: query the hkey_current_user hive - - `--hklm` `(-)`: query the hkey_local_machine hive - - `--hku` `(-)`: query the hkey_users hive - - `--hkpd` `(-)`: query the hkey_performance_data hive - - `--hkpt` `(-)`: query the hkey_performance_text hive - - `--hkpnls` `(-)`: query the hkey_performance_nls_text hive - - `--hkcc` `(-)`: query the hkey_current_config hive - - `--hkdd` `(-)`: query the hkey_dyn_data hive - - `--hkculs` `(-)`: query the hkey_current_user_local_settings hive -## Notes -Currently supported only on Windows systems. + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | any | + ## Examples Query the HKEY_CURRENT_USER hive @@ -47,3 +56,6 @@ Query the HKEY_LOCAL_MACHINE hive > registry query --hklm 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment' ``` + +## Notes +Currently supported only on Windows systems. \ No newline at end of file diff --git a/commands/docs/reject.md b/commands/docs/reject.md index b41e0023e19..9021562e734 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | diff --git a/commands/docs/rename.md b/commands/docs/rename.md index bd98c765cd8..e889c6ac0f5 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Creates a new table with columns renamed. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--column, -c {list}`: column name to be changed + - `--column, -c {record}`: column name to be changed - `--block, -b {closure(any)}`: A closure to apply changes on each column ## Parameters @@ -60,7 +60,7 @@ Rename many columns Rename a specific column ```nu -> [[a, b, c]; [1, 2, 3]] | rename -c [a ham] +> [[a, b, c]; [1, 2, 3]] | rename --column { a: ham } ╭───┬─────┬───┬───╮ │ # │ ham │ b │ c │ ├───┼─────┼───┼───┤ @@ -80,7 +80,7 @@ Rename the fields of a record Rename fields based on a given closure ```nu -> {abc: 1, bbc: 2} | rename -b {str replace -a 'b' 'z'} +> {abc: 1, bbc: 2} | rename --block {str replace --all 'b' 'z'} ╭─────┬───╮ │ azc │ 1 │ │ zzc │ 2 │ diff --git a/commands/docs/return.md b/commands/docs/return.md index a1bb00a74fc..ea9a3ad96d6 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.85.0 +version: 0.86.0 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index e086c99d306..ea9cf62a0e2 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 51fd72b6981..816576a7860 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 8af7ba0a316..e4f64790b31 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 34d27563303..fe223e521df 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 3a163ce5bf6..0b5b55e912b 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index c222cdc71e7..0f489a17933 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index a12d0c88d51..0fe671cb106 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 8d23addefe4..9b5ec772c41 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.85.0 +version: 0.86.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 7ec4b20cf5f..2a3810a6309 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.85.0 +version: 0.86.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 593d8063bd0..4079c6c2227 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index b83df62ad80..a477b27d2f9 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.85.0 +version: 0.86.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 3cf75ccecc8..5511236a32c 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.85.0 +version: 0.86.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 bf8310a117f..2ff22b5a417 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output info on the aliases in the current scope. usage: | diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 3e80c8d910b..3c1da344192 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output info on the commands in the current scope. usage: | diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index 340c2124153..d2855ce520c 100644 --- a/commands/docs/scope_engine-stats.md +++ b/commands/docs/scope_engine-stats.md @@ -2,7 +2,7 @@ title: scope engine-stats categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output stats on the engine in the current state. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index e3a8c36d584..1efd717f0c5 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output info on the known externals in the current scope. usage: | diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index e76310fd307..a45a662a9b3 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output info on the modules in the current scope. usage: | diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index 14519d4573c..7424e8330e6 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index fc753e7f528..48dbec30d1c 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 9bb242446c7..453f9550eb2 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.85.0 +version: 0.86.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 4fdb6cf7c14..9803b66eb82 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.85.0 +version: 0.86.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 27dfedbb6e1..a1b98b4a5b2 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.85.0 +version: 0.86.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index f847951e82d..e4007f5033d 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/size.md b/commands/docs/size.md index 48462322e80..1bdc91d1dd9 100644 --- a/commands/docs/size.md +++ b/commands/docs/size.md @@ -2,7 +2,7 @@ title: size categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 902989c5b93..b1d9f217953 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.85.0 +version: 0.86.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 692fbd2896e..fa65fe6f975 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.85.0 +version: 0.86.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 0f942848dc3..039a19ef92a 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.85.0 +version: 0.86.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 ad0bd05b2d6..7641e9040b6 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.85.0 +version: 0.86.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 67acb68483f..fba3693d421 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Sort by the given columns, in increasing order. usage: | @@ -45,13 +45,13 @@ Sort files by modified date Sort files by name (case-insensitive) ```nu -> ls | sort-by name -i +> ls | sort-by name --ignore-case ``` Sort a table by a column (reversed order) ```nu -> [[fruit count]; [apple 9] [pear 3] [orange 7]] | sort-by fruit -r +> [[fruit count]; [apple 9] [pear 3] [orange 7]] | sort-by fruit --reverse ╭───┬────────┬───────╮ │ # │ fruit │ count │ ├───┼────────┼───────┤ diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 951540f91ce..5ed878df66c 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Sort in increasing order. usage: | @@ -47,7 +47,7 @@ sort the list by increasing value sort the list by decreasing value ```nu -> [2 0 1] | sort -r +> [2 0 1] | sort --reverse ╭───┬───╮ │ 0 │ 2 │ │ 1 │ 1 │ @@ -69,7 +69,7 @@ sort a list of strings sort a list of strings in reverse ```nu -> [betty amy sarah] | sort -r +> [betty amy sarah] | sort --reverse ╭───┬───────╮ │ 0 │ sarah │ │ 1 │ betty │ diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 6f860f75d9b..90f15cc6409 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.85.0 +version: 0.86.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 86702ade696..780498327dd 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.85.0 +version: 0.86.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 d5c86e17c8b..af945c60c45 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Create a new table split. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 45e021f7397..6351cf19199 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.85.0 +version: 0.86.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 c032d0cb6d3..935d6980946 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Split a string into a list of characters. usage: | diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index 602bce4e0bd..18f18bf053d 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Split a string into multiple columns using a separator. usage: | diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index d4634d0a103..ef9c99542ee 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Split a list into multiple lists using a separator. usage: | @@ -93,7 +93,7 @@ Split a list of chars into two lists Split a list of chars into lists based on multiple characters ```nu -> [a, b, c, d, a, e, f, g] | split list -r '(b|e)' +> [a, b, c, d, a, e, f, g] | split list --regex '(b|e)' ╭───┬───────────╮ │ 0 │ ╭───┬───╮ │ │ │ │ 0 │ a │ │ diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 460200e8ef0..6cb39a1293d 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.85.0 +version: 0.86.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 dd08ed8f9ec..13e623b5405 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Split a string's words into separate rows. usage: | @@ -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 -c | sort-by count --reverse | first 10 +> 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 ``` diff --git a/commands/docs/start.md b/commands/docs/start.md index f66eb7ceb2c..b1ec6b25380 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.85.0 +version: 0.86.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 c4ebf5785dd..03041a2eda4 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Various commands for working with string data. usage: | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 2f28a15ab67..e2b00abe2bb 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.85.0 +version: 0.86.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 2539b494dd1..9ba3c192aa0 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 360d4acd200..823a488f6c6 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index f2ff62c7df2..65449ba5eaf 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.85.0 +version: 0.86.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 f2dda6935d2..a3bcd6a7f1f 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index fcf9083fec4..eea74d7565b 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.85.0 +version: 0.86.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index b7ac5fe4d98..9edeb083a01 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.85.0 +version: 0.86.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 ac7f65eb2f3..7eeda526957 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.85.0 +version: 0.86.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index a12289c0eef..357fb692329 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.85.0 +version: 0.86.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 88fec77f5c7..2a8693b79ba 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.85.0 +version: 0.86.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index fd156e2267d..06679c42ad6 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 9f7ca1cd6cc..5107f51a3d5 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.85.0 +version: 0.86.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 522e6842155..9296f6e0d3e 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Find and replace text. usage: | @@ -50,7 +50,7 @@ Find and replace the first occurrence of a substring Find and replace all occurrences of a substring ```nu -> 'abc abc abc' | str replace -a 'b' 'z' +> 'abc abc abc' | str replace --all 'b' 'z' azc azc azc ``` @@ -62,13 +62,13 @@ my_library.nu Find and replace all occurrences of find string using regular expression ```nu -> 'abc abc abc' | str replace -ar 'b' 'z' +> 'abc abc abc' | str replace --all --regex 'b' 'z' azc azc azc ``` Find and replace all occurrences of find string in table using regular expression ```nu -> [[ColA ColB ColC]; [abc abc ads]] | str replace -ar 'b' 'z' ColA ColC +> [[ColA ColB ColC]; [abc abc ads]] | str replace --all --regex 'b' 'z' ColA ColC ╭───┬──────┬──────┬──────╮ │ # │ ColA │ ColB │ ColC │ ├───┼──────┼──────┼──────┤ @@ -79,7 +79,7 @@ Find and replace all occurrences of find string in table using regular expressio Find and replace all occurrences of find string in record using regular expression ```nu -> { KeyA: abc, KeyB: abc, KeyC: ads } | str replace -ar 'b' 'z' KeyA KeyC +> { KeyA: abc, KeyB: abc, KeyC: ads } | str replace --all --regex 'b' 'z' KeyA KeyC ╭──────┬─────╮ │ KeyA │ azc │ │ KeyB │ abc │ @@ -113,7 +113,7 @@ GHIKK-z+* Find and replace on individual lines using multiline regular expression ```nu -> "non-matching line\n123. one line\n124. another line\n" | str replace -am '^[0-9]+\. ' '' +> "non-matching line\n123. one line\n124. another line\n" | str replace --all --multiline '^[0-9]+\. ' '' non-matching line one line another line diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index cf15b68ca8a..abf9fac63f8 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.85.0 +version: 0.86.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 de7913d6c74..51b66cb094f 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.85.0 +version: 0.86.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 cb7063b6d98..dddb7114aad 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.85.0 +version: 0.86.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 b094892e4fe..82ced96e041 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.85.0 +version: 0.86.0 strings: | Check if an input starts with a string. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index b08abcbba3b..8f1ee6abba4 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.85.0 +version: 0.86.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: | diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index bbd3a8a5521..51484b3645c 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.85.0 +version: 0.86.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 8b502476583..3d6934e7acd 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index baf8e7e36e0..193eb83f7b5 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.85.0 +version: 0.86.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index f68dbb76282..fb077a296dc 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.85.0 +version: 0.86.0 system: | View information about the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index fc279fdaf2c..75cdc598d41 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.85.0 +version: 0.86.0 viewers: | Render the table. usage: | @@ -29,6 +29,7 @@ usage: | - `--flatten-separator, - {string}`: sets a separator when 'flatten' used - `--collapse, -c`: expand the table structure in collapse mode. Be aware collapse mode currently doesn't support width control + - `--abbreviated, -a {int}`: abbreviate the data in the table by truncating the middle part and only showing amount provided on top and bottom ## Input/output types: @@ -60,32 +61,26 @@ Render data in table view Render data in table view (expanded) ```nu > [[a b]; [1 2] [2 [4 4]]] | table --expand -╭───┬───┬───────────╮ -│ # │ a │ b │ -├───┼───┼───────────┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 2 │ ╭───┬───╮ │ -│ │ │ │ 0 │ 4 │ │ -│ │ │ │ 1 │ 4 │ │ -│ │ │ ╰───┴───╯ │ -╰───┴───┴───────────╯ +╭───┬───┬───╮ +│ # │ a │ b │ +├───┼───┼───┤ +│ 0 │ 1 │ 2 │ +│ 1 │ 3 │ 4 │ +╰───┴───┴───╯ ``` Render data in table view (collapsed) ```nu > [[a b]; [1 2] [2 [4 4]]] | table --collapse -╭───┬───╮ -│ a │ b │ -├───┼───┤ -│ 1 │ 2 │ -├───┼───┤ -│ 2 │ 4 │ -│ ├───┤ -│ │ 4 │ -╰───┴───╯ +╭───┬───┬───╮ +│ # │ a │ b │ +├───┼───┼───┤ +│ 0 │ 1 │ 2 │ +│ 1 │ 3 │ 4 │ +╰───┴───┴───╯ ``` ## Notes -If the table contains a column called 'index', this column is used as the table index instead of the usual continuous index. +If the table contains a column called 'index', this column is used as the table index instead of the usual continuous index. \ No newline at end of file diff --git a/commands/docs/take.md b/commands/docs/take.md index 1eda8fafd31..ee00ca4545e 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.85.0 +version: 0.86.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 999c8293432..65f21cbcd30 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.85.0 +version: 0.86.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 9a6fdd81dab..bb8e218f58a 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.85.0 +version: 0.86.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 4c374ab0e5f..be740bd5e68 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.85.0 +version: 0.86.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 55245c6211e..18e19abd70b 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 4440a12d07a..2f201dae874 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Translate structured data to a format. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index e35e9a3bb7a..b8c11d9930c 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert table into .csv text . usage: | @@ -42,7 +42,7 @@ foo,bar Outputs an CSV string representing the contents of this table ```nu -> [[foo bar]; [1 2]] | to csv -s ';' +> [[foo bar]; [1 2]] | to csv --separator ';' foo;bar 1;2 diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index dd1cab19456..b8743134cea 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 35ff8621f01..1f9bdb1447f 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Converts table data into JSON text. usage: | @@ -45,7 +45,7 @@ Outputs a JSON string, with default indentation, representing the contents of th Outputs a JSON string, with 4-space indentation, representing the contents of this table ```nu -> [Joe Bob Sam] | to json -i 4 +> [Joe Bob Sam] | to json --indent 4 [ "Joe", "Bob", diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index e1cd4d14258..e9d29a9eb59 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index abe89ea9c34..8ce6d270a0f 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | @@ -39,7 +39,7 @@ Outputs a NUON string representing the contents of this list, compact by default [1, 2, 3] ``` -Outputs a NUON array of integers, with pretty indentation +Outputs a NUON array of ints, with pretty indentation ```nu > [1 2 3] | to nuon --indent 2 [ diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index b365f566314..6cab362eff8 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index c94f4bd4c01..9041efc9b96 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 6f7f3009eb6..173f70a5417 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index bd911c5a418..8a59fddcea0 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert special record structure into .xml text. usage: | @@ -20,7 +20,8 @@ usage: | ## Flags - - `--pretty, -p {int}`: Formats the XML text with the provided indentation setting + - `--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 ## Input/output types: @@ -45,7 +46,7 @@ When formatting xml null and empty record fields can be omitted and strings can Optionally, formats the text with a custom indentation setting ```nu -> {tag: note content : [{tag: remember content : [Event]}]} | to xml -p 3 +> {tag: note content : [{tag: remember content : [Event]}]} | to xml --indent 3 Event diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index f4932a0c505..482c9f2fca1 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.85.0 +version: 0.86.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 8a90654524d..27614a4ebd2 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.85.0 +version: 0.86.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index af0eca4e45f..87a18f441c6 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | @@ -65,7 +65,7 @@ Transposes the table contents with specified column names Transposes the table without column names and specify a new column name ```nu -> [[c1 c2]; [1 2]] | transpose -i val +> [[c1 c2]; [1 2]] | transpose --ignore-titles val ╭───┬─────╮ │ # │ val │ ├───┼─────┤ @@ -77,7 +77,7 @@ Transposes the table without column names and specify a new column name Transfer back to record with -d flag ```nu -> {c1: 1, c2: 2} | transpose | transpose -i -r -d +> {c1: 1, c2: 2} | transpose | transpose --ignore-titles -r -d ╭────┬───╮ │ c1 │ 1 │ │ c2 │ 2 │ diff --git a/commands/docs/try.md b/commands/docs/try.md index cbeaf60baa5..a8d841ede2a 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.85.0 +version: 0.86.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 d0b7ef18473..15d74ea743d 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.85.0 +version: 0.86.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ucp.md b/commands/docs/ucp.md deleted file mode 100644 index 1058924b7ba..00000000000 --- a/commands/docs/ucp.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ucp -categories: | - filesystem -version: 0.85.0 -filesystem: | - Copy files using uutils/coreutils cp. -usage: | - Copy files using uutils/coreutils cp. ---- - - -# {{ $frontmatter.title }} for filesystem - -
{{ $frontmatter.filesystem }}
- -## Signature - -```> ucp {flags} ...rest``` - -## Flags - - - `--recursive, -r`: copy directories recursively - - `--verbose, -v`: explicitly state what is being done - - `--force, -f`: if an existing destination file cannot be opened, remove it and try - again (this option is ignored when the -n option is also used). - currently not implemented for windows - - `--interactive, -i`: ask before overwriting files - - `--progress, -p`: display a progress bar - - `--no-clobber, -n`: do not overwrite an existing file - - `--debug, -`: explain how a file is copied. Implies -v - -## Parameters - - - `...rest`: Copy SRC file/s to DEST - - -## Input/output types: - -| input | output | -| ------- | ------- | -| nothing | nothing | - -## Examples - -Copy myfile to dir_b -```nu -> ucp myfile dir_b - -``` - -Recursively copy dir_a to dir_b -```nu -> ucp -r dir_a dir_b - -``` - -Recursively copy dir_a to dir_b, and print the feedbacks -```nu -> ucp -r -v dir_a dir_b - -``` - -Move many files into a directory -```nu -> ucp *.txt dir_a - -``` diff --git a/commands/docs/unfold.md b/commands/docs/unfold.md new file mode 100644 index 00000000000..a2d961be755 --- /dev/null +++ b/commands/docs/unfold.md @@ -0,0 +1,71 @@ +--- +title: unfold +categories: | + generators +version: 0.86.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 + +```> unfold {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 +> unfold 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 +> unfold [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/uniq-by.md b/commands/docs/uniq-by.md index 71a97bd3751..71ceb458334 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.85.0 +version: 0.86.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 3d86443562a..a69f647003d 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Return the distinct values in the input. usage: | @@ -56,7 +56,7 @@ Return the input values that occur more than once Return the input values that occur once only ```nu -> [1 2 2] | uniq -u +> [1 2 2] | uniq --unique ╭───┬───╮ │ 0 │ 1 │ ╰───┴───╯ @@ -65,7 +65,7 @@ Return the input values that occur once only Ignore differences in case when comparing input values ```nu -> ['hello' 'goodbye' 'Hello'] | uniq -i +> ['hello' 'goodbye' 'Hello'] | uniq --ignore-case ╭───┬─────────╮ │ 0 │ hello │ │ 1 │ goodbye │ @@ -75,7 +75,7 @@ Ignore differences in case when comparing input values Return a table containing the distinct input values together with their counts ```nu -> [1 2 2] | uniq -c +> [1 2 2] | uniq --count ╭───┬───────┬───────╮ │ # │ value │ count │ ├───┼───────┼───────┤ diff --git a/commands/docs/update.md b/commands/docs/update.md index f1f1a20c663..2548677e27c 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.85.0 +version: 0.86.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 e417eb257fa..d756d0a83b3 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Update the table cells. usage: | @@ -47,11 +47,11 @@ Update the zero value cells to empty strings. $value } } -╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────┬──────────────┬──────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├──────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┼──────────────┼──────────────┤ -│ 0 │ 37 │ │ │ │ 37 │ │ │ -╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────┴──────────────┴──────────────╯ +╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ 0 │ 37 │ │ │ │ 37 │ │ │ +╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ ``` @@ -67,11 +67,11 @@ Update the zero value cells to empty strings in 2 last columns. $value } } -╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────┬──────────────┬──────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├──────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┼──────────────┼──────────────┤ -│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ -╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────┴──────────────┴──────────────╯ +╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ +╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ ``` diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 3a68bf0bc84..1ddc72ef8bd 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.85.0 +version: 0.86.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 f5eb9bfa9eb..1da2c85b472 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.85.0 +version: 0.86.0 network: | Various commands for working with URLs. usage: | @@ -33,6 +33,7 @@ You must use one of the following subcommands. Using this command as-is will onl | name | type | usage | | ------------------------------------------------------ | ------- | --------------------------------------------------------------------- | | [`url build-query`](/commands/docs/url_build-query.md) | Builtin | Converts record or table into query string applying percent-encoding. | +| [`url decode`](/commands/docs/url_decode.md) | Builtin | Converts a percent-encoded web safe string to a string. | | [`url encode`](/commands/docs/url_encode.md) | Builtin | Converts a string to a percent encoded web safe string. | | [`url join`](/commands/docs/url_join.md) | Builtin | Converts a record to url. | | [`url parse`](/commands/docs/url_parse.md) | Builtin | Parses a url. | \ No newline at end of file diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 8bc4cba412e..648b23870cd 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.85.0 +version: 0.86.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 new file mode 100644 index 00000000000..755452831b1 --- /dev/null +++ b/commands/docs/url_decode.md @@ -0,0 +1,51 @@ +--- +title: url decode +categories: | + strings +version: 0.86.0 +strings: | + Converts a percent-encoded web safe string to a string. +usage: | + Converts a percent-encoded web safe string to a string. +--- + + +# {{ $frontmatter.title }} for strings + +
{{ $frontmatter.strings }}
+ +## Signature + +```> url decode {flags} ...rest``` + +## Parameters + + - `...rest`: For a data structure input, url decode strings at the given cell paths + + +## Input/output types: + +| input | output | +| ------------ | ------------ | +| list\ | list\ | +| record | record | +| string | string | +| table | table | +## Examples + +Decode a url with escape characters +```nu +> 'https://example.com/foo%20bar' | url decode +https://example.com/foo bar +``` + +Decode multiple urls with escape characters in list +```nu +> ['https://example.com/foo%20bar' 'https://example.com/a%3Eb' '%E4%B8%AD%E6%96%87%E5%AD%97/eng/12%2034'] | url decode +╭───┬─────────────────────────────╮ +│ 0 │ https://example.com/foo bar │ +│ 1 │ https://example.com/a>b │ +│ 2 │ 中文字/eng/12 34 │ +╰───┴─────────────────────────────╯ + +``` diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index f8dcdf6c501..33dd8e1a630 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.85.0 +version: 0.86.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 461b222002e..0796de3cd91 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.85.0 +version: 0.86.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index 640b6116393..a51dd5b235c 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.85.0 +version: 0.86.0 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 07f9d75b0b9..d402c98c919 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.85.0 +version: 0.86.0 core: | Use definitions from a module, making them available in your shell. usage: | @@ -40,7 +40,7 @@ foo Define a custom command that participates in the environment in a module and call it ```nu -> module foo { export def-env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR +> module foo { export def --env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR BAZ ``` diff --git a/commands/docs/values.md b/commands/docs/values.md index d5e8f8df189..7a90eb90a8e 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.85.0 +version: 0.86.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 d20f87d2d85..735657d16c2 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.85.0 +version: 0.86.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index d67d8f9e575..36926577b42 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index acc90beb53e..c56fd853b08 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.85.0 +version: 0.86.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 af0f236e634..4acdcacad86 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | View a block, module, or a definition. usage: | @@ -45,7 +45,7 @@ def hi [] { echo 'Hi!' } View the source of a custom command, which participates in the caller environment ```nu -> def-env foo [] { $env.BAR = 'BAZ' }; view source foo +> def --env foo [] { $env.BAR = 'BAZ' }; view source foo def foo [] { $env.BAR = 'BAZ' } ``` diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index e3edd2b816a..22effc4867d 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.85.0 +version: 0.86.0 debug: | View the contents of a span. usage: | @@ -32,9 +32,9 @@ usage: | ## Examples -View the source of a span. 1 and 2 are just example values. Use the return of debug -r to get the actual values +View the source of a span. 1 and 2 are just example values. Use the return of debug --raw to get the actual values ```nu -> some | pipeline | or | variable | debug -r; view span 1 2 +> some | pipeline | or | variable | debug --raw; view span 1 2 ``` diff --git a/commands/docs/watch.md b/commands/docs/watch.md index a717ac82069..e3bd3903ad2 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.85.0 +version: 0.86.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 ae1f0478a3c..6bcaf476064 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Filter values based on a row condition. usage: | @@ -78,7 +78,7 @@ List all files that were modified in the last two weeks Find files whose filenames don't begin with the correct sequential number ```nu -> ls | where type == file | sort-by name -n | enumerate | where {|e| $e.item.name !~ $'^($e.index + 1)' } | each {|| get item } +> ls | where type == file | sort-by name --natural | enumerate | where {|e| $e.item.name !~ $'^($e.index + 1)' } | each {|| get item } ``` diff --git a/commands/docs/which.md b/commands/docs/which.md index 5d70068225e..462398bb2d6 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.85.0 +version: 0.86.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 59b0a2d11c2..67f13be34af 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.85.0 +version: 0.86.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 39915e9a41b..75aed5046e7 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.85.0 +version: 0.86.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 87e3a7e5172..68a4629603a 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.85.0 +version: 0.86.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index d195502d34f..07e4067e9dc 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 9dc17bd4edb..dfe7f9d5d63 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.85.0 +version: 0.86.0 filters: | Combine a stream with the input. usage: |